Compartilhar via

Set-SweepRule

Módulo:
Exchange PowerShell

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e definições podem ser exclusivos de um ambiente ou outro.

Utilize o cmdlet Set-SweepRule para modificar as regras de Varrer em caixas de correio.

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

Sintaxe

Default (Padrão) 

Set-SweepRule
    [-Identity] <SweepRuleIdParameter>
    [-Confirm]
    [-DestinationFolder <MailboxFolderIdParameter>]
    [-DomainController <Fqdn>]
    [-Enabled <Boolean>]
    [-ExceptIfFlagged <Boolean>]
    [-ExceptIfPinned <Boolean>]
    [-KeepForDays <Int32>]
    [-KeepLatest <Int32>]
    [-Mailbox <MailboxIdParameter>]
    [-Name <String>]
    [-Provider <String>]
    [-Sender <RecipientIdParameter>]
    [-SourceFolder <MailboxFolderIdParameter>]
    [-SystemCategory <SystemCategoryType>]
    [-WhatIf]
    [<CommonParameters>]

Description

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. 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-SweepRule -Identity x2hlsdpGmUifjFgxxGIOJw== -KeepForDays 15 -ExceptIfPinned $true

Este exemplo modifica a regra existente que tem o valor de ID da regra x2hlsdpGmUifjFgxxGIOJw== com o valor especificado.

Parâmetros

-Confirm

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

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, 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 confirmar 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

-DestinationFolder

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

O parâmetro DestinationFolder especifica uma ação para a regra varrer que move mensagens para a pasta especificada. A sintaxe é MailboxID:\ParentFolder[\SubFolder].

Para o valor de MailboxID, pode utilizar qualquer valor que identifique exclusivamente a caixa de correio. Por exemplo:

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

Os valores de exemplo para este parâmetro são john@contoso.com:\Unimportant ou John:\Inbox\Misc. O valor padrão é MailboxID:\Deleted Items.

Propriedades do parâmetro

Tipo:MailboxFolderIdParameter
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 2016, Exchange Server 2019

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

-Enabled

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

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

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

-ExceptIfFlagged

Aplicável: Exchange Server 2016, Exchange Server 2019

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

O parâmetro ExceptIfFlagged especifica uma exceção para a regra varrer que procura mensagens com um sinalizador de mensagem aplicado. Os valores válidos são:

  • $true: a ação da regra não é aplicada a mensagens que tenham um sinalizador de mensagem aplicado.
  • $false: a exceção não é utilizada.

Os valores típicos do sinalizador de mensagem são:

  • Qualquer
  • Chamada
  • DoNotForward
  • Seguimento
  • ForYourInformation
  • Encaminhar
  • NoResponseNecessary
  • Leitura
  • Responder
  • ReplyToAll
  • Revisão

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

-ExceptIfPinned

Aplicável: Exchange Server 2016, Exchange Server 2019

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

O parâmetro PinMessage especifica uma exceção para a regra varrer que procura mensagens afixadas. Os valores válidos são:

  • $true: a ação da regra não é aplicada às mensagens que estão afixadas na parte superior da Caixa de Entrada.
  • $false: a exceção não é utilizada.

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

-Identity

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

O parâmetro Identidade especifica a regra de Varrer que pretende modificar. É possível usar qualquer valor que identifique a regra com exclusividade. Por exemplo:

  • Propriedade RuleId (por exemplo, x2hlsdpGmUifjFgxxGIOJw==).
  • Exchange Online: MailboxAlias\RuleID (por exemplo, rzaher\2hlsdpGmUifjFgxxGIOJw==).
  • Exchange no local: MailboxCanonicalName\RuleID (por exemplo, contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==).

Pode obter estes valores de identidade com o cmdlet Get-SweepRule.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-KeepForDays

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

O parâmetro KeepForDays especifica uma ação para a regra Varrer que especifica o número de dias para manter as mensagens que correspondem às condições da regra. Após o número de dias, as mensagens são movidas para a localização especificada pelo parâmetro DestinationFolder (por predefinição, a pasta Itens Eliminados).

Não pode utilizar este parâmetro com o parâmetro KeepLatest e a regra Varrer tem de conter um valor de parâmetro KeepForDays ou KeepLatest.

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

-KeepLatest

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

O parâmetro KeepLatest especifica uma ação para a regra varrer que especifica o número de mensagens a manter que correspondem às condições da regra. Depois de o número de mensagens ser excedido, as mensagens mais antigas são movidas para a localização especificada pelo parâmetro DestinationFolder (por predefinição, a pasta Itens Eliminados).

Não pode utilizar este parâmetro com o parâmetro KeepForDays e a regra Varrer tem de conter um valor de parâmetro KeepForDays ou KeepLatest.

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

-Mailbox

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

O parâmetro Caixa de Correio especifica a caixa de correio que contém a regra que pretende modificar. É 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 Utilizador
  • 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

-Name

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

O parâmetro Nome especifica o nome da regra varrer. Se o valor contiver espaços, coloque-o entre aspas.

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

-Provider

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

O parâmetro Fornecedor especifica o fornecedor para a regra varrer. Se o valor contiver espaços, coloque-o entre aspas.

Para regras de varrimento criadas no Outlook na Web, o valor predefinido é Exchange16.

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

-Sender

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

O parâmetro Remetente especifica uma condição para a regra varrer que procura o remetente especificado nas mensagens. Para remetentes internos, é possível usar qualquer valor que identifique exclusivamente o remetente. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • DN canônico
  • GUID

Para remetentes externos, utilize o respetivo endereço de e-mail.

Propriedades do parâmetro

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

-SourceFolder

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

O parâmetro SourceFolder especifica uma condição para a regra varrer que procura mensagens na pasta especificada. A sintaxe é MailboxID:\ParentFolder[\SubFolder].

Para o valor de MailboxID, pode utilizar qualquer valor que identifique exclusivamente a caixa de correio. Por exemplo:

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

Os valores de exemplo para este parâmetro são john@contoso.com:\Marketing ou John:\Inbox\Reports. O valor padrão é MailboxID:\Inbox.

Propriedades do parâmetro

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

-SystemCategory

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

O parâmetro SystemCategory especifica uma condição para a regra de varrimento que procura mensagens com a categoria de sistema especificada. As categorias de sistema estão disponíveis para todas as caixas de correio na organização. Os valores válidos são:

  • Não Definido
  • Faturas
  • Documento
  • DocumentPlus
  • Evento
  • Família
  • Arquivo
  • Piloto piloto
  • FromContact
  • Importante
  • LiveView
  • Alojamento
  • Lista de Correio
  • Boletim Informativo
  • Photo
  • Comprar
  • RentalCar
  • RestaurantReservation
  • RetiredPromotion
  • ShippingNotification
  • Compras
  • SocialUpdate
  • Viajar
  • Vídeo

Propriedades do parâmetro

Tipo:SystemCategoryType
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 2016, Exchange Server 2019, Exchange Online

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.

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 suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.