Switch-PowerBIEncryptionKey
Switch the encryption key for Power BI workspaces assigned to a capacity.
Syntax
Default (Default)
Switch-PowerBIEncryptionKey
-Name <String>
-KeyVaultKeyUri <String>
[<CommonParameters>]
Description
Rotate the customer owned key for the tenant. Make sure the current encryption key and new version of key is valid. 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:\> Switch-PowerBIEncryptionKey -Name 'Contoso Sales' -KeyVaultKeyUri 'https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2'
Parameters
-KeyVaultKeyUri
Uri to the version of the "Azure Key Vault" key to be used. Only supports 4096 bytes key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the encryption key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.