ModulesClient.SetAsync(Module, Boolean, CancellationToken) Método

Definición

Espacio de nombres:

Microsoft.Azure.Devices

Ensamblado:

Microsoft.Azure.Devices.dll

Paquete:

Microsoft.Azure.Devices v2.0.0-preview002

Reemplace el estado de una identidad de módulo por el estado de la identidad del módulo proporcionado.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module> SetAsync (Microsoft.Azure.Devices.Module module, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>
override this.SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>

Public Overridable Function SetAsync (module As Module, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Module)

Parámetros

module

Module

El nuevo estado de la identidad del módulo.

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 iniciará un IotHubServiceException elemento con PreconditionFailed si el módulo proporcionado tiene una ETag obsoleta. Una ETag actualizada se puede recuperar mediante GetAsync(String, String, CancellationToken).

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task<Module>

La identidad del módulo recién actualizada, incluida su nueva ETag.

Excepciones

ArgumentNullException

Se produce cuando el módulo proporcionado es NULL.

IotHubServiceException

Se produce si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si se ha limitado la solicitud proporcionada, IotHubServiceException se produce con ThrottlingException . Para obtener una lista completa de 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 token de cancelación proporcionado ha solicitado la cancelación.