Compartilhar via

New-ComplianceTag

  • Referência
Módulo:
ExchangePowerShell
Aplica-se a:
Security & Compliance

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-ComplianceTag para criar rótulos de retenção no portal de conformidade do Microsoft Purview. Os rótulos de retenção aplicam as configurações de retenção ao conteúdo.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

New-ComplianceTag
   [-Name] <String>
   [-Comment <String>]
   [-ComplianceTagForNextStage <String>]
   [-Confirm]
   [-EventType <ComplianceRuleIdParameter>]
   [-FilePlanProperty <String>]
   [-FlowId <System.Guid>]
   [-Force]
   [-IsRecordLabel <Boolean>]
   [-IsRecordUnlockedAsDefault <Boolean>]
   [-MultiStageReviewProperty <String>]
   [-Notes <String>]
   [-Regulatory <Boolean>]
   [-RetentionAction <String>]
   [-RetentionDuration <Unlimited>]
   [-RetentionType <String>]
   [-ReviewerEmail <SmtpAddress[]>]
   [-WhatIf]
   [<CommonParameters>]

Description

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-ComplianceTag -Name "HR Content" -RetentionAction Keep -RetentionDuration 1825 -RetentionType ModificationAgeInDays

Este exemplo cria um novo rótulo chamado Conteúdo de RH com as seguintes configurações:

  • Ação: Manter.
  • Duração: 5 anos (1825 dias)
  • Tipo: idade de modificação em dias.

Parâmetros

-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

-ComplianceTagForNextStage

{{ Preencher ConformidadeTagForNextStage Description }}

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

-EventType

O EventType especifica a regra de retenção associada ao rótulo. É possível usar qualquer valor que identifique a regra com exclusividade. Por exemplo:

  • Nome
  • DN (nome diferenciado)
  • GUID

Você pode usar o cmdlet Get-RetentionComplianceRule para exibir as regras de retenção disponíveis.

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

-FilePlanProperty

O parâmetro FilePlanProperty especifica as propriedades do plano de arquivo a serem incluídas no rótulo. Para exibir os nomes de propriedades do plano de arquivo que você precisa usar neste parâmetro, execute os seguintes comandos:

  • Get-FilePlanPropertyAuthority | Format-List Name
  • Get-FilePlanPropertyCategory | Format-List Name
  • Get-FilePlanPropertyCitation | Format-List Name
  • Get-FilePlanPropertyDepartment | Format-List Name
  • Get-FilePlanPropertyReferenceId | Format-List Name
  • Get-FilePlanPropertySubCategory | Format-List Name

Um valor válido para este parâmetro envolve duas etapas:

  • Uma variável para armazenar as propriedades do plano de arquivo como um PSCustomObject usando a seguinte sintaxe:

    $Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}

    Por exemplo:

    $retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="ReferenceA"},@{Key="FilePlanPropertyAuthority"; Value="Auth1"})}

  • Uma segunda variável para converter o PSCustomObject em um objeto JSON usando a seguinte sintaxe:

    $Variable2 = ConvertTo-Json $Variable1

    Por exemplo:

    $fpStr = ConvertTo-Json $retentionLabelAction

Você usa a segunda variável como o valor para este parâmetro.

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

-FlowId

Observação: esse parâmetro está atualmente em Versão Prévia, não está disponível em todas as organizações e está sujeito a alterações.

O parâmetro FlowId especifica o fluxo do Power Automate a ser executado no final do período de retenção. Um valor válido para esse parâmetro é o valor GUID do fluxo.

Você pode encontrar o valor GUID do fluxo usando um dos seguintes métodos:

  • Navegue até o fluxo do portal do Power Automate. O valor GUID do fluxo está na URL.
  • Use a ação Do Power Automate chamada 'Fluxos de lista como administrador'.
Type:System.Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Force

A opção 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.

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

-IsRecordLabel

O parâmetro IsRecordLabel especifica se o rótulo é um rótulo de registro. Os valores válidos são:

  • $true: o rótulo é uma gravadora. Quando o rótulo é aplicado ao conteúdo, não é possível removê-lo.
  • $false: a gravadora não é uma gravadora. Esse é o valor padrão.
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-IsRecordUnlockedAsDefault

{{ Preenchimento IsRecordUnlockedAsDefault Description }}

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

-MultiStageReviewProperty

O parâmetro MultiStageReviewProperty especifica as propriedades de revisão de vários estágios a serem incluídas no rótulo. Esse parâmetro aceita a seguinte sintaxe:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'

Por exemplo:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'

Essa sintaxe é um objeto JSON que define cada id do estágio de revisão, o nome do estágio de revisão e a lista de revisores.

Type:String
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 o rótulo. Se o valor contiver espaços, coloque-o entre aspas (").

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

-Notes

O parâmetro Notes especifica informações adicionais sobre o objeto. Se o valor contiver espaços, coloque-o entre aspas (").

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

-Regulatory

{{ Preencher Descrição Regulatória }}

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

-RetentionAction

O parâmetro RetentionAction especifica a ação para o rótulo. Os valores válidos são:

  • Excluir
  • Manter
  • KeepAndDelete
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 o número de dias para reter o conteúdo. Os valores válidos são:

  • Um inteiro positivo.
  • O valor unlimited.
Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionType

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

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

-ReviewerEmail

O parâmetro ReviewerEmail especifica o endereço de email de um revisor para as ações de retenção Delete e KeepAndDelete. Você pode especificar vários endereços de email separados por vírgulas.

Type:SmtpAddress[]
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