Set-RetentionPolicy
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.
Командлет Set-RetentionPolicy используется для изменения свойств существующей политики хранения.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Set-RetentionPolicy
[-Identity] <MailboxPolicyIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-Name <String>]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
Описание
Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.
Примеры
Пример 1
Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"
В этом примере показано изменение политики MyPolicy, с которой необходимо связать тег политики хранения MyRetentionPolicyTag.
Параметр Identity является позиционным параметром. Позиционные параметры могут использоваться без метки (Identity). Дополнительные сведения о позиционных параметрах см. в разделе О параметрах.
Параметры
-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, Exchange Online Protection |
-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 |
-Force
Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.
Используйте этот параметр, чтобы скрыть запрос подтверждения при использовании параметра RetentionId.
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
Параметр Identity указывает имя, различающееся имя (DN) или идентификатор GUID политики хранения.
Type: | MailboxPolicyIdParameter |
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, Exchange Online Protection |
-IsDefault
Этот параметр доступен только в облачной службе.
Параметр IsDefault указывает, что эта политика хранения является политикой хранения по умолчанию. Указывать значение для этого параметра необязательно.
При использовании этого параметра вы получите предупреждение о том, что эта политика хранения заменит текущую политику хранения по умолчанию (политику, где значение свойства IsDefault в настоящее время равно True) в качестве значения по умолчанию. По умолчанию политика хранения по умолчанию называется Политика MRM по умолчанию.
Примечание. Изменение политики хранения по умолчанию может повлиять на новые и существующие почтовые ящики на основе значения параметра RetentionPolicy во всех планах почтовых ящиков:
- $null (пустая): изменения, для которых используется политика хранения по умолчанию, постоянно отражаются в новых и существующих почтовых ящиках.
- Указана политика хранения. Значение параметра RetentionPolicy для всех планов почтовых ящиков должно быть $null (пустое) или соответствовать политике хранения Exchange, настроенной в качестве политики по умолчанию для организации. В противном случае взаимодействие может быть несогласованным при создании новых почтовых ящиков, включении отключенных почтовых ящиков и изменении лицензий. Дополнительные сведения см. в разделе Планы почтовых ящиков в Exchange Online.
Если почтовому ящику назначена политика хранения Exchange, которая не является политикой по умолчанию, значение RetentionPolicy почтового ящика будет перезаписано при изменении лицензий и потребуется вручную сбросить исходное значение.
Изменения в политике хранения по умолчанию, влияющие на существующие почтовые ящики, могут потенциально перенасыщать сеть, если существуют сотни или тысячи почтовых ящиков, требующих обновлений.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-IsDefaultArbitrationMailbox
Этот параметр доступен только в облачной службе.
Параметр IsDefaultArbitrationMailbox настраивает эту политику в качестве политики хранения по умолчанию для почтовых ящиков арбитража в Exchange Online организации. Указывать значение для этого параметра необязательно.
В случае локального развертывания этот параметр недоступен.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Name
Параметр Name определяет уникальное имя для политики хранения.
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 |
-RetentionId
Параметр RetentionId указывает удостоверение политики хранения, чтобы убедиться, что к почтовым ящикам, перемещенным между двумя организациями Exchange, по-прежнему применяется та же политика хранения. Например, в развертывании между лесами или в локальном развертывании при перемещении почтового ящика с локального сервера Exchange в облако или при перемещении облачного почтового ящика на локальный сервер Exchange Server этот параметр используется, чтобы убедиться, что к почтовому ящику применяется та же политика хранения.
Обычно указывать или изменять параметр RetentionId для тега сохранения не требуется. Параметр автоматически задается при импорте тегов хранения с помощью сценария Import-RetentionTags.ps1.
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 |
-RetentionPolicyTagLinks
Параметр RetentionPolicyTagLinks определяет идентификатор тегов политики хранения, который должен быть сопоставлен с политикой хранения. Почтовые ящики, к которым применяется политика хранения, имеют теги хранения, связанные с этой политикой хранения.
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 |
-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, Exchange Online Protection |
Входные данные
Input types
Сведения о типах входных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип ввода для командлета пустое, командлет не принимает входные данные.
Выходные данные
Output types
Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.