Set-OMEConfiguration

此 cmdlet 仅在基于云的服务中可用。

使用 Set-OMEConfiguration cmdlet 配置Microsoft Purview 邮件加密。

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

Default (默认值)

Set-OMEConfiguration
    [-Identity] <OMEConfigurationIdParameter>
    [-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>]

说明

您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果某些参数未包含在分配给你的权限中,则可能无法访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

示例

示例 1

Set-OMEConfiguration -Identity "OME Configuration" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image ([System.IO.File]::ReadAllBytes('C:\Temp\OME Logo.gif'))

此示例为名为“OME 配置”的默认 OME 配置配置指定值。

参数

-BackgroundColor

适用:Exchange Online、Exchange Online Protection

BackgroundColor 参数指定背景色。 有效值包含:

  • HTML 十六进制颜色代码值 (#RRGGBB) 用引号括起来。 例如, "#FFFFFF" 为白色。
  • 有效的颜色名称值。 例如, yellow 是 #ffff00。 有关有效颜色名称的列表,请参阅 背景色参考
  • $null (空白) 。 此值为默认值。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

适用:Exchange Online、Exchange Online Protection

Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

  • 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:-Confirm:$false
  • 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisclaimerText

适用:Exchange Online、Exchange Online Protection

DisclaimerText 参数指定包含加密邮件的电子邮件中的免责声明文本。 最大长度为 1024 个字符。 如果值中有空格,请使用双引号 (") 将此值括起来。

若要删除现有文本并使用默认值,请对此参数使用值 $null。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EmailText

适用:Exchange Online、Exchange Online Protection

EmailText 参数指定加密电子邮件附带的默认文本。 默认文本显示在说明的上方,以查看加密邮件。 最大长度为 1024 个字符。 如果值中有空格,请使用双引号 (") 将此值括起来。

若要删除现有文本并使用默认值,请对此参数使用值 $null。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ExternalMailExpiryInDays

适用:Exchange Online

此参数仅适用于 Microsoft 365 高级消息加密订阅。

ExternalMailExpiryInDays 参数指定加密邮件在 Microsoft 365 门户中对外部收件人可用的天数。 有效值是 0 到 730 的整数。 值 0 表示消息永不过期。 默认值为 0。

无法在默认 OME 配置中更新此参数的值。 只能在自定义配置中修改此值。

在 Get-OMEConfiguration cmdlet 的输出中,此参数的值显示在 ExternalMailExpiryInterval 属性中。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Int32
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Identity

适用:Exchange Online、Exchange Online Protection

Identity 参数指定您要修改的 OME 配置。 具有标识值“OME 配置”的默认 OME 配置。

参数属性

类型:OMEConfigurationIdParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Image

适用:Exchange Online、Exchange Online Protection

Image 参数标识并上传要显示在电子邮件和Microsoft 365 管理中心中的图像。

此参数的有效值要求使用以下语法将文件读取到字节编码对象: ([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))。 可以使用此命令作为参数值,也可以将输出写入变量 () $data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>') ,并将变量用作参数值 ($data) 。

  • 支持的文件格式:.png、.jpg、.bmp 或 .tiff
  • 徽标文件的最佳大小:小于 40 KB
  • 徽标图像的最佳尺寸:170x70 像素

若要删除现有图片并使用默认图像,可使用此参数的 $null 值。

参数属性

类型:

Byte[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IntroductionText

适用:Exchange Online、Exchange Online Protection

IntroductionText 参数指定发件人姓名和电子邮件地址旁边的文本。 如果值中有空格,请使用双引号 (") 将此值括起来。

若要删除现有文本并使用默认值,请对此参数使用值 $null。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-OTPEnabled

适用:Exchange Online、Exchange Online Protection

OTPEnabled 参数指定是否允许收件人使用一次性密码来查看加密邮件。 有效值包含:

  • $true:收件人可以使用一次性密码查看加密邮件。 此值为默认值。
  • $false:收件人不能使用一次性密码查看加密邮件。 收件人需要使用 Microsoft 365 工作或学校帐户登录。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PortalText

适用:Exchange Online、Exchange Online Protection

PortalText 参数指定将显示在加密邮件查看门户顶部的文本。 最大长度为 128 个字符。 如果值中有空格,请使用双引号 (") 将此值括起来。

若要删除现有文本并使用默认值,请对此参数使用值 $null。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PrivacyStatementUrl

适用:Exchange Online、Exchange Online Protection

PrivacyStatementUrl 参数指定加密电子邮件通知消息中的隐私声明链接。

如果不使用此参数,隐私声明链接将转到默认Microsoft隐私声明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ReadButtonText

适用:Exchange Online、Exchange Online Protection

ReadButtonText 参数指定在“阅读邮件”按钮上显示的文本。 如果值中有空格,请使用双引号 (") 将此值括起来。

若要删除现有文本并使用默认值,请对此参数使用值 $null。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SocialIdSignIn

适用:Exchange Online、Exchange Online Protection

SocialIdSignIn 参数指定是否允许用户使用自己的社交网络 ID (Google、Yahoo 和 Microsoft 帐户) 查看Microsoft 365 管理中心中的加密邮件。 有效值包含:

  • $true:允许社交网络 ID 登录。 此值为默认值。
  • $false:不允许登录社交网络 ID。 收件人是否可以使用一次性密码或其Microsoft 365 工作或学校帐户由 OTPEnabled 参数控制。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

适用:Exchange Online、Exchange Online Protection

保留此参数以供 Microsoft 内部使用。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

Input types

若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。