Set-RetentionPolicyTag

Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.

Командлет Set-RetentionPolicyTag используется для изменения свойств тега хранения.

Дополнительные сведения о тегах хранения см. в тегах хранения и политиках хранения в Exchange Server.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

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

Описание

Теги хранения позволяют применять параметры хранения сообщений к папкам и элементам почтового ящика.

Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.

Примеры

Пример 1

Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"

В этом примере изменяется комментарий для тега политики хранения AllUsers-DeletedItems.

Пример 2

Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"

В этом примере создаются дополнительные теги хранения, доступные пользователю Сергею Климову посредством параметров Mailbox и OptionalInMailbox.

Параметры

-AddressForJournaling

Этот параметр доступен только в Exchange Server 2010.

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-AgeLimitForRetention

Параметр AgeLimitForRetention определяет возраст, при котором для элемента включается сохранение. Максимальное время хранения соответствует числу дней от даты доставки элемента или его создания, если он не был доставлен. Если этот параметр не указан, а значение параметра RetentionEnabled равно $true, возвращается ошибка.

Type:EnhancedTimeSpan
Position:Named
Default value:None
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

Параметр Comment указывает комментарий для тега политики хранения.

Type:String
Position:Named
Default value:None
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

Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.

  • Деструктивные командлеты (например, Remove-* командлеты) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис: -Confirm:$false.
  • Большинство других командлетов (например, New-* и Set-*командлеты) не имеют встроенной паузы. Для этих командлетов указание переключателя Confirm без значения вводит паузу, которая заставляет вас подтвердить команду перед продолжением.
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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

Этот параметр доступен только в локальной среде Exchange.

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-Identity

Параметр Identity указывает имя, различающееся имя или идентификатор GUID тега политики хранения, который необходимо изменить.

Type:RetentionPolicyTagIdParameter
Position:1
Default value:None
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

Этот параметр доступен только в Exchange Server 2010.

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-LabelForJournaling

Этот параметр доступен только в Exchange Server 2010.

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-LegacyManagedFolder

Параметр LegacyManagedFolder указывает имя управляемой папки. Тег сохранения создается на основе параметров сохранения управляемой папки и соответствующих параметров управляемого содержимого. Этот параметр можно использовать для создания тегов сохранения на основе существующих управляемых папок при переносе пользователей из политик почтовых ящиков управляемых папок в политики сохранения.

Type:ELCFolderIdParameter
Position:Named
Default value:None
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

Параметр LocalizedComment указывает локализованный комментарий и язык для тега политики хранения. Этот комментарий отображается в Microsoft Outlook в зависимости от региональных точки пользователя.

Type:MultiValuedProperty
Position:Named
Default value:None
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

Параметр LocalizedRetentionPolicyTagName указывает локализованное имя для тега политики хранения. Это имя отображается в Outlook в зависимости от региональных точки пользователя.

Type:MultiValuedProperty
Position:Named
Default value:None
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

Параметр Mailbox указывает почтовый ящик для назначения принятых тегов. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.

  • Имя
  • Псевдоним
  • различающееся имя (DN);
  • различающееся имя (DN);
  • Имя \ пользователя домена
  • Адрес электронной почты
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • Идентификатор пользователя или имя участника-пользователя

Необходимо использовать этот параметр с параметром OptionalInMailbox.

Type:MailboxIdParameter
Position:Named
Default value:None
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

Параметр MessageClass указывает тип сообщения, к которому применяется тег. Если не указано, по умолчанию задано значение * .

За исключением тега политики по умолчанию (DPT) для голосовой почты, Exchange не поддерживает теги хранения для различных типов сообщений. Поддерживаются только теги с messageClass, которые * применяются для всех типов сообщений.

Чтобы создать тег политики по умолчанию для сообщений голосовой почты, задайте для параметра MessageClass значение voicemail, а для параметра Type — All.

DPT для сообщений голосовой почты применяется только к сообщениям голосовой почты единой системы обмена сообщениями Microsoft Exchange (определено значением свойства MAPI КЛАССА _ PR MESSAGE _ IPM. Note.Microsoft.Voicemail * ).

Type:String
Position:Named
Default value:None
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

Этот параметр доступен только в Exchange Server 2010.

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Type:JournalingFormat
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-MustDisplayCommentEnabled

Параметр MustDisplayCommentEnabled указывает, можно ли скрывать комментарии. Значение по умолчанию — $true.

Type:Boolean
Position:Named
Default value:None
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

Параметр Name указывает имя тега политики хранения.

Type:String
Position:Named
Default value:None
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

Параметр OptionalInMailbox используется вместе с параметром Mailbox для назначения личных тегов почтовому ящику. Этот параметр можно использовать, чтобы сделать доступным пользователю личный тег, который не назначен политике хранения, применяемой к указанному почтовому ящику. Можно указать несколько личных тегов, разделив их запятой.

Type:RetentionPolicyTagIdParameter[]
Position:Named
Default value:None
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

Параметр RetentionAction указывает действие для политики хранения. Допустимые значения:

  • DeleteAndAllowRecovery: удаляет сообщение и разрешает восстановление из папки "Элементы с возможностью восстановления".
  • DeleteAndAllowRecovery. Удаляет сообщение и разрешает восстановление из папки "Элементы с возможностью восстановления".
  • MoveToArchive: перемещает сообщение в архивный почтовый ящик пользователя. Это действие можно использовать для тегов хранения типа All, Personal и RecoverableItems.
  • PermanentlyDelete: окончательно удаляет сообщение. Сообщение, которое было окончательно удалено, не может быть восстановлено из папки "Восстанавливаемые элементы". Окончательно удаленные сообщения не возвращаются при поиске на обнаружение, если только для почтового ящика не включено судебное удержание.

Действия MoveToDeletedItems и MoveToFolder доступны, но не работают. Эти действия доступны для обновления MRM, или управления записями сообщений, версии 1.0 (управляемые папки) до MRM 2.0 (политики хранения). MrM 2.0 впервые была представлена в Exchange 2010 Пакет обновления 1 (SP1).

Если этот параметр не указан, а значение параметра RetentionEnabled равно $true, возвращается ошибка.

Type:RetentionAction
Position:Named
Default value:None
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

Параметр RetentionEnabled указывает, включен ли тег. Если установлено $false, тег отключается, и к тем сообщениям, к которые применен этот тег, не применяются никакие действия по хранению.

Сообщения с отключенным тегом считаются отмеченными, поэтому к таким сообщениям не применяются теги политики по умолчанию из политики сохранения пользователя.

Если для параметра RetentionEnabled установлено $false, срок хранения для тега отображается как "Никогда". Пользователи могут применять этот тег к тем элементами, которые они хотят указать, никогда не должны удаляться или никогда не должны быть перемещены в архив. Включение тега позже может привести к непреднамеренности удаления или архивации элементов. Чтобы избежать этой ситуации, если политика хранения временно отключена, рекомендуется изменить имя этого тега, чтобы пользователям не было бы ее использовать, например DISABLED_<Original Name> .

Type:Boolean
Position:Named
Default value:None
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

Параметр RetentionId указывает альтернативный ИД тега, чтобы тег хранения, найденный в элементе почтового ящика, помеченном в одной организации Exchange, совпадал с тегом при перемещении почтового ящика в другую организацию Exchange (например, при развертывании между лесами или в локальном развертывании, при перемещении почтового ящика с локального сервера Exchange в облако или при перемещении облачного почтового ящика на локальном сервере Exchange).

Как правило, указывать или изменять параметр RetentionId для тега хранения не требуется. Этот параметр заполняется автоматически при импорте тегов хранения в межлесном или локальном развертывании.

Type:Guid
Position:Named
Default value:None
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

Параметр SystemTag указывает, создается ли тег политики хранения для внутренних функций Exchange.

Type:Boolean
Position:Named
Default value:None
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

Переключатель WhatIf имитирует действия команды. Вы можете использовать его для просмотра результатов изменений без фактического внесения этих изменений. С этим параметром не нужно указывать значение.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Принудительно

Параметр Force подавляет отображение запроса на подтверждение при использовании параметра RetentionId.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Входные данные

Типы входных данных, поддерживаемые этим командлетом, см. в статье Типы входных и выходных данных для командлетов. Если поле "Типы входных данных" для командлета пустое, этот командлет не поддерживает ввода данных.

Выходные данные

Типы возвращаемых данных, или типы выходных данных, которые поддерживаются этим командлетом, см. в статье Типы входных и выходных данных для командлетов. Если поле "Типы выходных данных" пустое, командлет не возвращает данные.