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

2024-12-09

Bicep resource definition

The mediaServices/transforms/jobs resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Media/mediaServices/transforms/jobs@2018-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    correlationData: {
      {customized property}: 'string'
    }
    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'
  }
}

ClipTime objects

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

For #Microsoft.Media.AbsoluteClipTime, use:

{
  @odata.type: '#Microsoft.Media.AbsoluteClipTime'
  time: 'string'
}

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'
}

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'
  end: {
    @odata.type: 'string'
    // For remaining properties, see ClipTime objects
  }
  files: [
    'string'
  ]
  label: 'string'
  start: {
    @odata.type: 'string'
    // For remaining properties, see ClipTime objects
  }
}

For #Microsoft.Media.JobInputHttp, use:

{
  @odata.type: '#Microsoft.Media.JobInputHttp'
  baseUri: 'string'
  end: {
    @odata.type: 'string'
    // For remaining properties, see ClipTime objects
  }
  files: [
    'string'
  ]
  label: 'string'
  start: {
    @odata.type: 'string'
    // For remaining properties, see ClipTime objects
  }
}

For #Microsoft.Media.JobInputs, use:

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

Property Values

AbsoluteClipTime

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.AbsoluteClipTime' (required)
time	The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds.	string (required)

ClipTime

Name	Description	Value
@odata.type	Set to '#Microsoft.Media.AbsoluteClipTime' for type AbsoluteClipTime.	'#Microsoft.Media.AbsoluteClipTime' (required)

JobInput

Name	Description	Value
@odata.type	Set to '#Microsoft.Media.JobInputAsset' for type JobInputAsset. Set to '#Microsoft.Media.JobInputHttp' for type JobInputHttp. Set to '#Microsoft.Media.JobInputs' for type JobInputs.	'#Microsoft.Media.JobInputAsset' '#Microsoft.Media.JobInputHttp' '#Microsoft.Media.JobInputs' (required)

JobInputAsset

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.JobInputAsset' (required)
assetName	The name of the input Asset.	string (required)
end	Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.	ClipTime
files	List of files. Required for JobInputHttp. Maximum of 4000 characters each.	string[]
label	A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as 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'.	string
start	Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.	ClipTime

JobInputHttp

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.JobInputHttp' (required)
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
end	Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.	ClipTime
files	List of files. Required for JobInputHttp. Maximum of 4000 characters each.	string[]
label	A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as 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'.	string
start	Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.	ClipTime

JobInputs

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

JobOutput

Name	Description	Value
@odata.type	Set to '#Microsoft.Media.JobOutputAsset' for type JobOutputAsset.	'#Microsoft.Media.JobOutputAsset' (required)
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

JobOutputAsset

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

JobProperties

Name	Description	Value
correlationData	Customer provided key, value pairs that will be returned in Job and JobOutput state events.	JobPropertiesCorrelationData
description	Optional customer supplied description of the Job.	string
input	The inputs for the Job.	JobInput (required)
outputs	The outputs for the Job.	JobOutput[] (required)
priority	Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.	'High' 'Low' 'Normal'

JobPropertiesCorrelationData

Name	Description	Value