DevicesClient.DeleteAsync 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

DeleteAsync(String, CancellationToken)	Exclua a identidade do dispositivo com a ID fornecida do registro do hub IoT.
DeleteAsync(Device, Boolean, CancellationToken)	Exclua a identidade do dispositivo com a ID fornecida do registro do hub IoT.
DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)	Exclua até 100 identidades de dispositivo do registro do hub IoT em massa.

DeleteAsync(String, CancellationToken)

Exclua a identidade do dispositivo com a ID fornecida do registro do hub IoT.

public virtual System.Threading.Tasks.Task DeleteAsync (string deviceId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

deviceId: String

A ID da identidade do dispositivo a ser excluída.

cancellationToken: CancellationToken

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

Retornos

Task

Exceções

ArgumentNullException

Quando a ID do dispositivo fornecida é nula.

ArgumentException

Quando a ID do dispositivo fornecida estiver vazia ou espaço em branco.

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

Aplica-se a

DeleteAsync(Device, Boolean, CancellationToken)

Exclua a identidade do dispositivo com a ID fornecida do registro do hub IoT.

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

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

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

Parâmetros

device: Device

A identidade do dispositivo a ser excluída do registro do hub IoT. Se a ETag do dispositivo fornecida estiver desatualizada, essa operação lançará um IotHubServiceException com PreconditionFailed Uma ETag atualizada pode ser recuperada usando GetAsync(String, CancellationToken). Para forçar a operação a ser executada independentemente da ETag, defina a ETag da identidade do dispositivo como "*" ou use DeleteAsync(String, CancellationToken).

onlyIfUnchanged: Boolean

Se for false, essa operação de exclusã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, CancellationToken).

cancellationToken: CancellationToken

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

Retornos

Task

Exceções

ArgumentNullException

Quando o dispositivo fornecido é nulo.

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

Aplica-se a

DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)

Exclua até 100 identidades de dispositivo do registro do hub IoT em massa.

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

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

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