Edit

Get-AzureStorSimpleJob

  • Reference
Module:
Azure

Gets StorSimple jobs.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.

Syntax

Get-AzureStorSimpleJob
   [-DeviceName <String>]
   [-InstanceId <String>]
   [-Status <String>]
   [-Type <String>]
   [-From <DateTime>]
   [-To <DateTime>]
   [-Skip <Int32>]
   [-First <Int32>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureStorSimpleJob cmdlet gets Azure StorSimple jobs. Specify an instance ID to get a specific job. Specify other parameters to limit the jobs that this cmdlet gets.

This cmdlet returns a maximum of 200 jobs. If more than 200 jobs exist, get the remaining jobs by using the First and Skip parameters. If you specify a value of 100 for Skip and 50 for First, this cmdlet does not return the first 100 results. It returns the next 50 results after the 100 that it skips.

Examples

Example 1: Get a job by using an ID

PS C:\>Get-AzureStorSimpleJob -InstanceId "574f47e0-44e9-495c-b8a5-0203c57ebf6d"
BackupPolicy             : 
BackupTimeStamp          : 1/1/0001 12:00:00 AM
BackupType               : CloudSnapshot
DataStats                : Microsoft.WindowsAzure.Management.StorSimple.Models.DataStatistics
Device                   : Microsoft.WindowsAzure.Management.StorSimple.Models.CisBaseObject
Entity                   : Microsoft.WindowsAzure.Management.StorSimple.Models.CisBaseObject
ErrorDetails             : {}
HideProgressDetails      : False
InstanceId               : 574f47e0-44e9-495c-b8a5-0203c57ebf6d
IsInstantRestoreComplete : False
IsJobCancellable         : True
JobDetails               : Microsoft.WindowsAzure.Management.StorSimple.Models.JobStatusInfo
Name                     : 26447caf-59bb-41c9-a028-3224d296c7dc
Progress                 : 100
SourceDevice             : Microsoft.WindowsAzure.Management.StorSimple.Models.CisBaseObject
SourceEntity             : Microsoft.WindowsAzure.Management.StorSimple.Models.CisBaseObject
SourceVolume             : Microsoft.WindowsAzure.Management.StorSimple.Models.CisBaseObject
Status                   : Completed
TimeStats                : Microsoft.WindowsAzure.Management.StorSimple.Models.TimeStatistics
Type                     : Backup
Volume                   : Microsoft.WindowsAzure.Management.StorSimple.Models.CisBaseObject

This command gets information for the job that has the specified ID.

Example 2: Get jobs by using a device name

PS C:\>Get-AzureStorSimpleJob -DeviceName "8600-Bravo 001" -First 2
InstanceId                           Type                         Status                                          DeviceName                                      StartTime                                       Progress                                       
----------                           ----                         ------                                          ----------                                      ---------                                       --------                                       
1997c33f-bfcc-4d08-9aba-28068340a1f9 Backup                       Running                                         8600-Bravo 001                                  4/15/2015 1:30:02 PM                            92                                             
85074062-ef6a-408a-b6c9-2a0904bb99ca Backup                       Completed                                       8600-Bravo 001                                  4/15/2015 1:30:02 PM                            100

This command gets information for the jobs for the device named 8600-Bravo 001. The command gets the first two jobs for the device.

Example 3: Get completed jobs

PS C:\>Get-AzureStorSimpleJob -Status "Completed" -Skip 10 -First 2

This command gets completed jobs. The command gets only the first two jobs after it skips the first ten jobs.

Example 4: Get manual backup jobs

PS C:\>Get-AzureStorSimpleJob -Type "ManualBackup"

This command gets jobs of the manual backup type.

Example 5: Get jobs between specified times

PS C:\>$StartTime = Get-Date -Year 2015 -Month 3 -Day 10
PS C:\> $EndTime = Get-Date -Year 2015 -Month 3 -Day 11 -Hour 12 -Minute 15
PS C:\>Get-AzureStorSimpleJob -DeviceName "Device07" -From $StartTime -To $EndTime

The first two commands create DateTime objects by using the Get-Date cmdlet. The commands store the new times in the $StartTime and $EndTime variables. For more information, type Get-Help Get-Date.

The final command gets jobs for the device named Device07 between the times stored in $StartTime and $EndTime.

Parameters

-DeviceName

Specifies the name of a StorSimple device.

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

-First

Gets only the specified number of objects. Enter the number of objects to get.

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

-From

Specifies the start date and time for the jobs that this cmdlet gets.

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

-InstanceId

Specifies the ID of the job to get.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-Skip

Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.

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

-Status

Specifies the status. The acceptable values for this parameter are:

  • Running
  • Completed
  • Cancelled
  • Failed
  • Canceling
  • CompletedWithErrors
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-To

Specifies the end date and time for the jobs that this cmdlet gets.

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

-Type

Specifies the job type. The acceptable values for this parameter are:

  • Backup
  • ManualBackup
  • Restore
  • CloneWorkflow
  • DeviceRestore
  • Update
  • SupportPackage
  • VirtualApplianceProvisioning
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

IList\<DeviceJobDetails\>, DeviceJobDetails

This cmdlet returns a list of job details objects, or, if you specify the InstanceID parameter, it returns a single job detail object.