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

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

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

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

■名前

New-AzureRMBackupRetentionPolicyObject

■概要

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

■構文

New-AzureRMBackupRetentionPolicyObject [-DailyRetention [<SwitchParameter>]] -Retention <Int32> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupRetentionPolicyObject [-WeeklyRetention [<SwitchParameter>]] -DaysOfWeek <String[]> -Retention <Int32> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupRetentionPolicyObject [-MonthlyRetentionInDailyFormat [<SwitchParameter>]] -DaysOfMonth <List`1[String]> -Retention <Int32> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupRetentionPolicyObject [-MonthlyRetentionInWeeklyFormat [<SwitchParameter>]] -DaysOfWeek <String[]> -WeekNumber <String[]> -Retention <Int32> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupRetentionPolicyObject [-YearlyRetentionInDailyFormat [<SwitchParameter>]] -DaysOfMonth <List`1[String]> -MonthsOfYear <String[]> -Retention <Int32> [-Profile <AzureProfile>] [<CommonParameters>]

New-AzureRMBackupRetentionPolicyObject [-YearlyRetentionInWeeklyFormat [<SwitchParameter>]] -DaysOfWeek <String[]> -WeekNumber <String[]> -MonthsOfYear <String[]> -Retention <Int32> [-Profile <AzureProfile>] [<CommonParameters>]

■説明

バックアップポリシーは少なくとも保持ポリシーに関連付けられます。保持ポリシーは、Azure Backup が回復ポイントをどの期間保持するかを定義します。このコマンドレットは、保持ポリシー情報で保持する PowerShell オブジェクトを作成します。これらの保持ポリシーオブジェクトは、New-AzureRMBackupProtectionPolicy コマンドレットへ入力として、もしくは直接 Enable-AzureRMBackupProtection コマンドレットに使用されます。

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

■パラメーター

-DailyRetention [<SwitchParameter>]
日次の保持情報を持つオブジェクトを作成するスイッチパラメーター。

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

-Retention <Int32>
バックアップポイントが格納される保持期間を指定します。このユニットは、コマンドレットで指定されたスイッチのオプションによって異なります。例として、-DailyRetention フラグを使用している場合、この値は日次の保持を指定します。また -MonthlyRetentionInDailyFormat フラグを使用している場合、この値は、月次の保持を指定します。

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

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

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

-WeeklyRetention [<SwitchParameter>]
週次の保持情報を持つオブジェクトを作成するスイッチパラメーター。

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

-DaysOfWeek <String[]>
週の日数は、回復ポイントをどのくらいの期間で保持することを識別するために使用されます。このパラメーターは、-WeeklyRetention、-MonthlyRetentionInWeeklyFormat、および -YearlyRetentionInWeeklyFormat オプションで動作します。

注: バックアップと保持のために取り出される曜日が整列されていることを確認する必要があります! 例として、バックアップが土曜日に設定されている場合、週次/月次/年次の保持ポリシーは、-DaysOfWeek オプションとして土曜日を使用する必要があります。

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

-MonthlyRetentionInDailyFormat [<SwitchParameter>]
月次の保持情報を持つオブジェクトを作成するスイッチパラメーター。

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

-DaysOfMonth <List`1[String]>
月の日数は、回復ポイントをどのくらいの期間で保持することを識別するために使用されます。このパラメーターは、-DailyRetention、-MonthlyRetentionInDailyFormat、-YearlyRetentionInDailyFormat オプションで動作します。

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

-MonthlyRetentionInWeeklyFormat [<SwitchParameter>]
月次の保持情報を持つオブジェクトを作成するスイッチパラメーター。

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

-WeekNumber <String[]>
月次の保持を定義する場合、このパラメーターは、月次で保持を取得する必要がある回復ポイントを持つひと月の間でどの週かを指定します。

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

-YearlyRetentionInDailyFormat [<SwitchParameter>]
年次の保持情報を持つオブジェクトを作成するスイッチパラメーター。

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

-MonthsOfYear <String[]>
年次の保持を定義する場合、このパラメーターは、年次で保持を取得する必要がある回復ポイントを持つ 1 年の間でどの月かを指定します。

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

-YearlyRetentionInWeeklyFormat [<SwitchParameter>]
年次の保持情報を持つオブジェクトを作成するスイッチパラメーター。

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

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

■入力

なし

■出力

AzureRMBackupRetentionPolicy

■メモ

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

■エイリアス

なし

■例

例 1: 日次の保持を 30 日間とする保持ポリシーの作成

$Daily = New-AzureRMBackupRetentionPolicyObject -DailyRetention -Retention 30
$Daily

RetentionType      Retention          RetentionTimes
————-      ———          ————–
Daily              30

例 2: 月次の保持ポリシーの作成

$Monthly = New-AzureRMBackupRetentionPolicyObject -MonthlyRetentionInDailyFormat -DaysOfMonth (10, 20) -Retention 12
$Monthly | select *

RetentionFormat : Daily
DaysOfMonth     : {10, 20}
WeekNumber      :
DaysOfWeek      :
RetentionType   : Monthly
Retention       : 12
RetentionTimes :

このポリシーは、10 日および 20 日のバックアップをそれぞれ 12 ヶ月保持します。