Set-CaseHoldPolicy
このコマンドレットは、セキュリティ & コンプライアンス PowerShell でのみ使用できます。 詳細については、「 セキュリティ & コンプライアンス PowerShell」を参照してください。
Set-CaseHoldPolicy コマンドレットを使用して、Microsoft Purview コンプライアンス ポータル内の既存のケース ホールド ポリシーを変更します。
注: このコマンドレットを実行すると、organization全体で完全同期が実行されます。これは重要な操作です。 複数のポリシーを更新する必要がある場合は、ポリシーの配布が成功するまで待ってから、次のポリシーのコマンドレットをもう一度実行します。 ポリシーを複数回更新する必要がある場合は、コマンドレットの 1 回の呼び出しですべての変更を行います。 配布状態の詳細については、「 Get-CaseHoldPolicy」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Set-CaseHoldPolicy
[-Identity] <PolicyIdParameter>
[-RetryDistribution]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Set-CaseHoldPolicy
[-Identity] <PolicyIdParameter>
[-AddExchangeLocation <MultiValuedProperty>]
[-AddPublicFolderLocation <MultiValuedProperty>]
[-AddSharePointLocation <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-RemoveExchangeLocation <MultiValuedProperty>]
[-RemovePublicFolderLocation <MultiValuedProperty>]
[-RemoveSharePointLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>] 説明
セキュリティ & コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可を割り当てる必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
注: スコープの場所を追加または削除するときは、パイプForeach-Object コマンドを使用しないでください。 "Value1","Value2",..."ValueN" | Foreach-Object {Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}
例
例 1
Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14"この例では、「Regulation 123 Compliance」という名前の既存のケース保持ポリシーを次のように変更します。
- Kitty Petersen という名前のユーザーのメールボックスを追加します。
- SharePoint Online サイト
https://contoso.sharepoint.com/sites/teams/financeを追加します。 - パブリック フォルダーを削除します。
- コメントを更新します。
パラメーター
-AddExchangeLocation
AddExchangeLocation パラメーターは、含まれているメールボックスの一覧に追加するメールボックスを指定します。 有効な値は次のとおりです。
- ExchangeLocation パラメーターは、ポリシーに含めるメールボックスを指定します。有効な値は次のとおりです。
- メールボックス。
メールボックスまたは配布グループを指定するには、次の値を使用します。
- 名前
- SMTP アドレス。 非アクティブなメールボックスを指定するには、アドレスの前にピリオド (.) を付けます。
- Azure AD ObjectId。 この値を見つけるには、Microsoft Graph PowerShell の Get-MgUser コマンドレットまたは Get-MgGroup コマンドレットを使用します。
Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-AddPublicFolderLocation
AddPublicFolderLocation パラメーターは、ケース保持ポリシーにすべてのパブリック フォルダーを追加することを指定します。 このパラメーターに値 All を使用します。
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-AddSharePointLocation
AddSharePointLocation パラメーターは、SharePointLocation パラメーターの値 All を使用していない場合に含まれるサイトの一覧に追加する SharePoint Online サイトを指定します。 サイトは URL 値で指定します。
Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"
SharePoint Online サイトは、インデックスが作成されるまでポリシーに追加できません。
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-Comment
Comment パラメーターで、オプションのコメントを指定します。 スペースを含む値を指定する場合は、次のように値を二重引用符 (") で囲んでください。"これは管理者メモです。"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-Enabled
Enabled パラメーターは、ポリシーを有効にするかどうかを指定します。 有効な値は次のとおりです。
- $true: ポリシーを有効にします。 これは既定の値です。
- $true: ポリシーを有効にします。これが既定値です。
| Type: | Boolean |
| 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: | PolicyIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-RemoveExchangeLocation
RemoveExchangeLocation パラメーターは、ポリシーから削除する既存のメールボックスを指定します。 有効な値は次のとおりです。
- このパラメーターは、ExchangeLocation パラメーターに値 All を使用するときに、除外する一覧から削除するメールボックスを指定します。有効な値は次のとおりです。
- メールボックス。
すべてのメールボックスに対する値 All。 この値のみ、それ自体で使用できます。
- 名前
- SMTP アドレス。 非アクティブなメールボックスを指定するには、アドレスの前にピリオド (.) を付けます。
- Azure AD ObjectId。 この値を見つけるには、Microsoft Graph PowerShell の Get-MgUser コマンドレットまたは Get-MgGroup コマンドレットを使用します。
Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-RemovePublicFolderLocation
RemovePublicFolderLocation パラメーターは、ケース保持ポリシーからすべてのパブリック フォルダーを削除することを指定します。 このパラメーターに値 All を使用します。
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-RemoveSharePointLocation
RemoveSharePointLocation パラメーターは、SharePointLocation パラメーターの値 All を使用していない場合に含まれるサイトの一覧から削除する SharePoint Online サイトを指定します。 サイトは URL 値で指定します。
Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-RetryDistribution
RetryDistribution スイッチは、ポリシーをすべてのExchange Onlineと SharePoint Online の場所に再配布するかどうかを指定します。 このスイッチで値を指定する必要はありません。
初期の配布が成功した場所は、再試行に含まれません。 このスイッチを使用すると、ポリシーの配布エラーが報告されます。
注: 配布を再試行するプロセスは重要な操作であるため、必要な場合にのみ、一度に 1 つのポリシーに対して実行してください。 ポリシーを更新するたびに実行されるわけではありません。 スクリプトを実行して複数のポリシーを更新する場合は、ポリシー配布が成功するまで待ってから、次のポリシーのコマンドをもう一度実行します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |