Entities - List

Referência

Serviço:: Management Groups

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

Liste todas as entidades (Grupos de Gestão, Subscrições, etc.) para o utilizador 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 utilizar com o pedido de cliente. A versão atual é 2018-01-01-preview.
$filter	query		string	O parâmetro de filtro permite-lhe filtrar os campos nome ou nome a apresentar. Pode verificar a igualdade no campo de nome (por exemplo, nome eq '{entityName}') e pode verificar a existência de subcadeias nos campos de nome ou nome a apresentar (por exemplo, contém(nome, '{substringToSearch}'), contém(displayName, '{substringToSearch')). Tenha em atenção que os campos "{entityName}" e "{substringToSearch}" são verificados sem sensibilidade às maiúsculas e minúsculas.
$search	query		string	O parâmetro $search é utilizado em conjunto com o parâmetro $filter para devolver três saídas diferentes, dependendo do parâmetro transmitido. Com $search=AllowedParents, a API devolverá as informações de entidade de todos os grupos aos quais a entidade pedida poderá reapará-lo conforme determinado pelas permissões do utilizador. Com $search=AllowedChildren, a API devolverá as informações da entidade de todas as entidades que podem ser adicionadas como subordinados da entidade pedida. Com $search=ParentAndFirstLevelChildren, a API devolverá o principal e o primeiro nível de crianças a que o utilizador tem acesso direto ou acesso indireto através de um dos seus descendentes. Com $search=ParentOnly, a API só devolverá o grupo se o utilizador tiver acesso a, pelo menos, um dos descendentes do grupo. Com $search=ChildrenOnly, a API devolverá apenas o primeiro nível de subordinados das informações da entidade de grupo especificadas no $filter. O utilizador tem de ter acesso direto às entidades subordinadas ou a um dos seus descendentes para que apareça nos resultados.
$select	query		string	Este parâmetro especifica os campos a incluir na resposta. Pode incluir qualquer combinação de Nome,DisplayName,Tipo,ParentDisplayNameChain,ParentChain, por exemplo, "$select=Nome,NomeDoConta,Tipo,ParentDisplayNameChain,ParentNameChain". Quando especificado, o parâmetro $select pode substituir a seleção no $skipToken.
$skip	query		integer	Número de entidades a ignorar ao obter resultados. Ao transmiti-lo, irá substituir $skipToken.
$skiptoken	query		string	O token de continuação da página só é utilizado se uma operação anterior devolver 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 utilizar para chamadas subsequentes.
$top	query		integer	Número de elementos a devolver ao obter resultados. Ao transmiti-lo, irá substituir $skipToken.
$view	query		string	O parâmetro view permite que os clientes filtrem o tipo de dados que é devolvido pela chamada getEntities.
groupName	query		string	Um filtro que permite que a chamada obter entidades se concentre num grupo específico (ou seja, "$filter=name eq 'groupName'")

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Cache-Control		string	Indica que o pedido não deve utilizar caches.

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar 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 do pedido para ver entidades.
EntityParentGroupInfo	(Opcional) O ID do grupo de gestão principal.
ErrorDetails	Os detalhes do erro.
ErrorResponse	O objeto de erro.
Permissions	As permissões específicas dos utilizadores para este item.

EntityInfo

A entidade.

Name	Tipo	Description
id	string	O ID completamente qualificado da entidade. Por exemplo, /providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000000000
name	string	O nome da entidade. Por exemplo, 000000000-0000-0000-0000-0000000000000
properties.displayName	string	O nome amigável do grupo de gestão.
properties.inheritedPermissions	Permissions	Permissões Herdadas As permissões específicas dos utilizadores para este item.
properties.numberOfChildGroups	integer	Número de Grupos Subordinados O 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 O número de subordinados é 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	Principal (Opcional) O ID do grupo de gestão principal.
properties.parentDisplayNameChain	string[]	A cadeia de nomes a apresentar principal do grupo raiz para o elemento principal imediato
properties.parentNameChain	string[]	A cadeia de nomes principal do grupo raiz para o elemento principal imediato
properties.permissions	Permissions	Permissões As permissões específicas dos utilizadores para este item.
properties.tenantId	string	O ID do Inquilino do AAD associado à entidade. Por exemplo, 000000000-0000-0000-0000-0000000000000
type	string	O tipo de recurso. Por exemplo, Microsoft.Management/managementGroups

EntityListResult

Descreve o resultado do pedido para ver entidades.

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

EntityParentGroupInfo

(Opcional) O ID do grupo de gestão principal.

Name	Tipo	Description
id	string	O ID completamente qualificado para o grupo de gestão principal. Por exemplo, /providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000000000

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos 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

O objeto de erro.

Name	Tipo	Description
error	ErrorDetails	Erro Os detalhes do erro.

Permissions

As permissões específicas dos utilizadores para este item.

Name	Tipo	Description
delete	string
edit	string
noaccess	string
view	string

Partilhar via