Set-CaseHoldPolicy

Модуль:
Exchange PowerShell

Этот командлет доступен только в PowerShell безопасности и соответствия требованиям. Дополнительные сведения см. в статье PowerShell безопасности и соответствия требованиям.

Используйте командлет Set-CaseHoldPolicy для изменения существующих политик удержания регистра в Портал соответствия требованиям Microsoft Purview.

Примечание. Выполнение этого командлета приводит к полной синхронизации в организации, что является важной операцией. Если необходимо обновить несколько политик, дождитесь успешного распространения политики, прежде чем снова запустить командлет для следующей политики. Если необходимо обновить политику несколько раз, внесите все изменения в одном вызове командлета. Сведения о состоянии распространения см. в разделе Get-CaseHoldPolicy.

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

Синтаксис

RetryDistribution 

Set-CaseHoldPolicy
    [-Identity] <PolicyIdParameter>
    [-RetryDistribution]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Identity 

Set-CaseHoldPolicy
    [-Identity] <PolicyIdParameter>
    [-AddExchangeLocation <MultiValuedProperty>]
    [-AddPublicFolderLocation <MultiValuedProperty>]
    [-AddSharePointLocation <MultiValuedProperty>]
    [-Comment <String>]
    [-Confirm]
    [-Enabled <Boolean>]
    [-Force]
    [-RemoveExchangeLocation <MultiValuedProperty>]
    [-RemovePublicFolderLocation <MultiValuedProperty>]
    [-RemoveSharePointLocation <MultiValuedProperty>]
    [-WhatIf]
    [<CommonParameters>]

Описание

Чтобы использовать этот командлет в PowerShell безопасности и соответствия требованиям, вам должны быть назначены соответствующие разрешения. Дополнительные сведения см. в статье Разрешения на портале соответствия требованиям Microsoft Purview.

Примечание. Не используйте команду Foreach-Object по каналу при добавлении или удалении область расположений: "Value1","Value2",..."ValueN" | Foreach-Object {Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}.

Примеры

Пример 1

Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14"

Этот пример команд вносит в существующую политику удержания дел, Regulation 123 Compliance, следующие изменения:

  • Добавляется почтовый ящик для пользователя Kitty Petersen.
  • Добавляет сайт https://contoso.sharepoint.com/sites/teams/financeSharePoint .
  • Удаляются общедоступные папки.
  • Обновляется комментарий.

Параметры

-AddExchangeLocation

Применимо: соответствие требованиям & безопасности

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

  • Параметр ExchangeLocation указывает почтовые ящики, включаемые в политику. Допускаются следующие значения:
  • Почтовый ящик

Чтобы указать почтовый ящик или группу рассылки, можно использовать следующие значения:

  • Имя
  • SMTP-адрес. Чтобы указать неактивный почтовый ящик, перед адресом укажите точку (.).
  • Microsoft Entra ObjectId. Используйте командлеты Get-MgUser или Get-MgGroup в Microsoft Graph PowerShell, чтобы найти это значение.

Update Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Свойства параметров

Тип:MultiValuedProperty
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AddPublicFolderLocation

Применимо: соответствие требованиям & безопасности

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

Свойства параметров

Тип:MultiValuedProperty
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AddSharePointLocation

Применимо: соответствие требованиям & безопасности

Параметр AddSharePointLocation указывает сайты SharePoint, добавляемые в список включенных сайтов, если для параметра SharePointLocation не используется значение All. Чтобы добавить сайт, укажите его URL-адрес.

Update Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Сайты SharePoint нельзя добавить в политику, пока они не будут проиндексированы.

Свойства параметров

Тип:MultiValuedProperty
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Comment

Применимо: соответствие требованиям & безопасности

Параметр Comment указывает необязательный комментарий. Если вы указываете значение, содержащее пробелы, заключите его в кавычки ("), например:" Это примечание администратора ".

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Confirm

Применимо: соответствие требованиям & безопасности

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

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

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Enabled

Применимо: соответствие требованиям & безопасности

Параметр Enabled указывает, включена ли политика. Допустимые значения:

  • $true. Политика включена. Это значение является значением по умолчанию.
  • $true. Политика включена. Это значение задается по умолчанию.

Свойства параметров

Тип:Boolean
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Force

Применимо: соответствие требованиям & безопасности

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

Этот параметр можно применять для программного выполнения задач, не требующего вмешательства администратора.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Identity

Применимо: соответствие требованиям & безопасности

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

  • имя;
  • различающееся имя (DN);
  • GUID

Свойства параметров

Тип:PolicyIdParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-RemoveExchangeLocation

Применимо: соответствие требованиям & безопасности

Параметр RemoveExchangeLocation указывает существующие почтовые ящики, которые нужно удалить из политики. Допустимые значения:

  • Этот параметр указывает почтовые ящики, удаляемые из списка исключенных почтовых ящиков, когда для параметра ExchangeLocation используется значение All. Допускаются следующие значения:
  • Почтовый ящик

Значение All для всех почтовых ящиков. Это значение можно использовать только само по себе.

  • Имя
  • SMTP-адрес. Чтобы указать неактивный почтовый ящик, перед адресом укажите точку (.).
  • Microsoft Entra ObjectId. Используйте командлеты Get-MgUser или Get-MgGroup в Microsoft Graph PowerShell, чтобы найти это значение.

Update Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Свойства параметров

Тип:MultiValuedProperty
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RemovePublicFolderLocation

Применимо: соответствие требованиям & безопасности

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

Свойства параметров

Тип:MultiValuedProperty
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RemoveSharePointLocation

Применимо: соответствие требованиям & безопасности

Параметр RemoveSharePointLocation указывает сайты SharePoint, которые нужно удалить из списка включенных сайтов, если для параметра SharePointLocation не используется значение All. Чтобы добавить сайт, укажите его URL-адрес.

Update Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Свойства параметров

Тип:MultiValuedProperty
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

Identity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-RetryDistribution

Применимо: соответствие требованиям & безопасности

Параметр RetryDistribution указывает, следует ли распространять политику во все расположения Exchange Online и SharePoint. С этим параметром не нужно указывать значение.

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

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

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

RetryDistribution
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

Применимо: соответствие требованиям & безопасности

Параметр WhatIf не поддерживается в PowerShell безопасности и соответствия требованиям.

Свойства параметров

Тип: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.