Microsoft.Media mediaServices/transforms/jobs 2018-07-01

  • 2 minutes to read

Template format

To create a Microsoft.Media/mediaServices/transforms/jobs resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Media/mediaServices/transforms/jobs",
  "apiVersion": "2018-07-01",
  "properties": {
    "description": "string",
    "input": {
      "@odata.type": "string"
    },
    "outputs": [
      {
        "label": "string",
        "@odata.type": "string"
      }
    ],
    "priority": "string",
    "correlationData": {}
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Media/mediaServices/transforms/jobs object

Name Type Required Value
name string Yes The Job name.
type enum Yes jobs
-or-
Microsoft.Media/mediaServices/transforms/jobs

See Set name and type for child resources.
apiVersion enum Yes 2018-07-01
properties object Yes The resource properties. - JobProperties object

JobProperties object

Name Type Required Value
description string No Optional customer supplied description of the Job.
input object Yes The inputs for the Job. - JobInput object
outputs array Yes The outputs for the Job. - JobOutput object
priority enum No Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. - Low, Normal, High
correlationData object No Customer provided key, value pairs that will be returned in Job and JobOutput state events.

JobInput object

Name Type Required Value
@odata.type string Yes

JobOutput object

Name Type Required Value
label string No A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform.
@odata.type string Yes