New-RetentionComplianceRule
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-RetentionComplianceRule para criar novas regras de retenção no portal de conformidade do Microsoft Purview.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-IRMRiskyUserProfiles <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>] New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>] New-RetentionComplianceRule
-Policy <PolicyIdParameter>
-PublishComplianceTag <String>
[-Confirm]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>] Description
A regra de retenção tem de ser adicionada a uma política de retenção existente com o parâmetro Política. Só é possível adicionar uma regra a cada política de retenção.
Para usar este cmdlet no PowerShell de Segurança e Conformidade, você precisa receber permissões. Para obter mais informações, confira Permissões no portal de conformidade do Microsoft Purview.
Exemplos
Exemplo 1
New-RetentionComplianceRule -Name InternalCompanyRule -Policy "Internal Company Policy" -RetentionDuration UnlimitedEste exemplo cria uma nova regra de retenção de casos denominada InternalCompanyRule e adiciona-a à política de suspensão de casos existente denominada "Política Interna da Empresa". O conteúdo será mantido indefinidamente.
Exemplo 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDaysEste exemplo cria uma nova regra de retenção denominada SeptOneYear e adiciona-a à política de retenção existente denominada "Política Interna da Empresa". O conteúdo será mantido durante um ano a partir do dia em que o conteúdo foi modificado pela última vez antes de ser eliminado.
Parâmetros
-ApplyComplianceTag
O parâmetro ApplyComplianceTag especifica a etiqueta que é aplicada às mensagens de e-mail ou aos documentos pela regra (que afeta a duração da retenção do conteúdo). Um valor válido para este parâmetro é o nome de uma etiqueta existente. Se o valor contiver espaços, coloque-o entre aspas.
Pode ver e criar etiquetas com os cmdlets Get-ComplianceTag e New-ComplianceTag.
Não pode utilizar este parâmetro com os parâmetros Name ou PublishComplianceTag.
Não pode utilizar este parâmetro para regras de retenção do Teams.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| 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 |
-ContentContainsSensitiveInformation
O parâmetro ContentContainsSensitiveInformation especifica uma condição para a regra baseada em uma correspondência de tipo de informação confidencial no conteúdo. A regra é aplicada ao conteúdo que apresenta o tipo de informação confidencial especificado.
Esse parâmetro usa a sintaxe básica @(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...). Por exemplo, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}).
Use o cmdlet Get-DlpSensitiveInformationType para listar os tipos de informações confidenciais da sua organização no UCC_2nd. Para obter mais informações sobre os tipos de informações confidenciais, confira O que os tipos de informações confidenciais procuram.
Pode utilizar este parâmetro com o parâmetro ApplyComplianceTag.
Não pode utilizar este parâmetro para regras de retenção do Teams.
| 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 |
-ContentMatchQuery
O parâmetro ContentMatchQuery especifica um filtro de pesquisa de conteúdo.
Este parâmetro usa a cadeia de caracteres de pesquisa de texto ou uma consulta formatada através do uso da linguagem de consulta de palavra-chave (KQL). Para obter mais informações, veja Referência da sintaxe da Linguagem de Consulta de Palavras-chave (KQL) e Consultas de palavras-chave e condições de pesquisa para Deteção de Dados Eletrónicos.
Não pode utilizar este parâmetro para regras de retenção do Teams.
| 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 |
-ExcludedItemClasses
O parâmetro ExcludedItemClasses especifica os tipos de mensagens a excluir da regra. Só pode utilizar este parâmetro para excluir itens de uma política de suspensão, o que exclui a classe de item especificada de ser mantida. A utilização deste parâmetro não excluirá itens das políticas de eliminação. Normalmente, utiliza este parâmetro para excluir mensagens de voicemail, conversações de MI e outros Skype for Business conteúdo Online de serem mantidos por uma política de suspensão. Os valores de Skype for Business comuns incluem:
- O IPM. Note.Microsoft.Conversation
- O IPM. Note.Microsoft.Conversation.Voice
- O IPM. Note.Microsoft.Missed
- O IPM. Note.Microsoft.Missed.Voice
- O IPM. Note.Microsoft.Voicemail
- IPM.Note.Microsoft.VoiceMessage.UA
- O IPM. Note.Microsoft.Voicemail.UM
- IPM.Note.Microsoft.Voicemail.UM.CA
Além disso, pode especificar classes de mensagens para itens do Exchange e classes de mensagens personalizadas ou de terceiros. Tenha em atenção que os valores que especificar não são validados, pelo que o parâmetro aceita qualquer valor de texto.
Pode especificar vários valores de classe de itens com a seguinte sintaxe: "Value1","Value2",..."ValueN".
Não pode utilizar este parâmetro para regras de retenção do Teams.
| 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 |
-ExpirationDateOption
O parâmetro ExpirationDateOption especifica se a data de expiração é calculada a partir da data de criação do conteúdo ou da data da última modificação. Os valores válidos são:
- CreationAgeInDays
- ModificationAgeInDays
Não pode utilizar este parâmetro para regras de retenção do Teams.
| 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 |
-IRMRiskyUserProfiles
{{ Preenchimento IRMRiskyUserProfiles Descrição }}
| 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 |
-MachineLearningModelIDs
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 |
-Name
O parâmetro Nome especifica um nome exclusivo para a regra de retenção. Se o valor contiver espaços, coloque-o entre aspas.
Não pode utilizar este parâmetro com os parâmetros ApplyComplianceTag ou PublishComplianceTag.
| 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 |
-Policy
O parâmetro Policy especifica a política para conter a regra.
| Tipo: | PolicyIdParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| 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 |
-PublishComplianceTag
O parâmetro PublishComplianceTag especifica a etiqueta publicada para a regra, o que torna a etiqueta visível para os utilizadores nas aplicações (por exemplo, Outlook, SharePoint e OneDrive). Um valor válido para este parâmetro é o nome de uma etiqueta existente. Se o valor contiver espaços, coloque-o entre aspas.
Pode ver e criar etiquetas com os cmdlets Get-ComplianceTag e New-ComplianceTag.
Não pode utilizar este parâmetro nos seguintes cenários:
- Com os parâmetros Name ou ApplyComplianceTag.
- Para regras de retenção do Teams.
- Com políticas de anexo na cloud.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Security & Compliance |
-RetentionComplianceAction
O parâmetro RetentionComplianceAction especifica a ação de retenção da regra. Os valores válidos são:
- Excluir
- Manter
- KeepAndDelete
Se não utilizar este parâmetro, a política de retenção é criada como uma política "UniH" em vez de uma política "mbx".
| 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 |
-RetentionDuration
O parâmetro RetentionDuration especifica a duração da retenção para a regra de retenção. Os valores válidos são:
- Um número inteiro: a duração da suspensão em dias.
- Ilimitado: o conteúdo é mantido indefinidamente.
| Tipo: | Unlimited |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Security & Compliance |
-RetentionDurationDisplayHint
O parâmetro RetentionDurationDisplayHint especifica as unidades utilizadas para apresentar a duração da retenção no portal de conformidade do Microsoft Purview. Os valores válidos são:
- Dias
- Meses
- Anos
Por exemplo, se este parâmetro estiver definido como o valor Anos e o parâmetro RetentionDuration estiver definido como o valor 365, o portal de conformidade do Microsoft Purview apresentará 1 ano como a duração da suspensão do conteúdo.
Não pode utilizar este parâmetro para regras de retenção do Teams.
| Tipo: | HoldDurationHint |
| 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 |