Set-RetentionPolicy
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-RetentionPolicy para alterar as propriedades de uma diretiva de retenção existente.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
Set-RetentionPolicy
[-Identity] <MailboxPolicyIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-Name <String>]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>] Description
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
Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"Este exemplo modifica a diretiva MyPolicy para vincular a marca de diretiva de retenção MyRetentionPolicyTag a ela.
O parâmetro Identity é posicional. Os parâmetros posicionais podem ser usados sem o rótulo (Identidade). Para obter mais informações sobre parâmetros posicionais, consulte Sobre Parâmetros.
Parâmetros
-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, Exchange Online Protection |
-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 |
-Force
A opção Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.
Use essa opção para ocultar o prompt de confirmação ao usar o parâmetro RetentionId.
| 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 |
-Identity
O parâmetro Identity especifica o nome, o DN ou a GUID da diretiva de retenção.
| Type: | MailboxPolicyIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-IsDefault
Esse parâmetro só está disponível no serviço baseado em nuvem.
A opção IsDefault especifica que essa política de retenção é a política de retenção padrão. Não é preciso especificar um valor com essa opção.
Ao usar essa opção, você receberá um aviso de que essa política de retenção substituirá a política de retenção padrão atual (a política em que o valor da propriedade IsDefault é atualmente True) como padrão. Por padrão, a política de retenção padrão é chamada de Política de MRM Padrão.
Observação: alterar qual política de retenção é o padrão pode ou não afetar caixas de correio novas e existentes com base no valor do parâmetro RetentionPolicy em todos os planos de caixa de correio:
- $null (em branco): as alterações nas quais a política de retenção é o padrão são continuamente refletidas em caixas de correio novas e existentes.
- Uma política de retenção é especificada: o valor do parâmetro RetentionPolicy para todos os planos de caixa de correio deve ser $null (em branco) ou corresponder à política de retenção do Exchange configurada como a política padrão para a organização. Caso contrário, a experiência pode ser inconsistente ao criar novas caixas de correio, habilitar caixas de correio desabilitadas e alterar licenças. Para obter mais informações, consulte Planos de caixa de correio no Exchange Online.
Se uma caixa de correio receber uma política de retenção do Exchange que não seja a política padrão, o valor RetentionPolicy da caixa de correio será substituído ao alterar licenças e precisará ser redefinido manualmente para o valor original.
Alterações na política de retenção padrão que afetam as caixas de correio existentes podem potencialmente saturar a rede se houver centenas ou milhares de caixas de correio que exigem atualizações.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-IsDefaultArbitrationMailbox
Esse parâmetro só está disponível no serviço baseado em nuvem.
A opção IsDefaultArbitrationMailbox configura essa política como a política de retenção padrão para caixas de correio de arbitragem em sua organização Exchange Online. Não é preciso especificar um valor com essa opção.
Esse parâmetro não está disponível para implantações locais.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Name
O parâmetro Name especifica um nome exclusivo para a diretiva de retenção.
| 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 |
-RetentionId
O parâmetro RetentionId especifica a identidade da política de retenção para garantir que as caixas de correio movidas entre duas organizações do Exchange continuem a ter a mesma política de retenção aplicada a elas. Por exemplo, em uma implantação entre florestas ou em uma implantação entre locais, quando uma caixa de correio é movida de um servidor do Exchange local para a nuvem ou uma caixa de correio baseada em nuvem é movida para um servidor exchange local, esse parâmetro é usado para garantir que a mesma política de retenção seja aplicada à caixa de correio.
Não é normalmente solicitado para especificar ou modificar o parâmetro RetentionId para uma marca de retenção. O parâmetro é preenchido automaticamente ao importar as marcas de retenção usando o script Import-RetentionTags.ps1.
| 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 |
-RetentionPolicyTagLinks
O parâmetro RetentionPolicyTagLinks especifica a identidade das marcas de diretiva de retenção a serem associadas à diretiva de retenção. As caixas de correio que têm uma diretiva de retenção aplicada possuem marcas de retenção vinculadas à diretiva de retenção em questão.
| Type: | RetentionPolicyTagIdParameter[] |
| 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, Exchange Online Protection |
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.