Admin - Add Power BI Encryption Key

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

容量に割り当てられた Power BI ワークスペースの暗号化キーを追加します。

アクセス許可

ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っている必要があります。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

制限事項

1 時間あたり最大 600 件の要求。 

POST https://api.powerbi.com/v1.0/myorg/admin/tenantKeys

要求本文

名前 型 説明
activate

boolean

非アクティブ化された容量をアクティブ化し、その暗号化にこのキーを使用するかどうか
isDefault

boolean

暗号化キーがテナント全体の既定のキーかどうか。 新しく作成された容量は、既定のキーを継承します。
keyVaultKeyIdentifier

string

Azure Key Vaultで暗号化キーを一意に指定する URI
name

string

暗号化キーの名前

応答

名前 型 説明
200 OK

TenantKey

OK

例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/tenantKeys
Request Body
{
  "name": "Contoso Sales",
  "keyVaultKeyIdentifier": "https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2",
  "activate": true,
  "isDefault": true
}

Sample Response

Status code:
200 
{
  "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"
}

定義

名前 説明
TenantKey

暗号化キーの情報
TenantKeyCreationRequest

暗号化キー要求を追加する

TenantKey

暗号化キーの情報

名前 型 説明
createdAt

string

暗号化キーの作成日時
id

string

暗号化キーの ID
isDefault

boolean

暗号化キーがテナント全体の既定のキーかどうか。 新しく作成された容量は、既定のキーを継承します。
keyVaultKeyIdentifier

string

Azure Key Vaultで暗号化キーを一意に指定する URI
name

string

暗号化キーの名前
updatedAt

string

暗号化キーの最終更新日時

TenantKeyCreationRequest

暗号化キー要求を追加する

名前 型 説明
activate

boolean

非アクティブ化された容量をアクティブ化し、その暗号化にこのキーを使用するかどうか
isDefault

boolean

暗号化キーがテナント全体の既定のキーかどうか。 新しく作成された容量は、既定のキーを継承します。
keyVaultKeyIdentifier

string

Azure Key Vaultで暗号化キーを一意に指定する URI
name

string

暗号化キーの名前