ModulesClient.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(Module, Boolean, CancellationToken)	Elimine la identidad del módulo del registro de IoT Hub.
DeleteAsync(String, String, CancellationToken)	Elimine la identidad del módulo con el identificador proporcionado del dispositivo con el identificador proporcionado del registro de IoT Hub.

DeleteAsync(Module, Boolean, CancellationToken)

Elimine la identidad del módulo del registro de IoT Hub.

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

Identidad del módulo que se va a eliminar del registro de IoT Hub. Si la ETag del módulo proporcionado no está actualizada, esta operación iniciará una IotHubServiceException con PreconditionFailed una ETag actualizada que se puede recuperar mediante GetAsync(String, String, CancellationToken). Para forzar la ejecución de la operación independientemente de ETag, establezca la ETag de la identidad del módulo en "*" o use DeleteAsync(String, String, CancellationToken).

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á un IotHubServiceException elemento con PreconditionFailed si el módulo proporcionado tiene una ETag obsoleta. Una ETag actualizada se puede recuperar mediante GetAsync(String, String, CancellationToken).

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task

Excepciones

ArgumentNullException

Se produce cuando el módulo proporcionado 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 token de cancelación proporcionado ha solicitado la cancelación.

DeleteAsync(String, String, CancellationToken)

Elimine la identidad del módulo con el identificador proporcionado del dispositivo con el identificador proporcionado del registro de IoT Hub.

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

Identificador de la identidad del dispositivo que contiene el módulo que se va a eliminar.

moduleId

String

Identificador de la identidad del módulo que se va a eliminar.

cancellationToken

CancellationToken

Token que permite cancelar la operación.

Devoluciones

Task

Excepciones

ArgumentNullException

Se produce cuando el identificador de dispositivo o el identificador de módulo proporcionados son NULL.

ArgumentException

Se produce cuando el identificador de dispositivo o el identificador del módulo proporcionados está vacío o espacio 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 token de cancelación proporcionado ha solicitado la cancelación.