TwinsClient.UpdateAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Devices

Ensamblado:

Microsoft.Azure.Devices.dll

Paquete:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)	Actualice los campos mutables de una lista de módulos gemelos creados anteriormente en el sistema.
UpdateAsync(String, ClientTwin, Boolean, CancellationToken)	Novedades los campos mutables del gemelo de un módulo.
UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)	Novedades los campos mutables del gemelo de un módulo.

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)

Actualice los campos mutables de una lista de módulos gemelos creados anteriormente en el sistema.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> UpdateAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.ClientTwin> twins, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAsync : seq<Microsoft.Azure.Devices.ClientTwin> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
override this.UpdateAsync : seq<Microsoft.Azure.Devices.ClientTwin> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>

Public Overridable Function UpdateAsync (twins As IEnumerable(Of ClientTwin), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)

Parámetros

twins

IEnumerable<ClientTwin>

Lista de ClientTwins con campos actualizados.

onlyIfUnchanged

Boolean

Si es false, esta operación se realizará incluso si la identidad del dispositivo proporcionada tiene una ETag obsoleta. Si es true, la operación producirá un IotHubServiceException con PreconditionFailed si la identidad del dispositivo proporcionada tiene una ETag obsoleta. Se puede recuperar una ETag actualizada mediante GetAsync(String, String, CancellationToken).

cancellationToken

CancellationToken

Token de cancelación de tareas.

Devoluciones

Task<BulkRegistryOperationResult>

módulo gemelo actualizado.

Excepciones

ArgumentNullException

Cuando el valor proporcionado twins es NULL.

ArgumentException

Cuando la enumeración proporcionada twins está vacía.

InvalidOperationException

Cuando falta un gemelo, falta una ETag esperada.

IotHubServiceException

Si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si la solicitud proporcionada se ha limitado, IotHubServiceException se produce con ThrottlingException . Para obtener una lista completa de los posibles casos de error, vea IotHubServiceErrorCode.

HttpRequestException

Si se produce un error en la solicitud HTTP debido a un problema subyacente, como la conectividad de red, el error dns o la validación del certificado de servidor.

OperationCanceledException

Si el proporcionado cancellationToken ha solicitado la cancelación.

UpdateAsync(String, ClientTwin, Boolean, CancellationToken)

Novedades los campos mutables del gemelo de un módulo.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> UpdateAsync (string deviceId, Microsoft.Azure.Devices.ClientTwin twinPatch, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.UpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>

Public Overridable Function UpdateAsync (deviceId As String, twinPatch As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)

Parámetros

deviceId

String

Identificador del dispositivo.

twinPatch

ClientTwin

Gemelo con campos actualizados.

onlyIfUnchanged

Boolean

Si es false, esta operación se realizará incluso si la identidad del dispositivo proporcionada tiene una ETag obsoleta. Si es true, la operación producirá un IotHubServiceException con PreconditionFailed si la identidad del dispositivo proporcionada tiene una ETag obsoleta. Se puede recuperar una ETag actualizada mediante GetAsync(String, String, CancellationToken).

cancellationToken

CancellationToken

Token de cancelación de tareas.

Devoluciones

Task<ClientTwin>

Se ha actualizado el dispositivo gemelo.

Excepciones

ArgumentNullException

Cuando el proporcionado deviceId o twinPatch es null.

ArgumentException

Si está deviceId vacío o está en blanco.

IotHubServiceException

Si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si la solicitud proporcionada se ha limitado, IotHubServiceException se produce con ThrottlingException . Para obtener una lista completa de los posibles casos de error, vea IotHubServiceErrorCode.

HttpRequestException

Si se produce un error en la solicitud HTTP debido a un problema subyacente, como la conectividad de red, el error dns o la validación del certificado de servidor.

OperationCanceledException

Si el proporcionado cancellationToken ha solicitado la cancelación.

UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)

Novedades los campos mutables del gemelo de un módulo.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> UpdateAsync (string deviceId, string moduleId, Microsoft.Azure.Devices.ClientTwin twinPatch, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.UpdateAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>

Public Overridable Function UpdateAsync (deviceId As String, moduleId As String, twinPatch As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)

Parámetros

deviceId

String

Identificador del dispositivo.

moduleId

String

Identificador del módulo.

twinPatch

ClientTwin

Gemelo con campos actualizados.

onlyIfUnchanged

Boolean

Si es false, esta operación se realizará incluso si la identidad del dispositivo proporcionada tiene una ETag obsoleta. Si es true, la operación producirá un IotHubServiceException con PreconditionFailed si la identidad del dispositivo o módulo proporcionado tiene una ETag obsoleta. Se puede recuperar una ETag actualizada mediante GetAsync(String, String, CancellationToken).

cancellationToken

CancellationToken

Token de cancelación de tareas.

Devoluciones

Task<ClientTwin>

Se ha actualizado el dispositivo gemelo.

Excepciones

ArgumentNullException

Cuando el objeto proporcionado deviceIdes , moduleIdo twinPatch es null.

ArgumentException

Si el o deviceIdmoduleId está vacío o el espacio en blanco.

IotHubServiceException

Si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si la solicitud proporcionada se ha limitado, IotHubServiceException se produce con ThrottlingException . Para obtener una lista completa de los posibles casos de error, vea IotHubServiceErrorCode.

HttpRequestException

Si se produce un error en la solicitud HTTP debido a un problema subyacente, como la conectividad de red, el error dns o la validación del certificado de servidor.

OperationCanceledException

Si el proporcionado cancellationToken ha solicitado la cancelación.