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

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

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

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

■名前

Set-AzureRMBackupProtectionPolicy

■概要

存在する保護ポリシーを更新します。

■構文

Set-AzureRMBackupProtectionPolicy [[-NewName] <String>] [[-BackupTime] <DateTime>] [[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [-Profile <AzureProfile>] [<CommonParameters>]

Set-AzureRMBackupProtectionPolicy [[-NewName] <String>] [[-Daily] [<SwitchParameter>]] [[-BackupTime] <DateTime>] [[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [-Profile <AzureProfile>] [<CommonParameters>]

Set-AzureRMBackupProtectionPolicy [[-NewName] <String>] [[-Weekly] [<SwitchParameter>]] [[-BackupTime] <DateTime>] [[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [[-DaysOfWeek] <String[]>] [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [-Profile <AzureProfile>] [<CommonParameters>]

■説明

保護ポリシーは、複数のコンポーネントを持ちます:

Name
Backup schedule
Retention policies

Set-AzureRMBackupProtectionPolicy コマンドレットは、ポリシー内の 1 つ以上のコンポーネントを更新することを許可します。この変更は、ポリシーに関連付けられた項目のバックアップや保持に影響を与える可能性があります。

■パラメーター

-NewName <String>
ポリシーの新しい名前を指定するための追加のパラメーターです。任意のポリシーと同様、この値は資格情報コンテナー内で一意である必要があります。

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

-BackupTime <DateTime>
ポリシーに対する新しいバックアップ時間を指定するための追加のパラメーターです。

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

-RetentionPolicy <AzureRMBackupRetentionPolicy[]>
保護ポリシーに関連付けられる 1 つ以上の新しい保持ポリシーを指定する追加のパラメーターです。

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

-ProtectionPolicy <AzureRMBackupProtectionPolicy>
このコマンドレットが更新される元のポリシーを参照する保護ポリシーオブジェクトを指定します。

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

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

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

-Daily [<SwitchParameter>]
Daily スケジュールを実行するためにバックアップアップ操作を設定する追加のパラメーターです。例については、New-AzureRMBackupProtectionPolicy コマンドレットを参照してください。

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

-Weekly [<SwitchParameter>]
Weekly スケジュールを実行するためにバックアップ操作を設定する追加のパラメーターです。例については、New-AzureRMBackupProtectionPolicy コマンドレットを参照してください。

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

-DaysOfWeek <String[]>
特定の曜日に実行するようにバックアップ操作を設定する追加のパラメーターです。 -Weekly パラメーターと組み合わせて使用します。例については、New-AzureRMBackupProtectionPolicy オブジェクトを参照してください。

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

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