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

スポンサーリンク

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

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

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

■名前

Get-AzureRMBackupItem

■概要

コンテナー配下の項目を取得します。

■構文

Get-AzureRMBackupItem [-ProtectionStatus <String>] [-Status <String>] [-Type <String>] [-Container] <AzureRMBackupContainer> [-Profile <AzureProfile>] [<CommonParameters>]

■説明

保護された 1 つ異常の項目を持つことができる Azure Backup 資格情報をコンテナーに登録します。これらの項目は Enable-AzureRMBackupProtection コマンドレットを用いて保護を有効にします。このコマンドレットは、コンテナー配下の項目およびその保護状態を取得します。

■パラメーター

-ProtectionStatus <String>
コンテナー内にある項目の全体的な保護状態を指定します。サポートされる値: Protected、Protecting

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

-Status <String>
項目に対するバックアップ状態を指定します。サポートされる値: IRPending、Protected、ProtectionError、ProtectionStopped。これは、保護として -ProtectionStatus パラメーターを持つ項目のフィルタとして使用することができるサブ状態です。

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

-Type <String>
要求される項目の型を指定します。サポートされる値: AzureVM

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

-Container <AzureRMBackupContainer>
項目をクエリする親コンテナー オブジェクトを指定します。資格情報コンテナー内のコンテナーを取得するために、Get-AzureRMBackupContainer コマンドレットを使用します。

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

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

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

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

■入力

  • AzureRMBackupContainer

■出力

  • AzureRMBackupItem

■メモ

  • Azure VM に対して、登録された VM コンテナー配下にあるのは 1 つの項目のみです。

■備考

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

■エイリアス

  • なし

■例

例 1: コンテナー内のすべての項目を表示

 Get-AzureRMBackupContainer -Type AzureVM -Name "test-vm" -Vault $v | Get-AzureRMBackupItem 

Name                    ProtectionStatus       DataSourceStatus       RecoveryPointsCount    ProtectionPolicyName
—-                    —————-       —————-       ——————-    ——————–
test-vm                 NotProtected                                  0

例 2: 項目のすべてのフィールドを表示

 Get-AzureRMBackupItem -Container $c | select * 

Name                 : test-vm
DataSourceStatus     :
ProtectionStatus     : NotProtected
Type                 : AzureVM
ProtectionPolicyName :
ProtectionPolicyId   :
RecoveryPointsCount  : 0
ItemName             : iaasvmcontainer;test-vm;test-vm
ContainerType        : AzureVM
ContainerUniqueName  : iaasvmcontainer;test-vm;test-vm
ResourceGroupName    : test-rg
ResourceName         : test-vault
Location             : southeastasia

■関連するトピック

  • Restore-AzureRMBackupItem
  • Get-AzureRMBackupContainer
  • Enable-AzureRMBackupProtection
  • Backup-AzureRMBackupItem
  • Disable-AzureRMBackupProtection

[参考]