Management Groups - Get

Reference

Služba:: Management Groups

Verze rozhraní API:: 2020-05-01

Získejte podrobnosti o skupině pro správu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
groupId	path	True	string	ID skupiny pro správu.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2018-01-01-preview.
$expand	query		string	Parametr řetězce dotazu $expand=children umožňuje klientům požadovat zahrnutí podřízených položek do datové části odpovědi. $expand=path zahrnuje cestu z kořenové skupiny do aktuální skupiny.
$filter	query		string	Filtr, který umožňuje vyloučit předplatná z výsledků (tj. '$filter=children.childType ne Subscription')
$recurse	query		boolean	Parametr řetězce dotazu $recurse=true umožňuje klientům vyžadovat zahrnutí celé hierarchie do datové části odpovědi. Mějte na paměti, že pokud je $recurse nastavená na hodnotu true, musí se předat $expand=podřízené položky.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Cache-Control		string	Označuje, že požadavek by neměl využívat žádné mezipaměti.

Odpovědi

Name	Typ	Description
200 OK	ManagementGroup	OK
Other Status Codes	ErrorResponse	Chyba

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetManagementGroup

GetManagementGroupsWithExpandAndRecurse

GetManagementGroupWithExpand

GetManagementGroup

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
      }
    ]
  }
}

Definice

Name	Description
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Objekt chyby.
ManagementGroup	Podrobnosti o skupině pro správu
ManagementGroupChildInfo	Podřízené informace skupiny pro správu.
ManagementGroupChildType	Typ podřízeného prostředku.
ManagementGroupDetails	Podrobnosti o skupině pro správu.
ManagementGroupPathElement	Element cesty nadřazených skupin pro správu.
ParentGroupInfo	(Volitelné) ID nadřazené skupiny pro správu.

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	string	Lidsky čitelná reprezentace podrobností o chybě.
message	string	Lidsky čitelná reprezentace chyby.

ErrorResponse

Objekt chyby.

Name	Typ	Description
error	ErrorDetails	Chyba Podrobnosti o chybě.

ManagementGroup

Podrobnosti o skupině pro správu

Name	Typ	Description
id	string	Plně kvalifikované ID skupiny pro správu. Například /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Název skupiny pro správu. Například 00000000-0000-0000-0000-000000000000000000
properties.children	ManagementGroupChildInfo[]	Seznam podřízených položek.
properties.details	ManagementGroupDetails	Podrobnosti Podrobnosti o skupině pro správu.
properties.displayName	string	Popisný název skupiny pro správu.
properties.tenantId	string	ID tenanta AAD přidružené ke skupině pro správu. Například 00000000-0000-0000-0000-000000000000000000
type	string	Typ prostředku. Například Microsoft.Management/managementGroups

ManagementGroupChildInfo

Podřízené informace skupiny pro správu.

Name	Typ	Description
children	ManagementGroupChildInfo[]	Seznam podřízených položek.
displayName	string	Popisný název podřízeného prostředku.
id	string	Plně kvalifikované ID podřízeného prostředku (skupiny pro správu nebo předplatného) Například /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Název podřízené entity.
type	ManagementGroupChildType	Typ podřízeného prostředku. Plně kvalifikovaný typ prostředku, který zahrnuje obor názvů poskytovatele (např. Microsoft.Management/managementGroups)

ManagementGroupChildType

Typ podřízeného prostředku.

Name	Typ	Description
/subscriptions	string
Microsoft.Management/managementGroups	string

ManagementGroupDetails

Podrobnosti o skupině pro správu.

Name	Typ	Description
parent	ParentGroupInfo	Parent (Volitelné) ID nadřazené skupiny pro správu.
path	ManagementGroupPathElement[]	Cesta z kořenového adresáře do aktuální skupiny.
updatedBy	string	Identita objektu zabezpečení nebo procesu, který objekt aktualizoval.
updatedTime	string	Datum a čas poslední aktualizace tohoto objektu.
version	number	Číslo verze objektu.

ManagementGroupPathElement

Element cesty nadřazených skupin pro správu.

Name	Typ	Description
displayName	string	Popisný název skupiny
name	string	Název skupiny.

ParentGroupInfo

(Volitelné) ID nadřazené skupiny pro správu.

Name	Typ	Description
displayName	string	Popisný název nadřazené skupiny pro správu.
id	string	Plně kvalifikované ID nadřazené skupiny pro správu. Například /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Název nadřazené skupiny pro správu

Sdílet prostřednictvím

Management Groups - Get

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

GetManagementGroup

Ukázkový požadavek

Ukázková odpověď

GetManagementGroupsWithExpandAndRecurse

Ukázkový požadavek

Ukázková odpověď

GetManagementGroupWithExpand

Ukázkový požadavek

Ukázková odpověď

Definice

ErrorDetails

ErrorResponse

ManagementGroup

ManagementGroupChildInfo

ManagementGroupChildType

ManagementGroupDetails

ManagementGroupPathElement

ParentGroupInfo

Další materiály