Azure Backup に関する Azure リソースマネージャーでの PowerShell コマンドレット (New-AzureRMBackupProtectionPolicy) について

2015/09/10 (現地時間) にプレビュー版で提供されていた Azure VM に対するバックアップ (Azure VM Backup) が (GA) となり、正式リリースされました。

Azure Backup の管理に使用することが可能な Azure リソースマネージャーでの PowerShell コマンドレットが提供されており、設定方法について MSDN サイト上で公開されていますが、PowerShell コマンドレットのヘルプについては英語のみであり、日本語による情報はほとんど公開されていません。

Azure Backup に関する Azure リソースマネージャー PowerShell コマンドレットの 1 つである「New-AzureRMBackupProtectionPolicy」について、本ブログにて日本語の情報として纏めてみました ((他の PowerShell コマンドレットについては、「Azure Backup に関する Azure リソースマネージャーでの PowerShell コマンドレットについて」を参照) (Windows Azure PowerShell バージョン 0.9.8 で確認しているものとなります) (Azure リソースマネージャーモードに変更して実行する必要があります)。

■名前

New-AzureRMBackupProtectionPolicy

■概要

バックアップポリシー情報を保持している PowerShell オブジェクトを作成します。

■構文

New-AzureRMBackupProtectionPolicy [-Name] <String> [-Type] <String> [-BackupTime] <DateTime> [[-DaysOfWeek] <String[]>] [-RetentionPolicy] <AzureRMBackupRetentionPolicy[]> [-Vault] <AzureRMBackupVault> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupProtectionPolicy [-Name] <String> [-Type] <String> [[-Daily] [<SwitchParameter>]] [-BackupTime] <DateTime> [-RetentionPolicy] <AzureRMBackupRetentionPolicy[]> [-Vault] <AzureRMBackupVault> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupProtectionPolicy [-Name] <String> [-Type] <String> [-Weekly] [<SwitchParameter>] [-BackupTime] <DateTime> [[-DaysOfWeek] <String[]>] [-RetentionPolicy] <AzureRMBackupRetentionPolicy[]> [-Vault] <AzureRMBackupVault> [-Profile <AzureProfile>] [<CommonParameters>]

■説明

バックアップポリシーは、いつ項目のバックアップがいつ行われれるか、およびその頻度を定義します。このコマンドレットは、バックアップポリシー情報を保持する PowerShell オブジェクトを作成します。バックアップポリシーは Enable-AzureRMBackupProtection コマンドレットへ入力として使用されます。

Daily、Weekly、Monthly、および Yearly の 4 種類の保持があります。使用する予定がある保持データの種類ごとに 1 つのオブジェクトを作成する必要があります。

■パラメーター

-Name <String>
バックアップポリシー名を指定します。資格情報コンテナー内で一意である必要があります。

必須	true
位置	1
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Type <String>
ポリシーが適用されるバックアップ項目の型を指定します。現在サポートされている値は AzureVM のみです。

必須	true
位置	2
既定値	なし
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-BackupTime <DateTime>
バックアップが起動する必要がある場合の時間を指定します。

必須	true
位置	5
既定値	なし
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-DaysOfWeek <String[]>
バックアップが -BackupTime オプションを使用して指定された時間に起動された場合、1 つ以上の曜日を指定します。このパラメーターは、-Weekly フラグと一緒に使用する必要があります。

必須	false
位置	6
既定値	なし
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-RetentionPolicy <AzureRMBackupRetentionPolicy[]>
このバックアップポリシー内に関連付けられた 1 つ以上の保持ポリシーを指定します。保持ポリシーを作成するために New-AzureRMBackupRetentionPolicyObject オブジェクトを用います。

必須	true
位置	7
既定値	なし
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Vault <AzureRMBackupVault>
バックアップポリシーに対して親である Azure Backup 資格情報コンテナーを指定します。

必須	false
位置	2
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Profile <AzureProfile>
AzureProfile 入力オブジェクトは必須ではありません。

必須	false
位置	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Daily [<SwitchParameter>]
バックアップポリシーが毎日実行されることを示すフラグです。

必須	false
位置	3
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Weekly [<SwitchParameter>]
バックアップポリシーが週 1 日以上で実行されることを示すフラグです。

必須	true
位置	4
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: –Verbose、-Debug、-ErrorAction、-ErrorVariable、-WarningAction、-WarningVariable、-OutBuffer、-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。

■入力

なし

■出力

AzureRMBackupProtectionPolicy

■メモ

詳細については、「Get-Help New-AzureRMBackupProtectionPolicy -detailed」と入力してください。
技術情報については、「Get-Help New-AzureRMBackupProtectionPolicy -full」と入力してください。

■エイリアス

なし

■例

例 1: 日次、月次保持する日次バックアップポリシーの作成

 $bp = New-AzureRMBackupProtectionPolicy -Name DailyBackup01 -Type AzureVM -Daily -BackupTime ([datetime]"3:30 PM") -RetentionPolicy ($Daily,$Monthly) -Vault $v

Name                      Type               ScheduleType       BackupTime
—-                      —-               ————       ———-
DailyBkp                  AzureVM            Daily              26-Aug-15 3:00:00 PM

この例のバックアップポリシーは、3:00 PM に日次バックアップ、New-AzureRMBackupRetentionPolicyObject コマンドレットを用いて作成された $Daily および $Monthly 保持ポリシーとして格納されたバックアップデータを持ちます。