Share via

az ams job

  • Reference

Manage jobs for a transform.

Commands

Name Description Type Status
az ams job cancel

Cancel a job.

 Core GA
az ams job delete

Delete a job.

 Core GA
az ams job list

List all the jobs of a transform within an Azure Media Services account.

 Core GA
az ams job show

Show the details of a job.

 Core GA
az ams job start

Start a job.

 Core GA
az ams job update

Update an existing job.

 Core GA

az ams job cancel

Edit

Cancel a job.

az ams job cancel [--account-name]
                  [--delete]
                  [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]
                  [--transform-name]

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--delete

Delete the job being cancelled.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--transform-name -t

The name of the transform.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams job delete

Edit

Delete a job.

az ams job delete [--account-name]
                  [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]
                  [--transform-name]

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--transform-name -t

The name of the transform.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams job list

Edit

List all the jobs of a transform within an Azure Media Services account.

az ams job list --account-name
                --resource-group
                --transform-name
                [--filter]
                [--orderby]

Examples

List all the jobs of a transform with 'Normal' priority by name.

az ams job list -a amsAccount -g resourceGroup -t transformName --query [?priority=='Normal'].{jobName:name}

List all the jobs of a transform by name and input.

az ams job list -a amsAccount -g resourceGroup -t transformName --query [].{jobName:name,jobInput:input}

Required Parameters

--account-name -a

The name of the Azure Media Services account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--transform-name -t

The name of the transform.

Optional Parameters

--filter

Restricts the set of items returned.

--orderby

Specifies the key by which the result collection should be ordered.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams job show

Edit

Show the details of a job.

az ams job show [--account-name]
                [--ids]
                [--name]
                [--resource-group]
                [--subscription]
                [--transform-name]

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--transform-name -t

The name of the transform.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams job start

Edit

Start a job.

az ams job start --output-assets
                 [--account-name]
                 [--base-uri]
                 [--correlation-data]
                 [--description]
                 [--files]
                 [--ids]
                 [--input-asset-name]
                 [--label]
                 [--name]
                 [--priority {High, Low, Normal}]
                 [--resource-group]
                 [--subscription]
                 [--transform-name]

Required Parameters

--output-assets

Space-separated assets in 'assetName=label' format. An asset without label can be sent like this: 'assetName='.

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--base-uri

Base uri for http job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris.

--correlation-data

Space-separated correlation data in 'key[=value]' format. This customer provided data will be returned in Job and JobOutput state events.

--description

The job description.

--files

Space-separated list of files. It can be used to tell the service to only use the files specified from the input asset.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--input-asset-name

The name of the input asset.

--label

A label that is assigned to a Job Input that is used to satisfy a reference used in the Transform. For example, a Transform can be authored to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'.

--name -n

The name of the job.

--priority

The priority with which the job should be processed.

Accepted values: High, Low, Normal
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--transform-name -t

The name of the transform.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams job update

Edit

Update an existing job.

az ams job update [--account-name]
                  [--add]
                  [--description]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--priority {High, Low, Normal}]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]
                  [--transform-name]

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--description

The job description.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the job.

--priority

The priority with which the job should be processed.

Accepted values: High, Low, Normal
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--transform-name -t

The name of the transform.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.