Share via

Get-SPOSiteDataEncryptionPolicy

Module:
Microsoft.Online.SharePoint.PowerShell Module

Validates the encryption of a Group Site, Team Site, or OneDrive for Business site if a Customer Key has been registered for the site.

Syntax

Default (Default) 

Get-SPOSiteDataEncryptionPolicy
    [-Identity] <SpoSitePipeBind>
    [<CommonParameters>]

Description

When a Customer Key has been configured in the Azure tenant, it is possible to set and subsequently verify the encryption status of a SharePoint Online or OneDrive for Business site. This cmdlet verifies the encryption status of the particular site.

This cmdlet will return an error if the Azure tenant has not been configured with a Customer Key. See the Related Links section for more information on how to configure the Customer Key.

Examples

Example 1

Get-SPOSiteDataEncryptionPolicy https://contoso.sharepoint.com/sites/Research

Verifies the encryption of the site https://contoso.sharepoint.com/sites/Research.

Parameters

-Identity

Applicable: SharePoint Online

The URL of the Site Collection.

Parameter properties

Type:Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
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

Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind

Outputs

System.String

The URI of the primary key.

System.String

The URI of the secondary key.

System.Object

The encryption status for the geo. Possible states include:

  • Unregistered: Customer Key encryption has not yet been applied.
  • Registering: Customer Key encryption has been applied and your files are in the process of being encrypted. If your geo is in this state, you'll also be shown information on what percentage of sites in the geo are complete so that you can monitor encryption progress.
  • Registered: Customer Key encryption has been applied, and all files in all sites have been encrypted.
  • Rolling: A key roll is in progress. If your geo is in this state, you'll also be shown information on what percentage of sites have completed the key roll operation so that you can monitor progress.