Test-ClientAccessRule

Módulo:
Exchange PowerShell

Observação

As regras de acesso de cliente foram preteridas para todas as organizações do Exchange Online em setembro de 2025. Para obter mais informações, consulte Atualização sobre a substituição de regras de acesso para cliente no Exchange Online.

Esse cmdlet funciona somente no Exchange Server 2019 ou posterior.

Use o cmdlet Test-ClientAccessRule para testar como as regras de acesso para cliente afetam o acesso à sua organização. Se qualquer uma das propriedades do cliente especificadas para esse cmdlet corresponder a qualquer regra de acesso para cliente, as regras serão retornadas nos resultados.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Sintaxe

Default (Default) 

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

Description

As regras de acesso do cliente são como regras de fluxo de emails (também conhecidas como regras de transporte) para conexões de cliente com sua organização. Você usa condições e exceções para identificar as conexões com base em suas propriedades e ações que permitem ou bloqueiam as conexões.

Observação: atualmente, nem todos os tipos de autenticação são compatíveis com todos os protocolos. Os tipos de autenticação com suporte por protocolo são descritos nesta lista:

  • OutlookWebApp:BasicAuthentication e AdfsAuthentication.
  • ExchangeAdminCenter:BasicAuthentication e AdfsAuthentication.
  • RemotePowerShell:BasicAuthentication e NonBasicAuthentication.
  • ExchangeActiveSync:BasicAuthentication, OAuthAuthentication e CertificateBasedAuthentication.

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

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

Este exemplo testa o acesso para cliente usando as seguintes propriedades de cliente:

  • Tipo de autenticação: Básica
  • Protocolo:OutlookWebApp
  • Endereço remoto: 172.17.17.26
  • Porta remota: 443
  • Usuário: julia@contoso.com

Parâmetros

-AuthenticationType

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O parâmetro AuthenticationType especifica o tipo de autenticação de cliente a ser testada.

O parâmetro PasswordQuality especifica a classificação mínima de qualidade da senha exigida para as senhas dos dispositivo. Qualidade de senha é uma escala numérica que indica a segurança e a complexidade da senha. Um valor de qualidade mais alto indica uma senha mais segura.

  • AdfsAuthentication
  • BasicAuthentication
  • CertificateBasedAuthentication
  • NonBasicAuthentication
  • OAuthAuthentication

Nas regras de acesso para cliente, os tipos de autenticação são definidos pelos parâmetros AnyOfAuthenticationTypes e ExceptAnyOfAuthenticationTypes.

Propriedades do parâmetro

Tipo:ClientAccessAuthenticationMethod
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, New- e Set-) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a reconhecer o comando antes de continuar.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OAuthClaims

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O parâmetro OAuthClaims especifica o token de declarações OAuth de um aplicativo de camada intermediária.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Protocol

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O parâmetro Protocol especifica o protocolo de cliente a ser testado.

O parâmetro PasswordQuality especifica a classificação mínima de qualidade da senha exigida para as senhas dos dispositivo. Qualidade de senha é uma escala numérica que indica a segurança e a complexidade da senha. Um valor de qualidade mais alto indica uma senha mais segura.

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

Nas regras de acesso para cliente, os tipos de autenticação são definidos pelos parâmetros AnyOfProtocols e ExceptAnyOfProtocols.

Propriedades do parâmetro

Tipo:ClientAccessProtocol
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RemoteAddress

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O parâmetro RemoteAddress especifica o endereço IP do cliente a ser testado. A entrada válida para esse parâmetro é um endereço IP. Por exemplo, 192.168.1.50.

Nas regras de acesso para cliente, os tipos de autenticação são definidos pelos parâmetros AnyOfClientIPAddressesOrRanges e ExceptAnyOfClientIPAddressesOrRanges.

Propriedades do parâmetro

Tipo:IPAddress
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RemotePort

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O parâmetro RemotePort especifica a porta TCP do cliente a ser testada. A entrada válida para esse parâmetro é um inteiro entre 1 e 65535.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-User

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O parâmetro User especifica a conta de usuário a ser testada.

Para obter os melhores resultados, recomendamos o uso dos seguintes valores:

  • UPN: por exemplo, user@contoso.com (somente usuários).
  • Domain\SamAccountName: Por exemplo, contoso\user.

Caso contrário, você poderá usar qualquer valor que identifique exclusivamente o usuário. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • Domínio\Nome de usuário
  • Endereço de email
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ID de usuário ou nome UPN

Nas regras de acesso do cliente, os usuários são definidos pelos parâmetros UsernameMatchesAnyOfPatterns, UserRecipientFilter e ExceptUsernameMatchesAnyOfPatterns.

Propriedades do parâmetro

Tipo:MailboxIdParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. Não é preciso especificar um valor com essa opção.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.