Set-RetentionPolicyTag
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут быть эксклюзивными для той или иной среды.
Командлет Set-RetentionPolicyTag используется для изменения свойств тега хранения.
Дополнительные сведения о тегах хранения см. в статье Теги хранения и политики хранения в Exchange Server.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Identity
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>]
MailboxTask
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 are automatically deleted in 120 days"
В этом примере изменяется комментарий для тега политики хранения AllUsers-DeletedItems.
Пример 2
Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"
В этом примере создаются дополнительные теги хранения, доступные пользователю Сергею Климову посредством параметров Mailbox и OptionalInMailbox.
Параметры
-AddressForJournaling
Применимо: Exchange Server 2010
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | RecipientIdParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AgeLimitForRetention
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр AgeLimitForRetention определяет возраст, при котором для элемента включается сохранение. Максимальное время хранения соответствует числу дней от даты доставки элемента или его создания, если он не был доставлен. Если этот параметр не указан, а значение параметра RetentionEnabled равно $true, возвращается ошибка.
Свойства параметров
| Тип: | EnhancedTimeSpan |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Comment
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр Comment указывает комментарий для тега политики хранения.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | 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 Server SE, Exchange Online
Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. То, как этот переключатель влияет на командлет, зависит от того, требует ли командлет подтверждения перед продолжением.
- Деструктивные командлеты (например, командлеты Remove-) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис:
-Confirm:$false. - Большинство других командлетов (например, командлеты New- и Set-) не имеют встроенной паузы. Для этих командлетов указание параметра Confirm без значения приводит к паузе, которая вынуждает вас подтвердить команду перед продолжением.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | 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 Server SE
Этот параметр доступен только в локальной среде Exchange.
Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.
Свойства параметров
| Тип: | Fqdn |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.
Используйте этот параметр, чтобы скрыть запрос на подтверждение при использовании параметра RetentionId.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр Identity указывает имя, различающееся имя или идентификатор GUID тега политики хранения, который необходимо изменить.
Свойства параметров
| Тип: | RetentionPolicyTagIdParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | 1 |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-JournalingEnabled
Применимо: Exchange Server 2010
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | Boolean |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LabelForJournaling
Применимо: Exchange Server 2010
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LegacyManagedFolder
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр LegacyManagedFolder указывает имя управляемой папки. Тег сохранения создается на основе параметров сохранения управляемой папки и соответствующих параметров управляемого содержимого. Этот параметр можно использовать для создания тегов сохранения на основе существующих управляемых папок при переносе пользователей из политик почтовых ящиков управляемых папок в политики сохранения.
Свойства параметров
| Тип: | ELCFolderIdParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LocalizedComment
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр LocalizedComment указывает локализованный комментарий и язык для тега политики хранения. Этот комментарий отображается в Microsoft Outlook в зависимости от языкового стандарта пользователя.
Свойства параметров
| Тип: | MultiValuedProperty |
| Значение по умолчанию: | 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 Server SE, Exchange Online
Параметр LocalizedRetentionPolicyTagName указывает локализованное имя для тега политики хранения. Это имя отображается в Outlook в зависимости от языкового стандарта пользователя.
Свойства параметров
| Тип: | MultiValuedProperty |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Mailbox
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр Mailbox указывает почтовый ящик для назначения принятых тегов. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.
- Имя
- Псевдоним
- различающееся имя (DN);
- различающееся имя (DN);
- Домен\Имя пользователя
- Адрес электронной почты
- GUID
- LegacyExchangeDN
- SamAccountName
- Идентификатор пользователя или имя участника-пользователя
Необходимо использовать этот параметр с параметром OptionalInMailbox.
Свойства параметров
| Тип: | MailboxIdParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
MailboxTask
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-MessageClass
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр MessageClass указывает тип сообщения, к которому применяется тег. Если параметр не задан, то значение по умолчанию устанавливается как *.
За исключением тега политики по умолчанию (DPT) для голосовой почты, Exchange не поддерживает теги хранения для различных типов сообщений. Поддерживаются только теги с MessageClass *, и они применяются ко всем типам сообщений.
Чтобы создать тег политики по умолчанию для сообщений голосовой почты, задайте для параметра MessageClass значение voicemail, а для параметра Type — All.
DPT для сообщений голосовой почты применяется только к сообщениям голосовой почты единой системы обмена сообщениями Microsoft Exchange (определяются по значениям свойств MAPI PR_MESSAGE_CLASS — IPM.Note.Microsoft.Voicemail*).
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-MessageFormatForJournaling
Применимо: Exchange Server 2010
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | JournalingFormat |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-MustDisplayCommentEnabled
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр MustDisplayCommentEnabled указывает, можно ли скрывать комментарии. Значение по умолчанию — $true.
Свойства параметров
| Тип: | Boolean |
| Значение по умолчанию: | 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 Server SE, Exchange Online
Параметр Name указывает имя тега политики хранения.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-OptionalInMailbox
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр OptionalInMailbox используется вместе с параметром Mailbox для назначения личных тегов почтовому ящику. С помощью этого параметра можно сделать доступным пользователю личный тег, не связанный с политикой хранения, применяемой к указанному почтовому ящику. Вы можете указать несколько личных тегов, разделенных запятыми.
Свойства параметров
| Тип: | RetentionPolicyTagIdParameter[] |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
MailboxTask
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RetentionAction
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, 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 |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RetentionEnabled
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр RetentionEnabled указывает, включен ли тег. Если установлен $false, тег отключается, и никакие действия по хранению сообщений, в которых применен этот тег, не выполняются.
Сообщения с отключенным тегом считаются отмеченными, поэтому к таким сообщениям не применяются теги политики по умолчанию из политики сохранения пользователя.
Если для параметра RetentionEnabled задано значение $false, срок хранения для тега отображается как "Никогда". Пользователи могут применить этот тег к элементам, которые, по их желанию, никогда не должны удаляться или никогда не должны перемещаться в архив. Включение тега позднее может привести к непреднамеренному удалению или архивации элементов. Чтобы избежать такой ситуации, если политика хранения временно отключена, рекомендуется изменить имя этого тега, чтобы пользователи не хотели его использовать, например DISABLED_<Original Name>, .
Свойства параметров
| Тип: | Boolean |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RetentionId
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр RetentionId указывает альтернативный идентификатор тега, чтобы тег хранения, найденный на элементах почтовых ящиков, помеченных в одной организации Exchange, совпадал с тегом при перемещении почтового ящика в другую организацию Exchange (например, при развертывании в нескольких лесах или в нескольких локальных развертываниях, когда почтовый ящик перемещается с локального сервера Exchange в облако). или облачный почтовый ящик перемещается на локальный сервер Exchange Server).
Как правило, не требуется указывать или изменять параметр RetentionId для тега хранения. Этот параметр заполняется автоматически при импорте тегов хранения в распределенном или локальном развертывании.
Свойства параметров
| Тип: | Guid |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SystemTag
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Параметр SystemTag указывает, создан ли тег политики хранения для внутренних функций Exchange.
Свойства параметров
| Тип: | Boolean |
| Значение по умолчанию: | 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 Server SE, Exchange Online
Переключатель WhatIf показывает, что команда делает без каких-либо изменений. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | 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
Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.