Test-ClientAccessRule

  • 參考
模組:
ExchangePowerShell
適用於:
Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

注意事項

從 2022 年 10 月開始，我們已針對所有未使用這些規則的現有Exchange Online組織，停用用戶端存取規則的存取權。 在 2024 年 9 月，所有Exchange Online組織的用戶端存取規則支援都將終止。 如需詳細資訊，請參閱更新：在Exchange Online中取代用戶端存取規則。

此 Cmdlet 只能在 2019 Exchange Server和雲端式服務中運作。 有些參數和設定可能是某一個環境所專屬。

使用 Test-ClientAccessRule Cmdlet 來測試用戶端存取規則如何影響您組織的存取。 如果您為此 Cmdlet 指定的任何用戶端屬性符合任何用戶端存取規則，則規則會在結果中傳回。

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

Syntax

Test-ClientAccessRule
    -AuthenticationType <ClientAccessAuthenticationMethod>
    -Protocol <ClientAccessProtocol>
    -RemoteAddress <IPAddress>
    -RemotePort <Int32>
    -User <MailboxIdParameter>
    [-Confirm]
    [-OAuthClaims <Hashtable>]
    [-WhatIf]
    [<CommonParameters>]

Description

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

注意：目前並非所有通訊協定都支援所有驗證類型。 此清單說明每個通訊協定所支援的驗證類型：

  • OutlookWebApp：BasicAuthentication 和 AdfsAuthentication。
  • ExchangeAdminCenter：BasicAuthentication 和 AdfsAuthentication。
  • RemotePowerShell：BasicAuthentication 和 NonBasicAuthentication。
  • ExchangeActiveSync：BasicAuthentication、OAuthAuthentication 和 CertificateBasedAuthentication。

您必須已獲指派權限，才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數，不過，如果某些參數並未包含在指派給您的權限中，您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限，請參閱 Find the permissions required to run any Exchange cmdlet。

範例

範例 1

Test-ClientAccessRule -AuthenticationType BasicAuthentication -Protocol OutlookWebApp -RemoteAddress 172.17.17.26 -RemotePort 443 -User julia@contoso.com

此範例會使用下列用戶端屬性來測試用戶端存取：

  • 驗證類型：基本
  • 通訊協定：OutlookWebApp
  • 遠端位址：172.17.17.26
  • 遠端連接埠：443
  • 使用者： julia@contoso.com

參數

-AuthenticationType

AuthenticationType 參數會指定要測試的用戶端驗證類型。

此參數的有效值為：

  • AdfsAuthentication
  • BasicAuthentication
  • CertificateBasedAuthentication
  • NonBasicAuthentication
  • OAuthAuthentication

在用戶端存取規則中，驗證類型是由 AnyOfAuthenticationTypes 和 ExceptAnyOfAuthenticationTypes 參數所定義。

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

-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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-OAuthClaims

OAuthClaims 參數會指定仲介層應用程式的 OAuth 宣告權杖。

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

-Protocol

Protocol 參數會指定要測試的用戶端通訊協定。

此參數的有效值為：

  • ExchangeActiveSync
  • ExchangeAdminCenter
  • ExchangeWebServices
  • IMAP4
  • OfflineAddressBook
  • OutlookAnywhere
  • OutlookWebApp
  • POP3
  • PowerShellWebServices
  • RemotePowerShell
  • REST

在用戶端存取規則中，通訊協定類型是由 AnyOfProtocols 和 ExceptAnyOfProtocols 參數所定義。

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

-RemoteAddress

RemoteAddress 參數會指定要測試的用戶端 IP 位址。 此參數的有效輸入是 IP 位址。 例如，192.168.1.50。

在用戶端存取規則中，IP 位址是由 AnyOfClientIPAddressesOrRanges 和 ExceptAnyOfClientIPAddressesOrRanges 參數所定義。

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

-RemotePort

RemotePort 參數會指定要測試的用戶端 TCP 埠。 此參數的有效輸入是從 1 到 65535 的整數。

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

-User

User 參數會指定要測試的使用者帳戶。 您可以使用唯一識別使用者的任何值。 例如：

  • 名稱
  • 別名
  • 辨別名稱 (DN)
  • 辨別名稱 (DN)
  • Domain\Username
  • 電子郵件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 使用者識別碼或使用者主要名稱 (UPN)

在用戶端存取規則中，使用者是由 UsernameMatchesAnyOfPatterns、UserRecipientFilter 和 ExceptUsernameMatchesAnyOfPatterns 參數所定義。

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

-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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection