jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.workload_orchestration.jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	Correlation ID for tracking.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
endTime	string (date-time)	End time of the job (ISO8601).
errorDetails	object	Error Details if any failure is there.
jobParameter	object	Parameters for the job.
jobType	string	The type of job. Required. Known values are: "deploy", "staging", and "externalValidation". (deploy, staging, externalValidation)
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
startTime	string (date-time)	Start time of the job (ISO8601).
status	string	Status of the job. Required. Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
steps	array	Steps and substatuses for the job.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
triggeredBy	string	The OID or identity that triggered the job.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_target

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	Correlation ID for tracking.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
endTime	string (date-time)	End time of the job (ISO8601).
errorDetails	object	Error Details if any failure is there.
jobParameter	object	Parameters for the job.
jobType	string	The type of job. Required. Known values are: "deploy", "staging", and "externalValidation". (deploy, staging, externalValidation)
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
startTime	string (date-time)	Start time of the job (ISO8601).
status	string	Status of the job. Required. Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
steps	array	Steps and substatuses for the job.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
triggeredBy	string	The OID or identity that triggered the job.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_uri, job_name		Get a Job resource.
list_by_target	select	resource_uri		List Jobs by parent resource.

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
job_name	string	The name of the Job. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get a Job resource.

SELECT
id,
name,
correlationId,
eTag,
endTime,
errorDetails,
jobParameter,
jobType,
provisioningState,
startTime,
status,
steps,
systemData,
triggeredBy,
type
FROM azure.workload_orchestration.jobs
WHERE resource_uri = '{{ resource_uri }}' -- required
AND job_name = '{{ job_name }}' -- required
;

list_by_target

List Jobs by parent resource.

SELECT
id,
name,
correlationId,
eTag,
endTime,
errorDetails,
jobParameter,
jobType,
provisioningState,
startTime,
status,
steps,
systemData,
triggeredBy,
type
FROM azure.workload_orchestration.jobs
WHERE resource_uri = '{{ resource_uri }}' -- required
;