Commands › Power BI
Add-PowerBIEncryptionKey
Adds an encryption key for Power BI workspaces assigned to a capacity.
Quick start script
# Add-PowerBIEncryptionKey — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint $thumb -ApplicationId $appId -Tenant $tenantId
# 2. Run and inspect
Add-PowerBIEncryptionKey -KeyVaultKeyUri <String> -Name <String> | Format-List
# 3. Export for evidence / drift tracking
Add-PowerBIEncryptionKey | Export-Clixml .\PowerBIEncryptionKey-$(Get-Date -Format yyyyMMdd).xmlSyntax — 3 parameter sets
DefaultAndActivate (Default)
Add-PowerBIEncryptionKey -Name <String> -KeyVaultKeyUri <String> [-Default] [-Activate] [<CommonParameters>]Default
Add-PowerBIEncryptionKey -Name <String> -KeyVaultKeyUri <String> [-Default] [<CommonParameters>]Activate
Add-PowerBIEncryptionKey -Name <String> -KeyVaultKeyUri <String> [-Activate] [<CommonParameters>]Parameters (4)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Activate | SwitchParameter | Indicates to activate any inactivated capacities to use this key for its encryption | |
| -Default | SwitchParameter | Indicates that this key is set as default for the entire tenant. Any new capacity creation will inherit this key upon creation. | |
| -KeyVaultKeyUri | String | yes | Uri to the version of the "Azure Key Vault" key to be used. Only supports 4096 bytes key. |
| -Name | String | yes | The name of the encryption key. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed MIT; restructured with original guidance by serv365.ai.