Entities - List

參考

Service:: Management Groups

API Version:: 2020-05-01

列出已驗證之使用者的所有實體 (管理群組、訂用帳戶等)。

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

With optional parameters:

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01&$skiptoken={$skiptoken}&$skip={$skip}&$top={$top}&$select={$select}&$search={$search}&$filter={$filter}&$view={$view}&groupName={groupName}

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本為 2018-01-01-preview。
$filter	query		string	篩選參數可讓您篩選名稱或顯示名稱欄位。您可以檢查名稱欄位 (是否相等，例如名稱 eq '{entityName}') ，而且您可以在名稱或顯示名稱 (字段上檢查子字符串，例如，包含 (名稱、'{substringToSearch}') 、包含 (displayName、'{substringToSearch') ) 。請注意，'{entityName}' 和 '{substringToSearch}' 字段不區分大小寫。
$search	query		string	$search參數會與 $filter 參數搭配使用，根據傳入的參數傳回三個不同的輸出。使用 $search=AllowedParents 時，API 會傳回要求之實體能夠依用戶權力所決定的所有群組的實體資訊。使用 $search=AllowedChildren 時，API 會傳回可新增為所要求實體子系之所有實體的實體資訊。使用 $search=ParentAndFirstLevelChildren 時，API 會傳回使用者透過其中一個子系直接存取或間接存取的父系和第一層子系。使用 $search=ParentOnly 時，只有當使用者至少有一個群組子系的存取權時，API 才會傳回群組。使用 $search=ChildrenOnly 時，API 只會傳回$filter中所指定群組實體資訊的第一層子系。用戶必須直接存取子實體或其中一個子系，才能顯示在結果中。
$select	query		string	此參數會指定要包含在回應中的欄位。可以包含 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain 的任何組合，例如 '$select=Name，DisplayName，Type，ParentDisplayNameChain，ParentNameChain'。指定時，$select參數可以覆寫$skipToken中的 select。
$skip	query		integer	擷取結果時要略過的實體數目。傳入此檔案將會覆寫$skipToken。
$skiptoken	query		string	只有在先前的作業傳回部分結果時，才會使用頁面接續令牌。如果先前的回應包含 nextLink 元素，nextLink 元素的值會包含 token 參數，指定後續呼叫要使用的起點。
$top	query		integer	擷取結果時要傳回的項目數目。傳入此檔案將會覆寫$skipToken。
$view	query		string	檢視參數可讓客戶端篩選 getEntities 呼叫所傳回的數據類型。
groupName	query		string	允許取得實體呼叫的篩選，將焦點放在特定群組 (，也就是 “$filter=name eq 'groupName'”)

要求標頭

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

回應

名稱	類型	Description
200 OK	EntityListResult	確定
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	模擬您的用戶帳戶

範例

GetEntities

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Management/getEntities?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",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "view",
        "inheritedPermissions": "view",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 1 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group1Tenant2Parent"
        ],
        "numberOfDescendants": 3,
        "numberOfChildren": 2,
        "numberOfChildGroups": 1
      }
    },
    {
      "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",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "delete",
        "inheritedPermissions": "delete",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 4 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group4 Tenant2Parent"
        ],
        "numberOfDescendants": 0,
        "numberOfChildren": 0,
        "numberOfChildGroups": 0
      }
    }
  ],
  "nextLink": null
}

定義

名稱	Description
EntityInfo	實體。
EntityListResult	描述檢視實體的要求結果。
EntityParentGroupInfo	(選擇性) 父管理群組的標識碼。
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤物件。
Permissions	此項目的使用者特定許可權。

EntityInfo

實體。

名稱	類型	Description
id	string	實體的完整標識碼。例如，/providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000
name	string	實體的名稱。例如，00000000-0000-0000-0000-0000000000000
properties.displayName	string	管理群組的易記名稱。
properties.inheritedPermissions	Permissions	繼承的權限此項目的使用者特定許可權。
properties.numberOfChildGroups	integer	子群組數目子係數目是目前 Group 底下剛好一個層級的群組數目。
properties.numberOfChildren	integer	子係數目子係數目是目前群組底下剛好一個層級的群組和訂用帳戶數目。
properties.numberOfDescendants	integer	子係數目
properties.parent	EntityParentGroupInfo	Parent (選擇性) 父管理群組的標識碼。
properties.parentDisplayNameChain	string[]	從根群組到直接父系的父顯示名稱鏈結
properties.parentNameChain	string[]	從根群組到直接父系的父名稱鏈結
properties.permissions	Permissions	權限此項目的使用者特定許可權。
properties.tenantId	string	與實體相關聯的 AAD 租用戶標識碼。例如，00000000-0000-0000-0000-0000000000000
type	string	資源類型。例如，Microsoft.Management/managementGroups

EntityListResult

描述檢視實體的要求結果。

名稱	類型	Description
count	integer	符合篩選條件的記錄總數
nextLink	string	用於取得下一組結果的 URL。
value	EntityInfo[]	實體清單。

EntityParentGroupInfo

(選擇性) 父管理群組的標識碼。

名稱	類型	Description
id	string	父管理群組的完整標識碼。例如，/providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000

ErrorDetails

錯誤的詳細數據。

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

ErrorResponse

錯誤物件。

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

Permissions

此項目的使用者特定許可權。

名稱	類型	Description
delete	string
edit	string
noaccess	string
view	string