Get-AzureRmBackupJob
バックアップ ジョブを取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Get-AzureRmBackupJob
-Vault <AzureRMBackupVault>
[-JobId <String>]
[-From <DateTime>]
[-To <DateTime>]
[-Status <String>]
[-Type <String>]
[-Operation <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmBackupJob
-Job <AzureRMBackupJob>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzureRmBackupJob コマンドレットは、特定のコンテナーの Azure Backup ジョブを取得します。
例
例 1: Backup コンテナー内のすべてのジョブを取得する
PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03"
PS C:\> Get-AzureRmBackupJob -Vault $Vault
WorkloadName Operation Status StartTime EndTime
------------ --------- ------ --------- -------
co03-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM
co03-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM
co03-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM
最初のコマンドでは、Get-AzureRmBackupVault コマンドレットを使用して、Vault03 という名前のコンテナーを取得します。 このコマンドは、そのオブジェクトを $Vault 変数に格納します。 2 番目のコマンドは、$Vault内のコンテナーのすべてのジョブを取得します。
例 2: 完了したジョブを取得する
PS C:\>Get-AzureRmBackupJob -Vault $Vault -Status Completed
WorkloadName Operation Status StartTime EndTime
------------ --------- ------ --------- -------
co03-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM
このコマンドは、$Vault内のコンテナーから完了したジョブを取得します。
例 3: 過去 1 週間に失敗したジョブを取得する
PS C:\>Get-AzureRmBackupJob -Vault $Vault -From (Get-Date).AddDays(-7) -Status Failed
このコマンドは、$Vaultのコンテナーから、先週の失敗したジョブを取得します。 From パラメーターは、過去 7 日間の時刻を指定します。 このコマンドでは、To パラメーターの値は指定されません。 したがって、現在の時刻の既定値が使用されます。
例 4: 完了した進行中のジョブのバックアップをポーリングする
PS C:\>$Jobs = Get-AzureRmBackupJob -Vault $Vault -Status InProgress
$Job = $Jobs[0]
while ( $Job.Status -ne Completed )
{
Write-Host "Waiting for completion..."
Start-Sleep -Seconds 10
$job = Get-AzureRmBackupJob -Vault $Vault -Job $Job
}
Write-Host "Done!"
Waiting for completion...
Waiting for completion...
Waiting for completion...
Done!
このスクリプトは、ジョブが完了するまで、現在進行中の最初のジョブをポーリングします。
スクリプトの最初の行は、進行中の$Vault内のすべてのジョブを取得し、それらのジョブを$Jobs配列変数に格納します。
2 行目は、$Jobs配列の最初のジョブを $Job 変数に格納します。
3 行目は、ジョブが完了するまでジョブの現在の状態をチェックする while ループを開始します。
while キーワード (keyword)の詳細については、「.」と入力しますGet-Help about_While
。
while ループはコンソールにメッセージを書き込み、10 秒間スリープ状態にしてから、$Job変数を更新します。
スクリプトは、$Jobの既存の値と現在のコマンドレットを使用して$Job変数を更新し、ジョブの現在の状態を取得します。
Windows PowerShell コマンドレットの詳細については、「.」と入力 Get-Help Write-Host
します Get-Help Start-Sleep
。
スクリプトの最後の行は、スクリプトが完了したことを示します。
パラメーター
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-From
このコマンドレットが取得するジョブの時間範囲の開始を DateTime オブジェクトとして指定します。
DateTime オブジェクトを取得するには、Get-Date コマンドレットを使用します。
DateTime オブジェクトの詳細については、「.」と入力しますGet-Help Get-Date
。
型: | Nullable<T>[DateTime] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Job
このコマンドレットが取得するジョブを指定します。 AzureRmBackupJob オブジェクトを取得するには、Get-AzureRmBackupJob コマンドレットを使用します。
型: | AzureRMBackupJob |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-JobId
このコマンドレットが取得するジョブの ID を指定します。 ID は、AzureRmBackupJob オブジェクトの InstanceId プロパティです。 AzureRmBackupJob オブジェクトを取得するには、Get-AzureRmBackupJob を使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Operation
このコマンドレットが取得するジョブの操作を指定します。 このパラメーターの有効値は、次のとおりです。
- バックアップ
- ConfigureBackup
- DeleteBackupData
- 登録
- 復元
- 解除
- Unregister
型: | String |
指定可能な値: | Backup, ConfigureBackup, DeleteBackupData, Register, Restore, UnProtect, Unregister |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Status
このコマンドレットが取得するジョブの状態を指定します。 このパラメーターの有効値は、次のとおりです。
- InProgress
- Failed
- 取消済
- キャンセル
- 完了済み
- CompletedWithWarnings このパラメーターを指定すると、進行中のすべてのジョブまたは失敗したすべてのジョブを検索できます。
型: | String |
指定可能な値: | Cancelled, Cancelling, Completed, CompletedWithWarnings, Failed, InProgress |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-To
このコマンドレットが取得するジョブの時間範囲の終了を DateTime オブジェクトとして指定します。 既定値は現在のシステム時刻です。 このパラメーターを指定する場合は、From パラメーターも指定する必要があります。
型: | Nullable<T>[DateTime] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Type
このコマンドレットがバックアップ ジョブを取得するコンテナーの種類を指定します。 現在、サポートされている値は AzureVM のみです。
型: | String |
指定可能な値: | AzureVM |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Vault
このコマンドレットがジョブを取得する Backup コンテナーを指定します。 AzureRmBackupVault オブジェクトを取得するには、Get-AzureRmBackupVault コマンドレットを使用します。
型: | AzureRMBackupVault |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
パラメーター: コンテナー (ByValue)
出力
メモ
- なし