Interface IDiscoveredAssetResourcesClient

Namespace

Azure.Iot.Operations.Services.Akri

Assembly

Azure.Iot.Operations.Services.dll

Interface for creating discovered assets and asset endpoint profiles.

public interface IDiscoveredAssetResourcesClient : IAsyncDisposable

Inherited Members

IAsyncDisposable.DisposeAsync()

Methods

CreateDiscoveredAssetAsync(CreateDiscoveredAssetRequestPayload, TimeSpan?, CancellationToken)

Creates a discovered asset based on the specified request details.

Task<CreateDiscoveredAssetResponseSchema?> CreateDiscoveredAssetAsync(CreateDiscoveredAssetRequestPayload discoveredAssetRequest, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

discoveredAssetRequest CreateDiscoveredAssetRequestPayload

Request containing information about the asset to be created.

timeout TimeSpan?

An optional timeout for the operation, which defines how long the method should wait before timing out.

cancellationToken CancellationToken

A token that can be used to cancel the operation before completion if needed.

Returns

Task<CreateDiscoveredAssetResponseSchema>

A task that represents the asynchronous operation. The task result contains an CreateDiscoveredAssetResponseSchema object if the asset creation succeeds, or null if the operation fails or no response is available.

CreateDiscoveredAssetEndpointProfileAsync(CreateDiscoveredAssetEndpointProfileRequestPayload, TimeSpan?, CancellationToken)

Creates a discovered asset endpoint profile based on the specified request details.

Task<CreateDiscoveredAssetEndpointProfileResponseSchema?> CreateDiscoveredAssetEndpointProfileAsync(CreateDiscoveredAssetEndpointProfileRequestPayload discoveredAssetEndpointProfileRequest, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

discoveredAssetEndpointProfileRequest CreateDiscoveredAssetEndpointProfileRequestPayload

Request containing the details required to create the asset endpoint profile.

timeout TimeSpan?

An optional timeout for the operation, which specifies the maximum time allowed for the request to complete.

cancellationToken CancellationToken

A token that can be used to cancel the operation before completion if needed.

Returns

Task<CreateDiscoveredAssetEndpointProfileResponseSchema>

A task that represents the asynchronous operation. The task result contains an CreateDiscoveredAssetEndpointProfileResponseSchema object if the asset endpoint profile is successfully created, or null if the operation fails or no response is available.