New-RetentionCompliancePolicy
Este cmdlet está disponível apenas no PowerShell de Segurança e Conformidade. Para obter mais informações, consulte PowerShell de Segurança e Conformidade..
Utilize o cmdlet New-RetentionCompliancePolicy para criar novas políticas de retenção e novas políticas de etiquetas de retenção no portal de conformidade do Microsoft Purview. A criação de uma nova política também requer a utilização do cmdlet New-RetentionComplianceRule.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
New-RetentionCompliancePolicy
[-Name] <String>
[-Applications <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-ExchangeLocation <MultiValuedProperty>]
[-ExchangeLocationException <MultiValuedProperty>]
[-Force]
[-IsSimulation]
[-ModernGroupLocation <MultiValuedProperty>]
[-ModernGroupLocationException <MultiValuedProperty>]
[-OneDriveLocation <MultiValuedProperty>]
[-OneDriveLocationException <MultiValuedProperty>]
[-PolicyRBACScopes <MultiValuedProperty>]
[-PolicyTemplateInfo <PswsHashtable>]
[-PriorityCleanup]
[-PublicFolderLocation <MultiValuedProperty>]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SharePointLocation <MultiValuedProperty>]
[-SharePointLocationException <MultiValuedProperty>]
[-SkipPriorityCleanupConfirmation]
[-SkypeLocation <MultiValuedProperty>]
[-SkypeLocationException <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
New-RetentionCompliancePolicy
[-Name] <String>
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-IsSimulation]
[-PriorityCleanup]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SkipPriorityCleanupConfirmation]
[-TeamsChannelLocation <MultiValuedProperty>]
[-TeamsChannelLocationException <MultiValuedProperty>]
[-TeamsChatLocation <MultiValuedProperty>]
[-TeamsChatLocationException <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
New-RetentionCompliancePolicy
[-Name] <String>
-AdaptiveScopeLocation <MultiValuedProperty>
[-Applications <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-IsSimulation]
[-PriorityCleanup]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SkipPriorityCleanupConfirmation]
[-WhatIf]
[<CommonParameters>]
Description
As políticas não são válidas até que seja adicionada uma regra (para políticas de retenção) ou uma etiqueta (para políticas de etiqueta de retenção). Para obter mais informações, veja New-RetentionComplianceRule. Além disso, tem de ser definido pelo menos um parâmetro de localização para criar uma política de retenção ou uma política de etiqueta de retenção.
Para usar este cmdlet no PowerShell de Segurança e Conformidade, você precisa receber permissões. Para obter mais informações, consulte [Permissões no portal de conformidade do Microsoft Purview]/purview/microsoft-365-compliance-center-permissions).
Exemplos
Exemplo 1
New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance"
Este exemplo cria uma política de retenção denominada "Conformidade do Regulamento 123" para as caixas de correio de Kitty Petersen e Scott Nakamura e o site financeiro do SharePoint Online.
O próximo passo consiste em utilizar o cmdlet New-RetentionComplianceRule para adicionar uma regra à política de retenção.
Exemplo 2
New-RetentionCompliancePolicy -Name "Marketing Department" -Enabled $true -SharePointLocation https://contoso.sharepoint.com -RetainCloudAttachment $true -Comment "Regulatory compliance for Marketing Dept."
Este exemplo cria uma nova política de etiquetas de aplicação automática direcionada para anexos na nuvem denominado Departamento de Marketing com os detalhes especificados.
O passo seguinte consiste em utilizar o cmdlet New-RetentionComplianceRule para adicionar uma etiqueta de retenção à política de etiqueta de retenção.
Parâmetros
-AdaptiveScopeLocation
O parâmetro AdaptiveScopeLocation especifica a localização do âmbito adaptável a incluir na política. Pode criar âmbitos ajustáveis com o cmdlet New-AdaptiveScope. Pode utilizar qualquer valor que identifique exclusivamente o âmbito adaptável. Por exemplo:
- Nome
- DN (nome diferenciado)
- GUID
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-Applications
O parâmetro Aplicações especifica o destino quando Grupos do Microsoft 365 são incluídos na política (o parâmetro ModernGroups está definido). Os valores válidos são:
-
Group:Exchange
para a caixa de correio que está ligada ao Grupo do Microsoft 365. -
Group:SharePoint
para o site do SharePoint que está ligado ao Grupo do Microsoft 365. -
"Group:Exchange,SharePoint"
tanto para a caixa de correio como para o site do SharePoint que estão ligados ao Grupo do Microsoft 365. - blank (
$null
): este é o valor predefinido e é funcionalmente equivalente ao valor"Group:Exchange,SharePoint"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-Comment
O parâmetro Comment especifica um comentário opcional. Se você especificar um valor que contenha espaços, coloque-o entre aspas ("), por exemplo: “Está é uma observação de administrador”.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-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, 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.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-Enabled
O parâmetro Enabled especifica se a política está habilitada ou desabilitada. Os valores válidos são:
- $true: a política está ativada. Esse é o valor padrão.
- $true: a política está habilitada. Esse é o valor padrão.
Tipo: | Boolean |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-ExchangeLocation
O parâmetro ExchangeLocation especifica as caixas de correio a incluir na política. Os valores válidos são:
- O parâmetro ExchangeLocation especifica as caixas de correio que devem ser incluídas na política. Os valores válidos são:
- Uma caixa de correio
- O valor Tudo para todas as caixas de correio. Você só pode usar esse valor sozinho.
O valor All para todas as caixas de correio. Você só pode usar esse valor sozinho.
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Se nenhuma caixa de correio for especificada, nenhuma caixa de correio será colocada em espera.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-ExchangeLocationException
O parâmetro ExchangeLocationException especifica as caixas de correio a excluir da política quando utiliza o valor Tudo para o parâmetro ExchangeLocation. Os valores válidos são:
- Este parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:
- Uma caixa de correio
O valor All para todas as caixas de correio. Você só pode usar esse valor sozinho.
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-Force
O comutador Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.
Você pode usar essa opção para executar tarefas de modo programático onde a solicitação por entrada administrativa é inadequada.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-IsSimulation
O comutador IsSimulation especifica que a política é criada no modo de simulação. Não é preciso especificar um valor com essa opção.
Para obter mais informações sobre o modo de simulação, consulte Saiba sobre o modo de simulação.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-ModernGroupLocation
O parâmetro ModernGroupLocation especifica o Grupos do Microsoft 365 a incluir na política. Os valores válidos são:
- Um Grupo do Microsoft 365
- O valor Tudo para todos os Grupos do Microsoft 365. Você só pode usar esse valor sozinho.
Para identificar o Grupo do Microsoft 365, pode utilizar qualquer valor que o identifique exclusivamente. Por exemplo:
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-ModernGroupLocationException
O parâmetro ModernGroupLocationException especifica o Grupos do Microsoft 365 a excluir da política quando utiliza o valor All para o parâmetro ModernGroupLocation.
Pode utilizar qualquer valor que identifique exclusivamente o Grupo do Microsoft 365. Por exemplo:
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-Name
O parâmetro Name especifica o nome exclusivo da política de retenção. Se o valor contiver espaços, coloque-o entre aspas.
Tipo: | String |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-OneDriveLocation
O parâmetro OneDriveLocation especifica o OneDrive for Business sites a incluir. Identifique o site pelo respectivo valor de URL ou use o valor All para incluir todos os sites.
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-OneDriveLocationException
Este parâmetro especifica o OneDrive for Business sites a excluir quando utiliza o valor Tudo para o parâmetro OneDriveLocation. Você pode identificar o site pelo valor da URL.
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-PolicyRBACScopes
O parâmetro PolicyRBACScopes especifica as unidades administrativas a atribuir à política. Um valor válido é o Microsoft Entra ObjectID (valor GUID) da unidade administrativa. Vários valores, separados por vírgulas, podem ser especificados.
As unidades administrativas só estão disponíveis no Microsoft Entra ID P1 ou P2. Pode criar e gerir unidades administrativas no Microsoft Graph PowerShell.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-PolicyTemplateInfo
Esse parâmetro está reservado para uso interno da Microsoft.
Tipo: | PswsHashtable |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-PriorityCleanup
{{ Prioridade de PreenchimentoDesução do Preenchimento }}
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-PublicFolderLocation
O parâmetro PublicFolderLocation especifica que você deseja incluir todas as pastas públicas na política de retenção. Use o valor All para esse parâmetro.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-RestrictiveRetention
O parâmetro RestrictiveRetention especifica se o Bloqueio de Preservação está ativado para a política. Os valores válidos são:
- $true: O Bloqueio de Preservação está ativado para a política. Ninguém, incluindo um administrador, pode desativar a política ou torná-la menos restritiva.
- $false: O Bloqueio de Preservação não está ativado para a política. Esse é o valor padrão.
Após o bloqueio de uma política, ninguém poderá desativá-la, desabilitá-la nem remover conteúdo dela. Além disso, não é possível modificar ou eliminar conteúdos sujeitos à política durante o período de retenção. As únicas formas possíveis de modificar a política de retenção são adicionando conteúdo a ela ou ampliando sua duração. Uma política bloqueada pode ser aumentada ou expandida, mas não pode ser reduzida, desativada ou desativada.
Portanto, antes de bloquear uma política de retenção, é fundamental que compreenda os requisitos de conformidade da sua organização e que não bloqueie uma política até ter a certeza de que é o que precisa.
Tipo: | Boolean |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-RetainCloudAttachment
Nota: este parâmetro está atualmente em Pré-visualização, não está disponível em todas as organizações e está sujeito a alterações.
O parâmetro RetainCloudAttachment especifica que se trata de uma política de anexos na cloud. Os valores válidos são:
- $true: a política é uma política de anexos na cloud.
- $false: a política não é uma política de anexos na cloud. Esse é o valor padrão.
Para o valor $true, só pode utilizar os seguintes parâmetros de localização:
- SharePointLocation e SharePointLocationException
- OneDriveLocation e OneDriveLocationException
- ModernGroupLocation e ModernGroupLocationException
Uma etiqueta que utiliza uma política de anexos na cloud para criar uma regra pode ser uma etiqueta de registo ou uma etiqueta regulamentar. Não pode utilizar uma etiqueta de publicação para uma política de anexos na cloud para criar uma regra; só são suportadas etiquetas de aplicação.
O parâmetro RetainCloudAttachment não está disponível no cmdlet Set-RetentionCompliancePolicy.
Tipo: | Boolean |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-SharePointLocation
O parâmetro SharePointLocation especifica os sites do SharePoint Online a incluir. Identifique o site pelo respectivo valor de URL ou use o valor All para incluir todos os sites.
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Os sites do SharePoint Online não podem ser adicionados à política até serem indexados. Se nenhum site for especificado, nenhum site será colocado em espera.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-SharePointLocationException
Este parâmetro especifica os sites do SharePoint Online a excluir quando utiliza o valor Tudo para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-SkipPriorityCleanupConfirmation
{{ Fill SkipPriorityCleanupConfirmation Description }}
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-SkypeLocation
O parâmetro SkypeLocation especifica o Skype for Business utilizadores online a incluir na política.
É possível usar qualquer valor que identifique o usuário com exclusividade. Por exemplo:
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-SkypeLocationException
Esse parâmetro está reservado para uso interno da Microsoft.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-TeamsChannelLocation
O parâmetro TeamsChannelLocation especifica o Teams a incluir na política.
Pode utilizar qualquer valor que identifique exclusivamente a equipa. Por exemplo:
- Nome
- Endereço de email
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-TeamsChannelLocationException
O parâmetro TeamsChannelLocationException especifica o Teams a excluir quando utiliza o valor Tudo para o parâmetro TeamsChannelLocation. Pode utilizar qualquer valor que identifique exclusivamente a equipa. Por exemplo:
- Nome
- Endereço de email
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-TeamsChatLocation
O parâmetro TeamsChatLocation especifica os utilizadores do Teams a incluir na política.
É possível usar qualquer valor que identifique o usuário com exclusividade. Por exemplo:
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-TeamsChatLocationException
O parâmetro TeamsChatLocationException especifica os utilizadores do Teams a excluir quando utiliza o valor Tudo para o parâmetro TeamsChatLocation. É possível usar qualquer valor que identifique o usuário com exclusividade. Por exemplo:
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN"
.
Tipo: | MultiValuedProperty |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |
-WhatIf
A opção WhatIf não funciona no PowerShell de Segurança e Conformidade.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Security & Compliance |