Entities - List

참조

서비스:: Management Groups

API 버전:: 2020-05-01

인증된 사용자에 대한 모든 엔터티(관리 그룹, 구독 등)를 나열합니다.

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

선택적 매개 변수:

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2018-01-01-preview입니다.
$filter	query		string	필터 매개 변수를 사용하면 이름 또는 표시 이름 필드를 필터링할 수 있습니다. 이름 필드(예: 이름 eq '{entityName}')에서 같음을 검사 이름 또는 표시 이름 필드(예: contains(name, '{substringToSearch}'), contains(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 선택을 재정의할 수 있습니다.
$skip	query		integer	결과를 검색할 때 건너뛸 엔터티 수입니다. 에 전달하면 $skipToken 재정의됩니다.
$skiptoken	query		string	페이지 연속 토큰은 이전 작업에서 부분 결과를 반환한 경우에만 사용됩니다. 이전 응답에 nextLink 요소가 포함된 경우 nextLink 요소의 값에는 후속 호출에 사용할 시작점을 지정하는 토큰 매개 변수가 포함됩니다.
$top	query		integer	결과를 검색할 때 반환할 요소 수입니다. 에 전달하면 $skipToken 재정의됩니다.
$view	query		string	view 매개 변수를 사용하면 클라이언트가 getEntities 호출에서 반환되는 데이터 형식을 필터링할 수 있습니다.
groupName	query		string	get 엔터티 호출이 특정 그룹에 집중할 수 있도록 하는 필터입니다(예: "$filter=name eq 'groupName'").

요청 헤더

Name	필수	형식	Description
Cache-Control		string	요청이 캐시를 활용해서는 안 됨을 나타냅니다.

응답

Name	형식	Description
200 OK	EntityListResult	정상
Other Status Codes	ErrorResponse	오류

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

GetEntities

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 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
}

정의

Name	Description
EntityInfo	엔터티입니다.
EntityListResult	엔터티를 보기 위한 요청의 결과를 설명합니다.
EntityParentGroupInfo	(선택 사항) 부모 관리 그룹의 ID입니다.
ErrorDetails	오류의 세부 정보입니다.
ErrorResponse	Error 개체.
Permissions	이 항목에 대한 사용자별 권한입니다.

EntityInfo

엔터티입니다.

Name	형식	Description
id	string	엔터티에 대한 정규화된 ID입니다. 예를 들어 /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000
name	string	엔터티의 이름입니다. 예를 들어 00000000-0000-0000-0000-000000000000
properties.displayName	string	관리 그룹의 이름입니다.
properties.inheritedPermissions	Permissions	상속된 사용 권한 이 항목에 대한 사용자별 권한입니다.
properties.numberOfChildGroups	integer	자식 그룹 수 자식 수는 현재 그룹 아래에 정확히 한 수준인 그룹 수입니다.
properties.numberOfChildren	integer	자식 수 자식 수는 현재 그룹 아래에 정확히 한 수준인 그룹 및 구독의 수입니다.
properties.numberOfDescendants	integer	하위 항목 수
properties.parent	EntityParentGroupInfo	Parent (선택 사항) 부모 관리 그룹의 ID입니다.
properties.parentDisplayNameChain	string[]	루트 그룹에서 직접 부모로의 부모 표시 이름 체인
properties.parentNameChain	string[]	루트 그룹에서 직접 부모로의 부모 이름 체인
properties.permissions	Permissions	사용 권한 이 항목에 대한 사용자별 권한입니다.
properties.tenantId	string	엔터티와 연결된 AAD 테넌트 ID입니다. 예를 들어 00000000-0000-0000-0000-000000000000
type	string	리소스 형식입니다. 예를 들어 Microsoft.Management/managementGroups

EntityListResult

엔터티를 보기 위한 요청의 결과를 설명합니다.

Name	형식	Description
count	integer	필터와 일치하는 레코드의 총 수
nextLink	string	다음 결과 집합을 가져오는 데 사용할 URL입니다.
value	EntityInfo[]	엔터티 목록입니다.

EntityParentGroupInfo

(선택 사항) 부모 관리 그룹의 ID입니다.

Name	형식	Description
id	string	부모 관리 그룹의 정규화된 ID입니다. 예를 들어 /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000000

ErrorDetails

오류의 세부 정보입니다.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
details	string	사용자가 읽을 수 있는 오류 세부 정보 표현입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

ErrorResponse

Error 개체.

Name	형식	Description
error	ErrorDetails	오류 오류의 세부 정보입니다.

Permissions

이 항목에 대한 사용자별 권한입니다.

Name	형식	Description
delete	string
edit	string
noaccess	string
view	string

다음을 통해 공유