Set-ComplianceTag

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

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

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

Синтаксис

Default

Set-ComplianceTag
    [-Identity] <ComplianceRuleIdParameter>
    [-AutoApprovalPeriod <System.Int32>]
    [-Comment <String>]
    [-ComplianceTagForNextStage <String>]
    [-Confirm]
    [-EventType <ComplianceRuleIdParameter>]
    [-FilePlanProperty <String>]
    [-FlowId <System.Guid>]
    [-Force]
    [-MultiStageReviewProperty <String>]
    [-Notes <String>]
    [-RetentionDuration <Unlimited>]
    [-ReviewerEmail <SmtpAddress[]>]
    [-WhatIf]
    [<CommonParameters>]

PriorityCleanup

Set-ComplianceTag
    [-Identity] <ComplianceRuleIdParameter>
    [-PriorityCleanup]
    [-Comment <String>]
    [-Confirm]
    [-Force]
    [-MultiStageReviewProperty <String>]
    [-Notes <String>]
    [-RetentionDuration <Unlimited>]
    [-WhatIf]
    [<CommonParameters>]

Описание

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

Примеры

Пример 1

Set-ComplianceTag -Identity "HR Content" -RetentionDuration 2555 -Comment "Retain HR content for 7 years"

Этот пример кода изменяет срок хранения и добавляет комментарий для существующей метки HR Content.

Параметры

-AutoApprovalPeriod

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

{{ Fill AutoApprovalPeriod Description }}

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

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

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

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

-Comment

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

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

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

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

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

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

-ComplianceTagForNextStage

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

{{ Fill ComplianceTagForNextStage Description }}

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

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

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

(All)
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

-EventType

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

EventType указывает правило хранения, связанное с меткой. Можно использовать любое значение, уникальным образом идентифицирующее правило. Пример:

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

Чтобы просмотреть доступные правила хранения, можно использовать командлет Get-RetentionComplianceRule.

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

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

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

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

-FilePlanProperty

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

Параметр FilePlanProperty указывает свойства плана файлов, которые необходимо включить в метку. Чтобы просмотреть имена свойств плана файлов, которые необходимо использовать в этом параметре, выполните следующие команды:

  • Get-FilePlanPropertyAuthority | Format-List Name
  • Get-FilePlanPropertyCategory | Format-List Name
  • Get-FilePlanPropertyCitation | Format-List Name
  • Get-FilePlanPropertyDepartment | Format-List Name
  • Get-FilePlanPropertyReferenceId | Format-List Name
  • Get-FilePlanPropertySubCategory | Format-List Name

Допустимое значение для этого параметра состоит из двух шагов:

  • Переменная для хранения свойств плана файла в виде PSCustomObject с использованием следующего синтаксиса:

    $Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}

    Например:

    $retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="ReferenceA"},@{Key="FilePlanPropertyAuthority"; Value="Auth1"})}

  • Вторая переменная для преобразования PSCustomObject в объект JSON с помощью следующего синтаксиса:

    $Variable2 = ConvertTo-Json $Variable1

    Например:

    $fpStr = ConvertTo-Json $retentionLabelAction

В качестве значения для этого параметра используется вторая переменная.

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

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

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

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

-FlowId

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

Примечание. Этот параметр сейчас находится в предварительной версии, он доступен не во всех организациях и может быть изменен.

Параметр FlowId указывает поток Power Automate, который будет выполняться в конце периода хранения. Допустимым значением для этого параметра является значение GUID потока.

Значение GUID потока можно найти с помощью любого из следующих методов:

  • Перейдите к потоку на портале Power Automate. Значение GUID потока находится в URL-адресе.
  • Используйте действие Power Automate с именем "Перечисление потоков от имени администратора".

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

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

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

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

-Force

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

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

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

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

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

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

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

-Identity

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

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

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

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

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

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

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

-MultiStageReviewProperty

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

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

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'

Например:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'

Этот синтаксис представляет собой объект JSON, определяющий идентификатор каждого этапа проверки, имя этапа проверки и список рецензентов.

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

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

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

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

-Notes

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

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

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

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

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

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

-PriorityCleanup

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

{{ Fill PriorityCleanup Description }}

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

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

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

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

-RetentionDuration

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

Параметр RetentionDuration указывает срок хранения содержимого (в днях). Допустимые значения:

  • положительное целое число;
  • значение unlimited.

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

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

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

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

-ReviewerEmail

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

Параметр ReviewerEmail задает адрес электронной почты проверяющего для действий хранения Delete и KeepAndDelete. Можно указать несколько адресов электронной почты, разделив их запятыми.

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

Тип:

SmtpAddress[]

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

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

(All)
Position:Named
Обязательно:False
Значение из конвейера: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.