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

スポンサーリンク

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

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

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

■名前

Stop-AzureRMBackupJob

■概要

継続的な Azure Backup ジョブをキャンセルします。

■構文

Stop-AzureRMBackupJob -Vault <AzureRMBackupVault> -JobID <String> [-Profile <AzureProfile>] [<CommonParameters>]

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

■説明

このコマンドレットは、既存の Azure Backup ジョブをキャンセルします。ジョブは時間がかかりすぎていると他の活動をブロックしている場合、特に有用です。

停止可能なジョブ型は次のとおり:

  • Backup
  • Restore

他のすべてのジョブ型はキャンセルできません。

■パラメーター

-Vault <AzureRMBackupVault>
コンテナー資格情報一覧を取得するために Get-AzureRMBackupVault コマンドレットを用います。

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

-JobID <String>
Azure Backup サービス内のジョブを一意に識別する GUID を指定します。1 つ以上のジョブを取得するために Get-AzureRMBackupJob コマンドレットを用います。AzureRMBackupJob オブジェクトからこの値に対して InstanceId フィールドを用います。

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

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

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

-Job <AzureRMBackupJob>
ジョブに関する情報が含まれているジョブ オブジェクトを指定します。コマンドレットは、このジョブを停止(キャンセル)を試みます。

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

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

■入力

  • AzureRMBackupJob

■出力

  • なし

■メモ

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

■エイリアス

  • なし

■例

例 1: ジョブ ID を持つバックアップ ジョブを停止

<br>$j = Get-AzureRMBackupJob -Vault $v -Operation Backup<br>Stop-AzureRMBackupJob -Vault $v -JobID $j.InstanceId<br>

例 2: 実行中のすべての回復操作を停止

 Get-AzureRMBackupJob -Vault $v -Operation Restore | Stop-AzureRMBackupJob 

この例では、Get-AzureRMBackupJob コマンドレットによって返される AzureRMBackupJob オブジェクトは、Stop-AzureRMBackupJob コマンドレットに渡されます。

■関連するトピック

[参考]

スポンサーリンク
スポンサーリンク
スポンサーリンク