Set-RetentionPolicyTag
Dieses Cmdlet ist der lokalen Bereitstellung von Exchange und im cloudbasierten Dienst verfügbar. Einige Parameter und Einstellungen gelten exklusiv für die eine oder andere Umgebung.
Verwenden Sie das Cmdlet Set-RetentionPolicyTag, um die Eigenschaften eines Aufbewahrungstags zu ändern.
Weitere Informationen zu Aufbewahrungstags finden Sie unter Aufbewahrungstags und Aufbewahrungsrichtlinien in Exchange Server.
Informationen zu den Parametersätzen im Abschnitt zur Syntax weiter unten finden Sie unter Syntax der Exchange-Cmdlets.
Syntax
Set-RetentionPolicyTag
[-Identity] <RetentionPolicyTagIdParameter>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] Set-RetentionPolicyTag
-Mailbox <MailboxIdParameter>
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-OptionalInMailbox <RetentionPolicyTagIdParameter[]>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] Beschreibung
Mithilfe von Aufbewahrungstags werden Einstellungen für die Aufbewahrung von Nachrichten auf die Ordner und Elemente in einem Postfach angewendet.
Bevor Sie dieses Cmdlet ausführen können, müssen Ihnen die entsprechenden Berechtigungen zugewiesen werden. Auch wenn in diesem Thema alle Parameter für das Cmdlet aufgeführt werden, verfügen Sie möglicherweise nicht über den Zugriff auf einige Parameter, wenn sie nicht in den Ihnen zugewiesenen Berechtigungen enthalten sind. Wie Sie herausfinden, welche Berechtigungen zur Ausführung eines bestimmten Cmdlets oder Parameters in Ihrer Organisation erforderlich sind, können Sie unter Find the permissions required to run any Exchange cmdlet nachlesen.
Beispiele
Beispiel 1
Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"In diesem Beispiel wird der Kommentar für das Aufbewahrungsrichtlinientag "AllUsers-DeletedItems" geändert.
Beispiel 2
Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"In diesem Beispiel wird dem Benutzer Terry Adams mit den Parametern Mailbox und OptionalInMailbox ein optionales Aufbewahrungstag zur Verfügung gestellt.
Parameter
-AddressForJournaling
Dieser Parameter ist nur in Exchange Server 2010 verfügbar.
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| Type: | RecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-AgeLimitForRetention
Der Parameter AgeLimitForRetention gibt das Alter an, ab dem für ein Element die Aufbewahrung erzwungen wird. Die Verfallszeit entspricht der Anzahl der Tage seit dem Zustellungsdatum des Elements oder seit dem Erstellungsdatum, falls das Element nicht zugestellt wurde. Wird dieser Parameter nicht angegeben und der Parameter RetentionEnabled auf $true festgelegt, wird ein Fehler zurückgegeben.
| Type: | EnhancedTimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Comment
Der Parameter Comment gibt einen Kommentar für das Aufbewahrungsrichtlinientag an.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-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 (z. B. Remove-*-Cmdlets) verfügen über eine integrierte Pause, die Sie zwingt, den Befehl zu bestätigen, bevor Sie fortfahren. Für diese Cmdlets können Sie die Bestätigungsaufforderung mit genau dieser Syntax überspringen:
-Confirm:$false. - Die meisten anderen Cmdlets (z. B. 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.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
Dieser Parameter ist im lokalen Exchange verfügbar.
Der Parameter "DomainController" gibt den Domänencontroller an, der von diesem Cmdlet verwendet wird, um aus Active Directory Daten zu lesen oder hineinzuschreiben. Der Domänencontroller kann anhand seines vollqualifizierten Domänennamens (Fully Qualified Domain Name, FQDN) ermittelt werden. Beispiel: dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Force
Der Schalter „Erzwingen“ blendet Warnungs- oder Bestätigungsmeldungen aus. Sie müssen keinen Wert für diese Option angeben.
Verwenden Sie diesen Schalter, um die Bestätigungsaufforderung auszublenden, wenn Sie den RetentionId-Parameter verwenden.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
Der Parameter Identity gibt den Namen, den DN (Distinguished Name) oder die GUID des zu ändernden Aufbewahrungsrichtlinientags an.
| Type: | RetentionPolicyTagIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-JournalingEnabled
Dieser Parameter ist nur in Exchange Server 2010 verfügbar.
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LabelForJournaling
Dieser Parameter ist nur in Exchange Server 2010 verfügbar.
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LegacyManagedFolder
Der Parameter LegacyManagedFolder gibt den Namen eines verwalteten Ordners an. Das Aufbewahrungstag wird mithilfe von Aufbewahrungseinstellungen über den verwalteten Ordner und die Einstellungen für verwaltete Inhalte erstellt. Sie können diesen Parameter zum Erstellen von Aufbewahrungstags basierend auf vorhandenen verwalteten Ordnern verwenden, um Benutzer aus Postfachrichtlinien für verwaltete Ordner in Aufbewahrungsrichtlinien zu migrieren.
| Type: | ELCFolderIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-LocalizedComment
Der Parameter LocalizedComment gibt den lokalisierten Kommentar und die Sprache für das Aufbewahrungsrichtlinientag an. Dieser Kommentar wird in Microsoft Outlook basierend auf dem Gebietsschema des Benutzers angezeigt.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-LocalizedRetentionPolicyTagName
Der Parameter LocalizedRetentionPolicyTagName gibt einen lokalisierten Namen für das Aufbewahrungsrichtlinientag an. Dieser Name wird in Outlook basierend auf dem Gebietsschema des Benutzers angezeigt.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
Der Parameter Mailbox gibt ein Postfach für die Zuweisung der Zustimmungstags an. Sie können jeden beliebigen Wert verwenden, sofern er das Postfach eindeutig kennzeichnet. Beispiel:
- Name
- Alias
- Distinguished Name (DN)
- Distinguished Name (DN)
- Domäne\benutzername
- E-Mail-Adresse
- GUID
- LegacyExchangeDN
- SamAccountName
- Benutzer-ID oder User Principal Name (UPN)
Dieser Parameter muss zusammen mit dem Parameter OptionalInMailbox verwendet werden.
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MessageClass
Der Parameter MessageClass gibt den Nachrichtentyp an, für den das Tag gilt. Falls keine Angabe erfolgt ist, wird der Standardwert auf * festgelegt.
Mit Ausnahme eines Standardrichtlinientags (DPT) für Voicemail unterstützt Exchange keine Aufbewahrungstags für verschiedene Nachrichtentypen. Nur Tags mit einer MessageClass von * werden unterstützt und gelten für alle Nachrichtentypen.
Legen Sie den Parameter MessageClass auf voicemail und den Parameter Type auf All fest, um ein Standardrichtlinientag für Voicemailnachrichten zu erstellen.
Ein Standardrichtlinientag für Voicemailnachrichten wird nur auf Microsoft Exchange Unified Messaging-Voicemailnachrichten angewendet (diese sind durch den PR_MESSAGE_CLASS-MAPI-Eigenschaftenwert IPM.Note.Microsoft.Voicemail* gekennzeichnet).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MessageFormatForJournaling
Dieser Parameter ist nur in Exchange Server 2010 verfügbar.
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| Type: | JournalingFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-MustDisplayCommentEnabled
Der Parameter MustDisplayCommentEnabled gibt an, ob der Kommentar ausgeblendet werden kann. Der Standardwert ist $true.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Name
Der Parameter Name gibt den Namen des Aufbewahrungsrichtlinientags an.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-OptionalInMailbox
Der Parameter OptionalInMailbox wird zusammen mit dem Parameter Mailbox verwendet, um dem Postfach persönliche Tags zuzuweisen. Sie können diesen Parameter verwenden, um einem Benutzer ein persönliches Tag zur Verfügung zu stellen, das nicht der Aufbewahrungsrichtlinie zugewiesen ist, die auf das angegebene Postfach angewendet wird. Sie können mehrere persönliche Tags angeben, die durch Kommas getrennt sind.
| Type: | RetentionPolicyTagIdParameter[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionAction
Der Parameter RetentionAction gibt die Aktion für die Aufbewahrungsrichtlinie an. Gültige Werte sind:
- DeleteAndAllowRecovery: Löscht eine Nachricht und ermöglicht die Wiederherstellung aus dem Ordner "Wiederherstellbare Elemente".
- DeleteAndAllowRecovery: Mit diesem Vorgang wird eine Nachricht gelöscht, und die Wiederherstellung aus dem Ordner "Wiederherstellbare Elemente" wird zugelassen.
- MoveToArchive: Verschiebt eine Nachricht in das Archivpostfach des Benutzers. Diese Aktion kann für Aufbewahrungstags vom Typ All, Personal und RecoverableItems verwendet werden.
- PermanentLöschen: Löscht eine Nachricht endgültig. Eine endgültig gelöschte Nachricht kann nicht aus dem Ordner "Wiederherstellbare Elemente" wiederhergestellt werden. In einer Discoverysuche werden endgültig gelöschte Nachrichten nicht zurückgegeben, es sei denn, das Postfach unterliegt dem Beweissicherungsverfahren.
Die Aktionen MoveToDeletedItems und MoveToFolder sind verfügbar, funktionieren aber nicht. Diese Aktionen stehen für Upgrades von Messaging-Datensatzverwaltung (Messaging Records Management, MRM) 1.0 (verwaltete Ordner) auf MRM 2.0 (Aufbewahrungsrichtlinien) zur Verfügung. MRM 2.0 wurde in Exchange 2010 Service Pack 1 (SP1) eingeführt.
Wird dieser Parameter nicht angegeben und der Parameter RetentionEnabled auf $true festgelegt, wird ein Fehler zurückgegeben.
| Type: | RetentionAction |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionEnabled
Der Parameter RetentionEnabled gibt an, ob das Tag aktiviert ist. Wenn auf $false festgelegt ist, ist das Tag deaktiviert, und es wird keine Aufbewahrungsaktion für Nachrichten ausgeführt, auf die das Tag angewendet wurde.
Auch Nachrichten mit einem deaktivierten Tag werden als mit Tag markiert betrachtet, sodass Standardrichtlinientags in der Aufbewahrungsrichtlinie des Benutzers auf diese Nachrichten nicht angewendet werden.
Wenn Sie den Parameter RetentionEnabled auf $false festlegen, wird der Aufbewahrungszeitraum für das Tag als Nie angezeigt. Benutzer können dieses Tag auf Elemente anwenden, die sie angeben möchten, dass sie niemals gelöscht oder nie in das Archiv verschoben werden sollten. Das spätere Aktivieren des Tags kann zu unbeabsichtigtem Löschen oder Archivieren von Elementen führen. Um diese Situation zu vermeiden, kann es ratsam sein, den Namen dieses Tags zu ändern, wenn eine Aufbewahrungsrichtlinie vorübergehend deaktiviert wird, damit Benutzer davon abgeraten werden, es zu verwenden, z DISABLED_<Original Name>. B. .
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionId
Der Parameter RetentionId gibt eine alternative Tag-ID an, um sicherzustellen, dass das Aufbewahrungstag für Postfachelemente, die in einer Exchange-Organisation markiert sind, dem Tag entspricht, wenn das Postfach in eine andere Exchange-Organisation verschoben wird (z. B. in einer gesamtstrukturübergreifenden Bereitstellung oder in einer standortübergreifenden Bereitstellung, wenn ein Postfach von einem lokalen Exchange-Server in die Cloud verschoben wird, oder ein cloudbasiertes Postfach wird auf einen lokalen Exchange-Server verschoben).
In der Regel müssen Sie den RetentionId-Parameter für ein Aufbewahrungstag nicht angeben oder ändern. Dieser Parameter wird beim Importieren von Aufbewahrungstags in einer gesamtstrukturübergreifenden oder standortübergreifenden Bereitstellung automatisch aufgefüllt.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SystemTag
Der Parameter SystemTag gibt an, ob das Aufbewahrungsrichtlinientag für interne Exchange-Funktionen erstellt wird.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-WhatIf
Die Option "WhatIf" simuliert die Aktionen des Befehls. Sie können diesen Switch verwenden, um die Änderungen anzuzeigen, die auftreten würden, ohne diese Änderungen tatsächlich anzuwenden. Sie müssen keinen Wert für diese Option angeben.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Eingaben
Input types
Eingabetypen, die dieses Cmdlet akzeptiert, finden Sie unter Eingabe- und Ausgabetypen für Cmdlets. Wenn das Feld mit dem Eingabetyp für ein Cmdlet leer ist, akzeptiert das Cmdlet diese Eingabedaten nicht.
Ausgaben
Output types
Informationen zu den Rückgabetypen, die auch als Ausgabetypen bezeichnet werden, die dieses Cmdlet akzeptiert, finden Sie unter Cmdlet Input and Output Types. Wenn das Feld Ausgabetyp leer ist, gibt das Cmdlet keine Daten zurück.
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für