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

回應

名稱	類型	Description
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"
    }
  ]
}

定義

名稱	Description
Capacities	Power BI 容量清單的 OData 回應包裝函式
Capacity	Power BI 容量
CapacityState	容量狀態
capacityUserAccessRight	使用者對於容量的存取權
TenantKey	加密金鑰資訊

Capacities

Power BI 容量清單的 OData 回應包裝函式

名稱	類型	Description
odata.context	string
value	Capacity[]	容量清單

Capacity

Power BI 容量

名稱	類型	Description
admins	string[]	容量管理員陣列
capacityUserAccessRight	capacityUserAccessRight	使用者對於容量的存取權
displayName	string	容量的顯示名稱
id	string	容量識別碼
region	string	布建容量的 Azure 區域
sku	string	容量 SKU
state	CapacityState	容量狀態
tenantKey	TenantKey	加密金鑰資訊 (僅適用于系統管理路由)
tenantKeyId	string	加密金鑰的識別碼 (僅適用于系統管理路由)

CapacityState

容量狀態

名稱	類型	Description
Active	string	容量已可供使用
Deleted	string	容量已刪除且無法使用
Deleting	string	正在刪除容量
Invalid	string	無法使用容量
NotActivated	string	不支援
PreSuspended	string	不支援
ProvisionFailed	string	容量布建失敗
Provisioning	string	容量的啟用正在進行中
Suspended	string	容量的使用已暫停
UpdatingSku	string	容量 SKU 變更正在進行中

capacityUserAccessRight

使用者對於容量的存取權

名稱	類型	Description
Admin	string	使用者具有容量的系統管理員許可權
Assign	string	使用者具有參與者許可權，而且可以將工作區指派給容量
None	string	使用者無法存取容量

TenantKey

加密金鑰資訊

名稱	類型	Description
createdAt	string	加密金鑰的建立日期和時間
id	string	加密金鑰的識別碼
isDefault	boolean	加密金鑰是否為整個租使用者的預設金鑰。 任何新建立的容量都會繼承預設金鑰。
keyVaultKeyIdentifier	string	唯一指定 Azure 金鑰保存庫中加密金鑰的 URI
name	string	加密金鑰的名稱
updatedAt	string	加密金鑰的上次更新日期和時間