New-RetentionPolicyTag

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

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

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

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

Синтаксис

New-RetentionPolicyTag
   [-Name] <String>
   [-AddressForJournaling <RecipientIdParameter>]
   [-AgeLimitForRetention <EnhancedTimeSpan>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-IsDefaultAutoGroupPolicyTag]
   [-IsDefaultModeratedRecipientsPolicyTag]
   [-JournalingEnabled <Boolean>]
   [-LabelForJournaling <String>]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MessageClass <String>]
   [-MessageFormatForJournaling <JournalingFormat>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-RetentionAction <RetentionAction>]
   [-RetentionEnabled <Boolean>]
   [-RetentionId <Guid>]
   [-SystemTag <Boolean>]
   [-Type <ElcFolderType>]
   [-WhatIf]
   [<CommonParameters>]
New-RetentionPolicyTag
   [-Name] <String>
   [-ManagedFolderToUpgrade <ELCFolderIdParameter>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-IsDefaultAutoGroupPolicyTag]
   [-IsDefaultModeratedRecipientsPolicyTag]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-SystemTag <Boolean>]
   [-Type <ElcFolderType>]
   [-WhatIf]
   [<CommonParameters>]

Описание

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

Теги хранения поддерживают отображение имени тега и дополнительного комментария на языках локализации. Для этой цели используются коды языковых культур из класса CultureInfo.

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

Примеры

Пример 1

New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete

В этом примере создается тег политики хранения Finance-DeletedItems для папки по умолчанию "Удаленные". Когда тег применяется к почтовому ящику как часть политики хранения, происходит окончательное удаление элементов всех типов в папке "Удаленные" за 30 дней.

Пример 2

New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete

В этом примере создается тег политики по умолчанию Finance-Default. Когда тег применяется к почтовому ящику как часть политики хранения, происходит окончательное удаление всех элементов без тега хранения за 365 дней. Не оказывается никакого воздействия на те элементы отдельного класса сообщений, например Voicemail, для которых существует тег по умолчанию (тег хранения типа All).

Пример 3

New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete

В этом примере создается тег хранения "Критические для предприятия" типа Personal. Когда тег применяется к элементам почтового ящика в рамках политики сохранения, окончательное удаление элементов происходит приблизительно за 7 лет.

Параметры

-AddressForJournaling

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

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

Type:RecipientIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-AgeLimitForRetention

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

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

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

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

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

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

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

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, 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

-IsDefaultAutoGroupPolicyTag

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-IsDefaultModeratedRecipientsPolicyTag

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-JournalingEnabled

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

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-LabelForJournaling

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

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

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

-LocalizedComment

Параметр LocalizedComment задает локализованные комментарии и используемые для них языки. Если языковой параметр пользователя соответствует языку, указанному для этого параметра, Майкрософт Outlook и Outlook в Интернете отобразить соответствующий локализованный комментарий. Комментарии следует указывать в формате ISO_код_языка:комментарий, например, LocalizedComment EN-US:"This is a localized comment in U.S. English".

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

Параметр LocalizedRetentionPolicyTagName задает локализованные имена тегов и используемые для них языки. Если параметр языка пользователя соответствует языку, указанному для этого параметра, Outlook и Outlook в Интернете отобразить соответствующее локализованное имя тега. Имена задаются в формате ISO_код_языка:имя, например, LocalizedRetentionPolicyTagName EN-US:"Business Critical".

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

-ManagedFolderToUpgrade

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

Параметр ManagedFolderToUpgrade указывает имя управляемой папки для использования в качестве шаблона для тега хранения.

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

-MessageClass

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

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

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

DPT для сообщений голосовой почты применяется только к сообщениям голосовой почты единой системы обмена сообщениями Microsoft Exchange (определяются по значениям свойств MAPI PR_MESSAGE_CLASS — IPM.Note.Microsoft.Voicemail*).

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

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

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

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

-MustDisplayCommentEnabled

Параметр MustDisplayCommentEnabled указывает, можно ли скрывать комментарии. Значение по умолчанию — $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

Параметр Name определяет имя тега.

Type:String
Position:1
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

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

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

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

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

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

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

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

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

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

-Type

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

  • Все
  • Архив
  • Календарь
  • Несрочная работа: доступно только в Exchange Online.
  • Контакты
  • ConversationHistory
  • DeletedItems
  • Черновики
  • Inbox;
  • Журнал
  • Нежелательная почта
  • LegacyArchiveJournals
  • ManagedCustomFolder
  • Примечания.
  • Исходящие
  • Персональный
  • RecoverableItems
  • RssSubscriptions
  • SentItems
  • SyncIssues
  • Задачи

Чтобы создать тег политики по умолчанию (DPT), укажите тип All. Единственное допустимое действие хранения для тегов типа RecoverableItems — MoveToArchive.

Type:ElcFolderType
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

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

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

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

Input types

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

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

Output types

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