Azure StorSimple 関連の PowerShell コマンドレット (Remove-AzureStorSimpleDeviceBackup) について

StorSimple は、Microsoft 社が提供するハイブリッドのクラウドストレージサービスです。 Microsoft Azure と組み合わせることで、Azure ストレージを拡張領域として利用することが可能であり、また別拠点でのデータ復旧が可能であることから、効率的なデータ管理、災害対策が実現できます。

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

Azure StorSimple 関連の PowerShell コマンドレットの 1 つである「Remove-AzureStorSimpleDeviceBackup」について、本ブログにて日本語の情報として纏めてみました((他の PowerShell コマンドレットについては、「Azure StorSimple 関連の PowerShell コマンドレットについて」を参照) (Windows Azure PowerShell バージョン 0.9.7 で確認しているものとなります)。

■名前

Remove-AzureStorSimpleDeviceBackup

■概要

バックアップオブジェクトを削除します。

■構文

Remove-AzureStorSimpleDeviceBackup [-DeviceName] <String> [-Backup] <Backup> [[-Force]] [[-WaitForComplete]] [-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]] [<CommonParameters>]

Remove-AzureStorSimpleDeviceBackup [-DeviceName] <String> [-BackupId] <String> [[-Force]] [[-WaitForComplete]] [-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]] [<CommonParameters>]

■説明

Remove-AzureStorSimpleDeviceBackup コマンドレットは、単一の Backup オブジェクトを削除します。既に削除されたバックアップを削除しようとした場合、コマンドレットはエラーを返します。

■パラメーター

-Backup <Backup>
削除する Backup オブジェクトを指定します。Backup オブジェクトを取得するために、Get-AzureStorSimpleDeviceBackup コマンドレットを用います。

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

-BackupId <String>
削除するバックアップのインスタンス ID を指定します。

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

-DeviceName <String>
バックアップを削除する StorSimple デバイス名を指定します。

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

-Force [<SwitchParameter>]
このコマンドレットが確認のプロンプトを表示しないことを示します。

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

-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]
Azure プロファイルを指定します。

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

-WaitForComplete [<SwitchParameter>]
Windows PowerShell コンソールに制御を返す前に、このコマンドレットが完了するための操作に対して待機するかを示します。

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

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

■入力

Backup

■出力

TaskStatusInfo, TaskResponse
このコマンドレットは、-WaitForComplete パラメーターが指定されている場合、TaskStatusInfo オブジェクトを返します。このパラメーターが指定されていない場合、TaskResponse オブジェクトを返します。

■メモ

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

■エイリアス

なし

■例

例 1: デバイスのバックアップを削除

Remove-AzureStorSimpleDeviceBackup -DeviceName "Contoso63-AppVm" -BackupId "dcb5c991-0485-400f-8d0a-03a1341ee989" -Force

The remove job is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId 6c73aff2-f5a1-4b5e-9a4e-857e128dc216 for tracking the job status

このコマンドは、デバイス名「Contoso63-AppVm」に対して指定した ID を持つバックアップを削除します。コマンドは、Backup オブジェクトを削除する操作を開始し、TaskResponse オブジェクトを返します。タスクの状態を確認するには、Get-AzureStorSimpleTask コマンドを用います。

例 2: ID を用いたデバイスにある 1 番目のバックアップを削除

$Backup = Get-AzureStorSimpleDeviceBackup -DeviceName "Contoso63-AppVm"
Remove-AzureStorSimpleDeviceBackup -DeviceName "Contoso63-AppVm" -BackupId $Backup[0].InstanceId -WaitForComplete

Error      : Microsoft.WindowsAzure.Management.StorSimple.Models.ErrorDetails
JobId      : 53a656c3-c082-4e1f-afb7-bff3db45c791
JobSteps   : {}
Result     : Succeeded
Status     : Completed
TaskResult : Succeeded
StatusCode : OK
RequestId : f4411f38d07f68b88095682dbeedd9e9

1 番目のコマンドは、デバイス名「Contoso63-AppVm」のバックアップを取得し、変数 $Backup に格納します。

2 番目のコマンドは、デバイス名「Contoso63-AppVm」からバックアップを削除します。コマンドは、$Backup 配列の最初の要素の InstanceId プロパティを参照するために、標準ドット記法を用います。コマンドに -WaitForComplete パラメーターが指定されていないので、コマンドは操作が完了するまで待機し、TaskStatusInfo オブジェクトを返します。

例 3: パイプラインを用いたデバイスにある 1 番目のバックアップの削除

$Backup = Get-AzureStorSimpleDeviceBackup -DeviceName "Contoso-AppVm" -WaitForComplete<br>$Backup[0] | Remove-AzureStorSimpleDeviceBackup -DeviceName "Contoso-AppVm" -Force -WaitForComplete

Error      : Microsoft.WindowsAzure.Management.StorSimple.Models.ErrorDetails
JobId      : 48059fd8-e355-4b91-9385-630d24f31df6
JobSteps   : {}
Result     : Succeeded
Status     : Completed
TaskResult : Succeeded
StatusCode : OK
RequestId : e1753f3bf68e6e44ab719436b5111e41

1 番目のコマンドは、デバイス名「Contoso63-AppVm」のバックアップを取得し、変数 $Backup に格納します。

2 番目のコマンドは、現在のコマンドレットへ $Backup に格納された 1 番目のオブジェクトを渡します。このコマンドレットは、デバイス名「Contoso63-AppVm」からバックアップを削除します。このコマンドは、-WaitForComplete パラメーターが指定されているので、コマンドは操作が完了するまで待機し、TaskStatusInfo オブジェクトを返します。