Entities - List

Referência

Serviço:: Management Groups

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

Listar todas as entidades (Grupos de Gerenciamento, Assinaturas e etc.) para o 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 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.
$filter	query		string	O parâmetro de filtro permite filtrar os campos nome ou nome de exibição. Você pode marcar para igualdade no campo nome (por exemplo, nome eq '{entityName}') e pode marcar para subcadeias de caracteres nos campos nome ou nome de exibição(por exemplo, contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Observe que os campos '{entityName}' e '{substringToSearch}' não diferenciam maiúsculas de 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 de entidade de todos os grupos para os quais a entidade solicitada poderá separá-la novamente conforme determinado pelas permissões do usuário. Com $search=AllowedChildren, a API retornará as informações de 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á apenas 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 de entidade de grupo especificadas em $filter. O usuário deve ter acesso direto às entidades filho ou um dos descendentes para que ele apareça nos resultados.
$select	query		string	Esse 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 select no $skipToken.
$skip	query		integer	Número de entidades a serem ignoradas ao recuperar resultados. Passar isso para substituirá $skipToken.
$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.
$top	query		integer	Número de elementos a serem retornados ao recuperar resultados. Passar isso para substituirá $skipToken.
$view	query		string	O parâmetro de exibição permite que os clientes filtrem o tipo de dados retornado pela chamada getEntities.
groupName	query		string	Um filtro que permite que a chamada obter entidades se concentre em um grupo específico (ou seja, "$filter=name eq 'groupName'")

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	EntityListResult	OK
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

GetEntities

Solicitação de exemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Management/getEntities?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",
        "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

Nome	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

A entidade.

Nome	Tipo	Description
id	string	A ID totalmente qualificada para a entidade. Por exemplo, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Nome da entidade. Por exemplo, 00000000-0000-0000-0000-0000000000000
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 filho Número de filhos é o número de Grupos que estão exatamente um nível abaixo do Grupo atual.
properties.numberOfChildren	integer	Número de filhos Número de filhos é o número de Grupos e Assinaturas que estão exatamente um nível abaixo do Grupo atual.
properties.numberOfDescendants	integer	Número de descendentes
properties.parent	EntityParentGroupInfo	Parent (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	A ID do locatário do AAD associada à entidade. Por exemplo, 00000000-0000-0000-0000-0000000000000
type	string	Tipo do recurso. Por exemplo, Microsoft.Management/managementGroups

EntityListResult

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

Nome	Tipo	Description
count	integer	Contagem total de registros 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

(Opcional) A ID do grupo de gerenciamento pai.

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

ErrorDetails

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 dos detalhes do erro.
message	string	Uma representação legível do erro.

ErrorResponse

O objeto de erro.

Nome	Tipo	Description
error	ErrorDetails	Erro Os detalhes do erro.

Permissions

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

Nome	Tipo	Description
delete	string
edit	string
noaccess	string
view	string

Compartilhar via