Capacities - Get Capacities

Service:

Power BI REST APIs

API Version:

v1.0

返回用户有权访问的容量列表。

权限

此 API 调用可由服务主体配置文件调用。 有关详细信息，请参阅：Power BI Embedded中的服务主体配置文件。 配置文件创建者必须具有容量权限。

所需范围

Capacity.Read.All 或 Capacity.ReadWrite.All

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

响应

名称	类型	说明
200 OK	Capacities	确定

示例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/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"
    }
  ]
}

定义

名称	说明
Capacities	Power BI 容量列表的 OData 响应包装器
Capacity	Power BI 容量
CapacityState	容量状态
capacityUserAccessRight	用户对容量具有的访问权限
TenantKey	加密密钥信息

Capacities

Power BI 容量列表的 OData 响应包装器

名称	类型	说明
odata.context	string
value	Capacity[]	容量列表

Capacity

Power BI 容量

名称	类型	说明
admins	string[]	容量管理员数组
capacityUserAccessRight	capacityUserAccessRight	用户对容量的访问权限
displayName	string	容量的显示名称
id	string	容量 ID
region	string	预配容量的 Azure 区域
sku	string	容量 SKU
state	CapacityState	容量状态
tenantKey	TenantKey	加密密钥信息 (仅适用于管理路由)
tenantKeyId	string	加密密钥的 ID (仅适用于管理路由)

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	加密密钥的 ID
isDefault	boolean	加密密钥是否是整个租户的默认密钥。 任何新创建的容量都继承默认密钥。
keyVaultKeyIdentifier	string	唯一指定 Azure 密钥保管库中的加密密钥的 URI
name	string	加密密钥的名称
updatedAt	string	加密密钥的上次更新日期和时间