New-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 New-ClientAccessRule para criar regras de acesso para cliente. As regras de acesso do cliente ajudam a controlar o acesso à sua organização com base nas propriedades da conexão.

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

Sintaxe

Default (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>]

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: nem todos os protocolos dão suporte a filtros de tipo de autenticação, e mesmo os protocolos que dão suporte a filtros de tipo de autenticação não dão suporte a todos os tipos de autenticação. As combinações com suporte são descritas nas listas a seguir. Tenha cuidado ao misturar protocolos e tipos de autenticação na mesma regra.

Protocolos que dão suporte a filtros de tipo de autenticação:

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

Protocolos que não dão suporte a filtros de tipo de autenticação:

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

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

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

Este exemplo cria uma regra de prioridade mais alta que permite o acesso ao PowerShell remoto. Essa regra é uma proteção importante para preservar o acesso à sua organização. Sem essa regra, se você criar regras que bloqueiam seu acesso ao PowerShell remoto ou que bloqueiam todos os protocolos para todos, você perde a capacidade de corrigir as regras por conta própria (você precisa chamar o Serviço de Suporte e Atendimento ao Cliente Microsoft).

Exemplo 2

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

Este exemplo cria uma nova regra de acesso para cliente denominada Bloquear ActiveSync que bloqueia o acesso para clientes do Exchange ActiveSync, exceto para clientes no intervalo de endereços IP 192.168.10.1/24.

Parâmetros

-Action

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

O parâmetro Action especifica a ação da regra de acesso ao cliente. Os valores válidos para este parâmetro são AllowAccess e DenyAccess.

Propriedades do parâmetro

Tipo:ClientAccessRulesAction
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

-AnyOfAuthenticationTypes

Aplicável: Exchange Server 2013, Exchange Server 2016

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-AnyOfClientIPAddressesOrRanges

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

O parâmetro AnyOfClientIPAddressesOrRanges especifica uma condição para a regra de acesso do cliente com base no endereço IPv4 ou IPv6 do cliente. Os valores válidos são:

  • Endereço IP único: Por exemplo, 192.168.1.1 ou 2001:DB8::2AA:FF:C0A8:640A.
  • Intervalo de endereços IP: Por exemplo, 192.168.0.1-192.168.0.254 ou 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414.
  • Intervalo de endereços IP do Classless Inter-Domain Routing (CIDR): Por exemplo, 192.168.3.1/24 ou 2001:DB8::2AA:FF:C0A8:640A/64.

Update

Para obter mais informações sobre endereços IPv6 e sintaxe, consulte este artigo do Exchange 2013: Noções básicas de endereço IPv6.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-AnyOfProtocols

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

O parâmetro AnyOfProtocols especifica uma condição para a Regra de Acesso ao Cliente com base no protocolo do cliente.

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
  • UniversalOutlook (aplicativo Email e Calendar)

Observação: no Exchange 2019, os únicos valores com suporte são ExchangeAdminCenter e RemotePowerShell.

Update Não use aspas.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-AnyOfSourceTcpPortNumbers

Aplicável: Exchange Server 2013

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-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.

Este cmdlet tem uma pausa interna, portanto, use -Confirm:$false para ignorar a confirmação.

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

-DomainController

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

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.

Propriedades do parâmetro

Tipo:Fqdn
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

-Enabled

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

O parâmetro Enabled especifica se a regra de acesso ao cliente está habilitada ou desabilitada. Os valores válidos para esse parâmetro são $true ou $false. O valor padrão é $true.

Propriedades do parâmetro

Tipo:Boolean
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

-ExceptAnyOfAuthenticationTypes

Aplicável: Exchange Server 2013, Exchange Server 2016

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-ExceptAnyOfClientIPAddressesOrRanges

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

O parâmetro ExceptAnyOfClientIPAddressesOrRanges especifica uma exceção para a regra de acesso do cliente com base no endereço IPv4 ou IPv6 do cliente. Os valores válidos são:

  • Endereço IP único: Por exemplo, 192.168.1.1 ou 2001:DB8::2AA:FF:C0A8:640A.
  • Intervalo de endereços IP: Por exemplo, 192.168.0.1-192.168.0.254 ou 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414.
  • Intervalo de endereços IP do Classless Inter-Domain Routing (CIDR): Por exemplo, 192.168.3.1/24 ou 2001:DB8::2AA:FF:C0A8:640A/64.

Update

Para obter mais informações sobre endereços IPv6 e sintaxe, consulte este artigo do Exchange 2013: Noções básicas de endereço IPv6.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-ExceptAnyOfProtocols

Aplicável: Exchange Server 2013, Exchange Server 2016

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-ExceptAnyOfSourceTcpPortNumbers

Aplicável: Exchange Server 2013

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-ExceptUserIsMemberOf

Aplicável: Exchange Server 2013

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-ExceptUsernameMatchesAnyOfPatterns

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

O parâmetro ExceptUsernameMatchesAnyOfPatterns especifica uma exceção para a regra de acesso do cliente com base no nome da conta do usuário no formato <Domain>\<UserName> (por exemplo, contoso.com\jeff). Esse parâmetro aceita texto e o caractere curinga (*) (por exemplo, *jeff*, mas não jeff*). Caracteres não alfanuméricos não exigem um caractere de escape.

Update

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-Name

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

O parâmetro Name especifica um nome exclusivo para a regra de acesso ao cliente.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Priority

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

O parâmetro Priority especifica um valor de prioridade para a regra que determina a ordem de processamento da regra. Um valor inteiro mais baixo indica uma prioridade mais alta, o valor 0 é a prioridade mais alta, e as regras não podem ter o mesmo valor de prioridade.

O parâmetro Priority especifica um valor de prioridade para a regra que determina a ordem do processamento da regra. Um valor inteiro mais baixo indica uma prioridade mais alta, o valor 0 é a prioridade mais alta, e as regras não podem ter o mesmo valor de prioridade.

  • Os valores válidos e o valor padrão para esse parâmetro dependem do número de regras existentes. Por exemplo, se houver 8 regras existentes:
  • Os valores válidos de prioridade para as 8 regras existentes vão de 0 a 7.
  • Os valores válidos de prioridade para uma nova regra (a 9ª) vão de 0 a 8.

Se você modificar o valor de prioridade de uma regra, a posição da regra na lista mudará para corresponder ao valor de prioridade especificado. Em outras palavras, se você definir o valor de prioridade de uma regra para o mesmo valor de uma regra existente, o valor de prioridade da regra existente e de todas as outras regras de prioridade mais baixas depois dele será aumentado em 1.

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:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Scope

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

O parâmetro Scope especifica o escopo da regra de acesso do cliente. Os valores válidos são:

  • Usuários: a regra só se aplica a conexões de usuário final.
  • Todas: a regra se aplica a todas as conexões (usuários finais e aplicativos de camada intermediária).

Propriedades do parâmetro

Tipo:ClientAccessRulesScope
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

-UserIsMemberOf

Aplicável: Exchange Server 2013

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:MultiValuedProperty
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

-UsernameMatchesAnyOfPatterns

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

O parâmetro UsernameMatchesAnyOfPatterns especifica uma condição para a regra de acesso do cliente com base no nome da conta do usuário no formato <Domain>\<UserName> (por exemplo, contoso.com\jeff). Esse parâmetro aceita texto e o caractere curinga (*) (por exemplo, *jeff*, mas não jeff*). Caracteres não alfanuméricos não exigem um caractere de escape. Esse parâmetro não funciona com o parâmetro -AnyOfProtocols do UniversalOutlook.

Update

Propriedades do parâmetro

Tipo:MultiValuedProperty
Valor padrão:None
Dá suporte a curingas:True
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

-UserRecipientFilter

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

O parâmetro UserRecipientFilter especifica uma condição para a regra de acesso do cliente que usa a sintaxe de filtro OPATH para identificar o usuário com base em um conjunto limitado de propriedades do destinatário. As Regras de Acesso para Cliente não oferecem suporte à lista completa de propriedades de destinatário disponíveis.

Você pode usar as seguintes propriedades com este parâmetro:

  • Cidade
  • Empresa
  • CountryOrRegion (código de país ISO 3166-1 alfa-2.)
  • CustomAttribute1 to CustomAttribute15
  • Departamento
  • Escritório
  • PostalCode
  • StateOrProvince
  • StreetAddress

A sintaxe básica para este parâmetro é "Property -ComparisonOperator 'Value'":

  • Property é uma das propriedades filtráveis na lista acima (por exemplo City , ou CustomAttribute1).
  • ComparisonOperator é um operador de comparação OPATH (por exemplo, -eq para igual e -like para comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators.
  • Valor é o valor da propriedade a ser pesquisado. Coloque os valores de texto e variáveis entre aspas simples ('Value' ou '$Variable'). Se um valor de variável contiver aspas simples, você precisará identificar (escapar) as aspas simples para expandir a variável corretamente. Por exemplo, em vez de '$User', use '$($User -Replace "'","''")'. Não coloque números inteiros ou valores do sistema entre aspas (por exemplo, use 500, $true, $false, ou $null em vez disso).
  • Coloque todo o filtro OPATH entre aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo, $true, $false, ou $null), use aspas simples " '. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também poderá usar chaves { }, mas somente se o filtro não contiver variáveis.

Por exemplo:

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

Você pode encadear vários critérios de pesquisa usando os operadores -and lógicos e -or. Por exemplo:

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

Para obter informações detalhadas sobre a sintaxe do filtro OPATH no Exchange, consulte Informações adicionais sobre a sintaxe do OPATH.

Propriedades do parâmetro

Tipo:String
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

-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.

Entradas

Input types

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.