< Back

Start-AzureStorSimpleDeviceBackupRestoreJob

Wed Jan 30, 2019 5:55 pm

NAME Start-AzureStorSimpleDeviceBackupRestoreJob



SYNOPSIS

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





SYNTAX

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

<Microsoft.Azure.Common.Authentication.Models.AzureProfile>] [<CommonParameters>]



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

<Microsoft.Azure.Common.Authentication.Models.AzureProfile>] [<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.





PARAMETERS

-BackupId <String>

Specifies the instance ID of the backup to restore.



Required? true

Position? 2

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-DeviceName <String>

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



Required? true

Position? 1

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Indicates that this cmdlet does not prompt you for confirmation.



Required? false

Position? 5

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]

Specifies an Azure profile.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-SnapshotId <String>

Specifies the instance ID of the snapshot to restore.



Required? true

Position? 3

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-WaitForComplete [<SwitchParameter>]

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



Required? false

Position? 4

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



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.





NOTES





Keywords: azure, azuresm, servicemanagement, management, service, store, storsimple



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.







RELATED LINKS

Get-AzureStorSimpleJob

Start-AzureStorSimpleDeviceBackupJob