New-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 ambiente ou de outro.
Use o cmdlet New-RetentionPolicy para criar uma diretiva de retenção.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Default (Default)
New-RetentionPolicy
[-Name] <String>
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
Description
As marcas de diretiva de retenção são associadas a uma diretiva de retenção. Quando uma diretiva de retenção é aplicada a uma caixa de correio, as marcas associadas à diretiva estarão disponíveis ao usuário da caixa de correio.
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo 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-RetentionPolicy "Business General"
Este exemplo cria a diretiva de retenção Business General sem associar nenhuma marca de diretiva de retenção.
Exemplo 2
New-RetentionPolicy "Business General" -RetentionPolicyTagLinks "General Business","Legal"
Este exemplo cria a diretiva de retenção Business General e usa o parâmetro RetentionPolicyTagLinks para associar duas marcas de diretiva de retenção a essa diretiva. Podem ser inseridas várias marcas de diretiva de retenção, separadas por vírgulas. Se o nome de uma marca incluir espaços, escreva o nome entre aspas.
A segunda marca de retenção, chamada Legal, também foi escrita entre aspas para manter a consistência. Os valores que não incluem espaços podem ser escritos entre aspas sem alterar a forma como o comando é interpretado.
Parâmetros
-Confirm
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer 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 reconhecer 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 |
-IsDefault
Aplicável: Exchange Online
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ê recebe um aviso de que essa política de retenção substitui 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 é denominada Política 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 para as quais a política de retenção é o padrão são refletidas continuamente 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 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 as licenças. Você precisa redefinir manualmente a RetentionPolicy para o valor original.
As alterações na política de retenção padrão que afetam as caixas de correio existentes podem saturar a rede se houver centenas ou milhares de caixas de correio que exijam 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 essa política como a política de retenção padrão para caixas de correio de arbitragem em sua organização do Exchange Online. 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 |
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 o nome da política.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | True |
| 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 de uma implantação local do Exchange para a nuvem continuem a ter a mesma política de retenção aplicada a elas. O parâmetro RetentionId é usado em implantações entre locais. Você não precisa especificá-lo nas implantações somente no local.
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 os nomes das marcas de diretiva de retenção a serem associadas a essa diretiva.
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
A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. 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 dá suporte aos 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.