Add-PowerBIEncryptionKey

Reference

Module:: MicrosoftPowerBIMgmt.Admin

Adds an encryption key for Power BI workspaces assigned to a capacity.

Syntax

Add-PowerBIEncryptionKey
   -Name <String>
   -KeyVaultKeyUri <String>
   [-Default]
   [-Activate]
   [<CommonParameters>]

Add-PowerBIEncryptionKey
   -Name <String>
   -KeyVaultKeyUri <String>
   [-Default]
   [<CommonParameters>]

Add-PowerBIEncryptionKey
   -Name <String>
   -KeyVaultKeyUri <String>
   [-Activate]
   [<CommonParameters>]

Description

Associates an encryption key for Power BI workspaces that is assigned to a premium capacity. Make sure to grant wrap and unwrap key permissions for Power BI service in the Azure Key Vault.

Before you run this command, make sure you log in using Connect-PowerBIServiceAccount. This cmdlet requires the calling user to be a tenant administrator of the Power BI service.

Examples

Example 1

PS C:\> Add-PowerBIEncryptionKey -Name 'Contoso Sales' -KeyVaultKeyUri 'https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2'

Parameters

-Activate

Indicates to activate any inactivated capacities to use this key for its encryption

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Default

Indicates that this key is set as default for the entire tenant. Any new capacity creation will inherit this key upon creation.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultKeyUri

Uri to the version of the "Azure Key Vault" key to be used. Only supports 4096 bytes key.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the encryption key.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

Microsoft.PowerBI.Common.Api.Encryption.EncryptionKey