Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Add-PowerBIEncryptionKey
Adds an encryption key for Power BI workspaces assigned to a capacity.
Syntax
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>]
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
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Default
Indicates that this key is set as default for the entire tenant. Any new capacity creation will inherit this key upon creation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Name
The name of the encryption key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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.
Inputs
None
Outputs
Microsoft.PowerBI.Common.Api.Encryption.EncryptionKey
Feedback
Was this page helpful?