Set-RetentionPolicyTag

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 ou outro ambiente.

Use o cmdlet Set-RetentionPolicyTag para modificar as propriedades de uma marca de retenção.

Para obter mais informações sobre marcas de retenção, consulte marcas de retenção e políticas de retenção no Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies).

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).

Syntax

Set-RetentionPolicyTag
   [-Identity] <RetentionPolicyTagIdParameter>
   [-AddressForJournaling <RecipientIdParameter>]
   [-AgeLimitForRetention <EnhancedTimeSpan>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-JournalingEnabled <Boolean>]
   [-LabelForJournaling <String>]
   [-LegacyManagedFolder <ELCFolderIdParameter>]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MessageClass <String>]
   [-MessageFormatForJournaling <JournalingFormat>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-Name <String>]
   [-RetentionAction <RetentionAction>]
   [-RetentionEnabled <Boolean>]
   [-RetentionId <Guid>]
   [-SystemTag <Boolean>]
   [-WhatIf]
   [<CommonParameters>]
Set-RetentionPolicyTag
   -Mailbox <MailboxIdParameter>
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-LegacyManagedFolder <ELCFolderIdParameter>]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-Name <String>]
   [-OptionalInMailbox <RetentionPolicyTagIdParameter[]>]
   [-RetentionId <Guid>]
   [-SystemTag <Boolean>]
   [-WhatIf]
   [<CommonParameters>]

Description

As marcas de retenção são usadas para aplicar configurações de retenção de mensagens a pastas e itens em uma caixa de correio.

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.

Examples

Exemplo 1

Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"

Este exemplo altera o comentário da marca da diretiva de retenção AllUsers-DeletedItems.

Exemplo 2

Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"

Este exemplo disponibiliza marcas de retenção opcionais para o usuário Terry Adams usando os parâmetros Mailbox e OptionalInMailbox.

Parameters

-AddressForJournaling

Esse parâmetro está disponível ou funcional somente no Exchange Server 2010.

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

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-AgeLimitForRetention

O parâmetro AgeLimitForRetention especifica a idade com que a retenção é imposta a um item. O limite de idade corresponde ao número de dias a contar da data em que o item foi entregue ou da data em que um item foi criado, se não tiver sido entregue. Se esse parâmetro não estiver presente e o parâmetro RetentionEnabled estiver definido como $true, um erro será retornado.

Type:EnhancedTimeSpan
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Comentário

O parâmetro Comment especifica um comentário para a marca da diretiva de retenção.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-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, Remover-* cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para esses cmdlets, você pode ignorar a solicitação 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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-Força

A opção Force sobrescreve o prompt de confirmação exibido pelo cmdlet quando você usa o parâmetro RetentionId.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Identity

O parâmetro Identity especifica o nome, o DN ou o GUID da marca da diretiva de retenção a ser modificada.

Type:RetentionPolicyTagIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-JournalingEnabled

Esse parâmetro está disponível ou funcional somente no Exchange Server 2010.

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

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-LabelForJournaling

Esse parâmetro está disponível ou funcional somente no Exchange Server 2010.

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-LegacyManagedFolder

O parâmetro LegacyManagedFolder especifica o nome de uma pasta gerenciada. A marca de retenção é criada usando configurações de retenção da pasta gerenciada e as suas configurações de conteúdos gerenciados. Você pode usar este parâmetro para criar marcas de retenção baseadas nas pastas gerenciadas existentes para migrar usuários da diretiva de caixa de correio da pasta gerenciada à diretiva de retenção.

Type:ELCFolderIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-LocalizedComment

O parâmetro LocalizedComment especifica o comentário localizado e o idioma da marca da política de retenção. Este comentário é exibido no Microsoft Outlook com base na localidade do usuário.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-LocalizedRetentionPolicyTagName

O parâmetro LocalizedRetentionPolicyTagName especifica um nome localizado para a marca de política de retenção. Esse nome é exibido no Outlook com base na localidade do usuário.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Mailbox

O parâmetro Mailbox especifica uma caixa de correio para atribuir marcas de aceitar. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

  • Nome

  • Alias

  • Nome diferenciado (DN)

  • Nome diferenciado (DN)

  • <domain name>\<account name>

  • DN canônico

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • ID de usuário ou nome UPN

Você deve usar esse parâmetro com o parâmetro OptionalInMailbox.

Type:MailboxIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-MessageClass

O parâmetro MessageClass especifica o tipo de mensagem ao qual a marca se aplica. Se não for especificado, o valor padrão será definido como * .

Com exceção de uma marca de política padrão (DPT) para a caixa postal, o Exchange não oferece suporte a marcas de retenção para diferentes tipos de mensagens. Somente marcas com uma MessageClass * são suportadas e aplicam-se a todos os tipos de mensagens.

Para criar um DPT para mensagens de caixa postal, defina o parâmetro MessageClass para voicemail e o parâmetro Type para All.

Um DPT para mensagens de caixa postal aplica-se apenas às mensagens de caixa postal da Unificação de mensagens do Microsoft Exchange (identificadas pelo _ valor da propriedade de MAPI da classe de mensagem PR _ IPM. Note. Microsoft. NETcaixa de correio * ).

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-MessageFormatForJournaling

Esse parâmetro está disponível ou funcional somente no Exchange Server 2010.

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

Type:JournalingFormat
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-MustDisplayCommentEnabled

O parâmetro MustDisplayCommentEnabled especifica se o comentário pode ficar oculto. O valor padrão é $true.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Name

O parâmetro Name especifica o nome da marca da diretiva de retenção.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-OptionalInMailbox

O parâmetro OptionalInMailbox é usado com o parâmetro Mailbox para atribuir marcas pessoais à caixa de correio. Você pode usar esse parâmetro para tornar disponível a um usuário uma marca pessoal que não esteja atribuída à política de retenção aplicada à caixa de correio especificada. Você pode especificar várias marcas pessoais separadas por vírgulas.

Type:RetentionPolicyTagIdParameter[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-RetentionAction

O parâmetro RetentionAction especifica a ação da política de retenção. Os valores válidos são:

  • DeleteAndAllowRecovery: exclui uma mensagem e permite a recuperação da pasta itens recuperáveis.

  • DeleteAndAllowRecovery: exclui uma mensagem e permite a recuperação da pasta Itens Recuperáveis.

  • MoveToArchive: move uma mensagem para a caixa de correio de arquivo morto do usuário. Você pode usar essa ação para marcas de retenção do tipo All, Personal e RecoverableItems.

  • PermanentlyDelete: exclui permanentemente uma mensagem. Uma mensagem que tenha sido excluída em definitivo não pode ser recuperada usando a pasta Itens Recuperáveis. As mensagens excluídas definitivamente não são retornadas em uma pesquisa de Descoberta, a menos que a retenção de litígio esteja habilitada para a caixa de correio.

As ações MoveToDeletedItems e MoveToFolder estão disponíveis, mas não funcionam. Estas ações estão disponíveis para atualizações de gerenciamento de registros de mensagens (MRM) 1.0 (pastas gerenciadas) à MRM 2.0 (políticas de retenção). MRM 2,0 foi introduzido no Exchange 2010 Service Pack 1 (SP1).

Se esse parâmetro não estiver presente e o parâmetro RetentionEnabled estiver definido como $true, um erro será retornado.

Type:RetentionAction
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-RetentionEnabled

O parâmetro RetentionEnabled especifica se a marca está habilitada. Quando definido como $false, a marca é desabilitada e nenhuma ação de retenção é tomada em mensagens com a marca aplicada.

As mensagens com um a marca desabilitada ainda serão consideradas marcadas, portanto, qualquer marca de política padrão na política de retenção do usuário não será aplicada a essas mensagens.

Ao definir o parâmetro RetentionEnabled para $false, o período de retenção para a marca é exibido como Never. Os usuários podem aplicar essa marca a itens que desejam que nunca sejam excluídos ou que não sejam movidos para o arquivo. Permitir a marca mais tarde pode resultar na exclusão acidental ou no arquivamento de itens. Para evitar essa situação, se uma política de retenção estiver desabilitada temporariamente, talvez seja aconselhável alterar o nome dessa marca para que os usuários sejam desencorajados de usá-la, como DESABILITAda _ <Original Name> .

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-RetentionId

O parâmetro RetentionId especifica uma ID de marca alternativa para garantir que a marca de retenção encontrada em itens de caixa de correio marcadas em uma organização do Exchange corresponda à marca quando a caixa de correio for movida para outra organização do Exchange (por exemplo, em uma implantação entre florestas ou em uma implantação entre instalações, quando uma caixa de correio é movida de um servidor local do Exchange para a nuvem, ou uma caixa de correio baseada em nuvem é movida para um servidor Exchange local).

Ele não é normalmente solicitado a especificar ou modificar o parâmetro RetentionId para uma marca de retenção. O parâmetro é preenchido automaticamente ao <scriptname> importar marcas de retenção em uma implantação entre florestas ou entre instalações.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-SystemTag

O parâmetro SystemTag especifica se a marca de política de retenção é criada para funcionalidade interna do Exchange.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Inputs

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.

Outputs

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.