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

Referência

Definição

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Substitua o estado de uma identidade de módulo pelo estado da identidade do módulo fornecido.

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

O novo estado da identidade do módulo.

onlyIfUnchanged: Boolean

Se for false, essa operação será executada mesmo se a identidade do dispositivo fornecida tiver uma ETag desatualizada. Se for true, a operação lançará um IotHubServiceException com PreconditionFailed se o módulo fornecido tiver uma ETag desatualizada. Uma ETag atualizada pode ser recuperada usando GetAsync(String, String, CancellationToken).

cancellationToken: CancellationToken

O token que permite que a operação seja cancelada.

Retornos

Task<Module>

A identidade do módulo recém-atualizada, incluindo sua nova ETag.

Exceções

ArgumentNullException

Gerado quando o módulo fornecido é nulo.

IotHubServiceException

Gerado se o Hub IoT respondeu à solicitação com um código de status não bem-sucedido. Por exemplo, se a solicitação fornecida foi limitada, IotHubServiceException com ThrottlingException é lançada. Para obter uma lista completa de possíveis casos de erro, consulte IotHubServiceErrorCode.

HttpRequestException

Se a solicitação HTTP falhar devido a um problema subjacente, como conectividade de rede, falha de DNS ou validação de certificado do servidor.

OperationCanceledException

Se o token de cancelamento fornecido tiver solicitado o cancelamento.

Aplica-se a

Compartilhar via