DeviceManagementClient.DeleteGroupAsync(String, RequestContext) Método

Definición

Espacio de nombres:

Azure.IoT.DeviceUpdate

Ensamblado:

Azure.IoT.DeviceUpdate.dll

Paquete:

Azure.IoT.DeviceUpdate v1.0.0

Source:

DeviceManagementClient.cs

Elimina un grupo de dispositivos. Este grupo se crea automáticamente cuando un dispositivo habilitado para Device Update está conectado al centro e informa de sus propiedades. Los grupos, los subgrupos y las implementaciones no se limpian automáticamente, pero se conservan con fines de historial. Los usuarios pueden llamar a este método para eliminar un grupo si no necesitan conservar ninguno del historial del grupo y ya no lo necesitan. Si un dispositivo se vuelve a conectar para este grupo después de eliminarlo, se volverá a crear automáticamente, pero no habrá historial.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteGroupAsync(string groupId, Azure.RequestContext context = default);

abstract member DeleteGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteGroupAsync (groupId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parámetros

groupId

String

Identificador de grupo.

context

RequestContext

Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.

Devoluciones

Task<Response>

Respuesta devuelta por el servicio.

Excepciones

ArgumentNullException

groupId es null.

ArgumentException

groupId es una cadena vacía y se esperaba que no estuviera vacía.

RequestFailedException

El servicio devolvió un código de estado no correcto.

Ejemplos

En este ejemplo se muestra cómo llamar a DeleteGroupAsync con los parámetros necesarios.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new DeviceManagementClient(endpoint, "<instanceId>", credential);

Response response = await client.DeleteGroupAsync("<groupId>");
Console.WriteLine(response.Status);

Comentarios

Esquema para Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [Error],
                innererror: {
                  code: string,
                  message: string,
                  errorDetail: string,
                  innerError: InnerError
                },
                occurredDateTime: string (ISO 8601 Format)
              }
            }