DigitalTwinsClient.InvokeComponentCommandAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

デジタル ツインのコンポーネントでコマンドを呼び出します。

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)

パラメーター

digitalTwinId

String

デジタル ツインの ID。

componentName

String

コマンドが定義されているコンポーネント名。

commandName

String

呼び出されるコマンド。

requestOptions

InvokeDigitalTwinCommandOptions

この要求のオプションの設定。

cancellationToken

CancellationToken

cancellationToken。

戻り値

Task<InvokeDigitalTwinCommandResponse>

シリアル化された application/json コマンド呼び出し応答、コマンド応答状態コード、および要求 ID。

例外

ArgumentNullException

指定 digitalTwinId された または componentNamecommandName が null の場合。

ArgumentException

指定 digitalTwinId された または componentNamecommandName が空または空白の場合。

IotHubServiceException

IoT ハブが失敗した状態コードで要求に応答した場合にスローされます。 たとえば、指定された要求が調整された場合、 IotHubServiceException が ThrottlingException スローされます。 考えられるエラー ケースの完全な一覧については、「」を参照してください IotHubServiceErrorCode。

HttpRequestException

ネットワーク接続、DNS エラー、サーバー証明書の検証などの根本的な問題が原因で HTTP 要求が失敗した場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。