New-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 New-RetentionPolicyTag para criar 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.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
New-RetentionPolicyTag
[-Name] <String>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefaultAutoGroupPolicyTag]
[-IsDefaultModeratedRecipientsPolicyTag]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-Type <ElcFolderType>]
[-WhatIf]
[<CommonParameters>] New-RetentionPolicyTag
[-Name] <String>
[-ManagedFolderToUpgrade <ELCFolderIdParameter>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefaultAutoGroupPolicyTag]
[-IsDefaultModeratedRecipientsPolicyTag]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-SystemTag <Boolean>]
[-Type <ElcFolderType>]
[-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.
As marcas de retenção têm suporte à exibição do nome da marca e a um comentário opcional em idiomas localizados. Os códigos de cultura de idiomas da classe CultureInfo são usados para esse fim.
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
New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDeleteEste exemplo cria a marca de diretiva de retenção Finance-DeletedItems para a pasta padrão Itens Excluídos. Quando aplicada a uma caixa de correio como parte de uma diretiva de retenção, a marca exclui permanentemente itens de todos os tipos na pasta Itens Excluídos em 30 dias.
Exemplo 2
New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDeleteEste exemplo cria a marca de diretiva padrão Finance-Default. Quando aplicada a uma caixa de correio como parte de uma diretiva de retenção, a marca exclui permanentemente todos os itens sem uma marca de retenção em 365 dias. Os itens de uma classe de mensagens em particular, como Caixa Postal, para a qual existe uma marca padrão (uma marca de retenção de tipo All), não são afetados.
Exemplo 3
New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDeleteEste exemplo cria a marca de retenção Business Critical de tipo Personal. Quando aplicada a itens de caixa de correio de uma diretiva de retenção, os itens são excluídos definitivamente em aproximadamente 7 anos.
Parâmetros
-AddressForJournaling
Esse parâmetro só está disponível no Exchange Server 2010.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | RecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Comment
O parâmetro Comment especifica um comentário para a marca.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, 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 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IsDefaultAutoGroupPolicyTag
Esse parâmetro só está disponível no serviço baseado em nuvem.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-IsDefaultModeratedRecipientsPolicyTag
Esse parâmetro só está disponível no serviço baseado em nuvem.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-JournalingEnabled
Esse parâmetro só está disponível no Exchange Server 2010.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LabelForJournaling
Esse parâmetro só está disponível no Exchange Server 2010.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LocalizedComment
O parâmetro LocalizedComment especifica comentários localizados e seus idiomas. Quando a configuração de idioma do usuário corresponde a um idioma especificado para esse parâmetro, Microsoft Outlook e Outlook na Web exibir o comentário localizado correspondente. Os comentários são especificados no formato ISO Language Code:Comment, por exemplo, LocalizedComment EN-US:"This is a localized comment in U.S. English".
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 nomes de marcas localizados e seus idiomas. Quando a configuração do idioma do usuário corresponde a um idioma especificado para esse parâmetro, o Outlook e Outlook na Web exibem o nome da marca localizada correspondente. Os nomes são especificados no formato ISO Language Code:Name, por exemplo, LocalizedRetentionPolicyTagName EN-US:"Business Critical".
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ManagedFolderToUpgrade
Este parâmetro está disponível somente no Exchange local.
O parâmetro ManagedFolderToUpgrade especifica o nome de uma pasta gerenciada a ser usada como modelo para uma marca de retenção.
| Type: | ELCFolderIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-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 DPT (marca de política padrão) para caixa postal, o Exchange não dá suporte a marcas de retenção para diferentes tipos de mensagem. São suportadas apenas marcas com MessageClass de *, e se aplicam a todos os tipos de mensagem.
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 se aplica apenas a mensagens de caixa postal do Serviço de Unificação de Mensagens do Microsoft Exchange (identificadas pelo valor de propriedade de MAPI PR_MESSAGE_CLASSIPM.Note.Microsoft.Voicemail*).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 só está disponível no Exchange Server 2010.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | JournalingFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| 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 para a 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 do usuário. Você pode usar essa ação para marcas de retenção do tipo Todos, Pessoal e RecoverableItems.
- PermanentementeDelete: 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). 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 |
| Required: | False |
| 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 definida como $false, a marca será desabilitada e nenhuma ação de retenção é tomada em mensagens que possuam a marca aplicada.
As mensagens com uma marca desabilitada ainda são consideradas marcadas, portanto, todas as marcas do mesmo tipo que a marca desabilitada na política de retenção do usuário não são aplicadas 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 for desabilitada temporariamente, talvez seja recomendável alterar o nome dessa marca para que os usuários sejam desencorajados a usá-la, como DISABLED_<Original Name>.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 marcados em uma implantação local corresponda à marca quando a caixa de correio é movida para a nuvem ou os itens de caixa de correio marcados na nuvem correspondem à marca quando a caixa de correio é movida para um servidor do Exchange local. O parâmetro é usado em implantações entre locais. Você não precisa especificá-lo nas implantações somente no local.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 que a marca é criada para a funcionalidade interna do Exchange.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Type
O parâmetro Type especifica o tipo da marca de retenção que está sendo criada. Os valores válidos incluem:
- Todos
- Arquivar
- Calendário
- Desordem: disponível somente em Exchange Online.
- Contatos
- ConversationHistory
- Deleteditems
- Rascunhos
- Caixa de Entrada
- Diário
- JunkEmail
- LegacyArchiveJournals
- ManagedCustomFolder
- Observações
- Caixa de saída
- Personal
- RecoverableItems
- RssSubscriptions
- SentItems
- SyncIssues
- Tarefas
Para criar uma marca de diretiva padrão (DPT), especifique o tipo All. Para as marcas do tipo RecoverableItems, a única ação de retenção válida é MoveToArchive.
| Type: | ElcFolderType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
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.