Set-ClientAccessRule

模組:
Exchange PowerShell

注意事項

用戶端存取規則已在 2025 年 9 月針對所有 Exchange Online 組織淘汰。 如需詳細資訊，請參閱 Exchange Online 中用戶端存取規則淘汰的更新。

此 Cmdlet 只能在 Exchange Server 2019 或更新版本中運作。

使用 Set-ClientAccessRule Cmdlet 修改現有的用戶端存取規則。 用戶端存取規則可協助您根據連線的內容來控制對組織的存取權。

如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。

語法

Default (預設值) 

Set-ClientAccessRule
    [-Identity] <ClientAccessRuleIdParameter>
    [-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>]
    [-Name <String>]
    [-Priority <Int32>]
    [-Scope <ClientAccessRulesScope>]
    [-UserIsMemberOf <MultiValuedProperty>]
    [-UsernameMatchesAnyOfPatterns <MultiValuedProperty>]
    [-UserRecipientFilter <String>]
    [-WhatIf]
    [<CommonParameters>]

Description

對於用戶端對貴組織的連線來說，用戶端存取規則就像是郵件流程規則 (又稱為傳輸規則)。 您可以使用條件和例外狀況，根據它們的屬性識別連線，以及允許或封鎖這些連線的動作。

注意： 並非所有通訊協定都支援驗證類型篩選，甚至支援驗證類型篩選的通訊協定也並非支援所有驗證類型。 下列清單說明支援的組合。 在同一規則中混合使用通訊協定和驗證類型時請務必小心。

支援驗證類型篩選的通訊協定：

  • 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 或參數所需的權限，請參閱 Find the permissions required to run any Exchange cmdlet。

範例

範例 1

Set-ClientAccessRule "Allow IMAP4" -AnyOfClientIPAddressesOrRanges @{Add="172.17.17.27/16"}

本範例會將 IP 位址範圍 172.17.17.27/16 新增至名為「允許 IMAP4」的現有用戶端存取規則，而不會影響現有的 IP 位址值。

參數

-Action

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Action 參數指定用戶端存取規則的動作。 此參數的有效值為 AllowAccess 和 DenyAccess。

參數屬性

類型:ClientAccessRulesAction
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值: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。
  • 無類別網域間路由 (CIDR) IP 位址範圍：例如，192.168.3.1/24 或 2001：DB8：：2AA：FF：C0A8：640A/64。

若要輸入多個值並覆寫現有的項目，請使用下列語法: Value1,Value2,...ValueN。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

若要新稱或移除一個或多個值，而不影響任何現有的項目，請使用以下語法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}。

如需有關 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 參數指定以用戶端通訊協定為基礎的用戶端存取規則條件。

此參數的有效值為：

  • ExchangeActiveSync
  • ExchangeAdminCenter
  • ExchangeWebServices
  • IMAP4
  • OfflineAddressBook
  • OutlookAnywhere
  • OutlookWebApp
  • POP3
  • PowerShellWebServices
  • RemotePowerShell
  • REST
  • UniversalOutlook (郵件和行事曆應用程式)

備註：在 Exchange 2019 中，唯一支援的值是 ExchangeAdminCenter 和 RemotePowerShell。

若要輸入多個值並覆寫現有的項目，請使用下列語法: Value1,Value2,...ValueN。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

若要新稱或移除一個或多個值，而不影響任何現有的項目，請使用以下語法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}。

參數屬性

類型: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-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet，指定不帶值的 Confirm 參數會造成暫停，強制您在繼續之前先確認命令。

此 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。

參數屬性

類型: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。
  • 無類別網域間路由 (CIDR) IP 位址範圍：例如，192.168.3.1/24 或 2001：DB8：：2AA：FF：C0A8：640A/64。

若要輸入多個值並覆寫現有的項目，請使用下列語法: Value1,Value2,...ValueN。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

若要新稱或移除一個或多個值，而不影響任何現有的項目，請使用以下語法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}。

如需有關 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* 接受) 。 非英數字元不需要逸出字元。

若要輸入多個值並覆寫現有的項目，請使用下列語法: Value1,Value2,...ValueN。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

若要新稱或移除一個或多個值，而不影響任何現有的項目，請使用以下語法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Identity

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Identity 參數會指定您要修改的用戶端存取規則。 您可以使用唯一識別用戶端存取規則的任何值。 例如：

  • 名稱
  • 辨別名稱 (DN)
  • GUID

參數屬性

類型:ClientAccessRuleIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Name

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Name 參數指定用戶端存取規則的唯一名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Priority

適用項目：Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Priority 參數會指定用戶端存取規則的優先順序值。 整數值越低表示優先順序越高，且優先順序越高的規則會在優先順序較低的規則之前評估。 預設值為 1。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Scope

適用項目：Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Scope 參數會指定用戶端存取規則的範圍。 有效值為：

  • Users：此規則僅適用於使用者連線。
  • All：此規則會套用到所有連線 (使用者和中介層應用程式)。

參數屬性

類型: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 參數指定以格式 <Domain>\<UserName> 的使用者帳戶名稱 (例如，contoso.com\jeff) 為基礎的用戶端存取規則條件。 例如， *jeff*此參數接受文字和萬用字元 (*) (，但不能 jeff* 接受) 。 非英數字元不需要逸出字元。

若要輸入多個值並覆寫現有的項目，請使用下列語法: Value1,Value2,...ValueN。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

若要新稱或移除一個或多個值，而不影響任何現有的項目，請使用以下語法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示: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 是要搜尋的屬性值。 以單引號括住文字值和變數 ('Value' 或 '$Variable')。 如果變數值包含單引號，您必須識別 (逸出) 單引號，以正確展開變數。 例如，使用 '$($User -Replace "'","''")'，而不是 '$User'。 請勿用引號括住整數或系統值 (例如，使用 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

若要查看此指令程式可接受的輸入類型，請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的，表示指令程式不接受輸入資料。

輸出

Output types

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型)，請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的，表示指令程式不會傳回資料。