Management Groups - Get

リファレンス

Service:: Management Groups

API Version:: 2020-05-01

管理グループの詳細を取得します。

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 パラメーター

名前	/	必須	型	説明
groupId	path	True	string	管理グループ ID。
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2018-01-01-preview です。
$expand	query		string	$expand=children クエリ文字列パラメーターを使用すると、クライアントは応答ペイロードに子を含めることを要求できます。 $expand=path には、ルートグループから現在のグループへのパスが含まれます。
$filter	query		string	結果からのサブスクリプションの除外を許可するフィルター (つまり、'$filter=children.childType ne Subscription')
$recurse	query		boolean	$recurse=true クエリ文字列パラメーターを使用すると、クライアントは応答ペイロードに階層全体の包含を要求できます。 $recurseが true に設定されている場合は、$expand=children を渡す必要があることに注意してください。

要求ヘッダー

名前	必須	型	説明
Cache-Control		string	要求でキャッシュを使用しないことを示します。

応答

名前	型	説明
200 OK	ManagementGroup	OK
Other Status Codes	ErrorResponse	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

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

定義

名前	説明
ErrorDetails	エラーの詳細。
ErrorResponse	error オブジェクト。
ManagementGroup	管理グループの詳細。
ManagementGroupChildInfo	管理グループの子情報。
ManagementGroupChildType	子リソースの種類。
ManagementGroupDetails	管理グループの詳細。
ManagementGroupPathElement	管理グループの先祖の path 要素。
ParentGroupInfo	(省略可能)親管理グループの ID。

ErrorDetails

エラーの詳細。

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
details	string	エラーの詳細を人間が判読できる表現。
message	string	エラーの人間が判読できる表現。

ErrorResponse

error オブジェクト。

名前	型	説明
error	ErrorDetails	エラーエラーの詳細。

ManagementGroup

管理グループの詳細。

名前	型	説明
id	string	管理グループの完全修飾 ID。たとえば、/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-00000000000
name	string	管理グループの名前。たとえば、00000000-0000-0000-0000-000000000000000000
properties.children	ManagementGroupChildInfo[]	子の一覧。
properties.details	ManagementGroupDetails	詳細管理グループの詳細。
properties.displayName	string	管理グループのフレンドリ名。
properties.tenantId	string	管理グループに関連付けられている AAD テナント ID。たとえば、00000000-0000-0000-0000-000000000000000000
type	string	リソースの型。たとえば、Microsoft.Management/managementGroups

ManagementGroupChildInfo

管理グループの子情報。

名前	型	説明
children	ManagementGroupChildInfo[]	子の一覧。
displayName	string	子リソースのフレンドリ名。
id	string	子リソース (管理グループまたはサブスクリプション) の完全修飾 ID。たとえば、/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-00000000000
name	string	子エンティティの名前。
type	ManagementGroupChildType	子リソースの種類。プロバイダー名前空間を含む完全修飾リソースの種類 (Microsoft.Management/managementGroups など)

ManagementGroupChildType

子リソースの種類。

名前	型	説明
/subscriptions	string
Microsoft.Management/managementGroups	string

ManagementGroupDetails

管理グループの詳細。

名前	型	説明
parent	ParentGroupInfo	Parent (省略可能)親管理グループの ID。
path	ManagementGroupPathElement[]	ルートから現在のグループへのパス。
updatedBy	string	オブジェクトを更新したプリンシパルまたはプロセスの ID。
updatedTime	string	このオブジェクトが最後に更新された日時。
version	number	オブジェクトのバージョン番号。

ManagementGroupPathElement

管理グループの先祖の path 要素。

名前	型	説明
displayName	string	グループのフレンドリ名。
name	string	グループの名前。

ParentGroupInfo

(省略可能)親管理グループの ID。

名前	型	説明
displayName	string	親管理グループのフレンドリ名。
id	string	親管理グループの完全修飾 ID。たとえば、/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-00000000000
name	string	親管理グループの名前

Management Groups - Get

URI パラメーター

要求ヘッダー

応答

セキュリティ

azure_auth

Scopes

例

GetManagementGroup

Sample Request

Sample Response

GetManagementGroupsWithExpandAndRecurse

Sample Request

Sample Response

GetManagementGroupWithExpand

Sample Request

Sample Response

定義

ErrorDetails

ErrorResponse

ManagementGroup

ManagementGroupChildInfo

ManagementGroupChildType

ManagementGroupDetails

ManagementGroupPathElement

ParentGroupInfo

その他のリソース