jobs

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

Overview

Name	jobs
Type	Resource
Id	azure_extras.storsimple_1200_series.jobs

Fields

The following fields are returned by SELECT queries:

get

The job.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
endTime	string (date-time)	The UTC time at which the job completed
error	object	The Error details.
percentComplete	integer (int32)	The percentage of the job that is already complete
properties	object	Other properties of the job
startTime	string (date-time)	The UTC time at which the job was started
status	string	Current status of the job
type	string	The type.

list_by_device

The collection of jobs.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
endTime	string (date-time)	The UTC time at which the job completed
error	object	The Error details.
percentComplete	integer (int32)	The percentage of the job that is already complete
properties	object	Other properties of the job
startTime	string (date-time)	The UTC time at which the job was started
status	string	Current status of the job
type	string	The type.

list_by_manager

The collection of jobs.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
endTime	string (date-time)	The UTC time at which the job completed
error	object	The Error details.
percentComplete	integer (int32)	The percentage of the job that is already complete
properties	object	Other properties of the job
startTime	string (date-time)	The UTC time at which the job was started
status	string	Current status of the job
type	string	The type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, jobName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified job name.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName	$filter	Retrieves all the jobs in a device.
list_by_manager	select	subscriptionId, resourceGroupName, managerName	$filter	Retrieves all the jobs in a manager.

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 job name.
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id
$filter	string	OData Filter options

SELECT examples

get

Returns the properties of the specified job name.

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

list_by_device

Retrieves all the jobs in a device.

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

list_by_manager

Retrieves all the jobs in a manager.

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