Remove-AzureStorSimpleDeviceBackup

  • リファレンス
モジュール:
Azure

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

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Remove-AzureStorSimpleDeviceBackup
      -DeviceName <String>
      -BackupId <String>
      [-Force]
      [-WaitForComplete]
      [-Profile <AzureSMProfile>]
      [<CommonParameters>]
Remove-AzureStorSimpleDeviceBackup
      -DeviceName <String>
      -Backup <Backup>
      [-Force]
      [-WaitForComplete]
      [-Profile <AzureSMProfile>]
      [<CommonParameters>]

説明

Remove-AzureStorSimpleDeviceBackup コマンドレットは、1 つのバックアップ オブジェクトを削除します。 既に削除されているバックアップを削除しようとすると、このコマンドレットはエラーを返します。

例

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

PS C:\>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 を使用してデバイスの最初のバックアップを削除する

PS C:\>$Backup = Get-AzureStorSimpleDeviceBackup -DeviceName "Contoso63-AppVm"
PS C:\> 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

最初のコマンドは、Contoso63-AppVm という名前のデバイスのバックアップを取得し、$Backup変数に格納します。

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

例 3: パイプラインを使用してデバイスの最初のバックアップを削除する

PS C:\>$Backup = Get-AzureStorSimpleDeviceBackup -DeviceName "Contoso-AppVm" -WaitForComplete
PS C:\> $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

最初のコマンドは、Contoso63-AppVm という名前のデバイスのバックアップを取得し、$Backup変数に格納します。

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

パラメーター

-Backup

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

型:Backup
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-BackupId

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DeviceName

バックアップを削除する StorSimple デバイスの名前を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

このコマンドレットが確認を求めないことを示します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Profile

Azure プロファイルを指定します。

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WaitForComplete

このコマンドレットは、Windows PowerShell コンソールに制御を返す前に、操作が完了するまで待機することを示します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

Backup

出力

TaskStatusInfo, TaskResponse

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