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..
Use 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
ComplianceTag
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-IRMRiskyUserProfiles <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
Default
New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
PublishComplianceTag
New-RetentionComplianceRule
-Policy <PolicyIdParameter>
-PublishComplianceTag <String>
[-Confirm]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
Description
A regra de retenção deve ser adicionada a uma política de retenção existente usando o parâmetro Policy. Somente uma regra pode ser adicionada 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 Unlimited -RetentionComplianceAction Keep
Este exemplo cria uma nova regra de retenção chamada InternalCompanyRule e a adiciona à política de retenção existente chamada "Política Interna da Empresa". O conteúdo é mantido indefinidamente.
Exemplo 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDays
Este exemplo cria uma nova regra de retenção chamada SeptOneYear e a adiciona à política de retenção existente chamada "Política Interna da Empresa". O conteúdo é mantido por um ano a partir do dia em que foi modificado pela última vez antes de ser excluído.
Parâmetros
-ApplyComplianceTag
Aplicável: Segurança & Conformidade
O parâmetro ApplyComplianceTag especifica o rótulo aplicado a mensagens de email ou documentos pela regra (que afeta por quanto tempo o conteúdo é retido). Um valor válido para esse parâmetro é o nome de um rótulo existente. Se o valor contiver espaços, coloque-o entre aspas.
Você pode exibir e criar rótulos usando os cmdlets Get-ComplianceTag e New-ComplianceTag.
Não é possível usar esse parâmetro com os parâmetros Name ou PublishComplianceTag.
Não é possível usar esse parâmetro para regras de retenção do Teams.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComplianceTag
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Comment
Aplicável: Segurança & Conformidade
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”.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Default
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Aplicável: Segurança & Conformidade
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 |
-ContentContainsSensitiveInformation
Aplicável: Segurança & Conformidade
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.
Você pode usar esse parâmetro com o parâmetro ApplyComplianceTag.
Não é possível usar esse parâmetro para regras de retenção do Teams.
Propriedades do parâmetro
| Tipo: | PswsHashtable[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComplianceTag
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ContentMatchQuery
Aplicável: Segurança & Conformidade
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, consulte Referência de sintaxe QL por palavra-chave (KQL) e Consultas de palavra-chave e condições de pesquisa para descoberta eletrônica.
Não é possível usar esse parâmetro para regras de retenção do Teams.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComplianceTag
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
Default
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ExcludedItemClasses
Aplicável: Segurança & Conformidade
O parâmetro ExcludedItemClasses especifica os tipos de mensagens a serem excluídas da regra. Você pode usar esse parâmetro somente para excluir itens de uma política de retenção, o que exclui a classe de item especificada de ser mantida. O uso desse parâmetro não exclui itens das políticas de exclusão. Normalmente, você usa esse parâmetro para excluir mensagens de caixa postal, conversas de mensagens instantâneas e outros conteúdos do Skype for Business Online de serem mantidos por uma política de retenção. Os valores comuns do Skype for Business incluem:
- IPM. Note.Microsoft.Conversation
- IPM. Note.Microsoft.Conversation.Voice
- IPM. Note.Microsoft.Missed
- IPM. Note.Microsoft.Missed.Voice
- IPM. Note.Microsoft.Voicemail
- IPM.Note.Microsoft.VoiceMessage.UA
- IPM. Note.Microsoft.Voicemail.UM
- IPM.Note.Microsoft.Voicemail.UM.CA
Além disso, você pode especificar classes de mensagem para itens do Exchange e classes de mensagens personalizadas ou não Microsoft. Os valores especificados não são validados, portanto, o parâmetro aceita qualquer valor de texto.
Você pode especificar vários valores de classe de item usando a seguinte sintaxe: "Value1","Value2",..."ValueN".
Não é possível usar esse parâmetro para regras de retenção do Teams.
Propriedades do parâmetro
| Tipo: | MultiValuedProperty |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Default
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ExpirationDateOption
Aplicável: Segurança & Conformidade
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 é possível usar esse parâmetro para regras de retenção do Teams.
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 |
-IRMRiskyUserProfiles
Aplicável: Segurança & Conformidade
{{ Preencher IRMRiskyUserProfiles Description }}
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComplianceTag
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-MachineLearningModelIDs
Aplicável: Segurança & Conformidade
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | MultiValuedProperty |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComplianceTag
| 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: Segurança & Conformidade
O parâmetro Name especifica um nome exclusivo para a regra de retenção. Se o valor contiver espaços, coloque-o entre aspas.
Não é possível usar esse parâmetro com os parâmetros ApplyComplianceTag ou PublishComplianceTag.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Default
| Cargo: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Policy
Aplicável: Segurança & Conformidade
O parâmetro Policy especifica a política para conter a regra.
Propriedades do parâmetro
| Tipo: | PolicyIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-PriorityCleanup
Aplicável: Segurança & Conformidade
A opção PriorityCleanup especifica se uma regra deve ser criada associada a uma política de limpeza de prioridade. Não é preciso especificar um valor com essa opção.
As políticas de limpeza prioritária agilizam a exclusão de conteúdo confidencial substituindo quaisquer configurações de retenção existentes ou retenções de Descoberta Eletrônica. Para obter mais informações, consulte Limpeza prioritária.
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 |
-PublishComplianceTag
Aplicável: Segurança & Conformidade
O parâmetro PublishComplianceTag especifica o rótulo publicado para a regra, o que torna o rótulo visível para usuários em aplicativos (por exemplo, Outlook, SharePoint e OneDrive). Um valor válido para esse parâmetro é o nome de um rótulo existente. Se o valor contiver espaços, coloque-o entre aspas.
Você pode exibir e criar rótulos usando os cmdlets Get-ComplianceTag e New-ComplianceTag.
Você não pode usar esse 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 nuvem.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
PublishComplianceTag
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-RetentionComplianceAction
Aplicável: Segurança & Conformidade
O parâmetro RetentionComplianceAction especifica a ação de retenção para a regra. Os valores válidos são:
- Excluir
- Manter
- KeepAndDelete
Se você não usar esse parâmetro, a política de retenção será criada como uma política "UniH" em vez de uma política "mbx". Esse parâmetro é obrigatório para evitar a exclusão não compatível.
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 |
-RetentionDuration
Aplicável: Segurança & Conformidade
O parâmetro RetentionDuration especifica a duração de retenção para a regra de retenção. Os valores válidos são:
- Um inteiro: a duração da retenção em dias.
- Ilimitado: o conteúdo é mantido indefinidamente.
Propriedades do parâmetro
| Tipo: | Unlimited |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Default
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-RetentionDurationDisplayHint
Aplicável: Segurança & Conformidade
O parâmetro RetentionDurationDisplayHint especifica as unidades que são usadas para exibir a duração de retenção no portal de conformidade do Microsoft Purview. Os valores válidos são:
- Dias
- Meses
- Anos
Por exemplo, se esse parâmetro for definido como o valor Years e o parâmetro RetentionDuration for definido como o valor 365, o portal de conformidade do Microsoft Purview exibirá 1 ano como a duração de retenção de conteúdo.
Não é possível usar esse parâmetro para regras de retenção do Teams.
Propriedades do parâmetro
| Tipo: | HoldDurationHint |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Default
| 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: Segurança & Conformidade
A opção WhatIf não funciona no PowerShell de Segurança e Conformidade.
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.