jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.ml_services.jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	[Required] Additional attributes of the entity. (x-ms-client-name: JobBaseProperties)

list

Name	Datatype	Description
properties	object	[Required] Additional attributes of the entity. (x-ms-client-name: JobBaseProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, id
list	select	subscriptionId, resourceGroupName, workspaceName	$skip, jobType, tag, listViewType, properties
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, id, data__properties
delete	delete	subscriptionId, resourceGroupName, workspaceName, id
cancel	exec	subscriptionId, resourceGroupName, workspaceName, id

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
id	string	The name and identifier for the Job. This is case-sensitive.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	Azure Machine Learning Workspace Name
$skip	string	Continuation token for pagination.
jobType	string	Type of job to be returned.
listViewType	string	View type for including/excluding (for example) archived entities.
properties	string	Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2
tag	string	Jobs returned will have this tag key.

SELECT examples

get

Success

SELECT
properties
FROM azure.ml_services.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND id = '{{ id }}' -- required
;

list

Success

SELECT
properties
FROM azure.ml_services.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND $skip = '{{ $skip }}'
AND jobType = '{{ jobType }}'
AND tag = '{{ tag }}'
AND listViewType = '{{ listViewType }}'
AND properties = '{{ properties }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.jobs (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
id
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ id }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the jobs resource.
    - name: workspaceName
      value: string
      description: Required parameter for the jobs resource.
    - name: id
      value: string
      description: Required parameter for the jobs resource.
    - name: properties
      value: object
      description: |
        [Required] Additional attributes of the entity.

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.jobs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND id = '{{ id }}' --required
;

Lifecycle Methods

cancel

Success

EXEC azure.ml_services.jobs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@id='{{ id }}' --required
;