ScheduledJobsClient.ScheduleTwinUpdateAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Crée un travail pour mettre à jour les balises de jumeau et les propriétés souhaitées sur un ou plusieurs appareils.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.TwinScheduledJob> ScheduleTwinUpdateAsync (string queryCondition, Microsoft.Azure.Devices.ClientTwin twin, DateTimeOffset startOnUtc, Microsoft.Azure.Devices.ScheduledJobsOptions scheduledJobsOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ScheduleTwinUpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * DateTimeOffset * Microsoft.Azure.Devices.ScheduledJobsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.TwinScheduledJob>
override this.ScheduleTwinUpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * DateTimeOffset * Microsoft.Azure.Devices.ScheduledJobsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.TwinScheduledJob>

Public Overridable Function ScheduleTwinUpdateAsync (queryCondition As String, twin As ClientTwin, startOnUtc As DateTimeOffset, Optional scheduledJobsOptions As ScheduledJobsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TwinScheduledJob)

Paramètres

queryCondition: String

Condition de requête pour évaluer les appareils sur lesquels exécuter le travail.

twin: ClientTwin

Objet jumeau à utiliser pour la mise à jour.

startOnUtc: DateTimeOffset

Quand démarrer le travail, en UTC.

scheduledJobsOptions: ScheduledJobsOptions

Paramètres facultatifs pour la mise à jour planifiée du jumeau, c’est-à-dire : scheduledJobsOptions.JobId.JobId et scheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds.

cancellationToken: CancellationToken

Jeton d’annulation de tâche.

Retours

Task<TwinScheduledJob>

Objet de travail.

Exceptions

ArgumentNullException

Lorsque le fourni scheduledJobsOptions.JobId.JobId ou queryCondition ou twin ou startOnUtc ou est scheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds null.

ArgumentException

Si ou scheduledJobsOptions.JobId.JobIdqueryCondition est vide ou espace blanc.

IotHubServiceException

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.

S’applique à

Partager via