Admin - Add Power BI Encryption Key

Service:

Power BI REST APIs

API Version:

v1.0

Fügt einen Verschlüsselungsschlüssel für Power BI-Arbeitsbereiche hinzu, die einer Kapazität zugewiesen sind.

Berechtigungen

Der Benutzer muss über Administratorrechte verfügen (z. B. Office 365 globaler Administrator oder Power BI-Dienstadministrator).

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

Einschränkungen

Maximal 600 Anforderungen pro Stunde.

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

Anforderungstext

Name	Typ	Beschreibung
activate	boolean	Gibt an, ob sie alle inaktivierten Kapazitäten aktivieren und diesen Schlüssel für seine Verschlüsselung verwenden möchten.
isDefault	boolean	Gibt an, ob ein Verschlüsselungsschlüssel der Standardschlüssel für den gesamten Mandanten ist. Jede neu erstellte Kapazität erbt den Standardschlüssel.
keyVaultKeyIdentifier	string	Der URI, der einen Verschlüsselungsschlüssel in Azure Key Vault eindeutig angibt
name	string	Der Name des Verschlüsselungsschlüssels

Antworten

Name	Typ	Beschreibung
200 OK	TenantKey	OK

Beispiele

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

Definitionen

Name	Beschreibung
TenantKey	Verschlüsselungsschlüsselinformationen
TenantKeyCreationRequest	Hinzufügen einer Verschlüsselungsschlüsselanforderung

TenantKey

Verschlüsselungsschlüsselinformationen

Name	Typ	Beschreibung
createdAt	string	Das Erstellungsdatum und die Uhrzeit des Verschlüsselungsschlüssels
id	string	Die ID des Verschlüsselungsschlüssels
isDefault	boolean	Gibt an, ob der Verschlüsselungsschlüssel der Standardschlüssel für den gesamten Mandanten ist. Jede neu erstellte Kapazität erbt den Standardschlüssel.
keyVaultKeyIdentifier	string	Der URI, der den Verschlüsselungsschlüssel in Azure Key Vault eindeutig angibt
name	string	Der Name des Verschlüsselungsschlüssels
updatedAt	string	Datum und Uhrzeit der letzten Aktualisierung des Verschlüsselungsschlüssels

TenantKeyCreationRequest

Hinzufügen einer Verschlüsselungsschlüsselanforderung

Name	Typ	Beschreibung
activate	boolean	Gibt an, ob sie alle inaktivierten Kapazitäten aktivieren und diesen Schlüssel für seine Verschlüsselung verwenden möchten.
isDefault	boolean	Gibt an, ob ein Verschlüsselungsschlüssel der Standardschlüssel für den gesamten Mandanten ist. Jede neu erstellte Kapazität erbt den Standardschlüssel.
keyVaultKeyIdentifier	string	Der URI, der einen Verschlüsselungsschlüssel in Azure Key Vault eindeutig angibt
name	string	Der Name des Verschlüsselungsschlüssels