ConfigurationsClient.DeleteAsync Método

Definição

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Pacote:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

DeleteAsync(String, CancellationToken)	Exclui uma configuração do Hub IoT.
DeleteAsync(Configuration, Boolean, CancellationToken)	Exclui uma configuração do Hub IoT.

DeleteAsync(String, CancellationToken)

Exclui uma configuração do Hub IoT.

public virtual System.Threading.Tasks.Task DeleteAsync (string configurationId, 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 (configurationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

configurationId

String

A ID da configuração que está sendo excluída.

cancellationToken

CancellationToken

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

Retornos

Task

Exceções

ArgumentNullException

Gerado quando o fornecido configurationId é nulo.

ArgumentException

Gerado se o configurationId estiver vazio ou 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 é 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.

DeleteAsync(Configuration, Boolean, CancellationToken)

Exclui uma configuração do Hub IoT.

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

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

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

Parâmetros

configuration

Configuration

A configuração que está sendo excluída.

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 configuração 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

Gerado quando o fornecido configuration é 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 é 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.