DigitalTwinsClient.InvokeComponentCommandAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Paquet:

Microsoft.Azure.Devices v2.0.0-preview002

Appelez une commande sur un composant d’un jumeau numérique.

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)

Paramètres

digitalTwinId

String

ID du jumeau numérique.

componentName

String

Nom du composant sous lequel la commande est définie.

commandName

String

Commande à appeler.

requestOptions

InvokeDigitalTwinCommandOptions

Paramètres facultatifs pour cette demande.

cancellationToken

CancellationToken

CancellationToken.

Retours

Task<InvokeDigitalTwinCommandResponse>

La réponse d’appel de commande application/json sérialisée, la réponse de commande status code et l’ID de demande.

Exceptions

ArgumentNullException

Lorsque le fourni digitalTwinId ou ou commandNamecomponentName est null.

ArgumentException

Lorsque le fourni digitalTwinId ou ou commandNamecomponentName est vide ou espace blanc.

IotHubServiceException

Levée si IoT Hub a répondu à la demande avec un code de status non réussi. Par exemple, si la requête fournie a été limitée, IotHubServiceException avec ThrottlingException est levée. Pour obtenir la liste complète des cas d’erreur possibles, consultez IotHubServiceErrorCode.

HttpRequestException

Si la requête HTTP échoue en raison d’un problème sous-jacent tel que la connectivité réseau, l’échec DNS ou la validation du certificat de serveur.

OperationCanceledException

Si le fourni cancellationToken a demandé l’annulation.