Get-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 Get-RetentionPolicyTag para recuperar as configurações de uma marca de retenção.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
Get-RetentionPolicyTag
[[-Identity] <RetentionPolicyTagIdParameter>]
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
Get-RetentionPolicyTag
[-Mailbox <MailboxIdParameter>]
[-OptionalInMailbox]
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
Description
Marcas de retenção são usadas para aplicar configurações de retenção de mensagens a mensagens ou pastas. Existem três tipos de marcas de retenção:
- Marcas de diretiva de retenção
- Marcas de diretiva padrão
- Marcas pessoais
As marcas de diretiva de retenção são aplicadas a pastas padrão, como Caixa de Entrada e Itens Excluídos. As marcas pessoais estão disponíveis para usuários, com a finalidade de marcar itens e pastas. A marca de diretiva padrão é aplicada a todos os itens que não têm uma marca aplicada pelo usuário ou não foram herdados pela pasta na qual estão localizados. O cmdlet Get-RetentionPolicyTag exibe todas as configurações da marca especificada.
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
Get-RetentionPolicyTag
Este exemplo retorna todas as marcas de retenção.
Exemplo 2
Get-RetentionPolicyTag -IncludeSystemTags
Este exemplo retorna marcas de sistema, além de marcas pessoais e padrão.
Exemplo 3
Get-RetentionPolicyTag "Consolidated Messenger"
Este exemplo retorna as configurações da marca Consolidated Messenger.
Exemplo 4
Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize
Este exemplo retorna todas as marcas de retenção de Inbox e Todos os tipos e canaliza os resultados para o comando Format-Table para exibir as propriedades Nome, Tipo, RetentionEnabled, AgeLimitForRetention e RetentionAction.
Parâmetros
-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 |
-Identity
O parâmetro Identity especifica o nome da marca.
Type: | RetentionPolicyTagIdParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IncludeSystemTags
A opção IncludeSystemTags especifica se é necessário retornar uma marca de sistema. Não é preciso especificar um valor com essa opção.
Type: | SwitchParameter |
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 |
-Mailbox
O parâmetro Caixa de correio retorna as marcas de retenção atribuídas à política de retenção aplicada à caixa de correio especificada. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Nome diferenciado (DN)
- Domain\username
- Endereço de email
- GUID
- LegacyExchangeDN
- SamAccountName
- ID de usuário ou nome UPN
Esse parâmetro só retorna marcas de política padrão (DPTs) e marcas pessoais; ele não retorna marcas de política de retenção.
Type: | MailboxIdParameter |
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 |
-OptionalInMailbox
O parâmetro OptionalInMailbox é usado com o parâmetro Caixa de Correio para retornar todas as marcas de retenção opt-in atribuídas à caixa de correio especificada. Não é preciso especificar um valor com essa opção.
Uma marca de retenção opt-in é uma marca pessoal que foi explicitamente atribuída à caixa de correio com o comando Set-RetentionPolicyTag -Caixa de correio -OptionalInMailbox.
Type: | SwitchParameter |
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 |
-Types
O parâmetro Types especifica o tipo de marca de retenção a ser retornada. Os valores válidos incluem:
- Calendário
- Contatos
- Deleteditems
- Rascunhos
- Caixa de Entrada
- JunkEmail
- Diário
- Observações
- Caixa de saída
- SentItems
- Tarefas
- Todos
- RssSubscriptions
- ConversationHistory
- Personal
O parâmetro aceita vários valores separados por vírgula.
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 |
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.