New-ComplianceTag

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

Sintaxe

Default

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

PriorityCleanup

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

Parâmetros

-AutoApprovalPeriod

Aplicável: Segurança & Conformidade

{{ Preencher descrição do período de aprovação automática }}

Propriedades do parâmetro

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

-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

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ComplianceTagForNextStage

Aplicável: Segurança & Conformidade

{{ Fill ComplianceTagForNextStage Description }}

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

-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

-EventType

Aplicável: Segurança & Conformidade

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.

Propriedades do parâmetro

Tipo:ComplianceRuleIdParameter
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

-FilePlanProperty

Aplicável: Segurança & Conformidade

O parâmetro FilePlanProperty especifica as propriedades do plano de arquivo a serem incluídas no rótulo. Para visualizar os nomes de propriedade do plano de arquivo que você precisa usar nesse 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 esse 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 esse parâmetro.

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

-FlowId

Aplicável: Segurança & Conformidade

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 no portal do Power Automate. O valor GUID do fluxo está na URL.
  • Use a ação do Power Automate chamada 'Listar fluxos como administrador'.

Propriedades do parâmetro

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

-Force

Aplicável: Segurança & Conformidade

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.

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

-IsRecordLabel

Aplicável: Segurança & Conformidade

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

  • $true: A gravadora é uma gravadora. Quando o rótulo é aplicado ao conteúdo, não é possível removê-lo.
  • $false: A gravadora não é uma gravadora. Esse valor é o padrão.

Propriedades do parâmetro

Tipo:Boolean
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

-IsRecordUnlockedAsDefault

Aplicável: Segurança & Conformidade

{{ Fill IsRecordUnlockedAsDefault Description }}

Propriedades do parâmetro

Tipo:Boolean
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

-MultiStageReviewProperty

Aplicável: Segurança & Conformidade

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.

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

-Name

Aplicável: Segurança & Conformidade

O parâmetro Name especifica um nome exclusivo para o rótulo. Se o valor contiver espaços, coloque-o entre aspas (").

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Notes

Aplicável: Segurança & Conformidade

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

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

-PriorityCleanup

Aplicável: Segurança & Conformidade

{{ Preencher PriorityCleanup Description }}

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

PriorityCleanup
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Regulatory

Aplicável: Segurança & Conformidade

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

Propriedades do parâmetro

Tipo:Boolean
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

-RetentionAction

Aplicável: Segurança & Conformidade

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

  • Excluir
  • Manter
  • KeepAndDelete

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:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
PriorityCleanup
Cargo:Named
Obrigatório:True
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 o número de dias para reter o conteúdo. Os valores válidos são:

  • Um inteiro positivo.
  • O valor unlimited.

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:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
PriorityCleanup
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RetentionType

Aplicável: Segurança & Conformidade

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

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:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
PriorityCleanup
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ReviewerEmail

Aplicável: Segurança & Conformidade

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.

Propriedades do parâmetro

Tipo:

SmtpAddress[]

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

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