Invoke-HoldRemovalAction
このコマンドレットは、セキュリティ/コンプライアンス PowerShell でのみ使用できます。 詳細については、「セキュリティ/コンプライアンス PowerShell」を参照してください。
Invoke-HoldRemovalAction コマンドレットを使用して、メールボックスと SharePoint サイトの保留を表示および削除します。 このコマンドレットを使用して、以前に削除された保留リストを表示することもできます。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Invoke-HoldRemovalAction
-Action <HoldRemovalActionType>
[-Confirm]
[-ExchangeLocation <String>]
[-Force]
[-HoldId <String>]
[-SharePointLocation <String>]
[-WhatIf]
[<CommonParameters>]
説明
セキュリティ/コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可が割り当てられている必要があります。 Exchange または Sharepoint の場所の保留を削除できるのはコンプライアンス管理者のみです。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
例
例 1
Invoke-HoldRemovalAction -Action RemoveHold -ExchangeLocation "KittyPetersen@contoso.onmicrosoft.com" -HoldId "UniHecbf89df-74fc-444a-a2dc-c0756c7d3503"
次の使用例は、ポリシー UniHecbf89df-74fc-444a-a2dc-c0756c7d3503 がアクティブなケース ホールド ポリシーでない場合に、キティ ピーターセンのメールボックスで指定した保留を削除します。
例 2
Invoke-HoldRemovalAction -Action GetHolds -SharePointLocation "https://contoso.sharepoint.com/sites/finance"
次の使用例は、指定した SharePoint サイトのすべての保留情報を表示します。
例 3
Invoke-HoldRemovalAction -Action GetHoldRemovals
この例では、このコマンドレットを使用して行われたすべての保留の削除を表示します。
パラメーター
-Action
適用対象: セキュリティ & コンプライアンス
Action パラメーターは、コマンドレットが動作するモードを指定します。 有効な値は次のとおりです。
- GetHoldRemovals: このコマンドレットを使用して行われたすべての保留の削除を表示します。
- GetHolds: 指定したメールボックス (ExchangeLocation パラメーター) または SharePoint サイト (SharePointLocation パラメーター) の保留を表示します。
- RemoveHold: 指定したメールボックス (ExchangeLocation パラメーター) または SharePoint サイト (SharePointLocation パラメーター) から、指定した保留 (HoldId パラメーター) を削除します。
パラメーターのプロパティ
| 型: | HoldRemovalActionType |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
適用対象: セキュリティ & コンプライアンス
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExchangeLocation
適用対象: セキュリティ & コンプライアンス
ExchangeLocation パラメーターは、表示または削除する保留を含むメールボックスのメール アドレスを指定します。
このパラメーターは、Action パラメーターに GetHolds または RemoveHold の値を使用する場合に必要です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
適用対象: セキュリティ & コンプライアンス
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、ポリシーがアクティブな場合でも保留を強制的に削除できます。 代わりに、ケースホールド ポリシーから保留を削除する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HoldId
適用対象: セキュリティ & コンプライアンス
HoldId パラメーターは、表示または削除する保留を指定します。
このパラメーターの有効な値を見つけるには、このコマンドレットを Action パラメーター値 GetHolds と共に使用し、出力で HoldId プロパティを探します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SharePointLocation
適用対象: セキュリティ & コンプライアンス
SharePointLocation パラメーターは、表示または削除する保留を含む SharePoint サイトの URL を指定します。
このパラメーターは、Action パラメーターに GetHolds または RemoveHold の値を使用する場合に必要です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: セキュリティ & コンプライアンス
WhatIf スイッチは、セキュリティ/コンプライアンス PowerShell では機能しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。