Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

Возвращает список емкостей для организации.

Разрешения

• Пользователь должен иметь права администратора (например, Office 365 глобального администратора или администратора службы Power BI) или пройти проверку подлинности с помощью субъекта-службы.
• Поддерживаются делегированные разрешения.

При выполнении в режиме предварительной проверки подлинности службы в портал Azure приложение не должно иметь необходимых предустановок согласия администратора для Power BI.

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

Tenant.Read.All или Tenant.ReadWrite.All

Применимо только при проверке подлинности с помощью стандартного маркера доступа делегированного администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.

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

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/capacities?$expand={$expand}

Параметры URI

Имя	В	Обязательно	Тип	Описание
$expand	query		string	Развертывает встроенные связанные сущности

Ответы

Имя	Тип	Описание
200 OK	Capacities	ОК

Примеры

Example

Example with expand on tenant key

Example

Sample Request

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

Sample Response

Status code:

200

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

Example with expand on tenant key

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities?$expand=tenantKey

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "displayName": "MyCapacity",
      "admins": [
        "john@contoso.com"
      ],
      "sku": "A1",
      "state": "Active",
      "region": "West Central US",
      "capacityUserAccessRight": "Admin",
      "tenantKeyId": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "tenantKey": {
        "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
        "name": "Contoso Sales",
        "keyVaultKeyIdentifier": "https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2",
        "isDefault": true,
        "createdAt": "2019-04-30T21:35:15.867-07:00",
        "updatedAt": "2019-04-30T21:35:15.867-07:00"
      }
    }
  ]
}

Определения

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

Capacities

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

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

Capacity

Емкость Power BI

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

CapacityState

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

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

capacityUserAccessRight

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

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

TenantKey

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

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