Microsoft.Media mediaServices/transforms/jobs 2019-05-01-preview

The mediaServices/transforms/jobs resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Media/mediaServices/transforms/jobs resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Media/mediaServices/transforms/jobs@2019-05-01-preview' = {
  name: 'string'
  properties: {
    correlationData: {}
    description: 'string'
    input: {
      @odata.type: 'string'
      // For remaining properties, see JobInput objects
    }
    outputs: [
      {
        label: 'string'
        @odata.type: 'string'
        // For remaining properties, see JobOutput objects
      }
    ]
    priority: 'string'
  }
}

JobInput objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.JobInputAsset, use:

  @odata.type: '#Microsoft.Media.JobInputAsset'
  assetName: 'string'

For #Microsoft.Media.JobInputHttp, use:

  @odata.type: '#Microsoft.Media.JobInputHttp'
  baseUri: 'string'

For #Microsoft.Media.JobInputs, use:

  @odata.type: '#Microsoft.Media.JobInputs'
  inputs: [
    {
      @odata.type: 'string'
      // For remaining properties, see JobInput objects
    }
  ]

JobOutput objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.JobOutputAsset, use:

  @odata.type: '#Microsoft.Media.JobOutputAsset'
  assetName: 'string'

Property values

mediaServices/transforms/jobs

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Media/mediaServices/transforms/jobs'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-05-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Properties of the Job. JobProperties

JobProperties

Name Description Value
correlationData Customer provided key, value pairs that will be returned in Job and JobOutput state events. object
description Optional customer supplied description of the Job. string
input Base class for inputs to a Job. JobInput (required)
outputs The outputs for the Job. JobOutput[] (required)
priority Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. 'High'
'Low'
'Normal'

JobInput

Name Description Value
@odata.type Set the object type #Microsoft.Media.JobInputAsset
#Microsoft.Media.JobInputHttp
#Microsoft.Media.JobInputs

JobInputAsset

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.JobInputAsset'
assetName The name of the input Asset. string (required)

JobInputHttp

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.JobInputHttp'
baseUri Base URI for HTTPS 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. Maximum length of 4000 characters. string

JobInputs

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.JobInputs'
inputs List of inputs to a Job. JobInput[]

JobOutput

Name Description Value
label 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. string
@odata.type Set the object type #Microsoft.Media.JobOutputAsset

JobOutputAsset

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.JobOutputAsset'
assetName The name of the output Asset. string (required)