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

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 2018-01-01-preview.
$filter	query		string	Параметр filter позволяет выполнять фильтрацию по полям имени или отображаемого имени. Вы можете проверка для равенства в поле имени (например, name 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'")

Заголовок запроса

Имя	Обязательно	Тип	Описание
Cache-Control		string	Указывает, что запрос не должен использовать кэши.

Ответы

Имя	Тип	Описание
200 OK	EntityListResult	ОК
Other Status Codes	ErrorResponse	Ошибка

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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
}

Определения

Имя	Описание
EntityInfo	Сущность.
EntityListResult	Описывает результат запроса на просмотр сущностей.
EntityParentGroupInfo	(Необязательно) Идентификатор родительской группы управления.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Объект error.
Permissions	Разрешения пользователей для этого элемента.

EntityInfo

Сущность.

Имя	Тип	Описание
id	string	Полный идентификатор сущности. Например, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000000
name	string	Имя сущности. Например, 000000000-0000-0000-00000000000000000
properties.displayName	string	Понятное имя группы управления.
properties.inheritedPermissions	Permissions	Наследуемые разрешения Разрешения пользователей для этого элемента.
properties.numberOfChildGroups	integer	Число дочерних групп Число дочерних элементов — это количество групп, которые находятся ровно на один уровень ниже текущей группы.
properties.numberOfChildren	integer	Число дочерних элементов Число дочерних элементов — это количество групп и подписок, которые находятся ровно на один уровень ниже текущей группы.
properties.numberOfDescendants	integer	Число потомков
properties.parent	EntityParentGroupInfo	Parent (Необязательно) Идентификатор родительской группы управления.
properties.parentDisplayNameChain	string[]	Родительская цепочка отображаемых имен от корневой группы к непосредственному родительскому элементу
properties.parentNameChain	string[]	Цепочка родительских имен от корневой группы к непосредственному родительскому элементу
properties.permissions	Permissions	Разрешения Разрешения пользователей для этого элемента.
properties.tenantId	string	Идентификатор клиента AAD, связанный с сущностью. Например, 000000000-0000-0000-00000000000000000
type	string	Тип ресурса. Например, Microsoft.Management/managementGroups

EntityListResult

Описывает результат запроса на просмотр сущностей.

Имя	Тип	Описание
count	integer	Общее количество записей, соответствующих фильтру
nextLink	string	URL-адрес, используемый для получения следующего набора результатов.
value	EntityInfo[]	Список сущностей.

EntityParentGroupInfo

(Необязательно) Идентификатор родительской группы управления.

Имя	Тип	Описание
id	string	Полный идентификатор родительской группы управления. Например, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000000

ErrorDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
details	string	Понятное представление сведений об ошибке.
message	string	Удобочитаемое представление ошибки.

ErrorResponse

Объект error.

Имя	Тип	Описание
error	ErrorDetails	Ошибка Сведения об ошибке.

Permissions

Разрешения пользователей для этого элемента.

Имя	Тип	Описание
delete	string
edit	string
noaccess	string
view	string

Поделиться через