Management Groups - Get
取得管理群組的詳細數據。
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}?api-version=2020-05-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}?api-version=2020-05-01&$expand={$expand}&$recurse={$recurse}&$filter={$filter}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
group
|
path | True |
string |
管理群組標識碼。 |
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。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
Cache-Control |
string |
表示要求不應該使用任何快取。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
錯誤 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Get |
Get |
Get |
GetManagementGroup
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01
Sample Response
{
"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
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
{
"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
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000?api-version=2020-05-01&$expand=children
Sample Response
{
"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"
}
]
}
}
定義
名稱 | Description |
---|---|
Error |
錯誤的詳細數據。 |
Error |
error 物件。 |
Management |
管理群組詳細數據。 |
Management |
管理群組的子資訊。 |
Management |
子資源的類型。 |
Management |
管理群組的詳細數據。 |
Management |
管理群組上階的路徑專案。 |
Parent |
(選擇性) 父管理群組的標識碼。 |
ErrorDetails
錯誤的詳細數據。
名稱 | 類型 | Description |
---|---|---|
code |
string |
其中一組伺服器定義的錯誤碼。 |
details |
string |
人類可讀取的錯誤詳細數據表示法。 |
message |
string |
人類可讀取的錯誤表示法。 |
ErrorResponse
error 物件。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤 |
ManagementGroup
管理群組詳細數據。
名稱 | 類型 | Description |
---|---|---|
id |
string |
管理群組的完整標識碼。 例如,/providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000 |
name |
string |
管理群組的名稱。 例如,00000000-0000-0000-0000-0000000000000 |
properties.children |
子系的清單。 |
|
properties.details |
詳細資料 |
|
properties.displayName |
string |
管理群組的易記名稱。 |
properties.tenantId |
string |
與管理群組相關聯的 AAD 租用戶標識碼。 例如,00000000-0000-0000-0000-0000000000000 |
type |
string |
資源類型。 例如,Microsoft.Management/managementGroups |
ManagementGroupChildInfo
管理群組的子資訊。
名稱 | 類型 | Description |
---|---|---|
children |
子系的清單。 |
|
displayName |
string |
子資源的易記名稱。 |
id |
string |
子資源 (管理群組或訂用帳戶) 的完整標識符。 例如,/providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000 |
name |
string |
子實體的名稱。 |
type |
子資源的類型。 |
ManagementGroupChildType
子資源的類型。
名稱 | 類型 | Description |
---|---|---|
/subscriptions |
string |
|
Microsoft.Management/managementGroups |
string |
ManagementGroupDetails
管理群組的詳細數據。
名稱 | 類型 | Description |
---|---|---|
parent |
Parent |
|
path |
從根目錄到目前群組的路徑。 |
|
updatedBy |
string |
更新物件之主體或進程的身分識別。 |
updatedTime |
string |
上次更新此物件的日期和時間。 |
version |
number |
物件的版本號碼。 |
ManagementGroupPathElement
管理群組上階的路徑專案。
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
群組的易記名稱。 |
name |
string |
群組的名稱。 |
ParentGroupInfo
(選擇性) 父管理群組的標識碼。
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
父管理群組的易記名稱。 |
id |
string |
父管理群組的完整標識碼。 例如,/providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000 |
name |
string |
父管理群組的名稱 |