Freigeben über

New-ComplianceTag

  • Referenz
Modul:
ExchangePowerShell
Gilt für::
Security & Compliance

Dieses Cmdlet ist nur im Security & Compliance Center-PowerShell verfügbar. Weitere Informationen finden Sie unter Security & Compliance Center-PowerShell.

Verwenden Sie das Cmdlet New-ComplianceTag, um Aufbewahrungsbezeichnungen im Microsoft Purview-Complianceportal zu erstellen. Aufbewahrungsbezeichnungen wenden Aufbewahrungseinstellungen auf Inhalte an.

Informationen zu den Parametersätzen im Abschnitt zur Syntax weiter unten finden Sie unter Syntax der Exchange-Cmdlets.

Syntax

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

Beschreibung

Um dieses Cmdlet in Security & Compliance PowerShell zu verwenden, müssen Ihnen Berechtigungen zugewiesen werden. Weitere Informationen finden Sie unter Berechtigungen im Microsoft Purview-Complianceportal.

Beispiele

Beispiel 1

New-ComplianceTag -Name "HR Content" -RetentionAction Keep -RetentionDuration 1825 -RetentionType ModificationAgeInDays

In diesem Beispiel wird eine neue Bezeichnung namens „HR Content“ mit den folgenden Einstellungen erstellt:

  • Aktion: Beibehalten.
  • Dauer: 5 Jahre (1825 Tage)
  • Typ: Änderungsalter in Tagen.

Parameter

-AutoApprovalPeriod

{{ Fill AutoApprovalPeriod Description }}

Typ:System.Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-Comment

Der „Comment“-Parameter gibt einen optionalen Kommentar an. Wenn Sie einen Wert angeben, der Leerzeichen enthält, setzen Sie den Wert in Anführungszeichen ("), z. B. "This is an admin note".

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-ComplianceTagForNextStage

{{ Fill ComplianceTagForNextStage Description }}

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-Confirm

Die Option "Confirm" gibt an, ob die Bestätigungsaufforderung angezeigt oder ausgeblendet werden soll. Wie diese Option sich auf das Cmdlet auswirkt, hängt davon ab, ob für die Option vor dem Fortfahren eine Bestätigung erforderlich ist.

  • Destruktive Cmdlets (beispielsweise Remove-*-Cmdlets) verfügen über eine integrierte Pause, die Sie zwingt, den Befehl vor dem Fortfahren zu bestätigen. Für diese Cmdlets können Sie die Bestätigungsaufforderung mit genau dieser Syntax überspringen: -Confirm:$false.
  • Die meisten anderen Cmdlets (beispielsweise New-*- und Set-*-Cmdlets) verfügen nicht über eine integrierte Pause. Bei diesen Cmdlets führt das Angeben der Option "Confirm" ohne einen Wert eine Pause ein, die Sie zwingt, den Befehl vor dem Fortfahren zu bestätigen.
Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-EventType

EventType gibt die Aufbewahrungsregel an, die der Bezeichnung zugeordnet ist. Sie können einen beliebigen Wert verwenden, der die Regel eindeutig identifiziert. Zum Beispiel:

  • Name
  • Distinguished Name (DN)
  • GUID

Mit dem Cmdlet Get-RetentionComplianceRule können Sie die verfügbaren Aufbewahrungsregeln anzeigen.

Typ:ComplianceRuleIdParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-FilePlanProperty

Der Parameter FilePlanProperty gibt die Dateiplaneigenschaften an, die in die Bezeichnung eingeschlossen werden sollen. Führen Sie die folgenden Befehle aus, um die Namen der Dateiplaneigenschaft anzuzeigen, die Sie in diesem Parameter verwenden müssen:

  • 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

Ein gültiger Wert für diesen Parameter umfasst zwei Schritte:

  • Eine Variable zum Speichern der Dateiplaneigenschaften als PSCustomObject mit der folgenden Syntax:

    $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"})}

    Zum Beispiel:

    $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"})}

  • Eine zweite Variable zum Konvertieren des PSCustomObject in ein JSON-Objekt mit der folgenden Syntax:

    $Variable2 = ConvertTo-Json $Variable1

    Zum Beispiel:

    $fpStr = ConvertTo-Json $retentionLabelAction

Sie verwenden die zweite Variable als Wert für diesen Parameter.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-FlowId

Hinweis: Dieser Parameter befindet sich derzeit in der Vorschauphase, ist nicht in allen Organisationen verfügbar und kann geändert werden.

Der FlowId-Parameter gibt den Power Automate-Flow an, der am Ende des Aufbewahrungszeitraums ausgeführt werden soll. Ein gültiger Wert für diesen Parameter ist der GUID-Wert des Flows.

Sie können den GUID-Wert des Flows mithilfe einer der folgenden Methoden ermitteln:

  • Navigieren Sie im Power Automate-Portal zum Flow. Der GUID-Wert des Flows befindet sich in der URL.
  • Verwenden Sie die Power Automate-Aktion namens "Flows als Administrator auflisten".
Typ:System.Guid
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-Force

Der Schalter „Erzwingen“ blendet Warnungs- oder Bestätigungsmeldungen aus. Sie müssen keinen Wert für diese Option angeben.

Sie können diesen Switch verwenden, um Aufgaben in Fällen programmgesteuert auszuführen, in denen die administrative Eingabe unangemessen ist.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-IsRecordLabel

Der Parameter IsRecordLabel gibt an, ob die Bezeichnung eine Datensatzbezeichnung ist. Gültige Werte sind:

  • $true: Die Bezeichnung ist eine Datensatzbezeichnung. Nachdem das Label auf Inhalt angewendet wird, kann es nicht entfernt werden.
  • $false: Die Bezeichnung ist keine Datensatzbezeichnung. Dies ist der Standardwert.
Typ:Boolean
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-IsRecordUnlockedAsDefault

{{ Fill IsRecordUnlockedAsDefault Description }}

Typ:Boolean
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-MultiStageReviewProperty

Der Parameter MultiStageReviewProperty gibt die mehrstufigen Überprüfungseigenschaften an, die in die Bezeichnung eingeschlossen werden sollen. Dieser Parameter verwendet die folgende Syntax:

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

Zum Beispiel:

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

Diese Syntax ist ein JSON-Objekt, das jede Überprüfungsphase-ID, den Namen der Überprüfungsphase und die Liste der Prüfer definiert.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-Name

Der Parameter Name gibt einen eindeutigen Namen für die Bezeichnung an. Wenn der Wert Leerzeichen enthält, setzen Sie ihn in Anführungszeichen (").

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-Notes

Der Notes-Parameter gibt zusätzliche Informationen zum Objekt an. Wenn der Wert Leerzeichen enthält, setzen Sie ihn in Anführungszeichen (").

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-PriorityCleanup

{{ Fill PriorityCleanup Description }}

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-Regulatory

{{ Fill Regulatory Description }}

Typ:Boolean
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-RetentionAction

Der Parameter RetentionAction gibt die Aktion für die Bezeichnung an. Gültige Werte sind:

  • Delete
  • Beibehalten
  • KeepAndDelete
Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-RetentionDuration

Der Parameter RetentionDuration gibt die Anzahl der Tage an, die der Inhalt aubewahrt werden soll. Gültige Werte sind:

  • Positive Ganzzahl.
  • Der Wert unlimited.
Typ:Unlimited
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-RetentionType

Der RetentionType-Parameter gibt an, ob die Aufbewahrungsdauer anhand des Inhaltserstellungsdatums, des markierten Datums oder des Datums der letzten Änderung berechnet wird. Gültige Werte sind:

  • CreationAgeInDays
  • EventAgeInDays
  • ModificationAgeInDays
  • TaggedAgeInDays
Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-ReviewerEmail

Der Parameter ReviewerEmail gibt die E-Mail-Adresse des Bearbeiters für Aufbewahrungsaktionen Delete und KeepAndDelete an. Mehrere E-Mail-Adressen können durch Kommas getrennt angegeben werden.

Typ:SmtpAddress[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance

-WhatIf

Der WhatIf-Schalter funktioniert in Security & Compliance PowerShell nicht.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False
Gilt für::Security & Compliance