Entities - List

Serviço:: Management Groups

Versão da API:: 2020-05-01

Liste todas as entidades (Grupos de Gerenciamento, Assinaturas, etc.) do usuário autenticado.

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

Com parâmetros opcionais:

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01&$skiptoken={$skiptoken}&$skip={$skip}&$top={$top}&$select={$select}&$search={$search}&$filter={$filter}&$view={$view}&groupName={groupName}

Parâmetros do URI

Name	Em	Necessá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.
$filter	query		string	O parâmetro filter permite filtrar os campos name ou display name. Você pode verificar a igualdade no campo name (por exemplo, name eq '{entityName}') e pode verificar se há substrings nos campos name ou display name (por exemplo, contains (name, '{substringToSearch}'), contains (displayName, '{substringToSearch')). Observe que os campos '{entityName}' e '{substringToSearch}' são verificados sem distinção entre maiúsculas e minúsculas.
$search	query		string	O parâmetro $search é usado em conjunto com o parâmetro $filter para retornar três saídas diferentes, dependendo do parâmetro passado. Com $search=AllowedParents, a API retornará as informações da entidade de todos os grupos para os quais a entidade solicitada poderá reparentar conforme determinado pelas permissões do usuário. Com $search=AllowedChildren a API retornará as informações da entidade de todas as entidades que podem ser adicionadas como filhos da entidade solicitada. Com $search=ParentAndFirstLevelChildren, a API retornará o pai e o primeiro nível de filhos aos quais o usuário tem acesso direto ou indireto por meio de um de seus descendentes. Com $search=ParentOnly a API retornará somente o grupo se o usuário tiver acesso a pelo menos um dos descendentes do grupo. Com $search=ChildrenOnly, a API retornará apenas o primeiro nível de filhos das informações da entidade do grupo especificadas no $filter. O usuário deve ter acesso direto às entidades filhos ou a um de seus descendentes para que ele apareça nos resultados.
$select	query		string	Este parâmetro especifica os campos a serem incluídos na resposta. Pode incluir qualquer combinação de Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, por exemplo, '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando especificado, o parâmetro $select pode substituir a seleção em $skipToken.
$skip	query		integer	Número de entidades a serem ignoradas ao recuperar resultados. Passar isso substituirá $skipToken.
$skiptoken	query		string	O token de continuação de página só é usado se uma operação anterior retornou 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.
$top	query		integer	Número de elementos a serem retornados ao recuperar resultados. Passar isso substituirá $skipToken.
$view	query		string	O parâmetro view permite que os clientes filtrem o tipo de dados retornados pela chamada getEntities.
groupName	query		string	Um filtro que permite que a chamada get entities se concentre em um grupo específico (ou seja, "$filter=name eq 'groupName'")

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Cache-Control		string	Indica que a solicitação não deve utilizar nenhum cache.

Respostas

Name	Tipo	Description
200 OK	EntityListResult	OK
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

GetEntities

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "view",
        "inheritedPermissions": "view",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 1 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group1Tenant2Parent"
        ],
        "numberOfDescendants": 3,
        "numberOfChildren": 2,
        "numberOfChildGroups": 1
      }
    },
    {
      "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",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "delete",
        "inheritedPermissions": "delete",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 4 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group4 Tenant2Parent"
        ],
        "numberOfDescendants": 0,
        "numberOfChildren": 0,
        "numberOfChildGroups": 0
      }
    }
  ],
  "nextLink": null
}

Definições

Name	Description
EntityInfo	A entidade.
EntityListResult	Descreve o resultado da solicitação para exibir entidades.
EntityParentGroupInfo	(Opcional) A ID do grupo de gerenciamento pai.
ErrorDetails	Os detalhes do erro.
ErrorResponse	O objeto de erro.
Permissions	As permissões específicas dos usuários para este item.

EntityInfo

Object

A entidade.

Name	Tipo	Description
id	string	O ID totalmente qualificado para a entidade. Por exemplo, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
name	string	O nome da entidade. Por exemplo, 00000000-0000-0000-0000-00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
properties.displayName	string	O nome amigável do grupo de gerenciamento.
properties.inheritedPermissions	Permissions	Permissões herdadas As permissões específicas dos usuários para este item.
properties.numberOfChildGroups	integer	Número de grupos de crianças Número de crianças é o número de Grupos que estão exatamente um nível abaixo do Grupo atual.
properties.numberOfChildren	integer	Número de crianças Número de filhos é o número de Grupos e Subscrições que estão exatamente um nível abaixo do Grupo atual.
properties.numberOfDescendants	integer	Número de Descendentes
properties.parent	EntityParentGroupInfo	Progenitor (Opcional) A ID do grupo de gerenciamento pai.
properties.parentDisplayNameChain	string[]	A cadeia de nomes de exibição pai do grupo raiz para o pai imediato
properties.parentNameChain	string[]	A cadeia de nomes pai do grupo raiz para o pai imediato
properties.permissions	Permissions	Permissões As permissões específicas dos usuários para este item.
properties.tenantId	string	O ID do locatário do AAD associado à entidade. Por exemplo, 00000000-0000-0000-0000-00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
type	string	O tipo do recurso. Por exemplo, Microsoft.Management/managementGroups

EntityListResult

Object

Descreve o resultado da solicitação para exibir entidades.

Name	Tipo	Description
count	integer	Contagem total de registos que correspondem ao filtro
nextLink	string	A URL a ser usada para obter o próximo conjunto de resultados.
value	EntityInfo[]	A lista de entidades.

EntityParentGroupInfo

Object

(Opcional) A ID do grupo de gerenciamento pai.

Name	Tipo	Description
id	string	A ID totalmente qualificada para o grupo de gerenciamento pai. Por exemplo, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000

ErrorDetails

Object

Os detalhes do erro.

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

ErrorResponse

Object

O objeto de erro.

Name	Tipo	Description
error	ErrorDetails	Erro Os detalhes do erro.

Permissions

Enumeração

As permissões específicas dos usuários para este item.

Valor	Description
noaccess
view
edit
delete

Partilhar via

Entities - List

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

GetEntities

Pedido de amostra

Resposta da amostra

Definições

EntityInfo

EntityListResult

EntityParentGroupInfo

ErrorDetails

ErrorResponse

Permissions