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

スポンサーリンク

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

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

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

■名前

Remove-AzureStorSimpleDeviceBackupPolicy

■概要

存在するバックアップ ポリシーを削除します。

■構文

Remove-AzureStorSimpleDeviceBackupPolicy [-DeviceName] <String> [-BackupPolicy] <BackupPolicyDetails> [[-Force]] [[-WaitForComplete]] [-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]] [<CommonParameters>]

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

■説明

Remove-AzureStorSimpleDeviceBackupPolicy コマンドレットは、存在する BackupPolicy オブジェクトを削除します。バックアップ ポリシー削除後、これ以上のバックアップはポリシーに基づいて行われません。このコマンドレットは、削除されたポリシーに関連付けられたすべてのスケジュールを削除します。

■パラメーター

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

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

-BackupPolicyId <String>
削除する BackupPolicy オブジェクトのインスタンス 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 を参照してください。

■入力

  • BackupPolicyDetails
    このコマンドレットは、削除するために BackupPolicyDetails オブジェクトを受け入れます。

■出力

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

■メモ

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

■エイリアス

  • なし

■例

例 1: バックアップ ポリシーの削除

 Remove-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm" -BackupPolicyId "03710b4c-82c1-40ca-be5c-40289dc49642" -Force
VERBOSE: ClientRequestId: b3e4d485-eae4-4cf4-a43b-815f3abcd2dd_PS
VERBOSE: ClientRequestId: a260ee98-46aa-49e0-91ac-31d4155f4cae_PS
VERBOSE: About to create a job to remove your backuppolicy!
VERBOSE: ClientRequestId: 92a9c264-90df-4345-a495-92767dd266f2_PS
695be190-ac81-4cf2-b1c5-03ef6b08d005
VERBOSE: The remove task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
695be190-ac81-4cf2-b1c5-03ef6b08d005 for tracking the task’s status

このコマンドは、インスタンス ID「03710b4c-82c1-40ca-be5c-40289dc49642」を持つ BackupPolicy ポリシーを削除し、これ以上のバックアップはこのポリシーに基づいて行われません。コマンドは、このポリシーに関連付けられたすべてのスケジュールを削除します。コマンドは、BackupPolicy オブジェクトを移動する操作を開始し、TaskResponse オブジェクトを返します。タスクの状態を確認するには、Get-AzureStorSimpleTask コマンドレットを用います。

例 2: デバイスに対するバックアップ ポリシーの 1 番目の削除

$Policies = Get-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm"
Remove-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm" -BackupPolicyId $Policies[0].InstanceId -Force -WaitForComplete
VERBOSE: ClientRequestId: db3b49fa-cffa-446d-ba52-daa6802e00f7_PS
VERBOSE: ClientRequestId: 70e2b56f-c2df-40d0-a1e5-d7a4d7e25962_PS
VERBOSE: About to run a job to remove your backuppolicy!
VERBOSE: ClientRequestId: f8eb3d4d-2c57-4fc9-9f40-79d0f2ea1b6a_PS

JobId        : 820a246e-54b6-41a9-bdd5-15d5daea9b0a
JobResult    : Succeeded
JobStatus    : Completed
ErrorCode    :
ErrorMessage :
JobSteps     : {Microsoft.WindowsAzure.Management.StorSimple.Models.TaskStep,
               Microsoft.WindowsAzure.Management.StorSimple.Models.TaskStep}

VERBOSE: The job created for your remove operation has completed successfully.

最初のコマンドは、デバイス名「Contoso63-AppVm」に対するバックアップ ポリシーを取得し、$Policies 変数に格納します。

2 番目のコマンドは、「Contoso63-AppVm」から 1 番目のバックアップ ポリシーを削除します。コマンドは、$Policies の最初の項目の InstanceId プロパティで識別される標準ドット構文を使用します。このコマンドは、-WaitForComplete パラメーターを指定しており、コマンドがタスクを完了したら、タスクに対する TaskStatusInfo オブジェクトを返します。

例 3: 完了した移行状態の取得

Get-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm" -BackupPolicyName "TSQAVolume01_Default" | Remove-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm" -Force -WaitForComplete

VERBOSE: ClientRequestId: 60080fb1-2f88-4c17-bfd7-21aa73440a9c_PS
VERBOSE: ClientRequestId: 04c91121-50d7-4796-9af6-fc6a7d6b6a0e_PS
VERBOSE: ClientRequestId: 47ceb37c-672f-42e8-bd19-1190925c46cd_PS
VERBOSE: ClientRequestId: cbc39757-f2cc-4cc5-93ea-4ec0fbfb0ca8_PS
VERBOSE: ClientRequestId: 3614d47a-51fc-4500-a5f1-5401301ca4e3_PS
VERBOSE: About to create a job to remove your backuppolicy!
VERBOSE: ClientRequestId: dbd7166e-1888-4b11-9af9-8d49712a8c8b_PS
702ad240-5730-4015-b051-56055bd2c2d3
VERBOSE: The remove task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
702ad240-5730-4015-b051-56055bd2c2d3 for tracking the task’s status
VERBOSE: BackupPolicy with id bfe0bf8a-2d09-4690-93da-38a4f24e9f4f found!

このコマンドは、Get-AzureStorSimpleDeviceBackupPolicy コマンドレットを用いて BackupPolicyDetails オブジェクトを取得し、パイプライン操作を用いて現在のコマンドレットに渡します。 現在のコマンドレットは、バックアップ ポリシー名「TSQAVolume01_Default」を削除します。

■関連するトピック

  • Get-AzureStorSimpleDeviceBackupPolicy
  • New-AzureStorSimpleDeviceBackupPolicy
  • Set-AzureStorSimpleDeviceBackupPolicy
  • Get-AzureStorSimpleJob

[参考]