Set-RetentionPolicy
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.
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.
Sintaxe
Default (Default)
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 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-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 Identidade é posicional, o que significa que pode utilizá-lo sem a etiqueta -Identity na localização suportada no comando (neste caso, primeiro). Para obter mais informações sobre os parâmetros posicionais, veja About Parameters (Acerca dos Parâmetros).
Parâmetros
-Confirm
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
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 |
-DomainController
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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 |
-Force
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O comutador Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.
Utilize este comutador para ocultar o pedido de confirmação quando utilizar o parâmetro RetentionId.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
O parâmetro Identity especifica o nome, o DN ou a GUID da diretiva de retenção.
Propriedades do parâmetro
| Tipo: | MailboxPolicyIdParameter |
| 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 |
-IsDefault
Aplicável: Exchange Online
Esse parâmetro só está disponível no serviço baseado em nuvem.
O comutador IsDefault especifica que esta política de retenção é a política de retenção predefinida. Não é preciso especificar um valor com essa opção.
Quando utiliza este comutador, recebe um aviso de que esta política de retenção substitui a política de retenção predefinida atual (a política em que o valor da propriedade IsDefault é atualmente Verdadeiro) como predefinição. Por predefinição, a política de retenção predefinida é denominada Política MRM Predefinida.
Nota: alterar a política de retenção predefinida pode ou não afetar as 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 às quais a política de retenção é predefinida são continuamente refletidas em caixas de correio novas e existentes.
- É especificada uma política de retenção: 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 predefinida para a organização. Caso contrário, a experiência poderá ser inconsistente ao criar novas caixas de correio, ativar caixas de correio desativadas e alterar licenças. Para obter mais informações, consulte Planos de caixa de correio no Exchange Online.
Se for atribuída uma política de retenção do Exchange a uma caixa de correio que não seja a política predefinida, o valor RetentionPolicy da caixa de correio é substituído ao alterar as licenças. Tem de repor manualmente a RetentionPolicy para o valor original.
As alterações à política de retenção predefinida que afetam as caixas de correio existentes podem potencialmente saturar a rede se existirem centenas ou milhares de caixas de correio que necessitem de atualizações.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| 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 |
-IsDefaultArbitrationMailbox
Aplicável: Exchange Online
Esse parâmetro só está disponível no serviço baseado em nuvem.
O comutador IsDefaultArbitrationMailbox configura esta política como a política de retenção predefinida para caixas de correio de arbitragem na 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro Name especifica um nome exclusivo para a diretiva de retenção.
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 |
-RetentionId
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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 continuam a ter a mesma política de retenção aplicada às mesmas. Por exemplo, numa implementação entre florestas ou numa implementação em vários locais, quando uma caixa de correio é movida de um servidor Exchange no local para a nuvem ou uma caixa de correio baseada na nuvem é movida para um servidor Exchange no local, este parâmetro é utilizado para garantir que a mesma política de retenção é 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.
Propriedades do parâmetro
| Tipo: | Guid |
| 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 |
-RetentionPolicyTagLinks
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Propriedades do parâmetro
| Tipo: | RetentionPolicyTagIdParameter[] |
| 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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
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.
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.