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	OK

示例

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	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	加密密钥的上次更新日期和时间