Set-ComplianceTag

  • 參考
模組:
ExchangePowerShell
適用於:
Security & Compliance

此 Cmdlet 僅適用于安全 & 性合規性 PowerShell。 如需詳細資訊，請參閱 安全 & 性合規性 PowerShell。

使用 Set-ComplianceTag Cmdlet 來修改Microsoft Purview 合規性入口網站中的保留標籤。 保留標籤會將保留設定套用至內容。

如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。

Syntax

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>]

Description

若要在安全 & 性合規性 PowerShell 中使用此 Cmdlet，您必須獲指派許可權。 如需詳細資訊，請參閱 Microsoft Purview 合規性入口網站中的權限。

範例

範例 1

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

此範例會透過修改保留期間和新增註解，來修改名為 HR Content 的現有標籤。

參數

-Comment

Comment 參數會指定選擇性註解。 如果指定的值含有空格，則必須以雙引號 (") 括住值，例如︰"This is an admin note"。

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

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 物件，可定義每個檢閱階段識別碼、檢閱階段名稱和檢閱者清單。

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