Admin - Add Power BI Encryption Key

Referência

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Adiciona uma chave de criptografia para workspaces do Power BI atribuídos a uma capacidade.

Permissões

O usuário deve ser um administrador do Fabric.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

Máximo de 600 solicitações por hora.

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

Corpo da solicitação

Nome	Tipo	Description
activate	boolean	Se você deve ativar as capacidades inativas e usar essa chave para sua criptografia
isDefault	boolean	Se uma chave de criptografia é a chave padrão para todo o locatário. Qualquer capacidade recém-criada herda a chave padrão.
keyVaultKeyIdentifier	string	O URI que especifica exclusivamente uma chave de criptografia no Azure Key Vault
name	string	O nome da chave de criptografia

Respostas

Nome	Tipo	Description
200 OK	TenantKey	OKEY

Exemplos

Example

Solicitação de exemplo

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

Corpo da solicitação

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
TenantKey	Informações de chave de criptografia
TenantKeyCreationRequest	Adicionar solicitação de chave de criptografia

TenantKey

Informações de chave de criptografia

Nome	Tipo	Description
createdAt	string	A data e a hora de criação da chave de criptografia
id	string	A ID da chave de criptografia
isDefault	boolean	Se a chave de criptografia é a chave padrão para todo o locatário. Qualquer capacidade recém-criada herda a chave padrão.
keyVaultKeyIdentifier	string	O URI que especifica exclusivamente a chave de criptografia no Azure Key Vault
name	string	O nome da chave de criptografia
updatedAt	string	A data e a hora da última atualização da chave de criptografia

TenantKeyCreationRequest

Adicionar solicitação de chave de criptografia

Nome	Tipo	Description
activate	boolean	Se você deve ativar as capacidades inativas e usar essa chave para sua criptografia
isDefault	boolean	Se uma chave de criptografia é a chave padrão para todo o locatário. Qualquer capacidade recém-criada herda a chave padrão.
keyVaultKeyIdentifier	string	O URI que especifica exclusivamente uma chave de criptografia no Azure Key Vault
name	string	O nome da chave de criptografia

Partilhar via