Commands › Exchange Online

New-OMEConfiguration

Exchange Online ExchangeOnlineManagement New-*

Create a Microsoft Purview Message Encryption configuration.

Quick start script

# New-OMEConfiguration — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-OMEConfiguration
$before | Format-List

# 3. Make the change (dry run first)
New-OMEConfiguration -Identity <OrganizationIdParameter> -WhatIf
New-OMEConfiguration -Identity <OrganizationIdParameter>

# 4. Verify and diff
$after = Get-OMEConfiguration
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

New-OMEConfiguration [-Identity] <OrganizationIdParameter>
 [-BackgroundColor <String>]
 [-Confirm]
 [-DisclaimerText <String>]
 [-EmailText <String>]
 [-ExternalMailExpiryInDays <Int32>]
 [-Image <Byte[]>]
 [-IntroductionText <String>]
 [-OTPEnabled <Boolean>]
 [-PortalText <String>]
 [-PrivacyStatementUrl <String>]
 [-ReadButtonText <String>]
 [-SocialIdSignIn <Boolean>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (14)

Parameter	Type	Required	What it controls
-Identity	OrganizationIdParameter	yes	The Identity parameter specifies a unique name for the OME configuration object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
-BackgroundColor	String		The BackgroundColor parameter specifies the background color. Valid values are:
-Confirm	SwitchParameter		This parameter is reserved for internal Microsoft use.
-DisclaimerText	String		The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks (").
-EmailText	String		The EmailText parameter specifies the default text that accompanies encrypted email messages. The default text appears above the instructions for viewing encrypted messages. The maximum length is 1024 characters. If...
-ExternalMailExpiryInDays	String		This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription.
-Image	Byte[]		The Image parameter identifies and uploads an image that's displayed in the email message and in the Microsoft 365 admin center.
-IntroductionText	String		The IntroductionText parameter specifies the default text that accompanies encrypted email messages. The default text appears below the recipient email address for viewing the encrypted message. If the value contains...
-OTPEnabled	Boolean		The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are:
-PortalText	String		The PortalText parameter specifies the text that appears at the top of the encrypted email viewing portal. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks (").
-PrivacyStatementUrl	String		{{ Fill PrivacyStatementUrl Description }}
-ReadButtonText	String		The ReadButtonText parameter specifies the text that appears on the "Read Message" button. If the value contains spaces, enclose the value in quotation marks (").
-SocialIdSignIn	Boolean		The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, etc). Valid values are:
-WhatIf	SwitchParameter		This parameter is reserved for internal Microsoft use.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.