Edit

Share via

Update-SPODataEncryptionPolicy

Module:
Microsoft.Online.SharePoint.PowerShell Module

Updates customer encryption status for a geo tenant.

Syntax

BYOK_MultipleParameters (Default) 

Update-SPODataEncryptionPolicy
    -KeyVaultName <String>
    -KeyName <String>
    -KeyVersion <Guid>
    -KeyType <CustomerKeyVaultKeyType>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BYOK_Uri 

Update-SPODataEncryptionPolicy
    -KeyVaultUri <Uri>
    -KeyType <CustomerKeyVaultKeyType>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use the Update-SPODataEncryptionPolicy cmdlet to update customer encryption status for your geo tenant. For more information, see Controlling your data in Office 365 using Customer Key

Examples

Example 1

Update-SPODataEncryptionPolicy -KeyVaultName <ReplacementKeyVaultName> -KeyName <ReplacementKeyName> -KeyVersion <ReplacementKeyVersion> -KeyType Primary

This example updates the DEP used with SharePoint Online and OneDrive for Business to start using the new key

Parameters

-Confirm

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

-KeyName

The name of the 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

-KeyType

The type of the key, possible values are

  • Primary
  • Secondary

Parameter properties

Type:Microsoft.SharePoint.Client.CustomerKeyVaultKeyType
Default value:None
Accepted values:Primary, Secondary, Availability
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-KeyVaultName

The name of the Azure Key Vault Name

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

-KeyVaultUri

{{ Fill KeyVaultUri Description }}

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

-KeyVersion

The version of the 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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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.

Inputs

None

Outputs

System.Object