Start-AzureStorSimpleDeviceBackupJob
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
Empty (Default)
Start-AzureStorSimpleDeviceBackupJob
-DeviceName <String>
-BackupPolicyId <String>
[-WaitForComplete]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
BackupTypeGiven
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-BackupType
Specifies the backup type. Valid values are: LocalSnapshot and CloudSnapshot.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BackupTypeGiven
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DeviceName
Specifies the name of the StorSimple device on which to start the backup job.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Profile
Specifies an Azure profile.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WaitForComplete
Indicates that this cmdlet waits for the operation to complete before it returns control to the Windows PowerShell console.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.