Set-DataEncryptionPolicy
This cmdlet is available only in the cloud-based service.
Use the Set-DataEncryptionPolicy cmdlet to modify data encryption policies in Exchange Online.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
DCAdminPurgeKeyRequest
Set-DataEncryptionPolicy
[-Identity] <DataEncryptionPolicyIdParameter>
-PermanentDataPurgeReason <String>
[-PermanentDataPurgeContact <String>]
[-Confirm]
[-Description <String>]
[-DomainController <Fqdn>]
[-Enabled <Boolean>]
[-Force]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
TenantAdminPurgeKeyRequest
Set-DataEncryptionPolicy
[-Identity] <DataEncryptionPolicyIdParameter>
-PermanentDataPurgeContact <String>
-PermanentDataPurgeReason <String>
[-PermanentDataPurgeRequested]
[-Confirm]
[-Description <String>]
[-DomainController <Fqdn>]
[-Enabled <Boolean>]
[-Force]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
RefreshKey
Set-DataEncryptionPolicy
[-Identity] <DataEncryptionPolicyIdParameter>
[-Refresh]
[-Confirm]
[-Description <String>]
[-DomainController <Fqdn>]
[-Enabled <Boolean>]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
Description
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Set-DataEncryptionPolicy -Identity "US Mailboxes" -Enabled $false
This example disabled the data encryption policy named US Mailboxes.
Example 2
Set-DataEncryptionPolicy -Identity "Europe Mailboxes" -Refresh
This example updates the data encryption policy named Europe Mailboxes after one of the associated keys is rotated in the Azure Key Vault.
Parameters
-Confirm
Applicable: Exchange Online, Exchange Online Protection
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.
This cmdlet has a built-in pause, so use -Confirm:$false to skip the confirmation.
Parameter properties
| Type: | 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 |
-Description
Applicable: Exchange Online
The Description parameter specifies an optional description for the data encryption policy. If the value contains spaces, enclose the value in quotation marks.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainController
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Enabled
Applicable: Exchange Online, Exchange Online Protection
The Enabled parameter enables or disable the data encryption policy. Valid values are:
- $true: The policy is enabled.
- $false: The policy is disabled.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Exchange Online, Exchange Online Protection
The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
Use this switch to delete all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TenantAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
DCAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Online
The Identity parameter specifies the data encryption policy that you want to modify. You can use any value that uniquely identifies the policy. For example:
- Name
- Distinguished name (DN)
- GUID
Parameter properties
| Type: | DataEncryptionPolicyIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Applicable: Exchange Online
The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PermanentDataPurgeContact
Applicable: Exchange Online, Exchange Online Protection
The PermanentDataPurgeContact parameter specifies a contact for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks.
You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeReason parameters.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TenantAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
DCAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PermanentDataPurgeReason
Applicable: Exchange Online, Exchange Online Protection
The PermanentDataPurgeReason parameter specifies a descriptive reason for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks.
You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeContact parameters.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TenantAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
DCAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PermanentDataPurgeRequested
Applicable: Exchange Online, Exchange Online Protection
The PermanentDataPurgeRequested switch specifies whether to initiate the deletion of all data that's encrypted by the data encryption policy. You don't need to specify a value with this switch.
You need to use this switch with the PermanentDataPurgeReason and PermanentDataPurgeContact parameters.
After you use this switch, you can't assign the data encryption policy to other mailboxes.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TenantAdminPurgeKeyRequest
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Refresh
Applicable: Exchange Online
Use the Refresh switch to update the data encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RefreshKey
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Exchange Online, Exchange Online Protection
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: | 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.