DeviceManagementClient.DeleteGroup(String, RequestContext) Método

Referência

Definição

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Pacote:: Azure.IoT.DeviceUpdate v1.0.0

Origem:: DeviceManagementClient.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Exclui um grupo de dispositivos. Esse grupo é criado automaticamente quando um dispositivo habilitado para Atualização de Dispositivo é conectado ao hub e relata suas propriedades. Grupos, subgrupos e implantações não são limpos automaticamente, mas são mantidos para fins de histórico. Os usuários podem chamar esse método para excluir um grupo se não precisarem reter nenhum histórico do grupo e não precisarem mais dele. Se um dispositivo estiver conectado novamente para esse grupo após a exclusão do grupo, ele será recriado automaticamente, mas não haverá histórico.

public virtual Azure.Response DeleteGroup (string groupId, Azure.RequestContext context = default);

abstract member DeleteGroup : string * Azure.RequestContext -> Azure.Response
override this.DeleteGroup : string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteGroup (groupId As String, Optional context As RequestContext = Nothing) As Response

Parâmetros

groupId: String

Identificador de grupo.

context: RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Response

A resposta retornada do serviço.

Exceções

ArgumentNullException

groupId é nulo.

ArgumentException

groupId é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar DeleteGroup com os parâmetros necessários.

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

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

Comentários

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)
              }
            }

Aplica-se a

Compartilhar via