Skip to content

Latest commit

 

History

History
178 lines (138 loc) · 4.79 KB

Register-SPODataEncryptionPolicy.md

File metadata and controls

178 lines (138 loc) · 4.79 KB
external help file Module Name online version applicable title schema author ms.author ms.reviewer
sharepointonline.xml
Microsoft.Online.SharePoint.PowerShell
SharePoint Online
Register-SPODataEncryptionPolicy
2.0.0
techwriter40
pamgreen

Register-SPODataEncryptionPolicy

SYNOPSIS

Cmdlet to register customer encryption status for your geo tenant. For more information, see Controlling your data in Office 365 using Customer Key

SYNTAX

Register-SPODataEncryptionPolicy -PrimaryKeyVaultName <string> -PrimaryKeyName <string> -PrimaryKeyVersion <guid> -SecondaryKeyVaultName <string>  -SecondaryKeyName <string> -SecondaryKeyVersion <guid> [-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

-PrimaryKeyVaultName

The name of the primary key vault

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrimaryKeyName

The name of the primary key

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrimaryKeyVersion

The version of the primary key

Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecondaryKeyVaultName

The name of the secondary key vault

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecondaryKeyName

The name of the secondary key

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecondaryKeyVersion

The version of the secondary key

Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

NOTES