Edit

Share via

Set-PowerBICapacityEncryptionKey

Module:
MicrosoftPowerBIMgmt.Admin Module

Updates the encryption key for the Power BI capacity.

Syntax

KeyNameAndCapacityId (Default) 

Set-PowerBICapacityEncryptionKey
    -KeyName <String>
    -CapacityId <Guid>
    [<CommonParameters>]

KeyNameAndCapacity 

Set-PowerBICapacityEncryptionKey
    -KeyName <String>
    -Capacity <Capacity>
    [<CommonParameters>]

KeyAndCapacityId 

Set-PowerBICapacityEncryptionKey
    -Key <EncryptionKey>
    -CapacityId <Guid>
    [<CommonParameters>]

Description

Updates the encryption key associated with the Power BI capacity. Encryption key for the tenant must be exist before calling this cmdlet.

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:\> Set-PowerBICapacityEncryptionKey -CapacityId 08d57fce-9e79-49ac-afac-d61765f97f6f -KeyName 'Contoso Sales'

Parameters

-Capacity

The capacity entity to update.

Parameter properties

Type:Capacity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

KeyNameAndCapacity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-CapacityId

ID of the capacity to update.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

KeyNameAndCapacityId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
KeyAndCapacityId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Key

The encryption key entity to use.

Parameter properties

Type:EncryptionKey
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

KeyAndCapacityId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-KeyName

Name of the encryption key to use.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

KeyNameAndCapacityId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
KeyNameAndCapacity
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.

Inputs

Microsoft.PowerBI.Common.Api.Encryption.EncryptionKey

Microsoft.PowerBI.Common.Api.Capacities.Capacity

Outputs

System.Object