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

限制

每小时最多 600 个请求。

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

请求正文

名称	类型	说明
activate	boolean	是否激活任何未激活的容量并使用此密钥进行加密
isDefault	boolean	加密密钥是否是整个租户的默认密钥。 任何新创建的容量都继承默认密钥。
keyVaultKeyIdentifier	string	在 Azure 密钥保管库中唯一指定加密密钥的 URI
name	string	加密密钥的名称

响应

名称	类型	说明
200 OK	TenantKey	确定

示例

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 密钥保管库中的加密密钥的 URI
name	string	加密密钥的名称
updatedAt	string	加密密钥的上次更新日期和时间

TenantKeyCreationRequest

添加加密密钥请求

名称	类型	说明
activate	boolean	是否激活任何未激活的容量并使用此密钥进行加密
isDefault	boolean	加密密钥是否是整个租户的默认密钥。 任何新创建的容量都继承默认密钥。
keyVaultKeyIdentifier	string	在 Azure 密钥保管库中唯一指定加密密钥的 URI
name	string	加密密钥的名称