Edit

Share via

Start-AzureStorSimpleDeviceBackupJob

  • Reference
Module:
Azure

Starts a new job that creates a backup from an existing backup policy.

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-AzureStorSimpleDeviceBackupJob
     -DeviceName <String>
     -BackupPolicyId <String>
     [-WaitForComplete]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureStorSimpleDeviceBackupJob
     -DeviceName <String>
     -BackupPolicyId <String>
     -BackupType <String>
     [-WaitForComplete]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]

Description

The Start-AzureStorSimpleDeviceBackupJob cmdlet starts a new job that creates a backup from an existing backup policy on a StorSimple device. By default, this cmdlet creates a local snapshot backup. To create a cloud backup, specify a value of CloudSnapshot for the BackupType parameter.

Examples

Example 1: Create a local snapshot backup

PS C:\>Start-AzureStorSimpleDeviceBackupJob -DeviceName "Contoso63-AppVm" -BackupPolicyId "00001111-aaaa-2222-bbbb-3333cccc4444"
JobId                                                                StatusCode RequestId
-----                                                                ---------- ---------
fb9acdca-ed6f-4b69-93f2-5c0bce0a1e08                                 Accepted   456cf6bafd427103b71c07145e26d35c

VERBOSE: Your backup operation has been submitted for processing. Use commandlet "Get-AzureStorSimpleJob -JobId
fb9acdca-ed6f-4b69-93f2-5c0bce0a1e08" to track status.

This command creates a local snapshot backup for the specified policy ID. This command starts the job, and then returns a TaskResponse object. To see the status of the job, use the Get-AzureStorSimpleTask cmdlet.

Example 2: Create a cloud snapshot backup and wait to finish

PS C:\>Start-AzureStorSimpleDeviceBackupJob -DeviceName "Contoso63-AppVm" -BackupPolicyId "00001111-aaaa-2222-bbbb-3333cccc4444" -BackupType CloudSnapshot -WaitForComplete
Error      : Microsoft.WindowsAzure.Management.StorSimple.Models.ErrorDetails
JobId      : fb9acdca-ed6f-4b69-93f2-5c0bce0a1e08
JobSteps   : {}
Result     : Succeeded
Status     : Completed
TaskResult : Succeeded
StatusCode : OK
RequestId  : f28ecf6cf75a7f128ca18e6ae14f9003

This command creates a cloud snapshot backup for the specified policy ID. This command specifies the WaitForComplete parameter, so the command completes the task, and then returns a TaskStatusInfo object for the job.

Parameters

-BackupPolicyId

Specifies the ID of the backup policy to use to create the backup.

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

-BackupType

Specifies the backup type. Valid values are: LocalSnapshot and CloudSnapshot.

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 to start the backup job.

Type:String
Position:Named
Default value:None
Required:True
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

-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.