jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	`jobs`
Type	Resource
Id	`azure_extras.storsimple_8000_series.jobs`

Fields

The following fields are returned by SELECT queries:

get
list_by_device
list_by_manager

The job.

Name	Datatype	Description
`id`	`string`	The path ID that uniquely identifies the object.
`name`	`string`	The name of the object.
`endTime`	`string (date-time)`	The UTC time at which the job completed.
`error`	`object`	The error details, if any, for the job.
`kind`	`string`	The Kind of the object. Currently only Series8000 is supported
`percentComplete`	`integer (int32)`	The percentage of the job that is already complete.
`properties`	`object`	The properties of the job.
`startTime`	`string (date-time)`	The UTC time at which the job was started.
`status`	`string`	The current status of the job.
`type`	`string`	The hierarchical type of the object.

The collection of jobs for the specified manager and device name.

Name	Datatype	Description
`id`	`string`	The path ID that uniquely identifies the object.
`name`	`string`	The name of the object.
`endTime`	`string (date-time)`	The UTC time at which the job completed.
`error`	`object`	The error details, if any, for the job.
`kind`	`string`	The Kind of the object. Currently only Series8000 is supported
`percentComplete`	`integer (int32)`	The percentage of the job that is already complete.
`properties`	`object`	The properties of the job.
`startTime`	`string (date-time)`	The UTC time at which the job was started.
`status`	`string`	The current status of the job.
`type`	`string`	The hierarchical type of the object.

The collection of device jobs on all devices under the specified manager.

Name	Datatype	Description
`id`	`string`	The path ID that uniquely identifies the object.
`name`	`string`	The name of the object.
`endTime`	`string (date-time)`	The UTC time at which the job completed.
`error`	`object`	The error details, if any, for the job.
`kind`	`string`	The Kind of the object. Currently only Series8000 is supported
`percentComplete`	`integer (int32)`	The percentage of the job that is already complete.
`properties`	`object`	The properties of the job.
`startTime`	`string (date-time)`	The UTC time at which the job was started.
`status`	`string`	The current status of the job.
`type`	`string`	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`deviceName`, `jobName`, `subscriptionId`, `resourceGroupName`, `managerName`		Gets the details of the specified job name.
`list_by_device`	`select`	`deviceName`, `subscriptionId`, `resourceGroupName`, `managerName`	`$filter`	Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned.
`list_by_manager`	`select`	`subscriptionId`, `resourceGroupName`, `managerName`	`$filter`	Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned.
`cancel`	`exec`	`deviceName`, `jobName`, `subscriptionId`, `resourceGroupName`, `managerName`		Cancels a job on the device.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`deviceName`	`string`	The device name
`jobName`	`string`	The jobName.
`managerName`	`string`	The manager name
`resourceGroupName`	`string`	The resource group name
`subscriptionId`	`string`	The subscription id
`$filter`	`string`	OData Filter options

`SELECT` examples

get
list_by_device
list_by_manager

Gets the details of the specified job name.

SELECT
id,
name,
endTime,
error,
kind,
percentComplete,
properties,
startTime,
status,
type
FROM azure_extras.storsimple_8000_series.jobs
WHERE deviceName = '{{ deviceName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned.

SELECT
id,
name,
endTime,
error,
kind,
percentComplete,
properties,
startTime,
status,
type
FROM azure_extras.storsimple_8000_series.jobs
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND $filter = '{{ $filter }}'
;

Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned.

SELECT
id,
name,
endTime,
error,
kind,
percentComplete,
properties,
startTime,
status,
type
FROM azure_extras.storsimple_8000_series.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

cancel

Cancels a job on the device.

EXEC azure_extras.storsimple_8000_series.jobs.cancel 
@deviceName='{{ deviceName }}' --required, 
@jobName='{{ jobName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Lifecycle Methods​