Management Groups - Get

Referens

Service:: Management Groups

API Version:: 2020-05-01

Hämta information om hanteringsgruppen.

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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
groupId	path	True	string	Hanteringsgrupps-ID.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2018-01-01-preview.
$expand	query		string	Med frågesträngsparametern $expand=children kan klienter begära inkludering av underordnade i svarsnyttolasten. $expand=path innehåller sökvägen från rotgruppen till den aktuella gruppen.
$filter	query		string	Ett filter som tillåter uteslutning av prenumerationer från resultat (dvs. "$filter=children.childType ne Subscription")
$recurse	query		boolean	Parametern $recurse=true query string gör att klienter kan begära inkludering av hela hierarkin i svarsnyttolasten. Observera att $expand=underordnade måste skickas om $recurse är inställt på sant.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Cache-Control		string	Anger att begäran inte ska använda några cacheminnen.

Svar

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

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
ErrorDetails	Information om felet.
ErrorResponse	Felobjektet.
ManagementGroup	Information om hanteringsgruppen.
ManagementGroupChildInfo	Underordnad information om en hanteringsgrupp.
ManagementGroupChildType	Typ av underordnad resurs.
ManagementGroupDetails	Information om en hanteringsgrupp.
ManagementGroupPathElement	Ett sökvägselement i en överordnad hanteringsgrupp.
ParentGroupInfo	(Valfritt) ID för den överordnade hanteringsgruppen.

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	string	En läsbar återgivning av felinformationen.
message	string	En läsbar återgivning av felet.

ErrorResponse

Felobjektet.

Name	Typ	Description
error	ErrorDetails	Fel Information om felet.

ManagementGroup

Information om hanteringsgruppen.

Name	Typ	Description
id	string	Det fullständigt kvalificerade ID:t för hanteringsgruppen. Till exempel /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Namnet på hanteringsgruppen. Till exempel 000000000-0000-0000-0000-0000000000000000
properties.children	ManagementGroupChildInfo[]	Listan över underordnade.
properties.details	ManagementGroupDetails	Information Information om en hanteringsgrupp.
properties.displayName	string	Hanteringsgruppens eget namn.
properties.tenantId	string	Det AAD-klient-ID som är associerat med hanteringsgruppen. Till exempel 000000000-0000-0000-0000-0000000000000000
type	string	Resurstypen. Till exempel Microsoft.Management/managementGroups

ManagementGroupChildInfo

Underordnad information om en hanteringsgrupp.

Name	Typ	Description
children	ManagementGroupChildInfo[]	Listan över underordnade.
displayName	string	Det egna namnet på den underordnade resursen.
id	string	Det fullständigt kvalificerade ID:t för den underordnade resursen (hanteringsgrupp eller prenumeration). Till exempel /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Namnet på den underordnade entiteten.
type	ManagementGroupChildType	Typ av underordnad resurs. Den fullständigt kvalificerade resurstypen som innehåller providernamnområdet (t.ex. Microsoft.Management/managementGroups)

ManagementGroupChildType

Typ av underordnad resurs.

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

ManagementGroupDetails

Information om en hanteringsgrupp.

Name	Typ	Description
parent	ParentGroupInfo	Överordnad (Valfritt) ID för den överordnade hanteringsgruppen.
path	ManagementGroupPathElement[]	Sökvägen från roten till den aktuella gruppen.
updatedBy	string	Identiteten för huvudkontot eller processen som uppdaterade objektet.
updatedTime	string	Datum och tid då objektet senast uppdaterades.
version	number	Objektets versionsnummer.

ManagementGroupPathElement

Ett sökvägselement i en överordnad hanteringsgrupp.

Name	Typ	Description
displayName	string	Det egna namnet på gruppen.
name	string	Namnet på gruppen.

ParentGroupInfo

(Valfritt) ID för den överordnade hanteringsgruppen.

Name	Typ	Description
displayName	string	Det egna namnet på den överordnade hanteringsgruppen.
id	string	Det fullständigt kvalificerade ID:t för den överordnade hanteringsgruppen. Till exempel /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000
name	string	Namnet på den överordnade hanteringsgruppen

Dela via

Management Groups - Get

URI-parametrar

Begärandehuvud

Svar

Säkerhet

azure_auth

Scopes

Exempel

GetManagementGroup

Sample Request

Sample Response

GetManagementGroupsWithExpandAndRecurse

Sample Request

Sample Response

GetManagementGroupWithExpand

Sample Request

Sample Response

Definitioner

ErrorDetails

ErrorResponse

ManagementGroup

ManagementGroupChildInfo

ManagementGroupChildType

ManagementGroupDetails

ManagementGroupPathElement

ParentGroupInfo

Ytterligare resurser