Commands › SharePoint Online
Register-SPODataEncryptionPolicy
Cmdlet to register customer encryption status for your geo tenant. For more information, see Controlling your data in Office 365 using Customer Key
Quick start script
# Register-SPODataEncryptionPolicy — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com
# 2. Run and inspect
Register-SPODataEncryptionPolicy -PrimaryKeyName <String> -PrimaryKeyVaultName <String> -PrimaryKeyVaultUri <Uri> | Format-List
# 3. Export for evidence / drift tracking
Register-SPODataEncryptionPolicy | Export-Clixml .\SPODataEncryptionPolicy-$(Get-Date -Format yyyyMMdd).xmlSyntax — 2 parameter sets
BYOK_MultipleParameters (Default)
Register-SPODataEncryptionPolicy -PrimaryKeyVaultName <String> -PrimaryKeyName <String>
-PrimaryKeyVersion <Guid> -SecondaryKeyVaultName <String> -SecondaryKeyName <String>
-SecondaryKeyVersion <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]BYOK_Uri
Register-SPODataEncryptionPolicy -PrimaryKeyVaultUri <Uri> -SecondaryKeyVaultUri <Uri> [-WhatIf] [-Confirm]
[<CommonParameters>]Parameters (10)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -PrimaryKeyName | String | yes | The name of the primary key |
| -PrimaryKeyVaultName | String | yes | The name of the primary key vault |
| -PrimaryKeyVaultUri | Uri | yes | The Uri of the primary key vault |
| -PrimaryKeyVersion | Guid | yes | The version of the primary key |
| -SecondaryKeyName | String | yes | The name of the secondary key |
| -SecondaryKeyVaultName | String | yes | The name of the secondary key vault |
| -SecondaryKeyVaultUri | Uri | yes | The Uri of the secondary key vault |
| -SecondaryKeyVersion | Guid | yes | The version of the secondary key |
| -Confirm | SwitchParameter | Prompts you for confirmation before running the cmdlet. | |
| -WhatIf | SwitchParameter | The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.