DigitalTwinsClient.InvokeComponentCommandAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Invoke a command on a component of a digital twin.

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

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

Public Overridable Function InvokeComponentCommandAsync (digitalTwinId As String, componentName 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.

componentName

String

The component name under which the command is defined.

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 componentName or commandName is null.

ArgumentException

When the provided digitalTwinId or componentName 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.