DevicesClient.DeleteAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| DeleteAsync(String, CancellationToken) |
Elimine la identidad del dispositivo con el identificador proporcionado del registro de IoT Hub. |
| DeleteAsync(Device, Boolean, CancellationToken) |
Elimine la identidad del dispositivo con el identificador proporcionado del registro de IoT Hub. |
| DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken) |
Elimine hasta 100 identidades de dispositivo del registro de IoT Hub de forma masiva. |
DeleteAsync(String, CancellationToken)
Elimine la identidad del dispositivo con el identificador proporcionado del registro de IoT Hub.
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.TaskPublic Overridable Function DeleteAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParámetros
- deviceId
- String
Identificador de la identidad del dispositivo que se va a eliminar.
- cancellationToken
- CancellationToken
Token que permite cancelar la operación.
Devoluciones
Excepciones
Cuando el identificador de dispositivo proporcionado es null.
Cuando el identificador de dispositivo proporcionado está vacío o espacio en blanco.
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.
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.
Si el token de cancelación proporcionado ha solicitado la cancelación.
Se aplica a
DeleteAsync(Device, Boolean, CancellationToken)
Elimine la identidad del dispositivo con el identificador proporcionado del registro de IoT Hub.
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.TaskPublic Overridable Function DeleteAsync (device As Device, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As TaskParámetros
- device
- Device
Identidad del dispositivo que se va a eliminar del registro de IoT Hub. Si la ETag del dispositivo proporcionado no está actualizada, esta operación iniciará una IotHubServiceException con PreconditionFailed una ETag actualizada que se puede recuperar mediante GetAsync(String, CancellationToken). Para forzar la ejecución de la operación independientemente de ETag, establezca la ETag de la identidad del dispositivo en "*" o use DeleteAsync(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á una IotHubServiceException excepción con PreconditionFailed si la identidad del dispositivo 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
Excepciones
Cuando el dispositivo proporcionado es null.
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.
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.
Si el token de cancelación proporcionado ha solicitado la cancelación.
Se aplica a
DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)
Elimine hasta 100 identidades de dispositivo del registro de IoT Hub de forma masiva.
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)Parámetros
- devices
- IEnumerable<Device>
Identidades de dispositivo que se van a eliminar del registro de IoT Hub. Es posible que no supere los 100 dispositivos.
- 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 identidad del dispositivo 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
Resultado de la operación masiva.
Excepciones
Cuando la colección de dispositivos proporcionada es null.
Cuando la colección de dispositivos proporcionada está vacía.
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.
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.
Si el token de cancelación proporcionado ha solicitado la cancelación.
Se aplica a
Azure SDK for .NET