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

スポンサーリンク

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

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

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

■名前

Unregister-AzureRMBackupContainer

■概要

Azure Backup 資格情報コンテナーから指定した Windows Server もしくは Azure 仮想マシンの登録を解除します。

■構文

Unregister-AzureRMBackupContainer [[-Force] [<SwitchParameter>]] [-Container] <AzureRMBackupContainer> [-Profile <AzureProfile>] [<CommonParameters>]

■説明

Unregister-AzureRMBackupContainer コマンドレットは、Container オブジェクト上で動作します。Azure Backup 資格情報コンテナーからこのコンテナーの参照から削除します。Container オブジェクトを登録解除する前に、コンテナーに関連付けられているすべての保護されたデータを削除する必要があります。

■パラメーター

-Force [<SwitchParameter>]
Windows の AzureBackupContainer に適用された場合、Azure Backup 資格情報コンテナーからデータを削除する前に明示的な同意をユーザーに同意しません。

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

-Container <AzureRMBackupContainer>
登録解除する Windows Server もしくは Azure 仮想マシンを指定します。

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

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

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

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

■入力

  • Container of type [AzureBackupContainer]

■出力

  • AzureBackupJob
    • Windows Server のコンテナーの場合、値は $null を返します。

■メモ

  • なし

■備考

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

■エイリアス

  • なし

■例

例 1: ユーザー プロンプトによる Windows Server の登録解除

$c = Get-AzureBackupContainer -vault $v -type Windows -name "server1.contoso.com"
Unregister-AzureBackupContainer -container $c[0]

Unregister Server
This operation will delete all data in the backup vault that is associated with the server. Are you sure you want to unregister the server?
[] Yes  [] No  [?] Help (default is “No”): Yes

ユーザーは、最初に Get-AzureBackupContainer コマンドレットを用いて登録解除する必要があるコンテナーを取得します。このコンテナー オブジェクトは、Unregister-AzureBackupContainer コマンドレットに渡されます。これは、Azure Backup 資格情報コンテナーから指定した Windows Server を登録解除します。

例 2: 確認のプロンプトなしで Windows Server の登録解除

Unregister-AzureBackupContainer -container $c –force

-Force オプションは、データを削除しサーバーの登録解除を行う前にユーザー確認を実施しません。

■関連するリンク

  • Get-AzureRMBackupContainer

[参考]