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

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

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

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

■名前

Wait-AzureRMBackupJob

■概要

完了するまで Azure Backup を待機します。

■構文

Wait-AzureRMBackupJob -Job <Object> [-TimeOut <Nullable`1[Int64]>] [-Profile <AzureProfile>] [<CommonParameters>]

■説明

長時間実行操作は、ジョブを用いて Azure Backup サービスで追跡されます。このような長い実行中の操作を伴うワークフローシーケンスがスクリプトアウトするためには、次の動作が開始する前にスクリプトが完了するのを待機しなければなりません。このコマンドレットは、ジョブが完了するまでスクリプトが一時停止することが可能です。

このコマンドレットを使用したスクリプトは、ジョブ状態の「ポーリング」に必要としないため、スクリプトコードがより簡単になります。

■パラメーター

-Job <Object>
ジョブに関する情報が含まれているジョブオブジェクトを指定します。このジョブが完了するまでコマンドレットは待機します。

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

-TimeOut <Nullable`1[Int64]>
ジョブが完了するまでコマンドレットが待機する最大時間 (秒) を指定します。これは、タイムアウト値が常に無期限に待機することを防止するために指定することをお勧めします。24 時間待機するには、タイムアウト値を 86400 に設定します。

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

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

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

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