TwinsClient.UpdateAsync 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.

Sobrecargas

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)	Atualize os campos mutáveis para uma lista de módulos gêmeos criados anteriormente no sistema.
UpdateAsync(String, ClientTwin, Boolean, CancellationToken)	Atualizações os campos mutáveis do gêmeo de um módulo.
UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)	Atualizações os campos mutáveis do gêmeo de um módulo.

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)

Atualize os campos mutáveis para uma lista de módulos gêmeos criados anteriormente no 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 com campos atualizados.

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 gerará um IotHubServiceException com PreconditionFailed se a identidade do dispositivo fornecida tiver uma ETag desatualizada. Uma ETag atualizada pode ser recuperada usando GetAsync(String, String, CancellationToken).

cancellationToken: CancellationToken

Token de cancelamento de tarefa.

Retornos

Task<BulkRegistryOperationResult>

módulo gêmeo atualizado.

Exceções

ArgumentNullException

Quando o fornecido twins é nulo.

ArgumentException

Quando a enumeração fornecida twins estiver vazia.

InvalidOperationException

Quando um gêmeo está sem uma ETag esperada.

IotHubServiceException

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 é gerada. 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 fornecido cancellationToken tiver solicitado o cancelamento.

Aplica-se a

UpdateAsync(String, ClientTwin, Boolean, CancellationToken)

Atualizações os campos mutáveis do gêmeo de um 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

A ID do dispositivo.

twinPatch: ClientTwin

Gêmeo com campos atualizados.

onlyIfUnchanged: Boolean

cancellationToken: CancellationToken

Token de cancelamento de tarefa.

Retornos

Task<ClientTwin>

Dispositivo gêmeo atualizado.

Exceções

ArgumentNullException

Quando o fornecido deviceId ou twinPatch é nulo.

ArgumentException

Se o deviceId estiver vazio ou espaço em branco.

IotHubServiceException

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 fornecido cancellationToken tiver solicitado o cancelamento.

Aplica-se a

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

Atualizações os campos mutáveis do gêmeo de um 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

A ID do dispositivo.

moduleId: String

A ID do módulo.

twinPatch: ClientTwin

Gêmeo com campos atualizados.

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 gerará um IotHubServiceException com PreconditionFailed se a identidade do dispositivo/módulo fornecida tiver uma ETag desatualizada. Uma ETag atualizada pode ser recuperada usando GetAsync(String, String, CancellationToken).