Capacities - Get Capacities

Служба:: Power BI REST APIs

Версия API:: v1.0

Возвращает список емкостей, к которым у пользователя есть доступ.

Permissions

Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в разделе "Профили субъектов-служб" в Power BI Embedded. Создатель профиля должен иметь разрешения на емкость.

Требуемая область

Capacity.Read.All или Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities

Ответы

Имя	Тип	Описание
200 OK	Capacities	ХОРОШО

Примеры

Example

Образец запроса

GET https://api.powerbi.com/v1.0/myorg/capacities

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "displayName": "MyCapacity",
      "admins": [
        "john@contoso.com"
      ],
      "sku": "A1",
      "state": "Active",
      "region": "West Central US",
      "capacityUserAccessRight": "Admin"
    }
  ]
}

Определения

Имя	Описание
Capacities	Оболочка ответа OData для списка емкости Power BI
Capacity	Емкость Power BI
CapacityState	Состояние емкости
capacityUserAccessRight	Право доступа, которое пользователь имеет в емкости
TenantKey	Сведения о ключе шифрования

Capacities

Object

Оболочка ответа OData для списка емкости Power BI

Имя	Тип	Описание
@odata.context	string
value	Capacity[]	Список емкости

Capacity

Object

Емкость Power BI

Имя	Тип	Описание
admins	string[]	Массив администраторов емкости
capacityUserAccessRight	capacityUserAccessRight	Право доступа, которое пользователь имеет в емкости
displayName	string	Отображаемое имя емкости
id	string (uuid)	Идентификатор емкости
region	string	Регион Azure, в котором была подготовлена емкость
sku	string	Номер SKU емкости
state	CapacityState	Состояние емкости
tenantKey	TenantKey	Сведения о ключе шифрования (применяется только к маршрутам администратора)
tenantKeyId	string (uuid)	Идентификатор ключа шифрования (применимо только к маршруту администратора)

CapacityState

Перечисление

Состояние емкости

Значение	Описание
NotActivated	Не поддерживается
Active	Емкость готова к использованию
Provisioning	Активация емкости выполняется
ProvisionFailed	Сбой подготовки емкости
PreSuspended	Не поддерживается
Suspended	Использование емкости приостановлено
Deleting	Удаление емкости выполняется
Deleted	Емкость удалена и недоступна
Invalid	Не удается использовать емкость
UpdatingSku	Изменение номера SKU емкости выполняется

capacityUserAccessRight

Перечисление

Право доступа, которое пользователь имеет в емкости

Значение	Описание
None	У пользователя нет доступа к емкости
Assign	Пользователь имеет права участника и может назначать рабочие области емкости
Admin	У пользователя есть права администратора на емкость

TenantKey

Object

Сведения о ключе шифрования

Имя	Тип	Описание
createdAt	string (date-time)	Дата и время создания ключа шифрования
id	string (uuid)	Идентификатор ключа шифрования
isDefault	boolean	Является ли ключ шифрования ключом по умолчанию для всего клиента. Любая только что созданная емкость наследует ключ по умолчанию.
keyVaultKeyIdentifier	string	Универсальный код ресурса (URI), уникально указывающий ключ шифрования в Azure Key Vault
name	string	Имя ключа шифрования
updatedAt	string (date-time)	Дата последнего обновления и время ключа шифрования