Management Groups - Get

Referencia

Service:: Management Groups

API Version:: 2020-05-01

Obtenga los detalles del grupo de administración.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
groupId	path	True	string	Identificador del grupo de administración.
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.
$expand	query		string	El parámetro de cadena de consulta $expand=children permite a los clientes solicitar la inclusión de elementos secundarios en la carga de respuesta. $expand=path incluye la ruta de acceso del grupo raíz al grupo actual.
$filter	query		string	Filtro que permite la exclusión de suscripciones de los resultados (es decir, "$filter=children.childType ne Subscription")
$recurse	query		boolean	El parámetro de cadena de consulta $recurse=true permite a los clientes solicitar la inclusión de toda la jerarquía en la carga de respuesta. Tenga en cuenta que $expand=children debe pasarse si $recurse está establecido en true.

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	ManagementGroup	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

GetManagementGroup

GetManagementGroupsWithExpandAndRecurse

GetManagementGroupWithExpand

GetManagementGroup

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "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",
    "details": {
      "version": 1,
      "updatedTime": "2018-01-01T00:00:00.00Z",
      "updatedBy": "16b8ef21-5c9f-420c-bcc9-e4f8c9f30b4b",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/RootGroup",
        "name": "RootGroup",
        "displayName": "RootGroup"
      }
    }
  }
}

GetManagementGroupsWithExpandAndRecurse

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01&$expand=children&$recurse=True

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Management/managementGroups/RootGroup",
  "type": "Microsoft.Management/managementGroups",
  "name": "RootGroup",
  "properties": {
    "tenantId": "20000000-0000-0000-0000-000000000000",
    "displayName": "RootGroup",
    "details": {
      "version": 2,
      "updatedTime": "2018-01-25T02:26:49.0022093Z",
      "updatedBy": "bd490e30-04cb-433e-b8c8-6066959a8bab",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000",
        "name": "20000000-0000-0000-0000-000000000000",
        "displayName": "20000000-0000-0000-0000-000000000000"
      }
    },
    "children": [
      {
        "id": "/providers/Microsoft.Management/managementGroups/Child",
        "type": "Microsoft.Management/managementGroups",
        "name": "Child",
        "displayName": "Child",
        "children": [
          {
            "id": "/providers/Microsoft.Management/managementGroups/Leaf",
            "type": "Microsoft.Management/managementGroups",
            "name": "Leaf",
            "displayName": "Leaf",
            "children": [
              {
                "id": "/subscriptions/728bcbe4-8d56-4510-86c2-4921b8beefbc",
                "type": "/subscriptions",
                "name": "728bcbe4-8d56-4510-86c2-4921b8beefbc",
                "displayName": "Pay-As-You-Go"
              }
            ]
          }
        ]
      },
      {
        "id": "/providers/Microsoft.Management/managementGroups/AnotherChild",
        "type": "Microsoft.Management/managementGroups",
        "name": "AnotherChild",
        "displayName": "Leaf"
      }
    ]
  }
}

GetManagementGroupWithExpand

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01&$expand=children

Sample Response

Status code:: 200

{
  "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",
    "details": {
      "version": 1,
      "updatedTime": "2018-01-01T00:00:00.00Z",
      "updatedBy": "Test",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000",
        "name": "20000000-0000-0000-0000-000000000000",
        "displayName": "20000000-0000-0000-0000-000000000000"
      }
    },
    "children": [
      {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0002-0000-0000-000000000000",
        "type": "Microsoft.Management/managementGroups",
        "name": "20000000-0002-0000-0000-000000000000",
        "displayName": "Group 2 Tenant 2"
      },
      {
        "id": "/providers/Microsoft.Management/managementGroups/20000000-0003-0000-0000-000000000000",
        "type": "Microsoft.Management/managementGroups",
        "name": "20000000-0003-0000-0000-000000000000",
        "displayName": "Group 3 Tenant 2"
      },
      {
        "id": "/subscriptions/10000000-F004-0000-0000-000000000000",
        "type": "/subscriptions",
        "name": "10000000-F004-0000-0000-000000000000",
        "displayName": "Subscription 4 Tenant 1"
      },
      {
        "id": "/subscriptions/20000000-F005-0000-0000-000000000000",
        "type": "/subscriptions",
        "name": "20000000-F005-0000-0000-000000000000",
        "displayName": "Subscription 5 Tenant 2"
      },
      {
        "id": "/subscriptions/30000000-F003-0000-0000-000000000000",
        "type": "/subscriptions",
        "name": "30000000-F003-0000-0000-000000000000",
        "displayName": "Subscription 3 Tenant 3"
      }
    ]
  }
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
ErrorResponse	Objeto de error.
ManagementGroup	Detalles del grupo de administración.
ManagementGroupChildInfo	Información secundaria de un grupo de administración.
ManagementGroupChildType	Tipo de recurso secundario.
ManagementGroupDetails	Detalles de un grupo de administración.
ManagementGroupPathElement	Elemento path de los antecesores de un grupo de administración.
ParentGroupInfo	(Opcional) Identificador del grupo de administración primario.

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.

ManagementGroup

Detalles del grupo de administración.

Nombre	Tipo	Description
id	string	Identificador completo del grupo de administración. Por ejemplo, /providers/Microsoft.Management/managementGroups/00000000-0000-0000-00000-0000000000000
name	string	Nombre del grupo de administración. Por ejemplo, 00000000-0000-0000-0000-00000000000000
properties.children	ManagementGroupChildInfo[]	Lista de elementos secundarios.
properties.details	ManagementGroupDetails	Detalles Detalles de un grupo de administración.
properties.displayName	string	Nombre descriptivo del grupo de administración.
properties.tenantId	string	Identificador de inquilino de AAD asociado al grupo de administración. Por ejemplo, 00000000-0000-0000-0000-00000000000000
type	string	Tipo de recurso. Por ejemplo, Microsoft.Management/managementGroups

ManagementGroupChildInfo

Información secundaria de un grupo de administración.

Nombre	Tipo	Description
children	ManagementGroupChildInfo[]	Lista de elementos secundarios.
displayName	string	Nombre descriptivo del recurso secundario.
id	string	Identificador completo del recurso secundario (grupo de administración o suscripción). Por ejemplo, /providers/Microsoft.Management/managementGroups/00000000-0000-0000-00000-0000000000000
name	string	Nombre de la entidad secundaria.
type	ManagementGroupChildType	Tipo de recurso secundario. El tipo de recurso completo que incluye el espacio de nombres del proveedor (por ejemplo, Microsoft.Management/managementGroups)

ManagementGroupChildType

Tipo de recurso secundario.

Nombre	Tipo	Description
/subscriptions	string
Microsoft.Management/managementGroups	string

ManagementGroupDetails

Detalles de un grupo de administración.

Nombre	Tipo	Description
parent	ParentGroupInfo	Parent (Opcional) Identificador del grupo de administración primario.
path	ManagementGroupPathElement[]	Ruta de acceso de la raíz al grupo actual.
updatedBy	string	Identidad de la entidad de seguridad o proceso que actualizó el objeto.
updatedTime	string	Fecha y hora en que se actualizó por última vez este objeto.
version	number	Número de versión del objeto.

ManagementGroupPathElement

Elemento path de los antecesores de un grupo de administración.

Nombre	Tipo	Description
displayName	string	Nombre descriptivo del grupo.
name	string	Nombre del grupo.

ParentGroupInfo

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

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

Share via

Management Groups - Get

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

GetManagementGroup

Sample Request

Sample Response

GetManagementGroupsWithExpandAndRecurse

Sample Request

Sample Response

GetManagementGroupWithExpand

Sample Request

Sample Response

Definiciones

ErrorDetails

ErrorResponse

ManagementGroup

ManagementGroupChildInfo

ManagementGroupChildType

ManagementGroupDetails

ManagementGroupPathElement

ParentGroupInfo

Recursos adicionales