jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.media_services.jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The resource properties.
systemData	object	The system metadata relating to this resource.

list

Name	Datatype	Description
properties	object	The resource properties.
systemData	object	The system metadata relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, transformName, jobName	api-version	Gets a Job.
list	select	subscriptionId, resourceGroupName, accountName, transformName	api-version, $filter, $orderby	Lists all of the Jobs for the Transform.
create	insert	subscriptionId, resourceGroupName, accountName, transformName, jobName	api-version	Creates a Job.
update	update	subscriptionId, resourceGroupName, accountName, transformName, jobName	api-version	Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.
delete	delete	subscriptionId, resourceGroupName, accountName, transformName, jobName	api-version	Deletes a Job.
cancel_job	exec	subscriptionId, resourceGroupName, accountName, transformName, jobName	api-version	Cancel a Job.

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
accountName	string	The Media Services account name.
jobName	string	The Job name.
resourceGroupName	string	The name of the resource group within the Azure subscription.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription.
transformName	string	The Transform name.
$filter	string	Restricts the set of items returned.
$orderby	string	Specifies the key by which the result collection should be ordered.
api-version	string	The version of the API to be used with the client request.

SELECT examples

get

Gets a Job.

SELECT
properties,
systemData
FROM azure.media_services.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND transformName = '{{ transformName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists all of the Jobs for the Transform.

SELECT
properties,
systemData
FROM azure.media_services.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND transformName = '{{ transformName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Creates a Job.

INSERT INTO azure.media_services.jobs (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
transformName,
jobName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ transformName }}',
'{{ jobName }}',
'{{ api-version }}'
RETURNING
properties,
systemData
;

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: accountName
      value: string
      description: Required parameter for the jobs resource.
    - name: transformName
      value: string
      description: Required parameter for the jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the jobs resource.
    - name: properties
      value: object
      description: |
        The resource properties.
    - name: api-version
      value: string
      description: The version of the API to be used with the client request.

UPDATE examples

update

Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.

UPDATE azure.media_services.jobs
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND transformName = '{{ transformName }}' --required
AND jobName = '{{ jobName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes a Job.

DELETE FROM azure.media_services.jobs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND transformName = '{{ transformName }}' --required
AND jobName = '{{ jobName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

cancel_job

Cancel a Job.

EXEC azure.media_services.jobs.cancel_job 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@transformName='{{ transformName }}' --required, 
@jobName='{{ jobName }}' --required, 
@api-version='{{ api-version }}'
;