Compartilhar via

New-ComplianceTag

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

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-ComplianceTag para criar etiquetas de retenção no portal de conformidade do Microsoft Purview. As etiquetas de retenção aplicam definiçõ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.

Sintaxe

New-ComplianceTag
   [-Name] <String>
   [-AutoApprovalPeriod <System.Int32>]
   [-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>]
New-ComplianceTag
   [-Name] <String>
   -RetentionAction <String>
   -RetentionDuration <Unlimited>
   -RetentionType <String>
   -MultiStageReviewProperty <String>
   [-PriorityCleanup]
   [-Comment <String>]
   [-Confirm]
   [-Force]
   [-Notes <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

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-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 da modificação em dias.

Parâmetros

-AutoApprovalPeriod

{{ Fill AutoApprovalPeriod Description }}

Tipo:System.Int32
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

-ComplianceTagForNextStage

{{ Fill ComplianceTagForNextStage Description }}

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

-EventType

O EventType especifica a regra de retenção associada à etiqueta. É 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.

Tipo:ComplianceRuleIdParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False
Aplica-se a:Security & Compliance

-FilePlanProperty

O parâmetro FilePlanProperty especifica as propriedades do plano de ficheiros a incluir na etiqueta. Para ver os nomes de propriedade do plano de ficheiros que precisa de utilizar 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 dois passos:

  • Uma variável para armazenar as propriedades do plano de ficheiros como PSCustomObject com 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 num objeto JSON com a seguinte sintaxe:

    $Variable2 = ConvertTo-Json $Variable1

    Por exemplo:

    $fpStr = ConvertTo-Json $retentionLabelAction

Utilize a segunda variável como o valor para este parâmetro.

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

-FlowId

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 FlowId especifica o fluxo do Power Automate a ser executado no final do período de retenção. Um valor válido para este parâmetro é o valor GUID do fluxo.

Pode encontrar o valor GUID do fluxo através de um dos seguintes métodos:

  • Navegue para o fluxo a partir do portal do Power Automate. O valor GUID do fluxo está no URL.
  • Utilize a ação do Power Automate denominada "Listar fluxos como administrador".
Tipo:System.Guid
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

-IsRecordLabel

O parâmetro IsRecordLabel especifica se a etiqueta é uma etiqueta de registo. Os valores válidos são:

  • $true: a etiqueta é uma etiqueta de registo. Quando o rótulo é aplicado ao conteúdo, não é possível removê-lo.
  • $false: a etiqueta não é uma etiqueta de registo. 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

-IsRecordUnlockedAsDefault

{{ Fill IsRecordUnlockedAsDefault Description }}

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

-MultiStageReviewProperty

O parâmetro MultiStageReviewProperty especifica as propriedades de revisão em várias fases a incluir na etiqueta. 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]},]}'

Esta sintaxe é um objeto JSON que define cada ID da fase de revisão, o nome da fase de revisão e a lista de revisores.

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

-Name

O parâmetro Name especifica um nome exclusivo para o rótulo. 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

-Notes

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

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

-PriorityCleanup

{{ Prioridade de PreenchimentoDesução do Preenchimento }}

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False
Aplica-se a:Security & Compliance

-Regulatory

{{ Descrição Regulamentar de Preenchimento }}

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

-RetentionAction

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

  • Excluir
  • Manter
  • KeepAndDelete
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

-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.
Tipo:Unlimited
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False
Aplica-se a: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 data da última modificação. Os valores válidos são:

  • CreationAgeInDays
  • EventAgeInDays
  • ModificationAgeInDays
  • TaggedAgeInDays
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

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

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