Set-ClientAccessRule

Observação

A partir de outubro de 2022, desabilitamos o acesso às regras de acesso ao cliente para todas as organizações de Exchange Online existentes que não as estavam usando. Em setembro de 2024, o suporte às regras de acesso ao cliente terminará para todas as organizações Exchange Online. Para obter mais informações, consulte Atualização: preterimento das Regras de Acesso ao Cliente no Exchange Online.

Esse cmdlet é funcional apenas no Exchange Server 2019 e no serviço baseado em nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.

Use o cmdlet Set-ClientAccessRule para modificar regras de acesso para cliente. As regras de acesso ao cliente ajudam você 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.

Syntax

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

As regras de acesso ao cliente são como regras de fluxo de email (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 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.

Protcols 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 tópico 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

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

Este exemplo adiciona o intervalo de endereços IP 172.17.17.27/16 à regra de acesso para cliente existente, chamada Permitir IMAP4, sem afetar os valores de endereços IP existentes.

Parâmetros

-Action

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.

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

-AnyOfAuthenticationTypes

Esse parâmetro é funcional apenas no serviço baseado em nuvem.

O parâmetro AnyOfAuthenticationTypes especifica uma condição para a Regra de Acesso ao Cliente com base no tipo de autenticação 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.

  • AdfsAuthentication
  • Basicauthentication
  • CertificateBasedAuthentication
  • NonBasicAuthentication
  • OAuthAuthentication

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Observação: consulte a seção Descrição para ver quais tipos de autenticação podem ser usados com quais protocolos.

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

-AnyOfClientIPAddressesOrRanges

O parâmetro AnyOfClientIPAddressesOrRanges especifica uma condição para a regra de acesso do cliente baseada 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 CIDR (roteamento interdomínio sem classe): por exemplo, 192.168.3.1/24 ou 2001:DB8:::2AA:FF:C0A8:640A/64.

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Para obter mais informações sobre endereços E sintaxe IPv6, confira este tópico do Exchange 2013: conceitos básicos de endereço IPv6.

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

-AnyOfProtocols

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 Mail and Calendar)

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

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

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

-AnyOfSourceTcpPortNumbers

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

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013

-Confirm

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, cmdlets 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 confirmar o comando antes de continuar.
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

-DomainController

Este parâmetro está disponível somente no Exchange local.

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.

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

-Enabled

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.

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

-ExceptAnyOfAuthenticationTypes

Esse parâmetro é funcional apenas no serviço baseado em nuvem.

O parâmetro ExceptAnyOfAuthenticationTypes especifica uma exceção para a Regra de Acesso ao Cliente com base no tipo de autenticação 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.

  • AdfsAuthentication
  • Basicauthentication
  • CertificateBasedAuthentication
  • NonBasicAuthentication
  • OAuthAuthentication

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Observação: consulte a seção Descrição para ver quais tipos de autenticação podem ser usados com quais protocolos.

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

-ExceptAnyOfClientIPAddressesOrRanges

O parâmetro ExceptAnyOfClientIPAddressesOrRanges especifica uma exceção para a regra de acesso do cliente baseada 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 CIDR (roteamento interdomínio sem classe): por exemplo, 192.168.3.1/24 ou 2001:DB8:::2AA:FF:C0A8:640A/64.

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Para obter mais informações sobre endereços E sintaxe IPv6, confira este tópico do Exchange 2013: conceitos básicos de endereço IPv6.

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

-ExceptAnyOfProtocols

Esse parâmetro é funcional apenas no serviço baseado em nuvem.

O parâmetro ExceptAnyOfProtocols especifica uma exceçã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 Mail and Calendar)

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

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

-ExceptAnyOfSourceTcpPortNumbers

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

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013

-ExceptUserIsMemberOf

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

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013

-ExceptUsernameMatchesAnyOfPatterns

Esse parâmetro é funcional apenas no serviço baseado em nuvem.

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

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

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

-Identity

O parâmetro Identity especifica a regra de acesso para cliente que você quer modificar. É possível usar qualquer valor que identifique a regra de acesso para cliente com exclusividade. Por exemplo:

  • Nome
  • DN (nome diferenciado)
  • GUID
Type:ClientAccessRuleIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-Name

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

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

-Priority

O parâmetro Priority especifica um valor de prioridade para a regra de acesso ao cliente. Um valor inteiro mais baixo indica uma prioridade mais alta e uma regra de prioridade mais alta é avaliada antes de uma regra de prioridade mais baixa. O valor padrão é 1.

Type:Int32
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

-Scope

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

  • Usuários: a regra só se aplica a conexões de usuário final.
  • Tudo: a regra se aplica a todas as conexões (usuários finais e aplicativos de camada média).
Type:ClientAccessRulesScope
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

-UserIsMemberOf

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

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013

-UsernameMatchesAnyOfPatterns

Esse parâmetro é funcional apenas no serviço baseado em nuvem.

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

Para inserir vários valores e substituir quaisquer entradas existentes, use a seguinte sintaxe: Value1,Value2,...ValueN. Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Para adicionar ou remover um ou mais valores sem afetar nenhuma entrada existente, use a seguinte sintaxe: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

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

-UserRecipientFilter

Esse parâmetro é funcional apenas no serviço baseado em nuvem.

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 ao Cliente não dão suporte à lista completa de propriedades do 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 para CustomAttribute15
  • Departamento
  • Escritório
  • PostalCode
  • StateOrProvince
  • StreetAddress

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

  • A propriedade é uma das propriedades filtradas na lista acima (por exemplo City , ou CustomAttribute1).
  • ComparisonOperator é um operador de comparação OPATH (por exemplo -eq , para iguais 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. Inclua valores e variáveis de texto em aspas individuais ('Value' ou '$Variable'). Se um valor variável contiver aspas individuais, você precisará identificar (escapar) as aspas individuais para expandir a variável corretamente. Por exemplo, em vez de '$User', use '$($User -Replace "'","''")'. Não inclua inteiros ou valores do sistema entre aspas (por exemplo, use 500, $true, $falseou $null em vez disso).
  • Inclua todo o filtro OPATH nas aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo, $true, $falseou $null), use aspas individuais ' ' em vez disso. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também pode 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 lógicos -and 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 de sintaxe OPATH.

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

-WhatIf

A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.

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

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.