共用方式為

Admin - Get Capacities As Admin

服務:
Power BI REST APIs
API 版本:
v1.0

傳回組織的容量清單。

權限

  • 用戶必須是網狀架構系統管理員，或使用服務主體進行驗證。
  • 支援委派的許可權。

在服務原始驗證下執行時，應用程式 不得 在 Azure 入口網站中設定 Power BI 的任何系統管理員同意必要先決條件。

必要範圍

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 參數

名稱 位於 必要 類型 Description
$expand
 query

string

內嵌擴充相關實體

回應

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

定義

名稱 Description
Capacities

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

Power BI 容量
CapacityState

容量狀態
capacityUserAccessRight

使用者對容量的存取權
TenantKey

加密金鑰資訊

Capacities

Object

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

名稱 類型 Description
@odata.context

string

value

Capacity[]

容量清單

Capacity

Object

Power BI 容量

名稱 類型 Description
admins

string[]

容量管理員的陣列
capacityUserAccessRight

capacityUserAccessRight

使用者對容量的存取權
displayName

string

容量的顯示名稱
id

string (uuid)

容量標識碼
region

string

布建容量的 Azure 區域
sku

string

容量 SKU
state

CapacityState

容量狀態
tenantKey

TenantKey

加密金鑰資訊（僅適用於系統管理員路由）
tenantKeyId

string (uuid)

加密金鑰的識別碼（僅適用於系統管理路由）

CapacityState

列舉型別

容量狀態

值 Description
NotActivated

支援
Active

容量已準備好使用
Provisioning

容量的啟用正在進行中
ProvisionFailed

容量布建失敗
PreSuspended

支援
Suspended

容量的使用已暫停
Deleting

正在刪除容量
Deleted

容量已刪除且無法使用
Invalid

無法使用容量
UpdatingSku

容量 SKU 變更正在進行中

capacityUserAccessRight

列舉型別

使用者對容量的存取權

值 Description
None

用戶無法存取容量
Assign

使用者具有參與者許可權，並可將工作區指派給容量
Admin

使用者具有容量的系統管理員許可權

TenantKey

Object

加密金鑰資訊

名稱 類型 Description
createdAt

string (date-time)

加密金鑰的建立日期和時間
id

string (uuid)

加密金鑰的識別碼
isDefault

boolean

加密金鑰是否為整個租用戶的預設金鑰。 任何新建立的容量都會繼承預設密鑰。
keyVaultKeyIdentifier

string

唯一指定 Azure Key Vault 中加密金鑰的 URI
name

string

加密金鑰的名稱
updatedAt

string (date-time)

加密金鑰的上次更新日期和時間