Admin - Add Power BI Encryption Key

服務:

Power BI REST APIs

API 版本:

v1.0

為指派給容量的Power BI工作區新增加密金鑰。

權限

用戶必須是網狀架構系統管理員。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

局限性

每小時最多 600 個要求。

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

要求本文

名稱	類型	Description
activate	boolean	是否要啟用任何停用的容量，以及使用此金鑰進行加密
isDefault	boolean	加密金鑰是否為整個租用戶的預設金鑰。 任何新建立的容量都會繼承預設密鑰。
keyVaultKeyIdentifier	string	唯一指定 Azure Key Vault 中加密金鑰的 URI
name	string	加密金鑰的名稱

回應

名稱	類型	Description
200 OK	TenantKey	還行

範例

Example

範例要求

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

要求本文

{
  "name": "Contoso Sales",
  "keyVaultKeyIdentifier": "https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2",
  "activate": true,
  "isDefault": true
}

範例回覆

狀態碼:

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"
}

定義

名稱	Description
TenantKey	加密金鑰資訊
TenantKeyCreationRequest	新增加密金鑰要求

TenantKey

加密金鑰資訊

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

TenantKeyCreationRequest

新增加密金鑰要求

名稱	類型	Description
activate	boolean	是否要啟用任何停用的容量，以及使用此金鑰進行加密
isDefault	boolean	加密金鑰是否為整個租用戶的預設金鑰。 任何新建立的容量都會繼承預設密鑰。
keyVaultKeyIdentifier	string	唯一指定 Azure Key Vault 中加密金鑰的 URI
name	string	加密金鑰的名稱