Management Groups - Get

Service:

Management Groups

API Version:

2020-05-01

Uzyskaj szczegółowe informacje o grupie zarządzania.

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
groupId	path	True	string	Identyfikator grupy zarządzania.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2018-01-01-preview.
$expand	query		string	Parametr ciągu zapytania $expand=children umożliwia klientom żądanie włączenia elementów podrzędnych w ładunku odpowiedzi. $expand=ścieżka zawiera ścieżkę z grupy głównej do bieżącej grupy.
$filter	query		string	Filtr umożliwiający wykluczenie subskrypcji z wyników (tj. "$filter=children.childType ne Subscription")
$recurse	query		boolean	Parametr ciągu zapytania $recurse=true umożliwia klientom żądanie włączenia całej hierarchii w ładunku odpowiedzi. Należy pamiętać, że $expand=dzieci muszą zostać przekazane, jeśli $recurse ma wartość true.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Cache-Control		string	Wskazuje, że żądanie nie powinno korzystać z żadnych pamięci podręcznych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagementGroup	OK
Other Status Codes	ErrorResponse	Błąd

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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"
      }
    ]
  }
}

Definicje

Nazwa	Opis
ErrorDetails	Szczegóły błędu.
ErrorResponse	Obiekt błędu.
ManagementGroup	Szczegóły grupy zarządzania.
ManagementGroupChildInfo	Informacje podrzędne grupy zarządzania.
ManagementGroupChildType	Typ zasobu podrzędnego.
ManagementGroupDetails	Szczegóły grupy zarządzania.
ManagementGroupPathElement	Element ścieżki elementów podrzędnych grupy zarządzania.
ParentGroupInfo	(Opcjonalnie) Identyfikator nadrzędnej grupy zarządzania.

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	string	Czytelna dla człowieka reprezentacja szczegółów błędu.
message	string	Czytelna dla człowieka reprezentacja błędu.

ErrorResponse

Obiekt błędu.

Nazwa	Typ	Opis
error	ErrorDetails	Błąd Szczegóły błędu.

ManagementGroup

Szczegóły grupy zarządzania.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator grupy zarządzania. Na przykład /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Nazwa grupy zarządzania. Na przykład 000000000-0000-0000-0000-00000000000000000
properties.children	ManagementGroupChildInfo[]	Lista elementów podrzędnych.
properties.details	ManagementGroupDetails	Szczegóły Szczegóły grupy zarządzania.
properties.displayName	string	Przyjazna nazwa grupy zarządzania.
properties.tenantId	string	Identyfikator dzierżawy usługi AAD skojarzony z grupą zarządzania. Na przykład 000000000-0000-0000-0000-00000000000000000
type	string	Typ zasobu. Na przykład Microsoft.Management/managementGroups

ManagementGroupChildInfo

Informacje podrzędne grupy zarządzania.

Nazwa	Typ	Opis
children	ManagementGroupChildInfo[]	Lista elementów podrzędnych.
displayName	string	Przyjazna nazwa zasobu podrzędnego.
id	string	W pełni kwalifikowany identyfikator zasobu podrzędnego (grupa zarządzania lub subskrypcja). Na przykład /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Nazwa jednostki podrzędnej.
type	ManagementGroupChildType	Typ zasobu podrzędnego. W pełni kwalifikowany typ zasobu, który obejmuje przestrzeń nazw dostawcy (np. Microsoft.Management/managementGroups)

ManagementGroupChildType

Typ zasobu podrzędnego.

Nazwa	Typ	Opis
/subscriptions	string
Microsoft.Management/managementGroups	string

ManagementGroupDetails

Szczegóły grupy zarządzania.

Nazwa	Typ	Opis
parent	ParentGroupInfo	Parent (Opcjonalnie) Identyfikator nadrzędnej grupy zarządzania.
path	ManagementGroupPathElement[]	Ścieżka z katalogu głównego do bieżącej grupy.
updatedBy	string	Tożsamość podmiotu zabezpieczeń lub procesu, który zaktualizował obiekt.
updatedTime	string	Data i godzina ostatniej aktualizacji tego obiektu.
version	number	Numer wersji obiektu.

ManagementGroupPathElement

Element ścieżki elementów podrzędnych grupy zarządzania.

Nazwa	Typ	Opis
displayName	string	Przyjazna nazwa grupy.
name	string	Nazwa grupy.

ParentGroupInfo

(Opcjonalnie) Identyfikator nadrzędnej grupy zarządzania.

Nazwa	Typ	Opis
displayName	string	Przyjazna nazwa nadrzędnej grupy zarządzania.
id	string	W pełni kwalifikowany identyfikator nadrzędnej grupy zarządzania. Na przykład /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Nazwa nadrzędnej grupy zarządzania