Remove-OBPolicy
現在設定されているバックアップ ポリシー (OBPolicy オブジェクト) を削除または一時停止します。
構文
Default (既定)
Remove-OBPolicy
[-Policy] <CBPolicy>
[-DeleteBackup]
[-EnablePruning]
[-Confirm]
[-WhatIf]
説明
Remove-OBPolicy コマンドレットは、現在設定されているバックアップ ポリシー (OBPolicy オブジェクト) を削除または一時停止します。 DeleteBackup パラメーターを指定すると、このポリシーに従って Microsoft Azure Backup サーバー上にバックアップされたデータはすべて削除され、既存のバックアップのスケジュールも削除されます。 DeleteBackup パラメーターが指定されていない場合、既存のバックアップは削除され、バックアップの既存のスケジュールは一時停止されます。 EnablePruning パラメーターを DeleteBackup と共に使用して、バックアップ ポリシーの保有期間に従ってバックアップを保持します。
このコマンドレットは、 WhatIf パラメーターと Confirm パラメーターをサポートしています。
このコマンドレットは、既定でユーザーに確認を求めます。
WhatIf パラメーターは、操作を実行せずにコマンドレットが何を行うかを詳細に説明します。
Confirm パラメーターは、コマンドレットがユーザーにプロンプトを表示するかどうかを指定します。
プロンプトを上書きするには、-Confirm:$FALSE を指定します。
Microsoft Azure Backup コマンドレットを使用するには、ユーザーは保護されたコンピューターの管理者である必要があります。
例
例 1
Get-OBPolicy | Remove-OBPolicy
この例では、既存のポリシーを削除します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DeleteBackup
このポリシーに関連付けられている Microsoft Azure Backup サーバーにバックアップされたすべてのデータを直ちに削除するように指定します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | True |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 3 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EnablePruning
格納されたバックアップがすぐに削除されるのではなく、構成されたポリシーに従って削除されることを示します。 また、 DeleteBackup パラメータを指定して、このパラメータを有効にします。 このフラグを機能させるには、MARS エージェント バージョン 2.0.9250.0 が必要です。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Policy
削除するポリシーを指定します。
パラメーターのプロパティ
| 型: | CBPolicy |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |