Get-InboxRule
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ambiente ou de outro.
Use o cmdlet Get-InboxRule para exibir as propriedades da regra da Caixa de Entrada. As regras de Caixa de Entrada são usadas para processar mensagens na Caixa de Entrada com base nas condições especificadas e realizar ações, como mover uma mensagem para uma pasta especificada ou excluir uma mensagem.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Default (Default)
Get-InboxRule
[[-Identity] <InboxRuleIdParameter>]
[-BypassScopeCheck]
[-DescriptionTimeFormat <String>]
[-DescriptionTimeZone <ExTimeZoneValue>]
[-DomainController <Fqdn>]
[-IncludeHidden]
[-Mailbox <MailboxIdParameter>]
[-ResultSize <Unlimited>]
[-SkipCount <Int32>]
[-SweepRules]
[-UseCustomRouting]
[<CommonParameters>]
Description
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.
Observação: esse cmdlet não funciona para membros do grupo de função Gerenciamento da Organização no Exchange Online ou para View-Only função de Leitor Global no Microsoft Entra ID.
Exemplos
Exemplo 1
Get-InboxRule -Mailbox Joe@Contoso.com
Este exemplo recupera todas as regras de caixa de entrada para a caixa de correio Joe@Contoso.com.
Exemplo 2
Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "MM/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time"
Este exemplo recupera a regra de caixa de entrada ReceivedLastYear da caixa de correio joe@contoso.com na qual o parâmetro ReceivedBeforeDate foi definido quando a regra foi criada. Os parâmetros DescriptionTimeFormat e DescriptionTimeZone são usados neste exemplo para especificar a formatação da hora e do fuso horário usados na propriedade Description da regra.
Parâmetros
-BypassScopeCheck
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
A opção BypassScopeCheck especifica se a marcar de escopo deve ser ignorada para o usuário que está executando o comando. 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 |
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 |
-DescriptionTimeFormat
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro DescriptionTimeFormat especifica o formato dos valores de hora na descrição da regra. Por exemplo:
DD/mm/aaaa, em que MM é o mês de 2 dígitos, dd é o dia de 2 dígitos e aaaa é o ano de 4 dígitos.
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 |
-DescriptionTimeZone
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro DescriptionTimeZone especifica o fuso horário usado para valores de hora na descrição da regra.
$false: a regra ou política está desabilitada.
Para ver os valores disponíveis, execute o seguinte comando: $TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display.
Se o valor contiver espaços, coloque-o entre aspas ("). O valor padrão é a configuração de fuso horário do servidor Exchange.
Propriedades do parâmetro
| Tipo: | ExTimeZoneValue |
| 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 |
-DomainController
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
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 |
-Identity
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro Identity especifica a regra de caixa de entrada que você deseja exibir. É possível usar qualquer valor que identifique a regra com exclusividade. Por exemplo:
- Nome
- Propriedade RuleIdentity (por exemplo, 16752869479666417665).
- Exchange Online:
MailboxAlias\RuleIdentity(por exemplo,rzaher\16752869479666417665). - Troca local:
MailboxCanonicalName\RuleIdentity(por exemplo,contoso.com/Users/Rick Zaher\16752869479666417665).
Cuidado: O valor $null ou um valor inexistente para o parâmetro Identity retorna todos os objetos como se você tivesse executado o comando Get- sem o parâmetro Identity. Verifique se todas as listas de valores para o parâmetro Identity são precisas e não contêm valores de $null inexistentes.
Propriedades do parâmetro
| Tipo: | InboxRuleIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-IncludeHidden
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
A opção IncludeHidden especifica se as regras de Caixa de Entrada ocultas devem ser incluídas nos resultados. 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 |
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 |
-Mailbox
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro Mailbox especifica a caixa de correio que contém a regra da Caixa de Entrada. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. 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
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: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ResultSize
Aplicável: Exchange Online, complemento de segurança interno para caixas de correio locais
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.
Propriedades do parâmetro
| Tipo: | Unlimited |
| 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 |
-SkipCount
Aplicável: Exchange Online
Esse parâmetro só está disponível no serviço baseado em nuvem.
{{ Preencher SkipCount Description }}
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 |
-SweepRules
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
A opção SweepRules especifica se deseja retornar apenas regras Sweep nos resultados. Não é preciso especificar um valor com essa opção.
As regras de varredura são executadas em intervalos regulares para ajudar a manter sua caixa de entrada limpa.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| 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 |
-UseCustomRouting
Aplicável: Exchange Online
Esse parâmetro só está disponível no serviço baseado em nuvem.
{{ Preencher descrição do UseCustomRouting }}
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| 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 |
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.