DevicesClient.SetAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Devices

Ensamblado:

Microsoft.Azure.Devices.dll

Paquete:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

SetAsync(Device, Boolean, CancellationToken)	Reemplace el estado de una identidad de dispositivo por el estado de la identidad del dispositivo proporcionada.
SetAsync(IEnumerable<Device>, Boolean, CancellationToken)	Actualice hasta 100 identidades de dispositivo en el registro de IoT Hub de forma masiva.

SetAsync(Device, Boolean, CancellationToken)

Reemplace el estado de una identidad de dispositivo por el estado de la identidad del dispositivo proporcionada.

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

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

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

Parámetros

device

Device

El nuevo estado de la identidad del dispositivo.

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task<Device>

La identidad del dispositivo recién actualizada, incluida su nueva ETag.

Excepciones

ArgumentNullException

Cuando el dispositivo proporcionado es null.

IotHubServiceException

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.

SetAsync(IEnumerable<Device>, Boolean, CancellationToken)

Actualice hasta 100 identidades de dispositivo en el registro de IoT Hub de forma masiva.

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

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

Public Overridable Function SetAsync (devices As IEnumerable(Of Device), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)

Parámetros

devices

IEnumerable<Device>

Identidades de dispositivo que se van a actualizar al registro de IoT Hub. Es posible que no supere los 100 dispositivos.

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task<BulkRegistryOperationResult>

Resultado de la operación masiva.

Excepciones

ArgumentNullException

Cuando la colección de dispositivos proporcionada es null.

ArgumentException

Cuando la colección de dispositivos proporcionada está vacía.

IotHubServiceException

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.