New-RetentionPolicyTag
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и параметры могут быть эксклюзивными для одной или другой среды.
Командлет New-RetentionPolicyTag используется для создания тега хранения.
Дополнительные сведения о тегах хранения см. в разделе Теги хранения и политики хранения в Exchange Server.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
RetentionPolicy (По умолчанию)
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>]
UpgradeManagedFolder
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 г.
Этот параметр доступен только в Exchange Server 2010.
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | RecipientIdParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AgeLimitForRetention
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр AgeLimitForRetention определяет возраст, при котором для элемента включается сохранение. Максимальное время хранения соответствует числу дней от даты доставки элемента или его создания, если он не был доставлен. Если этот параметр не указан, а значение параметра RetentionEnabled равно $true, возвращается ошибка.
Свойства параметров
| Тип: | EnhancedTimeSpan |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Comment
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр Comment указывает комментарий для тега.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.
- Деструктивные командлеты (например, командлеты Remove-) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис:
-Confirm:$false. - Большинство других командлетов (например, командлеты New- и Set-) не имеют встроенной паузы. Для этих командлетов указание переключателя Confirm без значения вводит паузу, которая заставляет вас подтвердить команду перед продолжением.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-DomainController
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г.
Этот параметр доступен только в локальной среде Exchange.
Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.
Свойства параметров
| Тип: | Fqdn |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-IsDefaultAutoGroupPolicyTag
Применимо: Exchange Online
Этот параметр доступен только в облачной службе.
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-IsDefaultModeratedRecipientsPolicyTag
Применимо: Exchange Online
Этот параметр доступен только в облачной службе.
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-JournalingEnabled
Применимо: Exchange Server 2010 г.
Этот параметр доступен только в Exchange Server 2010.
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LabelForJournaling
Применимо: Exchange Server 2010 г.
Этот параметр доступен только в Exchange Server 2010.
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LocalizedComment
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр LocalizedComment задает локализованные комментарии и используемые для них языки. Если языковой параметр пользователя соответствует языку, указанному для этого параметра, Microsoft Outlook и Outlook в Интернете отобразить соответствующий локализованный комментарий. Комментарии следует указывать в формате ISO_код_языка:комментарий, например, LocalizedComment EN-US:"This is a localized comment in U.S. English".
Свойства параметров
| Тип: | MultiValuedProperty |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LocalizedRetentionPolicyTagName
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр LocalizedRetentionPolicyTagName задает локализованные имена тегов и используемые для них языки. Если языковой параметр пользователя соответствует языку, указанному для этого параметра, Outlook и Outlook в Интернете отобразить соответствующее локализованное имя тега. Имена задаются в формате ISO_код_языка:имя, например, LocalizedRetentionPolicyTagName EN-US:"Business Critical".
Свойства параметров
| Тип: | MultiValuedProperty |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ManagedFolderToUpgrade
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г.
Этот параметр доступен только в локальной среде Exchange.
Параметр ManagedFolderToUpgrade указывает имя управляемой папки для использования в качестве шаблона для тега хранения.
Свойства параметров
| Тип: | ELCFolderIdParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
UpgradeManagedFolder
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-MessageClass
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр MessageClass указывает тип сообщения, к которому применяется тег. Если параметр не задан, то значение по умолчанию устанавливается как *.
За исключением тега политики по умолчанию (DPT) для голосовой почты, Exchange не поддерживает теги хранения для сообщений разных типов. Поддерживаются только теги со значением параметра MessageClass — *, и они применяются ко всем типам сообщений.
Чтобы создать тег политики по умолчанию для сообщений голосовой почты, задайте для параметра MessageClass значение voicemail, а для параметра Type — All.
DPT для сообщений голосовой почты применяется только к сообщениям голосовой почты единой системы обмена сообщениями Microsoft Exchange (определяются по значениям свойств MAPI PR_MESSAGE_CLASS — IPM.Note.Microsoft.Voicemail*).
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-MessageFormatForJournaling
Применимо: Exchange Server 2010 г.
Этот параметр доступен только в Exchange Server 2010.
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | JournalingFormat |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-MustDisplayCommentEnabled
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр MustDisplayCommentEnabled указывает, можно ли скрывать комментарии. Значение по умолчанию — $true.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Name
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр Name определяет имя тега.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RetentionAction
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр 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, возвращается ошибка.
Свойства параметров
| Тип: | RetentionAction |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RetentionEnabled
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр RetentionEnabled указывает, включен ли тег. Если его значение равно $false, то тег отключен, и к сообщениям, к которым применен этот тег, не применяются действия сохранения.
Сообщения с отключенным тегом по-прежнему считаются тегами, поэтому все теги того же типа, что и отключенный тег в политике хранения пользователя, не применяются к таким сообщениям.
Если для параметра RetentionEnabled задано значение $false, период хранения для тега отображается как Никогда. Пользователи могут применять этот тег к элементам, которые они хотят указать, никогда не должны удаляться или перемещаться в архив. Включение тега позже может привести к непреднамеренному удалению или архивации элементов. Чтобы избежать этой ситуации, если политика хранения временно отключена, рекомендуется изменить имя этого тега, чтобы пользователи не могли использовать ее, например DISABLED_<Original Name>.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RetentionId
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр RetentionId задает альтернативный идентификатор тега, чтобы убедиться, что тег хранения, найденный в элементах почтового ящика, помеченных в локальном развертывании, соответствует тегу при перемещении почтового ящика в облако, или элементы почтового ящика, помеченные в облаке, соответствуют тегу при перемещении почтового ящика на локальный сервер Exchange Server. Параметр используется в случаях нелокального развертывания. Указывать этот параметр в случае исключительно локального развертывания не требуется.
Свойства параметров
| Тип: | Guid |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
RetentionPolicy
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SystemTag
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр SystemTag указывает, что тег создается для внутренних функций Exchange.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Type
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Параметр Type указывает тип создаваемого тега хранения. Допустимыми являются следующие значения:
- Все
- Архив
- Календарь
- Неактивный режим: доступно только в Exchange Online.
- Контакты
- ConversationHistory
- DeletedItems
- Черновики
- Inbox;
- Журнал
- Нежелательная почта
- LegacyArchiveJournals
- ManagedCustomFolder
- Примечания.
- Исходящие
- Персональный
- RecoverableItems
- RssSubscriptions
- SentItems
- SyncIssues
- Задачи
Чтобы создать тег политики по умолчанию (DPT), укажите тип All. Единственное допустимое действие хранения для тегов типа RecoverableItems — MoveToArchive.
Свойства параметров
| Тип: | ElcFolderType |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Online
Переключатель WhatIf имитирует действия команды. Вы можете использовать его для просмотра результатов изменений без фактического внесения этих изменений. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.
Входные данные
Input types
Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.
Выходные данные
Output types
Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.