Share via


Admin - Add Power BI Encryption Key

Ajoute une clé de chiffrement pour les espaces de travail Power BI affectés à une capacité.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (par exemple, Office 365 administrateur général ou administrateur de service Power BI).

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Limites

600 requêtes maximales par heure.

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

Corps de la demande

Nom Type Description
activate

boolean

Indique s’il faut activer des capacités inactivées et utiliser cette clé pour son chiffrement

isDefault

boolean

Indique si une clé de chiffrement est la clé par défaut pour l’ensemble du locataire. Toute capacité nouvellement créée hérite de la clé par défaut.

keyVaultKeyIdentifier

string

URI qui spécifie de manière unique une clé de chiffrement dans Azure Key Vault

name

string

Nom de la clé de chiffrement

Réponses

Nom Type Description
200 OK

TenantKey

Ok

Exemples

Example

Sample Request

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
}

Sample Response

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

Définitions

Nom Description
TenantKey

Informations sur la clé de chiffrement

TenantKeyCreationRequest

Ajouter une demande de clé de chiffrement

TenantKey

Informations sur la clé de chiffrement

Nom Type Description
createdAt

string

Date et heure de création de la clé de chiffrement

id

string

ID de la clé de chiffrement

isDefault

boolean

Indique si la clé de chiffrement est la clé par défaut pour l’ensemble du locataire. Toute capacité nouvellement créée hérite de la clé par défaut.

keyVaultKeyIdentifier

string

URI qui spécifie de manière unique la clé de chiffrement dans Azure Key Vault

name

string

Nom de la clé de chiffrement

updatedAt

string

Date et heure de la dernière mise à jour de la clé de chiffrement

TenantKeyCreationRequest

Ajouter une demande de clé de chiffrement

Nom Type Description
activate

boolean

Indique s’il faut activer des capacités inactivées et utiliser cette clé pour son chiffrement

isDefault

boolean

Indique si une clé de chiffrement est la clé par défaut pour l’ensemble du locataire. Toute capacité nouvellement créée hérite de la clé par défaut.

keyVaultKeyIdentifier

string

URI qui spécifie de manière unique une clé de chiffrement dans Azure Key Vault

name

string

Nom de la clé de chiffrement