DigitalTwinsClient.InvokeCommandAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Package:: Microsoft.Azure.Devices v2.0.0-preview002

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Invoke a command on a digital twin.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.InvokeDigitalTwinCommandResponse> InvokeCommandAsync (string digitalTwinId, string commandName, Microsoft.Azure.Devices.InvokeDigitalTwinCommandOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member InvokeCommandAsync : string * string * Microsoft.Azure.Devices.InvokeDigitalTwinCommandOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.InvokeDigitalTwinCommandResponse>
override this.InvokeCommandAsync : string * string * Microsoft.Azure.Devices.InvokeDigitalTwinCommandOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.InvokeDigitalTwinCommandResponse>

Public Overridable Function InvokeCommandAsync (digitalTwinId As String, commandName As String, Optional requestOptions As InvokeDigitalTwinCommandOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of InvokeDigitalTwinCommandResponse)

Parameters

digitalTwinId: String

The Id of the digital twin.

commandName: String

The command to be invoked.

requestOptions: InvokeDigitalTwinCommandOptions

The optional settings for this request.

cancellationToken: CancellationToken

The cancellationToken.

Returns

Task<InvokeDigitalTwinCommandResponse>

The serialized application/json command invocation response, the command response status code, and the request id.

Exceptions

ArgumentNullException

When the provided digitalTwinId or commandName is null.

ArgumentException

When the provided digitalTwinId or commandName is empty or whitespace.

IotHubServiceException

Thrown if IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to