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 パラメーター

名前	/	必須	型	説明
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2018-01-01-preview です。
$filter	query		string	filter パラメーターを使用すると、名前フィールドまたは表示名フィールドをフィルター処理できます。 name フィールドに等しいかどうかをチェックできます (例: name eq '{entityName}')、名前フィールドまたは表示名フィールドの部分文字列 (例: contains(name, '{substringToSearch}'))、contains(displayName,'{substringToSearch')) の部分文字列をチェックできます。 '{entityName}' フィールドと '{substringToSearch}' フィールドは大文字と小文字が区別されずにチェックされることに注意してください。
$search	query		string	$search パラメーターは、渡されたパラメーターに応じて 3 つの異なる出力を返すために、$filter パラメーターと組み合わせて使用されます。 $search=AllowedParents を使用すると、API は、ユーザーのアクセス許可によって決定された、要求されたエンティティが再親できるすべてのグループのエンティティ情報を返します。 $search=AllowedChildren では、API は要求されたエンティティの子として追加できるすべてのエンティティのエンティティ情報を返します。 $search=ParentAndFirstLevelChildren を使用すると、API は、ユーザーが直接アクセスできる子の親レベルと第 1 レベルの子、またはその子孫のいずれかを介した間接アクセスを返します。 $search=ParentOnly では、ユーザーがグループの少なくとも 1 つの子孫にアクセスできる場合、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'")

要求ヘッダー

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

応答

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

例

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
}

定義

名前	説明
EntityInfo	エンティティ。
EntityListResult	エンティティを表示する要求の結果について説明します。
EntityParentGroupInfo	(省略可能)親管理グループの ID。
ErrorDetails	エラーの詳細。
ErrorResponse	error オブジェクト。
Permissions	このアイテムに対するユーザー固有のアクセス許可。

EntityInfo

エンティティ。

名前	型	説明
id	string	エンティティの完全修飾 ID。たとえば、/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-00000000000
name	string	エンティティの名前。たとえば、00000000-0000-0000-0000-000000000000000000
properties.displayName	string	管理グループのフレンドリ名。
properties.inheritedPermissions	Permissions	継承された権限このアイテムに対するユーザー固有のアクセス許可。
properties.numberOfChildGroups	integer	子グループの数子の数は、現在のグループの下の 1 つのレベルであるグループの数です。
properties.numberOfChildren	integer	子の数子の数は、現在のグループの下にある 1 つのレベルであるグループとサブスクリプションの数です。
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-000000000000000000
type	string	リソースの型。たとえば、Microsoft.Management/managementGroups

EntityListResult

エンティティを表示する要求の結果について説明します。

名前	型	説明
count	integer	フィルターに一致するレコードの合計数
nextLink	string	次の結果セットを取得するために使用する URL。
value	EntityInfo[]	エンティティの一覧。

EntityParentGroupInfo

(省略可能)親管理グループの ID。

名前	型	説明
id	string	親管理グループの完全修飾 ID。たとえば、/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-00000000000

ErrorDetails

エラーの詳細。

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

ErrorResponse

error オブジェクト。

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

Permissions

このアイテムに対するユーザー固有のアクセス許可。

名前	型	説明
delete	string
edit	string
noaccess	string
view	string

Share via