Class AdrClientWrapper

Namespace

Azure.Iot.Operations.Connector

Assembly

Azure.Iot.Operations.Connector.dll

public class AdrClientWrapper : IAdrClientWrapper, IAsyncDisposable

Inheritance

object

AdrClientWrapper

Implements

IAdrClientWrapper

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AdrClientWrapper(ApplicationContext, IMqttPubSubClient)

public AdrClientWrapper(ApplicationContext applicationContext, IMqttPubSubClient mqttPubSubClient)

Parameters

applicationContext ApplicationContext

mqttPubSubClient IMqttPubSubClient

AdrClientWrapper(IAdrServiceClient, IAssetFileMonitor?)

public AdrClientWrapper(IAdrServiceClient adrServiceClient, IAssetFileMonitor? assetFileMonitor = null)

Parameters

adrServiceClient IAdrServiceClient

assetFileMonitor IAssetFileMonitor

Methods

CreateOrUpdateDiscoveredAssetAsync(string, string, CreateOrUpdateDiscoveredAssetRequest, TimeSpan?, CancellationToken)

public Task<CreateOrUpdateDiscoveredAssetResponsePayload> CreateOrUpdateDiscoveredAssetAsync(string deviceName, string inboundEndpointName, CreateOrUpdateDiscoveredAssetRequest request, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

deviceName string

inboundEndpointName string

request CreateOrUpdateDiscoveredAssetRequest

commandTimeout TimeSpan?

cancellationToken CancellationToken

Returns

Task<CreateOrUpdateDiscoveredAssetResponsePayload>

CreateOrUpdateDiscoveredDeviceAsync(CreateOrUpdateDiscoveredDeviceRequestSchema, string, TimeSpan?, CancellationToken)

public Task<CreateOrUpdateDiscoveredDeviceResponsePayload> CreateOrUpdateDiscoveredDeviceAsync(CreateOrUpdateDiscoveredDeviceRequestSchema request, string inboundEndpointType, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

request CreateOrUpdateDiscoveredDeviceRequestSchema

inboundEndpointType string

commandTimeout TimeSpan?

cancellationToken CancellationToken

Returns

Task<CreateOrUpdateDiscoveredDeviceResponsePayload>

DisposeAsync()

public ValueTask DisposeAsync()

Returns

ValueTask

GetAssetNames(string, string)

public IEnumerable<string> GetAssetNames(string deviceName, string inboundEndpointName)

Parameters

deviceName string

inboundEndpointName string

Returns

IEnumerable<string>

GetDeviceNames()

public IEnumerable<string> GetDeviceNames()

Returns

IEnumerable<string>

GetEndpointCredentials(string, string, InboundEndpointSchemaMapValue)

public EndpointCredentials GetEndpointCredentials(string deviceName, string inboundEndpointName, InboundEndpointSchemaMapValue inboundEndpoint)

Parameters

deviceName string

inboundEndpointName string

inboundEndpoint InboundEndpointSchemaMapValue

Returns

EndpointCredentials

GetInboundEndpointNames(string)

public IEnumerable<string> GetInboundEndpointNames(string deviceName)

Parameters

deviceName string

Returns

IEnumerable<string>

ObserveAssets(string, string)

public void ObserveAssets(string deviceName, string inboundEndpointName)

Parameters

deviceName string

inboundEndpointName string

ObserveDevices()

public void ObserveDevices()

UnobserveAllAsync(CancellationToken)

public Task UnobserveAllAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

UnobserveAssetsAsync(string, string, CancellationToken)

public Task UnobserveAssetsAsync(string deviceName, string inboundEndpointName, CancellationToken cancellationToken = default)

Parameters

deviceName string

inboundEndpointName string

cancellationToken CancellationToken

Returns

Task

UnobserveDevicesAsync(CancellationToken)

public Task UnobserveDevicesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

UpdateAssetStatusAsync(string, string, UpdateAssetStatusRequest, TimeSpan?, CancellationToken)

public Task<AssetStatus> UpdateAssetStatusAsync(string deviceName, string inboundEndpointName, UpdateAssetStatusRequest request, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

deviceName string

inboundEndpointName string

request UpdateAssetStatusRequest

commandTimeout TimeSpan?

cancellationToken CancellationToken

Returns

Task<AssetStatus>

UpdateDeviceStatusAsync(string, string, DeviceStatus, TimeSpan?, CancellationToken)

public Task<DeviceStatus> UpdateDeviceStatusAsync(string deviceName, string inboundEndpointName, DeviceStatus status, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

deviceName string

inboundEndpointName string

status DeviceStatus

commandTimeout TimeSpan?

cancellationToken CancellationToken

Returns

Task<DeviceStatus>

Events

AssetChanged

Executes whenever a asset is created, updated, or deleted.

public event EventHandler<AssetChangedEventArgs>? AssetChanged

Event Type

EventHandler<AssetChangedEventArgs>

Remarks

To start receiving these events, use ObserveAssets(string, string).

DeviceChanged

Executes whenever a device is created, updated, or deleted.

public event EventHandler<DeviceChangedEventArgs>? DeviceChanged

Event Type

EventHandler<DeviceChangedEventArgs>

Remarks

To start receiving these events, use ObserveDevices().