New-RetentionCompliancePolicy
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 New-RetentionCompliancePolicy Cmdlet 在 Microsoft Purview 合規性入口網站 中建立新的保留原則和新的保留卷標原則。 建立新原則也需要使用 New-RetentionComplianceRule Cmdlet。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
New-RetentionCompliancePolicy
[-Name] <String>
[-Applications <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-ExchangeLocation <MultiValuedProperty>]
[-ExchangeLocationException <MultiValuedProperty>]
[-Force]
[-IsSimulation]
[-ModernGroupLocation <MultiValuedProperty>]
[-ModernGroupLocationException <MultiValuedProperty>]
[-OneDriveLocation <MultiValuedProperty>]
[-OneDriveLocationException <MultiValuedProperty>]
[-PolicyRBACScopes <MultiValuedProperty>]
[-PolicyTemplateInfo <PswsHashtable>]
[-PriorityCleanup]
[-PublicFolderLocation <MultiValuedProperty>]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SharePointLocation <MultiValuedProperty>]
[-SharePointLocationException <MultiValuedProperty>]
[-SkipPriorityCleanupConfirmation]
[-SkypeLocation <MultiValuedProperty>]
[-SkypeLocationException <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
New-RetentionCompliancePolicy
[-Name] <String>
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-IsSimulation]
[-PriorityCleanup]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SkipPriorityCleanupConfirmation]
[-TeamsChannelLocation <MultiValuedProperty>]
[-TeamsChannelLocationException <MultiValuedProperty>]
[-TeamsChatLocation <MultiValuedProperty>]
[-TeamsChatLocationException <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
New-RetentionCompliancePolicy
[-Name] <String>
-AdaptiveScopeLocation <MultiValuedProperty>
[-Applications <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-IsSimulation]
[-PriorityCleanup]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SkipPriorityCleanupConfirmation]
[-WhatIf]
[<CommonParameters>]
Description
在) 新增保留原則的規則 (,或在保留卷標原則) (新增標籤之前,原則無效。 如需詳細資訊,請參閱 New-RetentionComplianceRule。 此外,至少必須定義一個位置參數,才能建立保留原則或保留標籤原則。
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 [Microsoft Purview 合規性入口網站 中的許可權]/purview/microsoft-365-compliance-center-permissions) 。
範例
範例 1
New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance"
此範例會為 Kitty Petersen 和 Scott 的 Scott 要件的信箱,以及 Finance SharePoint Online 網站建立名為「法規 123 合規性」的保留原則。
下一個步驟是使用 New-RetentionComplianceRule Cmdlet 將規則新增至保留原則。
範例 2
New-RetentionCompliancePolicy -Name "Marketing Department" -Enabled $true -SharePointLocation https://contoso.sharepoint.com -RetainCloudAttachment $true -Comment "Regulatory compliance for Marketing Dept."
此範例會建立新的自動套用標籤原則,以名為 Marketing Department 且具有指定詳細數據的雲端附件為目標。
下一個步驟是使用 New-RetentionComplianceRule Cmdlet 將保留標籤新增至保留卷標原則。
參數
-AdaptiveScopeLocation
AdaptiveScopeLocation 參數會指定要包含在原則中的調適型範圍位置。 您可以使用 New-AdaptiveScope Cmdlet 來建立調適型範圍。 您可以使用可唯一識別調適型範圍的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Applications
當modernGroups參數設定) (原則中包含 Microsoft 365 群組時,Applications 參數會指定目標。 有效值為:
-
Group:Exchange
適用於連線至 Microsoft 365 群組的信箱。 -
Group:SharePoint
適用於連線至 Microsoft 365 群組的 SharePoint 網站。 -
"Group:Exchange,SharePoint"
適用於已連線至 Microsoft 365 群組的信箱和 SharePoint 網站。 - 空白 (
$null
) :這是預設值,而且在功能上相當於 值"Group:Exchange,SharePoint"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Comment
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Confirm
Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false
。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Enabled
Enabled 參數會指定已啟用或已停用原則。 有效值為:
- $true:已啟用原則。 這是預設值。
- $true:已啟用原則。此為預設值。
類型: | Boolean |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ExchangeLocation
ExchangeLocation 參數會指定要包含在原則中的信箱。 有效值為:
- ExchangeLocation 參數會指定要包含在原則中的信箱。有效值為:
- 信箱
- 所有信箱的 All 值。 您只能單獨使用此值。
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
若未指定任何信箱,則沒有信箱會處於保留狀態。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ExchangeLocationException
當您使用 ExchangeLocation 參數的 All 值時,ExchangeLocationException 參數會指定要從原則中排除的信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Force
Force 參數會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-IsSimulation
IsSimulation 參數會指定以模擬模式建立原則。 您不需要使用此參數指定值。
如需模擬模式的詳細資訊,請參閲 了解模擬模式。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ModernGroupLocation
ModernGroupLocation 參數會指定要包含在原則中的 Microsoft 365 群組。 有效值為:
- Microsoft 365 群組
- 所有 Microsoft 365 群組的 All 值。 您只能單獨使用此值。
若要識別Microsoft 365 群組,您可以使用可唯一識別它的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ModernGroupLocationException
ModernGroupLocationException 參數會指定當您針對 ModernGroupLocation 參數使用 All 值時,要從原則中排除的 Microsoft 365 群組。
您可以使用可唯一識別Microsoft 365 群組的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Name
Name 參數會指定保留原則的唯一名稱。 如果值包含空格,請使用引號括住值。
類型: | String |
Position: | 1 |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-OneDriveLocation
OneDriveLocation 參數會指定要包含的 商務用 OneDrive 網站。 您依據其 URL 值識別網站,或者您可以使用 All 值以包含所有網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-OneDriveLocationException
當您針對 OneDriveLocation 參數使用 All 值時,此參數會指定要排除的 商務用 OneDrive 月臺。 您可以依據其 URL 值識別網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PolicyRBACScopes
PolicyRBACScopes 參數會指定要指派給原則的管理單位。 有效的值是管理單位的 Microsoft Entra ObjectID (GUID 值) 。 您可以指定多個以逗號分隔的值。
管理單位僅適用於 Microsoft Entra ID P1 或 P2。 您可以在 Microsoft Graph PowerShell 中建立和管理管理單位。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PolicyTemplateInfo
將保留此參數供 Microsoft 內部使用。
類型: | PswsHashtable |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PriorityCleanup
{{ Fill PriorityCleanup Description }}
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PublicFolderLocation
PublicFolderLocation 參數會指定您要將所有公用資料夾包含在保留原則中。 您可對此參數使用 All 值。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RestrictiveRetention
RestrictiveRetention 參數會指定是否啟用原則的保留鎖定。 有效值為:
- $true:已啟用原則的保留鎖定。 包括系統管理員在內的任何人員都無法關閉原則,或使其較不嚴格。
- $false:原則未啟用保留鎖定。 這是預設值。
鎖定原則之後,任何人均無法關閉或停用它,或從原則移除內容。 而且無法修改或刪除在保留期間受原則約束的內容。 修改保留原則的唯一方式是藉由在其中新增內容,或延長其持續時間。 鎖定的原則可以增加或擴充,但無法減少、停用或關閉。
因此,在鎖定保留原則之前,請務必瞭解組織的合規性需求,而且在確定這是您需要的原則之前,不要鎖定原則。
類型: | Boolean |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RetainCloudAttachment
注意:此參數目前為預覽狀態,並非所有組織都可使用,而且可能會變更。
RetainCloudAttachment 參數會指定這是雲端附件原則。 有效值為:
- $true:原則是雲端附件原則。
- $false:此原則不是雲端附件原則。 這是預設值。
針對$true值,您只能使用下列位置參數:
- SharePointLocation 和 SharePointLocationException
- OneDriveLocation 和 OneDriveLocationException
- ModernGroupLocation 和 ModernGroupLocationException
使用雲端附件原則建立規則的標籤可以是記錄標籤或法規標籤。 您無法使用雲端附件原則的發佈標籤來建立規則;僅支援套用標籤。
Set-RetentionCompliancePolicy Cmdlet 上無法使用 RetainCloudAttachment 參數。
類型: | Boolean |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-SharePointLocation
SharePointLocation 參數會指定要包含的 SharePoint Online 網站。 您依據其 URL 值識別網站,或者您可以使用 All 值以包含所有網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
在編制索引之前,無法將 SharePoint Online 網站新增至原則。 若未指定任何網站,則沒有網站會處於保留狀態。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-SharePointLocationException
當您針對 SharePointLocation 參數使用 All 值時,此參數會指定要排除的 SharePoint Online 網站。 您可以依據其 URL 值識別網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-SkipPriorityCleanupConfirmation
{{ Fill SkipPriorityCleanupConfirmation Description }}
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-SkypeLocation
SkypeLocation 參數會指定要包含在原則中的 商務用 Skype Online 使用者。
您可以使用唯一識別使用者的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-SkypeLocationException
將保留此參數供 Microsoft 內部使用。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-TeamsChannelLocation
TeamsChannelLocation 參數會指定要包含在原則中的 Teams。
您可以使用可唯一識別小組的任何值。 例如:
- 名稱
- 電子郵件地址
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-TeamsChannelLocationException
當您針對 TeamsChannelLocation 參數使用 All 值時,TeamsChannelLocationException 參數會指定要排除的 Teams。 您可以使用可唯一識別小組的任何值。 例如:
- 名稱
- 電子郵件地址
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-TeamsChatLocation
TeamsChatLocation 參數會指定要包含在原則中的 Teams 使用者。
您可以使用唯一識別使用者的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-TeamsChatLocationException
當您針對 TeamsChatLocation 參數使用 All 值時,TeamsChatLocationException 參數會指定要排除的 Teams 使用者。 您可以使用唯一識別使用者的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-WhatIf
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |