Edit

Share via

Start-AzureStorSimpleDeviceBackupRestoreJob

  • Reference
Module:
Azure

Starts a job that restores a backup on a StorSimple device.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Start-AzureStorSimpleDeviceBackupRestoreJob
     -DeviceName <String>
     -BackupId <String>
     [-WaitForComplete]
     [-Force]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureStorSimpleDeviceBackupRestoreJob
     -DeviceName <String>
     -BackupId <String>
     -SnapshotId <String>
     [-WaitForComplete]
     [-Force]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]

Description

The Start-AzureStorSimpleDeviceBackupRestoreJob cmdlet starts a job that restores a backup on a StorSimple device. Specify a backup ID and an optional snapshot ID.

Examples

Example 1: Start a job to restore a backup

PS C:\>Start-AzureStorSimpleDeviceBackupRestoreJob -DeviceName "Contoso63-AppVm" -BackupId "b3b50534-763c-4b05-9724-5ecf62bde721" -WaitForComplete
Confirm
Are you sure you want to restore the backup with backupId b3b50534-763c-4b05-9724-5ecf62bde721? 
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y


Error      : Microsoft.WindowsAzure.Management.StorSimple.Models.ErrorDetails
JobId      : 217d0647-c001-4f43-9833-f8155a458e95
JobSteps   : {}
Result     : Succeeded
Status     : Completed
TaskResult : Succeeded
StatusCode : OK
RequestId  : e0aa2dcd2f197a8588c40a067fe0e519

This command starts a job that restores the backup object that has the specified ID, and its associated snapshots, on the device named Contoso63-AppVm. The command specifies the WaitForComplete parameter, so the job finishes before the cmdlet returns control to the console.

Example 2: Start a job to restore a specific snapshot

PS C:\>Start-AzureStorSimpleDeviceBackupRestoreJob -DeviceName "Contoso63-AppVm" -BackupId "b3b50534-763c-4b05-9724-5ecf62bde721" -SnapshotId "2d0cfad7-46bf-4266-8859-96549646e947_0000000000000000" -Force

The start job is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId 9102ed9a-078f-4648-a
721-3cffbba31336 for tracking the job status

This command starts a job that restores the backup snapshot that has the specified ID. The command specifies the backup object by ID on the device named Contoso63-AppVm. The command specifies the Force parameter, so it starts the job without prompting you to confirm.

Parameters

-BackupId

Specifies the instance ID of the backup to restore.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DeviceName

Specifies the name of the StorSimple device on which the backup exists.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indicates that this cmdlet does not prompt you for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Specifies an Azure profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SnapshotId

Specifies the instance ID of the snapshot to restore.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WaitForComplete

Indicates that this cmdlet waits for the operation to complete before it returns control to the Windows PowerShell console.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

TaskStatusInfo, TaskResponse

This cmdlet returns a TaskStatusInfo object if you specify the WaitForComplete parameter. If you do not specify that parameter, it returns a TaskResponse object.