Edit

Share via


Get-PowerBIWorkspaceEncryptionStatus

List Power BI workspace encryption status.

Syntax

Name (Default)

Get-PowerBIWorkspaceEncryptionStatus
    -Name <String>
    [<CommonParameters>]

Id

Get-PowerBIWorkspaceEncryptionStatus
    -Id <Guid>
    [<CommonParameters>]

Workspace

Get-PowerBIWorkspaceEncryptionStatus
    -Workspace <Workspace>
    [<CommonParameters>]

Description

Retrieves the encryption status of datasets for a given workspace. Operates against all workspaces within a tenant (Organization scope) that is encrypted by customer owned key.

The encryption status enumeration represents the following situation:

  • Unknown - Unable to determine state due to dataset corruption.
  • NotSupported - Encryption is not supported for this dataset.
  • InSyncWithWorkspace - Encryption is supported and is in sync with the encryption settings.
  • NotInSyncWithWorkspace - Encryption is supported and not in sync with the encryption settings.

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:\> Get-PowerBIWorkspaceEncryptionStatus -Id '101be2ef-c88a-4291-9322-7e9b89ab665f'

Example 2

PS C:\> Get-PowerBIWorkspaceEncryptionStatus -Name 'Contoso Sales'

Example 3

PS C:\> Get-PowerBIWorkspaceEncryptionStatus -Workspace ( Get-PowerBIWorkspace -Scope Organization -Name "Contoso Sales")

Example 4

PS C:\> Get-PowerBIWorkspace -Scope Organization | Get-PowerBIWorkspaceEncryptionStatus

Parameters

-Id

ID of the workspace to return datasets.

Parameter properties

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

Parameter sets

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

-Name

Name of the workspace to return datasets.

Parameter properties

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

Parameter sets

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

-Workspace

Workspace from which datasets need to be returned.

Parameter properties

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

Parameter sets

Workspace
Position:Named
Mandatory:True
Value from pipeline:True
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

None

Outputs

Microsoft.PowerBI.Common.Api.Encryption.Dataset