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

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

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

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

■名前

Get-AzureRMBackupJob

■概要

ジョブ一覧、もしくは指定したジョブを取得します。

■構文

Get-AzureRMBackupJob -Vault <AzureRMBackupVault> [-JobId <String>] [-From <Nullable`1[DateTime]>] [-To <Nullable`1[DateTime]>] [-Status <String>] [-Type <String>] [-Operation <String>] [-Profile <AzureProfile>] [<CommonParameters>]

Get-AzureRMBackupJob -Job <AzureRMBackupJob> [-Profile <AzureProfile>] [<CommonParameters>]

■説明

Get-AzureRMBackupJob コマンドレットは、指定したフィルタ条件に合致する Azure Backup ジョブを取得します。返されるジョブは、Azure Backup 資格情報コンテナーに制限されます。

■パラメーター

-Vault <AzureRMBackupVault>
ジョブである特定の Azure Backup 資格情報コンテナーオブジェクトを取得します。資格情報コンテナーは、Azure Backup ジョブに対する親コンテナーで、与えられたジョブは任意の指定された資格情報コンテナーの一部でなければなりません。資格情報コンテナーを取得するために Get-AzureRMBackupVault コマンドレットを用います。

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

-JobId <String>
Azure Backup ジョブに対する一意の識別子を指定します。

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

-From <Nullable`1[DateTime]>
時間範囲は Azure Backup サービスから返されるジョブの一覧をフィルタするために示します。このパラメーターは時間範囲の開始時間を指定します。

-To パラメーターを使用する場合は、-From パラメーターは必須です。

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

-To <Nullable`1[DateTime]>
時間範囲は Azure Backup サービスから返されるジョブの一覧をフィルタするために示します。このパラメーターは、時間範囲の終了時刻を指定します。

このパラメーターが指定されていない場合、既定の資格情報コンテナーは現在のシステム日付/時刻です。

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

-Status <String>
指定した状態を持つジョブを取得するためのフィルタ値を指定します。通常、状態フィールドは InProgress および Failed ジョブを取得するために使用されます。

サポートされる値:

InProgress
Failed
Cancelled
Cancelling
Completed
CompletedWithWarnings

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

-Type <String>
フィルタとして使用されるコンテナーの型を指定します。現在サポートされている項目は AzureVM のみです。

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

-Operation <String>
ジョブが取得されている特定の操作を説明するフィルタを指定します。

サポートされる値:

Backup
ConfigureBackup
DeleteBackupData
Register
Restore
UnProtect
Unregister

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

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

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

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

■入力

AzureRMBackupVault

■出力

AzureRMBackupJob object (もしくは) Array of AzureRMBackupJob オブジェクトの配列

■メモ

なし

■備考

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

■エイリアス

なし

■例

例 1: バックアップ資格情報コンテナーからジョブ一覧の取得

 Get-AzureRMBackupJob -Vault $v

WorkloadName    Operation       Status          StartTime              EndTime
————    ———       ——          ———              ——-
test-vm         Backup          InProgress      26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM
test-vm         ConfigureBackup Completed       26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM
test-vm         Register        Completed       25-Aug-15 3:23:53 PM   25-Aug-15 3:25:00 PM

例 2: 完了したジョブ一覧の取得

 Get-AzureRMBackupJob -Vault $v -Status Completed

WorkloadName    Operation       Status          StartTime              EndTime
————    ———       ——          ———              ——-
test-vm         Register        Completed       25-Aug-15 3:23:53 PM   25-Aug-15 3:25:00 PM

例 3: 1 週間前の失敗したジョブ一覧の取得

 Get-AzureRMBackupJob -Vault $v -From (Get-Date).AddDays(-7) -Status Failed

例 4: ジョブ状態の変更に対するサービスのポーリング

$joblist = Get-AzureRMBackupJob -Vault $v -Status InProgress
$job = $joblist[0]
while ( $job.Status -ne Completed )
{
    Write-Host "Waiting for completion..."
    Start-Sleep -s 10
    $job = Get-AzureRMBackupJob -Vault $v -Job $job
}
Write-Host "Done!"

Waiting for completion…
Waiting for completion…
Waiting for completion…
Done!