ConfigurationsClient.DeleteAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Devices

Ensamblado:

Microsoft.Azure.Devices.dll

Paquete:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

DeleteAsync(String, CancellationToken)	Elimina una configuración de IoT Hub.
DeleteAsync(Configuration, Boolean, CancellationToken)	Elimina una configuración de IoT Hub.

DeleteAsync(String, CancellationToken)

Elimina una configuración de IoT Hub.

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

Identificador de la configuración que se va a eliminar.

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task

Excepciones

ArgumentNullException

Se produce cuando el proporcionado configurationId es NULL.

ArgumentException

Se produce si está vacío o espacio configurationId en blanco.

IotHubServiceException

Se produce si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si se ha limitado la solicitud proporcionada, IotHubServiceException se produce con ThrottlingException . Para obtener una lista completa de posibles casos de error, vea IotHubServiceErrorCode.

HttpRequestException

Si se produce un error en la solicitud HTTP debido a un problema subyacente, como la conectividad de red, el error dns o la validación del certificado de servidor.

OperationCanceledException

Si el proporcionado cancellationToken ha solicitado la cancelación.

DeleteAsync(Configuration, Boolean, CancellationToken)

Elimina una configuración de IoT Hub.

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

Configuración que se va a eliminar.

onlyIfUnchanged

Boolean

Si es false, esta operación de eliminación se realizará incluso si la identidad del dispositivo proporcionada tiene una ETag obsoleta. Si es true, la operación iniciará una IotHubServiceException excepción con PreconditionFailed si la configuración proporcionada tiene una ETag obsoleta. Una ETag actualizada se puede recuperar mediante GetAsync(String, CancellationToken).

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task

Excepciones

ArgumentNullException

Se produce cuando el proporcionado configuration es NULL.

IotHubServiceException

Se produce si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si se ha limitado la solicitud proporcionada, IotHubServiceException se produce con ThrottlingException . Para obtener una lista completa de posibles casos de error, vea IotHubServiceErrorCode.

HttpRequestException

Si se produce un error en la solicitud HTTP debido a un problema subyacente, como la conectividad de red, el error dns o la validación del certificado de servidor.

OperationCanceledException

Si el proporcionado cancellationToken ha solicitado la cancelación.