New-RetentionComplianceRule

Esse cmdlet está disponível apenas no PowerShell de Conformidade de Segurança & . Para obter mais informações, confira PowerShell de Conformidade de Segurança&.

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.

Syntax

New-RetentionComplianceRule
   -ApplyComplianceTag <String>
   -Policy <PolicyIdParameter>
   [-ContentContainsSensitiveInformation <PswsHashtable[]>]
   [-Confirm]
   [-ContentMatchQuery <String>]
   [-ExpirationDateOption <String>]
   [-MachineLearningModelIDs <MultiValuedProperty>]
   [-RetentionComplianceAction <String>]
   [-WhatIf]
   [<CommonParameters>]
New-RetentionComplianceRule
   [-Name] <String>
   -Policy <PolicyIdParameter>
   [-Comment <String>]
   [-ExcludedItemClasses <MultiValuedProperty>]
   [-RetentionDuration <Unlimited>]
   [-RetentionDurationDisplayHint <HoldDurationHint>]
   [-Confirm]
   [-ContentMatchQuery <String>]
   [-ExpirationDateOption <String>]
   [-RetentionComplianceAction <String>]
   [-WhatIf]
   [<CommonParameters>]
New-RetentionComplianceRule
   -Policy <PolicyIdParameter>
   -PublishComplianceTag <String>
   [-Confirm]
   [-ExpirationDateOption <String>]
   [-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 Política. Somente uma regra pode ser adicionada a cada política de retenção.

Para usar esse cmdlet no PowerShell de Conformidade de Segurança & , 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

Este exemplo cria uma nova regra de retenção de casos chamada InternalCompanyRule e a adiciona à política de retenção de casos existente chamada "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 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 será mantido por um ano a partir do dia em que o conteúdo foi modificado pela última vez antes de ser excluído.

Parâmetros

-ApplyComplianceTag

O parâmetro ApplyComplianceTag especifica o rótulo aplicado a mensagens de email ou documentos pela regra (que afeta 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ê exibe e cria rótulos usando os cmdlets Get-ComplianceTag e New-ComplianceTag.

Você não pode usar esse parâmetro com os parâmetros Nome ou PublishComplianceTag.

Você não pode usar esse parâmetro para regras de retenção do Teams.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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”.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, cmdlets 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.
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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 contém o tipo de informações confidenciais especificado.

Esse parâmetro usa a sintaxe @(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)básica . 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 para sua organização. Para obter mais informações sobre tipos de informações confidenciais, consulte Quais tipos de informações confidenciais no Exchange procuram.

Você pode usar esse parâmetro com o parâmetro ApplyComplianceTag.

Você não pode usar esse parâmetro para regras de retenção do Teams.

Type:PswsHashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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, consulte Referência de sintaxe KQL (Linguagem de Consulta de Palavra-Chave) e consultas de palavra-chave e condições de pesquisa para descoberta eletrônica.

Você não pode usar esse parâmetro para regras de retenção do Teams.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ExcludedItemClasses

O parâmetro ExcludeedItemClasses especifica os tipos de mensagens a serem excluídas da regra. Você pode usar esse parâmetro apenas para excluir itens de uma política de retenção, que exclui a classe de item especificada de ser mantida. O uso desse parâmetro não excluirá itens das políticas de exclusão. Normalmente, você usa esse parâmetro para excluir mensagens de caixa postal, conversas de IM e outros Skype for Business conteúdo online de ser mantido por uma política de espera. Os valores comuns de Skype for Business incluem:

  • IPM. Nota. Microsoft. Conversa
  • IPM. Nota. Microsoft. Conversation.Voice
  • IPM. Nota. Microsoft. Perdeu
  • IPM. Nota. Microsoft. Missed.Voice
  • IPM. Nota. Microsoft. Voicemail
  • IPM. Nota. Microsoft.VoiceMessage.UA
  • IPM. Nota. Microsoft. Voicemail.UM
  • IPM. Nota. Microsoft.Voicemail.UM.CA

Além disso, você pode especificar classes de mensagens para itens do Exchange e classes de mensagens personalizadas ou de terceiros. Observe que 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".

Você não pode usar esse parâmetro para regras de retenção do Teams.

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ExpirationDateOption

O parâmetro ExpirationDateOption especifica se a data de validade é calculada a partir da data de criação do conteúdo ou da última data de modificação. Os valores válidos são:

  • CreationAgeInDays
  • ModificationAgeInDays

Você não pode usar esse parâmetro para regras de retenção do Teams.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-MachineLearningModelIDs

Esse parâmetro está reservado para uso interno da Microsoft.

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Name

O parâmetro Name especifica um nome exclusivo para a regra de retenção. Se o valor contiver espaços, coloque-o entre aspas.

Você não pode usar esse parâmetro com os parâmetros ApplyComplianceTag ou PublishComplianceTag.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Policy

O parâmetro Policy especifica a política para conter a regra.

Type:PolicyIdParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-PublishComplianceTag

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ê exibe e cria 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 Nome ou ApplyComplianceTag.
  • Para regras de retenção do Teams.
  • Com políticas de anexo de nuvem.
Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionComplianceAction

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".

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDuration

O parâmetro RetentionDuration especifica a duração de retenção da 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.
Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDurationDisplayHint

O parâmetro RetentionDurationDisplayHint especifica as unidades usadas para exibir 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 esse parâmetro for definido como o valor Anos 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.

Você não pode usar esse parâmetro para regras de retenção do Teams.

Type:HoldDurationHint
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

A opção WhatIf não funciona no PowerShell de Conformidade de Segurança & .

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance