Set-ExchangeSettings

模块:

ExchangePowerShell

适用于:

Exchange Server 2016, Exchange Server 2019

此 cmdlet 仅适用于本地 Exchange。

使用 Set-ExchangeSettings cmdlet 配置使用 New-ExchangeSettings cmdlet 创建的 Exchange 设置对象。

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

语法

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   [-ClearHistory]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -ConfigName <String>
   -ConfigValue <String>
   -Reason <String>
   [-UpdateSetting]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-GroupName <String>]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -ConfigName <String>
   -Reason <String>
   [-RemoveSetting]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-GroupName <String>]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -ExpirationDate <DateTime>
   -Reason <String>
   [-ConfigPairs <String[]>]
   [-Confirm]
   [-CreateSettingsGroup]
   [-Disable]
   [-DomainController <Fqdn>]
   [-Force]
   [-GroupName <String>]
   [-MaxVersion <String>]
   [-MinVersion <String>]
   [-NameMatch <String>]
   [-Priority <Int32>]
   [-Scope <ExchangeSettingsScope>]
   [-ScopeFilter <String>]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -ExpirationDate <DateTime>
   -GuidMatch <Guid>
   -Reason <String>
   [-ConfigPairs <String[]>]
   [-Confirm]
   [-CreateSettingsGroup]
   [-Disable]
   [-DomainController <Fqdn>]
   [-Force]
   [-GroupName <String>]
   [-Priority <Int32>]
   [-Scope <ExchangeSettingsScope>]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   -SettingsGroup <String>
   [-CreateSettingsGroup]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -ExpirationDate <DateTime>
   -Reason <String>
   [-CreateSettingsGroup]
   [-ConfigPairs <String[]>]
   [-GenericScopeName <String>]
   [-GenericScopeValue <String>]
   [-GroupName <String>]
   [-Confirm]
   [-Disable]
   [-DomainController <Fqdn>]
   [-Force]
   [-Priority <Int32>]
   [-Scope <ExchangeSettingsScope>]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   [-ExpirationDate <DateTime>]
   [-GroupName <String>]
   [-UpdateSettingsGroup]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-Priority <Int32>]
   [-ScopeFilter <String>]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   -ConfigPairs <String[]>
   [-GroupName <String>]
   [-RemoveSetting]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   [-GroupName <String>]
   [-RemoveSettingsGroup]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   -SettingsGroup <String>
   [-UpdateSettingsGroup]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   -ConfigPairs <String[]>
   [-GroupName <String>]
   [-UpdateSetting]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Set-ExchangeSettings
   [-Identity] <ExchangeSettingsIdParameter>
   -Reason <String>
   [-EnableGroup <String>]
   [-DisableGroup <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

说明

您必须先获得权限，然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。

示例

示例 1

Set-ExchangeSettings Audit -UpdateSetting -ConfigName AuditLogPumperEnabled -ConfigValue $true -Reason "Enable Unified Audit Logging"

此示例允许用户查看统一审核日志记录的结果。 此示例假定你已通过运行命令 New-ExchangeSettings --Name Audit 为审核配置架构创建了 Exchange 设置对象。

参数

-ClearHistory

ClearHistory 开关指定要清除 Exchange 设置对象的修改历史记录中的条目。 不必为此开关指定值。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-ConfigName

ConfigName 参数指定要在 Exchange 设置对象中添加、删除或更新的可用 Exchange 设置。 此参数的有效值由配置架构确定，该架构由 New-ExchangeSettings cmdlet 上的 Name 参数指定。

对于添加和更新操作，还需要使用 ConfigValue 参数指定设置的实际值。 不能将 ConfigName 参数与 ConfigPairs 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-ConfigPairs

ConfigName 参数指定要在 Exchange 设置对象中添加、删除或更新的可用 Exchange 设置。 此参数的有效值由配置架构确定，该架构由 New-ExchangeSettings cmdlet 上的 Name 参数指定。 值的语法为 <Key>=<Value>。 可以分隔用逗号分隔的多个值。

不能将 ConfigPairs 参数与 ConfigName 或 ConfigValue 参数一起使用。

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-ConfigValue

ConfigValue 参数指定使用 ConfigName 参数指定的 Exchange 设置的值。 值由 (数字、时间跨度、$true或$false等) 的设置类型确定。

不能将 ConfigValue 参数与 ConfigPairs 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Confirm

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

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-CreateSettingsGroup

CreateSettingsGroup 开关指定要创建 Exchange 设置组，这是一组相关的 Exchange 设置。 不必为此开关指定值。

根据设置组的配置方式，可以使用 GroupName 参数或 SettingsGroup 参数指定 Exchange 设置组的名称。 请谨慎选择，因为无法重命名现有设置组。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Disable

“禁用”开关指定禁用 Exchange 设置组。 不必为此开关指定值。

只能将此开关与 CreateSettingsGroup 开关一起使用。

若要使用此开关启用 Exchange 设置组，请使用此确切语法 -Disable:$false。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-DisableGroup

DisableGroup 参数指定要禁用的已启用 Exchange 设置组的名称。 如果值中有空格，请使用双引号 (") 将此值括起来。

可以在同一命令中同时使用 DisableGroup 和 EnableGroup 参数，以同时启用和禁用不同的 Exchange 设置组。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-DomainController

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如，dc01.contoso.com。

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-EnableGroup

EnableGroup 参数指定要启用的已禁用 Exchange 设置组的名称。 如果值中有空格，请使用双引号 (") 将此值括起来。

可以在同一命令中同时使用 DisableGroup 和 EnableGroup 参数，以同时启用和禁用不同的 Exchange 设置组。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-ExpirationDate

ExpirationDate 参数指定由指定的 Exchange 设置组定义的 Exchange 设置的结束日期/时间。

请使用短日期格式，该格式在运行命令的计算机上的“区域选项”设置中定义。 例如，如果将计算机配置为使用短日期格式 mm/dd/yyyy，请输入 09/01/2018 来指定 2018 年 9 月 1 日。 可以只输入日期，也可以输入当天的日期和时间。 如果输入当天的日期和时间，请将该值括在引号 (") 中，例如，"09/01/2018 5:00 PM"。

只能将 ExpirationDate 参数与 CreateSettingsGroup 或 UpdateSettings 组参数一起使用。

Type:	DateTime
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Force

强制开关隐藏警告或确认消息。 不必为此开关指定值。

您可以在以编程方式运行任务时使用此开关，因为此时并不适合提示用户提供管理输入。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-GenericScopeName

GenericScopeName 参数指定范围的名称。 可用值由 Exchange 设置对象的架构确定。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-GenericScopeValue

GenericScopeValue 参数指定由 GenericScopeName 参数指定的作用域的值。 可用值由 Exchange 设置对象的架构确定。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-GroupName

GroupName 参数指定组操作中的 Exchange 设置组的名称。 例如：

• 创建 Exchange 设置组并同时配置组范围和优先级。
• 修改现有 Exchange 设置组的 ExpirationDate、Priority 和 ScopeFilter 值。
• 删除现有 Exchange 设置组。
• 在现有 Exchange 设置组中添加、删除或更新 Exchange 设置对象。

如果值中有空格，请使用双引号 (") 将此值括起来。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-GuidMatch

GuidMatch 参数根据对象的 GUID 指定 Exchange 设置组的范围， (例如邮箱数据库的 GUID) 。 此参数可用于除林以外的所有作用域参数值。

仅当使用 CreateSettingsGroup 开关和 GroupName 参数创建 Exchange 设置组时，才使用 GuidMatch 参数。

不能将此参数与 GenericScopeName、GenericScopeValue、MaxVersion、MinVersion 或 NameMatch 参数一起使用。

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Identity

Identity 参数指定包含要配置的 Exchange 设置的现有 Exchange 设置对象的名称。

此参数的值是在创建 Exchange 设置对象时，New-ExchangeSetting cmdlet 上的 Name 参数的值。

Type:	ExchangeSettingsIdParameter
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-MaxVersion

MaxVersion 参数根据对象版本 (指定 Exchange 设置组的范围，例如，服务器上安装的 Exchange 版本) 。 此参数可用于除林以外的所有作用域参数值。

仅当使用带 GroupName 参数的 CreateSettingsGroup 开关创建 Exchange 设置组时，才使用 MaxVersion 参数和 MinVersion 参数。

不能将此参数与 GuidMatch、GenericScopeName 或 GenericScopeValue 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-MinVersion

MinVersion 参数根据对象版本 (指定 Exchange 设置组的范围，例如，服务器上安装的 Exchange 版本) 。 此参数可用于除林以外的所有作用域参数值。

仅当使用带 GroupName 参数的 CreateSettingsGroup 开关创建 Exchange 设置组时，才能将 MinVersion 参数与 MaxVersion 参数一起使用。

不能将此参数与 GuidMatch、GenericScopeName 或 GenericScopeValue 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-NameMatch

NameMatch 参数根据对象名称指定 Exchange 设置组的范围 (例如进程名称) 。 此参数可用于除林以外的所有作用域参数值。

仅当使用 CreateSettingsGroup 开关和 GroupName 参数创建 Exchange 设置组时，才使用 NameMatch 参数。

不能将此参数与 GuidMatch、GenericScopeName 或 GenericScopeValue 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Priority

Priority 参数指定 Exchange 设置组的优先级。 每个组的优先级值必须唯一。 优先级值越低表示优先级越高。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Reason

Reason 参数指定创建或修改 Exchange 设置组的原因的说明。 如果值中有空格，请使用双引号 (") 将此值括起来。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-RemoveSetting

RemoveSetting 开关指定从 Exchange 设置对象中删除现有 Exchange 设置。 不必为此开关指定值。

使用 ConfigPairs 参数或 ConfigName 参数指定要删除的设置。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-RemoveSettingsGroup

RemoveSettingsGroup 开关指定删除 Exchange 设置组。 不必为此开关指定值。

使用 GroupName 参数指定要删除的 Exchange 设置组。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-Scope

Scope 参数指定 Exchange 设置对象的作用域。 有效值包含:

• Dag
• Database
• 林
• Generic
• 组织
• 流程
• 服务器
• User

Type:	ExchangeSettingsScope
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-ScopeFilter

ScopeFilter 参数使用 OPATH 筛选器语法来指定基于的 Exchange 设置组的范围。 语法 ("Property -ComparisonOperator 'Value'" 例如， "ServerRole -like 'Mailbox*'") 。

• 将整个 OPATH 筛选器括在双引号“”中。 如果筛选器包含系统值 (，例如 $true、 $false或 $null) ，请改用单引号 ' 。 虽然此参数是一个字符串 (不是) 的系统块，但也可以使用大括号 { }，但前提是筛选器不包含变量。
• 属性是可筛选的属性。
• ComparisonOperator 是一个 OPATH 比较运算符， (例如 -eq 用于等于和 -like 字符串比较) 。 有关比较运算符的详细信息，请参阅 about_Comparison_Operators。
• Value 是要搜索的属性值。 将文本值和变量括在单引号 ('Value' 或 '$Variable') 。 如果变量值包含单引号，则需要识别 (转义) 单引号才能正确展开变量。 例如，使用 '$($User -Replace "'","''")'而不是 '$User'。 不要将整数或系统值括在引号 (例如，改用 500、 $true、 $false或 $null) 。

可以使用逻辑运算符 -and 和 -or将多个搜索条件链接在一起。 例如，"Criteria1 -and Criteria2" 或 "(Criteria1 -and Criteria2) -or Criteria3"。

有关 Exchange 中的 OPATH 筛选器的详细信息，请参阅 其他 OPATH 语法信息。

不能将此参数与 Scope 参数和值 Forest 或其他范围相关参数一起使用。

仅当使用 UpdateSettingsGroup 开关和 GroupName 参数更新 Exchange 设置组时，才使用此参数。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-SettingsGroup

SettingsGroup 参数指定用于创建新设置组或修改现有设置组的现有 Exchange 设置组。

不能将 SettingsGroup 参数与 GroupName 参数一起使用。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-UpdateSetting

UpdateSetting 开关指定在现有 Exchange 设置对象中更新 Exchange 设置。 不必为此开关指定值。

使用 ConfigPairs 参数或 ConfigName 和 ConfigValue 参数配置 Exchange 设置。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-UpdateSettingsGroup

UpdateSettingsGroup 开关指定修改 Exchange 设置组。 不必为此开关指定值。

根据设置组的配置方式，可以使用 GroupName 参数或 SettingsGroup 参数来指定要修改的 Exchange 设置组。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019

-WhatIf

WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019