ModulesClient.DeleteAsync Método

Definição

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Pacote:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

DeleteAsync(Module, Boolean, CancellationToken)	Exclua a identidade do módulo do registro do hub IoT.
DeleteAsync(String, String, CancellationToken)	Exclua a identidade do módulo com a ID fornecida do dispositivo com a ID fornecida do registro do hub IoT.

DeleteAsync(Module, Boolean, CancellationToken)

Exclua a identidade do módulo do registro do hub IoT.

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

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

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

Parâmetros

module

Module

A identidade do módulo a ser excluída do registro do hub IoT. Se a ETag do módulo fornecido estiver desatualizada, essa operação lançará um IotHubServiceException com PreconditionFailed um ETag atualizado pode ser recuperado usando GetAsync(String, String, CancellationToken). Para forçar a operação a ser executada independentemente da ETag, defina a ETag da identidade do módulo como "*" ou use DeleteAsync(String, 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 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

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.

DeleteAsync(String, String, CancellationToken)

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

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

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

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

Parâmetros

deviceId

String

A ID da identidade do dispositivo que contém o módulo a ser excluído.

moduleId

String

A ID da identidade do módulo a ser excluída.

cancellationToken

CancellationToken

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

Retornos

Task

Exceções

ArgumentNullException

Gerado quando a ID do dispositivo ou A ID do módulo fornecida é nula.

ArgumentException

Gerado quando a ID do dispositivo ou A ID do módulo fornecida está vazia ou no espaço em branco.

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.