Admin - Get Capacities As Admin

Service:

Power BI REST APIs

API Version:

v1.0

組織の容量の一覧を返します。

アクセス許可

• ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っているか、サービス プリンシパルを使用して認証する必要があります。
• 委任されたアクセス許可がサポートされています。

サービス の prinicipal 認証で実行する場合、アプリには、Azure portalで 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 Key Vaultで暗号化キーを一意に指定する URI
name	string	暗号化キーの名前
updatedAt	string	暗号化キーの最終更新日時