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 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本是 2018-01-01-preview。
$skiptoken	query		string	只有在先前的作業傳回部分結果時，才會使用頁面接續令牌。如果先前的回應包含 nextLink 元素，nextLink 元素的值將包含標記參數，指定後續呼叫使用的起點。

要求標頭

名稱	必要	類型	Description
Cache-Control		string	表示要求不應該使用任何快取。

回應

名稱	類型	Description
200 OK	ManagementGroupListResult	確定
Other Status Codes	ErrorResponse	錯誤

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名稱	Description
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
}

定義

名稱	Description
ErrorDetails	錯誤的詳細數據。
ErrorResponse	error 物件。
ManagementGroupInfo	管理群組資源。
ManagementGroupListResult	描述列出管理群組的要求結果。

ErrorDetails

錯誤的詳細數據。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	string	人類可讀取的錯誤詳細數據表示法。
message	string	人類可讀取的錯誤表示法。

ErrorResponse

error 物件。

名稱	類型	Description
error	ErrorDetails	錯誤錯誤的詳細數據。

ManagementGroupInfo

管理群組資源。

名稱	類型	Description
id	string	管理群組的完整標識碼。例如，/providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000
name	string	管理群組的名稱。例如，00000000-0000-0000-0000-0000000000000
properties.displayName	string	管理群組的易記名稱。
properties.tenantId	string	與管理群組相關聯的 AAD 租用戶標識碼。例如，00000000-0000-0000-0000-0000000000000
type	string	資源類型。例如，Microsoft.Management/managementGroups

ManagementGroupListResult

描述列出管理群組的要求結果。

名稱	類型	Description
@nextLink	string	要用於取得下一組結果的URL。
value	ManagementGroupInfo[]	管理群組的清單。

Share via