TwinsClient.ReplaceAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Devices

Ensamblado:

Microsoft.Azure.Devices.dll

Paquete:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)	Novedades los campos mutables del gemelo de un dispositivo.
ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken)	Novedades los campos mutables del gemelo de un módulo.

ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)

Novedades los campos mutables del gemelo de un dispositivo.

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

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

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

Parámetros

deviceId

String

Identificador del dispositivo.

newTwin

ClientTwin

Nuevo objeto gemelo por el que se va a reemplazar.

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>

gemelos actualizados.

Excepciones

ArgumentNullException

Cuando el proporcionado deviceId o newTwin es null.

ArgumentException

Cuando el elemento proporcionado deviceId está vacío o 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.

ReplaceAsync(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> ReplaceAsync (string deviceId, string moduleId, Microsoft.Azure.Devices.ClientTwin newTwin, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function ReplaceAsync (deviceId As String, moduleId As String, newTwin 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.

newTwin

ClientTwin

Nuevo objeto twin por el que se va a reemplazar.

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 newTwin es null.

ArgumentException

Cuando el proporcionado deviceId o está vacío o moduleId 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.