New-ClientAccessRule

注意

2025 年 9 月,所有 Exchange Online 组织都弃用客户端访问规则。 有关详细信息,请参阅 Exchange Online 中客户端访问规则弃用的更新

此 cmdlet 仅在 Exchange Server 2019 或更高版本中有效。

使用 New-ClientAccessRule cmdlet 可以创建客户端访问规则。 客户端访问规则可帮助你根据连接的属性控制对组织的访问。

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

语法

Default (默认值)

New-ClientAccessRule
    [-Name] <String>
    -Action <ClientAccessRulesAction>
    [-AnyOfAuthenticationTypes <MultiValuedProperty>]
    [-AnyOfClientIPAddressesOrRanges <MultiValuedProperty>]
    [-AnyOfProtocols <MultiValuedProperty>]
    [-AnyOfSourceTcpPortNumbers <MultiValuedProperty>]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-Enabled <Boolean>]
    [-ExceptAnyOfAuthenticationTypes <MultiValuedProperty>]
    [-ExceptAnyOfClientIPAddressesOrRanges <MultiValuedProperty>]
    [-ExceptAnyOfProtocols <MultiValuedProperty>]
    [-ExceptAnyOfSourceTcpPortNumbers <MultiValuedProperty>]
    [-ExceptUserIsMemberOf <MultiValuedProperty>]
    [-ExceptUsernameMatchesAnyOfPatterns <MultiValuedProperty>]
    [-Priority <Int32>]
    [-Scope <ClientAccessRulesScope>]
    [-UserIsMemberOf <MultiValuedProperty>]
    [-UsernameMatchesAnyOfPatterns <MultiValuedProperty>]
    [-UserRecipientFilter <String>]
    [-WhatIf]
    [<CommonParameters>]

说明

客户端访问规则类似于邮件流规则 (也称为传输规则,) 用于客户端连接到组织。 您可以使用条件和例外来根据连接的属性以及允许或阻止连接的操作来标识连接。

注意:并非所有协议都支持身份验证类型筛选器,甚至支持身份验证类型筛选器的协议也不支持所有身份验证类型。 下面的列表介绍了支持的组合。 在同一规则中混合使用协议和身份验证类型时要小心。

支持身份验证类型筛选器的协议:

  • ExchangeActiveSync:BasicAuthentication、OAuthAuthentication 和 CertificateBasedAuthentication。
  • ExchangeAdminCenter:BasicAuthentication 和 AdfsAuthentication。
  • IMAP4:BasicAuthentication 和 OAuthAuthentication。
  • OutlookWebApp:BasicAuthentication 和 AdfsAuthentication。
  • POP3:BasicAuthentication 和 OAuthAuthentication。
  • RemotePowerShell:BasicAuthentication 和 NonBasicAuthentication。

不支持身份验证类型筛选器的协议:

  • ExchangeWebServices
  • OfflineAddressBook
  • OutlookAnywhere
  • PowerShellWebServices
  • REST
  • UniversalOutlook

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

示例

示例 1

New-ClientAccessRule -Name AllowRemotePS -Action Allow -AnyOfProtocols RemotePowerShell -Priority 1

此示例创建允许访问远程 PowerShell 的最高优先级规则。 此规则是保留对组织的访问权限的重要保障措施。 如果没有此规则,如果创建的规则阻止访问远程 PowerShell 或阻止所有人的所有协议,则无法自行修复规则, (需要致电 Microsoft 客户服务和支持) 。

示例 2

New-ClientAccessRule -Name "Block ActiveSync" -Action DenyAccess -AnyOfProtocols ExchangeActiveSync -ExceptAnyOfClientIPAddressesOrRanges 192.168.10.1/24

此示例创建名为 Block ActiveSync 的新客户端访问规则,该规则阻止 Exchange ActiveSync 客户端的访问,IP 地址范围为 192.168.10.1/24 中的客户端除外。

参数

-Action

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Action 参数指定客户端访问规则的操作。 此参数的有效值是 AllowAccess 和 DenyAccess。

参数属性

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

参数集

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

-AnyOfAuthenticationTypes

适用:Exchange Server 2013、Exchange Server 2016

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

参数属性

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

参数集

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

-AnyOfClientIPAddressesOrRanges

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

AnyOfClientIPAddressesOrRanges 参数为基于客户端的 IPv4 或 IPv6 地址的客户端访问规则指定条件。 有效值包含:

  • 单个 IP 地址:例如 192.168.1.1 或 2001:DB8::2AA:FF:C0A8:640A。
  • IP 地址范围:例如 192.168.0.1-192.168.0.254 或 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414。
  • 无类 Inter-Domain 路由 (CIDR) IP 地址范围:例如,192.168.3.1/24 或 2001:DB8::2AA:FF:C0A8:640A/64。

Update

有关 IPv6 地址和语法的详细信息,请参阅此 Exchange 2013 文章: IPv6 地址基础知识

参数属性

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

参数集

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

-AnyOfProtocols

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

AnyOfProtocols 参数指定基于客户端的协议的客户端访问规则的条件。

PasswordQuality 参数指定设备密码所需的最小密码质量分级。密码质量是指示密码安全性和复杂性的数值。质量值越高表示密码越安全。

  • ExchangeActiveSync
  • ExchangeAdminCenter
  • ExchangeWebServices
  • IMAP4
  • OfflineAddressBook
  • OutlookAnywhere
  • OutlookWebApp
  • POP3
  • PowerShellWebServices
  • RemotePowerShell
  • REST
  • UniversalOutlook (邮件和 Calendar 应用)

注意:在 Exchange 2019 中,唯一受支持的值是 ExchangeAdminCenter 和 RemotePowerShell。

Update 不要使用引号。

参数属性

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

参数集

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

-AnyOfSourceTcpPortNumbers

适用:Exchange Server 2013

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

参数属性

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

参数集

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

-Confirm

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

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

此 cmdlet 具有内置的暂停,因此请跳 -Confirm:$false 过确认。

参数属性

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

参数集

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

-DomainController

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

参数属性

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

参数集

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

-Enabled

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Enabled 参数指定客户端访问规则为启用还是禁用状态。 此参数的有效值为 $true 或 $false。 默认值为 $true。

参数属性

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

参数集

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

-ExceptAnyOfAuthenticationTypes

适用:Exchange Server 2013、Exchange Server 2016

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

参数属性

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

参数集

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

-ExceptAnyOfClientIPAddressesOrRanges

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExceptAnyOfClientIPAddressesOrRanges 参数指定基于客户端的 IPv4 或 IPv6 地址的客户端访问规则的例外。 有效值包含:

  • 单个 IP 地址:例如 192.168.1.1 或 2001:DB8::2AA:FF:C0A8:640A。
  • IP 地址范围:例如 192.168.0.1-192.168.0.254 或 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414。
  • 无类 Inter-Domain 路由 (CIDR) IP 地址范围:例如,192.168.3.1/24 或 2001:DB8::2AA:FF:C0A8:640A/64。

Update

有关 IPv6 地址和语法的详细信息,请参阅此 Exchange 2013 文章: IPv6 地址基础知识

参数属性

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

参数集

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

-ExceptAnyOfProtocols

适用:Exchange Server 2013、Exchange Server 2016

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

参数属性

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

参数集

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

-ExceptAnyOfSourceTcpPortNumbers

适用:Exchange Server 2013

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

参数属性

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

参数集

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

-ExceptUserIsMemberOf

适用:Exchange Server 2013

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

参数属性

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

参数集

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

-ExceptUsernameMatchesAnyOfPatterns

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExceptUsernameMatchesAnyOfPatterns 参数指定基于格式为) 的用户帐户名称 <Domain>\<UserName> (contoso.com\jeff 客户端访问规则的例外。 例如, *jeff*此参数接受文本和通配符 (*) (,但不 jeff* 接受) 。 非字母数字字符不需要转义字符。

Update

参数属性

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

参数集

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

-Name

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Name 参数指定客户端访问规则的唯一名称。

参数属性

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

参数集

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

-Priority

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

优先级参数指定确定规则处理顺序的规则的优先级值。 整数值越小,优先级越高。值 0 表示最高优先级,规则的优先级值不得相同。

此参数的有效值和默认值取决于现有规则的数量。 例如,如果现有 8 条规则:

  • 此参数的有效值和默认值取决于现有规则的数量。例如,如果现有 8 个规则:
  • 现有 8 个规则的有效优先级值为 0、1、2、3、4、5、6、7。
  • 新规则(第 9 个规则)的有效优先级值范围是 0 至 8。

如果修改某条规则的优先级值,则此规则在列表中的位置也会发生变化,以匹配指定的优先级值。 也就是说,如果将某条规则的优先级值设置为与现有规则相同的值,那么该现有规则及其后所有其他优先级更低的规则的优先级值都将增加 1。

参数属性

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

参数集

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

-Scope

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Scope 参数指定客户端访问规则的范围。 有效值包含:

  • 用户:该规则仅适用于最终用户连接。
  • 全部:该规则适用于最终用户和中间层应用 () 的所有连接。

参数属性

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

参数集

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

-UserIsMemberOf

适用:Exchange Server 2013

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

参数属性

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

参数集

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

-UsernameMatchesAnyOfPatterns

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

UsernameMatchesAnyOfPatterns 参数指定客户端访问规则的条件,该条件基于格式为 (contoso.com\jeff 例如) 的用户帐户名称<Domain>\<UserName>。 例如, *jeff*此参数接受文本和通配符 (*) (,但不 jeff* 接受) 。 非字母数字字符不需要转义字符。 此参数不适用于 -AnyOfProtocols UniversalOutlook 参数。

Update

参数属性

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

参数集

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

-UserRecipientFilter

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

UserRecipientFilter 参数指定客户端访问规则的条件,该规则使用 OPATH 筛选语法根据有限的收件人属性集识别用户。 客户端访问规则不支持可用收件人属性的完整列表。

可以将以下属性与此参数一起使用:

  • 城市
  • Company
  • CountryOrRegion (ISO 3166-1 alpha-2 国家/地区代码。)
  • CustomAttribute1 到 CustomAttribute15
  • 部门
  • 办公室
  • PostalCode
  • StateOrProvince
  • StreetAddress

此参数的基本语法为 "Property -ComparisonOperator 'Value'"

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

例如:

  • "City -eq 'Redmond'"
  • "CountryOrRegion -eq 'SG'".

可以使用逻辑运算符 -and-or将多个搜索条件链接在一起。 例如:

  • "CustomAttribute1 -eq 'AllowOWA' -and CountryOrRegion -eq AU'"
  • "(CountryOrRegion -eq 'US' -and Department -eq 'Sales') -or Department -eq 'Research'".

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

参数属性

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

参数集

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

-WhatIf

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

WhatIf 开关显示命令执行的操作,而无需进行任何更改。 不必为此开关指定值。

参数属性

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

参数集

(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 不返回任何数据。