Management Groups - List

リファレンス

Service:: Management Groups

API Version:: 2020-05-01

認証済みユーザーの管理グループを一覧表示します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2018-01-01-preview です。
$skiptoken	query		string	ページ継続トークンは、前の操作で部分的な結果が返された場合にのみ使用されます。前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定するトークンパラメーターが含まれます。

要求ヘッダー

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

応答

名前	型	説明
200 OK	ManagementGroupListResult	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	ユーザーアカウントの借用

例

ListManagementGroups

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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"
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0004-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 4 Tenant 2"
      }
    }
  ],
  "@nextLink": null
}

定義

名前	説明
ErrorDetails	エラーの詳細。
ErrorResponse	error オブジェクト。
ManagementGroupInfo	管理グループリソース。
ManagementGroupListResult	管理グループを一覧表示する要求の結果について説明します。

ErrorDetails

エラーの詳細。

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

ErrorResponse

error オブジェクト。

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

ManagementGroupInfo

管理グループリソース。

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

ManagementGroupListResult

管理グループを一覧表示する要求の結果について説明します。

名前	型	説明
@nextLink	string	次の結果セットを取得するために使用する URL。
value	ManagementGroupInfo[]	管理グループの一覧。