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 を参照してください。

■入力

  • AzureRMBackupProtectionPolicy

■出力

  • なし

■メモ

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

■エイリアス

  • なし

■関連するトピック

  • New-AzureRMBackupProtectionPolicy

[参考]