Set-ComplianceTag
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 Set-ComplianceTag Cmdlet 來修改 Microsoft Purview 合規性入口網站 中的保留標籤。 保留標籤會將保留設定套用至內容。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
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>]
Description
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
Set-ComplianceTag -Identity "HR Content" -RetentionDuration 2555 -Comment "Retain HR content for 7 years"
此範例會透過修改保留期間和新增註解,來修改名為 HR Content 的現有標籤。
參數
-AutoApprovalPeriod
適用:安全性 & 合規性
{{ 填入 AutoApprovalPeriod 描述 }}
參數屬性
| 類型: | System.Int32 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Comment
適用:安全性 & 合規性
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ComplianceTagForNextStage
適用:安全性 & 合規性
{{ Fill ComplianceTagForNextStage Description }}
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
適用:安全性 & 合規性
Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | cf |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-EventType
適用:安全性 & 合規性
EventType 會指定與標籤相關聯的保留規則。 您可以使用唯一識別規則的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
您可以使用 Get-RetentionComplianceRule Cmdlet 來檢視可用的保留規則。
參數屬性
| 類型: | ComplianceRuleIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-FilePlanProperty
適用:安全性 & 合規性
FilePlanProperty 參數會指定要包含在標籤中的檔案計畫屬性。 若要檢視您需要在此參數中使用的檔案計劃屬性名稱,請執行下列命令:
Get-FilePlanPropertyAuthority | Format-List NameGet-FilePlanPropertyCategory | Format-List NameGet-FilePlanPropertyCitation | Format-List NameGet-FilePlanPropertyDepartment | Format-List NameGet-FilePlanPropertyReferenceId | Format-List NameGet-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 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-FlowId
適用:安全性 & 合規性
注意:此參數目前為預覽狀態,並非所有組織都可使用,而且可能會變更。
FlowId 參數會指定要在保留期間結束時執行的 Power Automate 流程。 此參數的有效值是流程的 GUID 值。
您可以使用下列其中一種方法來尋找流程的 GUID 值:
- 從Power Automate入口網站流覽至流程。 流程的 GUID 值位於 URL 中。
- 使用名為「以系統管理員身分列出流程」的Power Automate 動作。
參數屬性
| 類型: | System.Guid |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
適用:安全性 & 合規性
Force 參數會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Identity
適用:安全性 & 合規性
Identity 參數會指定您要修改的標籤。 您可以使用能唯一識別標記的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
參數屬性
| 類型: | ComplianceRuleIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | 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 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Notes
適用:安全性 & 合規性
Notes 參數會指定選擇性的附注。 如果您指定包含空格的值,請將值括在引號 (“) ,例如:「這是使用者筆記」。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PriorityCleanup
適用:安全性 & 合規性
{{ Fill PriorityCleanup Description }}
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
PriorityCleanup
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RetentionDuration
適用:安全性 & 合規性
RetentionDuration 參數會指定要保留內容的天數。 有效值為:
- 正整數。
- 值 unlimited。
參數屬性
| 類型: | Unlimited |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ReviewerEmail
適用:安全性 & 合規性
ReviewerEmail 參數會指定 Delete 和 KeepAndDelete 保留動作檢閱者的電子郵件地址。 您可以指定以逗號隔開的多個電子郵件地址。
參數屬性
| 類型: | SmtpAddress[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
適用:安全性 & 合規性
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 無線 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。