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

Admin - Get Capacities As Admin

  • Ссылка
Служба:
Power BI REST APIs
Версия API:
v1.0

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

Разрешения

  • Пользователь должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.
  • Поддерживаются делегированные разрешения.

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

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

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

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

Ограничения

Максимум 200 запросов в час.

GET https://api.powerbi.com/v1.0/myorg/admin/capacities
С использованием необязательных параметров: 
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

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

GET https://api.powerbi.com/v1.0/myorg/admin/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",
      "tenantKeyId": "82d9a37a-2b45-4221-b012-cb109b8e30c7"
    }
  ]
}

Example with expand on tenant key

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

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

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

Код состояния:
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

Object

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

Имя Тип Описание
@odata.context

string

value

Capacity[]

Список емкости

Capacity

Object

Емкость Power BI

Имя Тип Описание
admins

string[]

Массив администраторов емкости
capacityUserAccessRight

capacityUserAccessRight

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

string

Отображаемое имя емкости
id

string

Идентификатор емкости
region

string

Регион Azure, в котором была подготовлена емкость
sku

string

Номер SKU емкости
state

CapacityState

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

TenantKey

Сведения о ключе шифрования (применяется только к маршрутам администратора)
tenantKeyId

string

Идентификатор ключа шифрования (применимо только к маршруту администратора)

CapacityState

Enumeration

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

Значение Описание
Active

Емкость готова к использованию
Deleted

Емкость удалена и недоступна
Deleting

Удаление емкости выполняется
Invalid

Не удается использовать емкость
NotActivated

Неподдерживаемые
PreSuspended

Неподдерживаемые
ProvisionFailed

Сбой подготовки емкости
Provisioning

Активация емкости выполняется
Suspended

Использование емкости приостановлено
UpdatingSku

Изменение номера SKU емкости выполняется

capacityUserAccessRight

Enumeration

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

Значение Описание
Admin

У пользователя есть права администратора на емкость
Assign

Пользователь имеет права участника и может назначать рабочие области емкости
None

У пользователя нет доступа к емкости

TenantKey

Object

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

Имя Тип Описание
createdAt

string

Дата и время создания ключа шифрования
id

string

Идентификатор ключа шифрования
isDefault

boolean

Является ли ключ шифрования ключом по умолчанию для всего клиента. Любая только что созданная емкость наследует ключ по умолчанию.
keyVaultKeyIdentifier

string

Универсальный код ресурса (URI), уникально указывающий ключ шифрования в Azure Key Vault
name

string

Имя ключа шифрования
updatedAt

string

Дата последнего обновления и время ключа шифрования