Remove-OMEConfiguration

This cmdlet is available only in the cloud-based service.

Use the Remove-OMEConfiguration cmdlet to remove custom Microsoft Purview Message Encryption configurations. You can't use this cmdlet to remove the default OME configuration.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Remove-OMEConfiguration
      [-Identity] <OMEConfigurationIdParameter>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not 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

Remove-OMEConfiguration -Identity "Contoso Marketing"

This example removes the custom OME configuration named Contoso Marketing.

Parameters

-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
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Identity

The Identity parameter specifies the custom OME configuration that you want to remove. You can use the Get-OMEConfiguration cmdlet to see the available values. If the value contains spaces, enclose the value in quotation marks

Type:OMEConfigurationIdParameter
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

-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
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online