Entities - List

Referencia

Service:: Management Groups

API Version:: 2020-05-01

Enumera todas las entidades (grupos de administración, suscripciones, etc.) del usuario autenticado.

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

With optional parameters:

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 identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2018-01-01-preview.
$filter	query		string	El parámetro filter permite filtrar por los campos de nombre o nombre para mostrar. Puede comprobar la igualdad en el campo de nombre (por ejemplo, name eq '{entityName}') y puede comprobar si hay subcadenas en los campos name o display name(por ejemplo, contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Tenga en cuenta que los campos '{entityName}' y '{substringToSearch}' se comprueban sin distinción entre mayúsculas y minúsculas.
$search	query		string	El parámetro $search se usa junto con el parámetro $filter para devolver tres salidas diferentes según el parámetro pasado. Con $search=AllowedParents, la API devolverá la información de entidad de todos los grupos a los que la entidad solicitada podrá volver a ser primario según lo determinado por los permisos del usuario. Con $search=AllowedChildren, la API devolverá la información de entidad de todas las entidades que se pueden agregar como elementos secundarios de la entidad solicitada. Con $search=ParentAndFirstLevelChildren, la API devolverá el nivel primario y el primer nivel de elementos secundarios a los que el usuario tiene acceso directo o indirecto a través de uno de sus descendientes. Con $search=ParentOnly, la API devolverá solo el grupo si el usuario tiene acceso al menos a uno de los descendientes del grupo. Con $search=ChildrenOnly, la API devolverá solo el primer nivel de elementos secundarios de la información de entidad del grupo especificada en $filter. El usuario debe tener acceso directo a las entidades secundarias o a uno de sus descendientes para que aparezca en los resultados.
$select	query		string	Este parámetro especifica los campos que se van a incluir en la respuesta. Puede incluir cualquier combinación de Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, por ejemplo, '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Cuando se especifica el parámetro $select puede invalidar la selección en $skipToken.
$skip	query		integer	Número de entidades que se omitirán al recuperar los resultados. Si se pasa esto, se invalidará $skipToken.
$skiptoken	query		string	El token de continuación de página solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro de token que especifica un punto de partida que se usará para las llamadas posteriores.
$top	query		integer	Número de elementos que se van a devolver al recuperar los resultados. Si se pasa esto, se invalidará $skipToken.
$view	query		string	El parámetro view permite a los clientes filtrar el tipo de datos devueltos por la llamada getEntities.
groupName	query		string	Filtro que permite que las entidades get se centren en un grupo determinado (es decir, "$filter=name eq 'groupName'")

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Cache-Control		string	Indica que la solicitud no debe usar ninguna memoria caché.

Respuestas

Nombre	Tipo	Description
200 OK	EntityListResult	Aceptar
Other Status Codes	ErrorResponse	Error

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

GetEntities

Sample Request

HTTP

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

Sample Response

Status code:: 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
}

Definiciones

Nombre	Description
EntityInfo	Entidad.
EntityListResult	Describe el resultado de la solicitud para ver las entidades.
EntityParentGroupInfo	(Opcional) Identificador del grupo de administración primario.
ErrorDetails	Detalles del error.
ErrorResponse	Objeto de error.
Permissions	Los usuarios permisos específicos para este elemento.

EntityInfo

Entidad.

Nombre	Tipo	Description
id	string	Identificador completo de la entidad. Por ejemplo, /providers/Microsoft.Management/managementGroups/00000000-0000-0000-00000-0000000000000
name	string	Nombre de la entidad. Por ejemplo, 00000000-0000-0000-0000-00000000000000
properties.displayName	string	Nombre descriptivo del grupo de administración.
properties.inheritedPermissions	Permissions	Permisos heredados Los usuarios permisos específicos para este elemento.
properties.numberOfChildGroups	integer	Número de grupos secundarios Número de elementos secundarios es el número de grupos que son exactamente un nivel debajo del grupo actual.
properties.numberOfChildren	integer	Número de elementos secundarios El número de elementos secundarios es el número de grupos y suscripciones que son exactamente un nivel debajo del grupo actual.
properties.numberOfDescendants	integer	Número de descendientes
properties.parent	EntityParentGroupInfo	Parent (Opcional) Identificador del grupo de administración primario.
properties.parentDisplayNameChain	string[]	Cadena de nombres para mostrar primaria del grupo raíz al primario inmediato
properties.parentNameChain	string[]	Cadena de nombres principal del grupo raíz al elemento primario inmediato
properties.permissions	Permissions	Permisos Los usuarios permisos específicos para este elemento.
properties.tenantId	string	Identificador de inquilino de AAD asociado a la entidad. Por ejemplo, 00000000-0000-0000-0000-00000000000000
type	string	Tipo de recurso. Por ejemplo, Microsoft.Management/managementGroups

EntityListResult

Describe el resultado de la solicitud para ver las entidades.

Nombre	Tipo	Description
count	integer	Recuento total de registros que coinciden con el filtro
nextLink	string	Dirección URL que se va a usar para obtener el siguiente conjunto de resultados.
value	EntityInfo[]	Lista de entidades.

EntityParentGroupInfo

(Opcional) Identificador del grupo de administración primario.

Nombre	Tipo	Description
id	string	Identificador completo del grupo de administración primario. Por ejemplo, /providers/Microsoft.Management/managementGroups/00000000-0000-0000-00000-0000000000000

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	string	Representación legible de los detalles del error.
message	string	Representación legible del error.

ErrorResponse

Objeto de error.

Nombre	Tipo	Description
error	ErrorDetails	Error Detalles del error.

Permissions

Los usuarios permisos específicos para este elemento.

Nombre	Tipo	Description
delete	string
edit	string
noaccess	string
view	string