Remove-OBPolicy
現在設定されているバックアップ ポリシー (OBPolicy オブジェクト) を削除または一時停止します。
構文
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 |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DeleteBackup
このポリシーに関連付けられている Microsoft Azure Backup サーバーにバックアップされたすべてのデータを直ちに削除することを指定します。
型: | SwitchParameter |
配置: | 3 |
規定値: | True |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EnablePruning
保存されているバックアップがすぐに削除されるのではなく、構成されたポリシーに従って削除されることを示します。 また、このパラメーターを有効にするには、DeleteBackup パラメーターを指定します。 このフラグを使用するには、MARS エージェントのバージョン 2.0.9250.0 が必要です。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Policy
削除するポリシーを指定します。
型: | CBPolicy |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
型: | SwitchParameter |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
None
出力
Microsoft.Internal.CloudBackup.Commands.OBPolicy