Skip to content

Set-DataEncryptionPolicy.md

Latest commit

 

History

History
330 lines (241 loc) · 9.25 KB

Set-DataEncryptionPolicy.md

File metadata and controls

330 lines (241 loc) · 9.25 KB
applicable Exchange Online, Built-in security add-on for on-premises mailboxes
external help file Microsoft.Exchange.WebClient-Help.xml
Locale en-US
Module Name ExchangePowerShell
online version https://learn.microsoft.com/powershell/module/exchangepowershell/set-dataencryptionpolicy
schema 2.0.0
title Set-DataEncryptionPolicy

Set-DataEncryptionPolicy

SYNOPSIS

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

-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
Type: DataEncryptionPolicyIdParameter
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True
Accept wildcard characters: False

-PermanentDataPurgeContact

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

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.

Type: String
Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PermanentDataPurgeReason

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

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.

Type: String
Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PermanentDataPurgeRequested

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

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.

Type: SwitchParameter
Parameter Sets: TenantAdminPurgeKeyRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Parameter Sets: RefreshKey
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DomainController

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

This parameter is reserved for internal Microsoft use.

Type: Fqdn
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Enabled

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

The Enabled parameter enables or disable the data encryption policy. Valid values are:

  • $true: The policy is enabled.
  • $false: The policy is disabled.
Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

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.

Type: SwitchParameter
Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes

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

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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS