Management Groups - List

Serviço:

Management Groups

Versão da API:

2020-05-01

Listar grupos de gerenciamento para o usuário autenticado.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups?api-version=2020-05-01

Com parâmetros opcionais:

GET https://management.azure.com/providers/Microsoft.Management/managementGroups?api-version=2020-05-01&$skiptoken={$skiptoken}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2018-01-01-preview.
$skiptoken	query		string	O token de continuação de página só será usado se uma operação anterior retornar um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro de token que especifica um ponto de partida a ser usado para chamadas subsequentes.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Cache-Control		string	Indica que a solicitação não deve utilizar nenhum cache.

Respostas

Nome	Tipo	Description
200 OK	ManagementGroupListResult	OKEY
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ListManagementGroups

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups?api-version=2020-05-01

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0001-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 1 Tenant 2"
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0004-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 4 Tenant 2"
      }
    }
  ],
  "@nextLink": null
}

Definições

Nome	Description
ErrorDetails	Os detalhes do erro.
ErrorResponse	O objeto de erro.
ManagementGroupInfo	O recurso do grupo de gerenciamento.
ManagementGroupListResult	Descreve o resultado da solicitação para listar grupos de gerenciamento.

ErrorDetails

Objeto

Os detalhes do erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	string	Uma representação legível por humanos dos detalhes do erro.
message	string	Uma representação legível pelo ser humano do erro.

ErrorResponse

Objeto

O objeto de erro.

Nome	Tipo	Description
error	ErrorDetails	Erro Os detalhes do erro.

ManagementGroupInfo

Objeto

O recurso do grupo de gerenciamento.

Nome	Tipo	Description
id	string	A ID totalmente qualificada para o grupo de gerenciamento. Por exemplo, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000
name	string	O nome do grupo de gerenciamento. Por exemplo, 00000000-0000-0000-0000-000000000000
properties.displayName	string	O nome amigável do grupo de gerenciamento.
properties.tenantId	string	A ID do Locatário do AAD associada ao grupo de gerenciamento. Por exemplo, 00000000-0000-0000-0000-000000000000
type	string	O tipo do recurso. Por exemplo, Microsoft.Management/managementGroups

ManagementGroupListResult

Objeto

Descreve o resultado da solicitação para listar grupos de gerenciamento.

Nome	Tipo	Description
@nextLink	string	A URL a ser usada para obter o próximo conjunto de resultados.
value	ManagementGroupInfo[]	A lista de grupos de gerenciamento.