通过

Set-ComplianceTag

  • 参考
模块:
ExchangePowerShell
适用于:
Security & Compliance

此 cmdlet 仅在安全性 & 合规性 PowerShell 中可用。 有关详细信息，请参阅 安全性 & 合规性 PowerShell。

使用 Set-ComplianceTag cmdlet 修改Microsoft Purview 合规门户中的保留标签。 保留标签将保留设置应用于内容。

有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。

语法

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

说明

若要在安全性 & 合规性 PowerShell 中使用此 cmdlet，需要分配权限。 有关详细信息，请参阅 Microsoft Purview 合规门户中的权限。

示例

示例 1

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

本示例通过修改保留期限并添加注释来修改名为 HR Content 的现有标签 。

参数

-Comment

Comment 参数指定可选注释。 如果您指定包含空格的值，为该值加上双引号(")，例如："这是管理员备注"。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ComplianceTagForNextStage

{{ Fill ComplianceTagForNextStage Description }}

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Confirm

Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

  • 破坏性 cmdlet (例如，Remove-* cmdlet) 具有内置的暂停，该暂停会强制你在继续操作之前确认命令。 对于这些 cmdlet，您可以使用此确切语法跳过确认提示：-Confirm:$false。
  • 大多数其他 cmdlet (例如，New-* 和 Set-* cmdlet) 没有内置暂停。 对于这些 cmdlet，指定不含值的 Confirm 开关会引入暂停，从而强制要求你先确认命令，然后再继续操作。
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-EventType

EventType 指定与标签关联的保留规则。 可以使用唯一标识该规则的任何值。 例如：

  • 名称
  • 可分辨名称 (DN)
  • GUID

可使用 Get-RetentionComplianceRule cmdlet 来查看可用的保留规则。

Type:ComplianceRuleIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-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

使用第二个变量作为此参数的值。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-FlowId

{{ Fill FlowId Description }}

Type:System.Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Force

强制开关隐藏警告或确认消息。 不必为此开关指定值。

您可以在以编程方式运行任务时使用此开关，因为此时并不适合提示用户提供管理输入。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Identity

Identity 参数指定要修改的标签。 可以使用唯一标识该标签的任何值。 例如：

  • 名称
  • 可分辨名称 (DN)
  • GUID
Type:ComplianceRuleIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Security & Compliance

-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 对象，用于定义每个评审阶段 ID、评审阶段名称和审阅者列表。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Notes

Notes 参数指定可选注释。 如果指定一个包含空格的值，请将该值括在引号 (“) ，例如：”这是用户备注”。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDuration

RetentionDuration 参数指定要保留内容的天数。 有效值包含:

  • 正整数。
  • 值 unlimited。
Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ReviewerEmail

ReviewerEmail 参数指定了 Delete 和 KeepAndDelete 保留操作的审阅者的电子邮件地址。 可以指定多个电子邮件地址，中间用逗号分隔。

Type:SmtpAddress[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

WhatIf 开关在安全 & 合规性 PowerShell 中不起作用。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance