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
Syntax
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>]
Description
Use the Register-DataEncryptionPolicy cmdlet to register customer encryption status for your geo tenant. For more information, see Controlling your data in Office 365 using Customer Key
Examples
Example 1
Register-SPODataEncryptionPolicy -PrimaryKeyVaultName 'PKVaultName1' -PrimaryKeyName 'PrimaryKey1' -PrimaryKeyVersion 'f635a23bd4a44b9996ff6aadd88d42ba' -SecondaryKeyVaultName 'SKVaultName1' -SecondaryKeyName 'SecondaryKey2' -SecondaryKeyVersion '2b3e8f1d754f438dacdec1f0945f251a'
This example registers the DEP used with SharePoint Online and OneDrive for Business to start using the given primary key.
Parameters
-Confirm
Applicable: SharePoint Online
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrimaryKeyName
Applicable: SharePoint Online
The name of the primary key
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_MultipleParameters
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrimaryKeyVaultName
Applicable: SharePoint Online
The name of the primary key vault
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_MultipleParameters
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrimaryKeyVaultUri
Applicable: SharePoint Online
The Uri of the primary key vault
Parameter properties
| Type: | System.Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_Uri
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrimaryKeyVersion
Applicable: SharePoint Online
The version of the primary key
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_MultipleParameters
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecondaryKeyName
Applicable: SharePoint Online
The name of the secondary key
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_MultipleParameters
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecondaryKeyVaultName
Applicable: SharePoint Online
The name of the secondary key vault
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_MultipleParameters
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecondaryKeyVaultUri
Applicable: SharePoint Online
The Uri of the secondary key vault
Parameter properties
| Type: | System.Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_Uri
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecondaryKeyVersion
Applicable: SharePoint Online
The version of the secondary key
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BYOK_MultipleParameters
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Online
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.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| 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.