Jobs - Get

Get Job
Gets a Job.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}?api-version=2020-05-01

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The Media Services account name.

jobName
path True
  • string

The Job name.

resourceGroupName
path True
  • string

The name of the resource group within the Azure subscription.

subscriptionId
path True
  • string

The unique identifier for a Microsoft Azure subscription.

transformName
path True
  • string

The Transform name.

api-version
query True
  • string

The version of the API to be used with the client request.

Responses

Name Type Description
200 OK

OK

404 Not Found

NotFound

Other Status Codes

Detailed error information.

Examples

Get a Job by name

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs/job1?api-version=2020-05-01

Sample Response

{
  "name": "job1",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1",
  "type": "Microsoft.Media/mediaservices/transforms/jobs",
  "properties": {
    "created": "0001-01-01T00:00:00Z",
    "state": "Queued",
    "input": {
      "@odata.type": "#Microsoft.Media.JobInputs",
      "inputs": [
        {
          "@odata.type": "#Microsoft.Media.JobInputAsset",
          "files": [],
          "inputDefinitions": [],
          "assetName": "job1-InputAsset"
        }
      ]
    },
    "lastModified": "0001-01-01T00:00:00Z",
    "outputs": [
      {
        "@odata.type": "#Microsoft.Media.JobOutputAsset",
        "state": "Queued",
        "progress": 0,
        "label": "example-custom-label",
        "assetName": "job1-OutputAsset"
      }
    ],
    "priority": "Low",
    "correlationData": {}
  },
  "systemData": {
    "createdBy": "contoso@microsoft.com",
    "createdByType": "User",
    "createdAt": "0001-01-01T00:00:00Z",
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "0001-01-01T00:00:00Z"
  }
}

Definitions

AbsoluteClipTime

Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

ApiError

The API error.

AttributeFilter

The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks.

AudioTrackDescriptor

A TrackSelection to select audio tracks.

ChannelMapping

Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks.

createdByType

The type of identity that created the resource.

FromAllInputFile

An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files.

FromEachInputFile

An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given.

InputFile

An InputDefinition for a single file. TrackSelections are scoped to the file specified.

Job

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

JobError

Details of JobOutput errors.

JobErrorCategory

Helps with categorization of errors.

JobErrorCode

Error code describing the error.

JobErrorDetail

Details of JobOutput errors.

JobInputAsset

Represents an Asset for input into a Job.

JobInputClip

Represents input files for a Job.

JobInputHttp

Represents HTTPS job input.

JobInputs

Describes a list of inputs to a Job.

JobInputSequence

A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input.

JobOutputAsset

Represents an Asset used as a JobOutput.

JobRetry

Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.

JobState

Describes the state of the JobOutput.

ODataError

Information about an error.

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.

SelectAudioTrackByAttribute

Select audio tracks from the input by specifying an attribute and an attribute filter.

SelectAudioTrackById

Select audio tracks from the input by specifying a track identifier.

SelectVideoTrackByAttribute

Select video tracks from the input by specifying an attribute and an attribute filter.

SelectVideoTrackById

Select video tracks from the input by specifying a track identifier.

systemData

Metadata pertaining to creation and last modification of the resource.

TrackAttribute

The TrackAttribute to filter the tracks by.

UtcClipTime

Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

VideoTrackDescriptor

A TrackSelection to select video tracks.

AbsoluteClipTime

Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

Name Type Description
@odata.type string:
  • #Microsoft.Media.AbsoluteClipTime

The discriminator for derived types.

time
  • string

The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds.

ApiError

The API error.

Name Type Description
error

The error properties.

AttributeFilter

The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks.

Name Type Description
All
  • string

All tracks will be included.

Bottom
  • string

The first track will be included when the attribute is sorted in ascending order. Generally used to select the smallest bitrate.

Top
  • string

The first track will be included when the attribute is sorted in descending order. Generally used to select the largest bitrate.

ValueEquals
  • string

Any tracks that have an attribute equal to the value given will be included.

AudioTrackDescriptor

A TrackSelection to select audio tracks.

Name Type Description
@odata.type string:
  • #Microsoft.Media.AudioTrackDescriptor

The discriminator for derived types.

channelMapping

Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks.

ChannelMapping

Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks.

Name Type Description
BackLeft
  • string

The Back Left Channel. Sometimes referred to as the Left Surround Channel.

BackRight
  • string

The Back Right Channel. Sometimes referred to as the Right Surround Channel.

Center
  • string

The Center Channel.

FrontLeft
  • string

The Front Left Channel.

FrontRight
  • string

The Front Right Channel.

LowFrequencyEffects
  • string

Low Frequency Effects Channel. Sometimes referred to as the Subwoofer.

StereoLeft
  • string

The Left Stereo channel. Sometimes referred to as Down Mix Left.

StereoRight
  • string

The Right Stereo channel. Sometimes referred to as Down Mix Right.

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

FromAllInputFile

An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files.

Name Type Description
@odata.type string:
  • #Microsoft.Media.FromAllInputFile

The discriminator for derived types.

includedTracks TrackDescriptor[]:

The list of TrackDescriptors which define the metadata and selection of tracks in the input.

FromEachInputFile

An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given.

Name Type Description
@odata.type string:
  • #Microsoft.Media.FromEachInputFile

The discriminator for derived types.

includedTracks TrackDescriptor[]:

The list of TrackDescriptors which define the metadata and selection of tracks in the input.

InputFile

An InputDefinition for a single file. TrackSelections are scoped to the file specified.

Name Type Description
@odata.type string:
  • #Microsoft.Media.InputFile

The discriminator for derived types.

filename
  • string

Name of the file that this input definition applies to.

includedTracks TrackDescriptor[]:

The list of TrackDescriptors which define the metadata and selection of tracks in the input.

Job

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

The name of the resource

properties.correlationData
  • object

Customer provided key, value pairs that will be returned in Job and JobOutput state events.

properties.created
  • string

The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.

properties.description
  • string

Optional customer supplied description of the Job.

properties.endTime
  • string

The UTC date and time at which this Job finished processing.

properties.input JobInput:

The inputs for the Job.

properties.lastModified
  • string

The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.

properties.outputs JobOutput[]:

The outputs for the Job.

properties.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.

properties.startTime
  • string

The UTC date and time at which this Job began processing.

properties.state

The current state of the job.

systemData

The system metadata relating to this resource.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

JobError

Details of JobOutput errors.

Name Type Description
category

Helps with categorization of errors.

code

Error code describing the error.

details

An array of details about specific errors that led to this reported error.

message
  • string

A human-readable language-dependent representation of the error.

retry

Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.

JobErrorCategory

Helps with categorization of errors.

Name Type Description
Configuration
  • string

The error is configuration related.

Content
  • string

The error is related to data in the input files.

Download
  • string

The error is download related.

Service
  • string

The error is service related.

Upload
  • string

The error is upload related.

JobErrorCode

Error code describing the error.

Name Type Description
ConfigurationUnsupported
  • string

There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration.

ContentMalformed
  • string

There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files.

ContentUnsupported
  • string

There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files.

DownloadNotAccessible
  • string

While trying to download the input files, the files were not accessible, please check the availability of the source.

DownloadTransientError
  • string

While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source.

ServiceError
  • string

Fatal service error, please contact support.

ServiceTransientError
  • string

Transient error, please retry, if retry is unsuccessful, please contact support.

UploadNotAccessible
  • string

While trying to upload the output files, the destination was not reachable, please check the availability of the destination.

UploadTransientError
  • string

While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination.

JobErrorDetail

Details of JobOutput errors.

Name Type Description
code
  • string

Code describing the error detail.

message
  • string

A human-readable representation of the error.

JobInputAsset

Represents an Asset for input into a Job.

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputAsset

The discriminator for derived types.

assetName
  • string

The name of the input Asset.

end ClipTime:

Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.

files
  • string[]

List of files. Required for JobInputHttp. Maximum of 4000 characters each.

inputDefinitions InputDefinition[]:

Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata.

label
  • string

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

start ClipTime:

Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.

JobInputClip

Represents input files for a Job.

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputClip

The discriminator for derived types.

end ClipTime:

Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.

files
  • string[]

List of files. Required for JobInputHttp. Maximum of 4000 characters each.

inputDefinitions InputDefinition[]:

Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata.

label
  • string

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

start ClipTime:

Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.

JobInputHttp

Represents HTTPS job input.

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputHttp

The discriminator for derived types.

baseUri
  • string

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.

end ClipTime:

Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.

files
  • string[]

List of files. Required for JobInputHttp. Maximum of 4000 characters each.

inputDefinitions InputDefinition[]:

Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata.

label
  • string

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

start ClipTime:

Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.

JobInputs

Describes a list of inputs to a Job.

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputs

The discriminator for derived types.

inputs JobInput[]:

List of inputs to a Job.

JobInputSequence

A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input.

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputSequence

The discriminator for derived types.

inputs JobInputClip[]:

JobInputs that make up the timeline.

JobOutputAsset

Represents an Asset used as a JobOutput.

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobOutputAsset

The discriminator for derived types.

assetName
  • string

The name of the output Asset.

endTime
  • string

The UTC date and time at which this Job Output finished processing.

error

If the JobOutput is in the Error state, it contains the details of the error.

label
  • string

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.

progress
  • integer

If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property.

startTime
  • string

The UTC date and time at which this Job Output began processing.

state

Describes the state of the JobOutput.

JobRetry

Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.

Name Type Description
DoNotRetry
  • string

Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected.

MayRetry
  • string

Issue may be resolved after waiting for a period of time and resubmitting the same Job.

JobState

Describes the state of the JobOutput.

Name Type Description
Canceled
  • string

The job was canceled. This is a final state for the job.

Canceling
  • string

The job is in the process of being canceled. This is a transient state for the job.

Error
  • string

The job has encountered an error. This is a final state for the job.

Finished
  • string

The job is finished. This is a final state for the job.

Processing
  • string

The job is processing. This is a transient state for the job.

Queued
  • string

The job is in a queued state, waiting for resources to become available. This is a transient state.

Scheduled
  • string

The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states.

ODataError

Information about an error.

Name Type Description
code
  • string

A language-independent error name.

details

The error details.

message
  • string

The error message.

target
  • string

The target of the error (for example, the name of the property in error).

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.

Name Type Description
High
  • string

Used for TransformOutputs that should take precedence over others.

Low
  • string

Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs.

Normal
  • string

Used for TransformOutputs that can be generated at Normal priority.

SelectAudioTrackByAttribute

Select audio tracks from the input by specifying an attribute and an attribute filter.

Name Type Description
@odata.type string:
  • #Microsoft.Media.SelectAudioTrackByAttribute

The discriminator for derived types.

attribute

The TrackAttribute to filter the tracks by.

channelMapping

Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks.

filter

The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks.

filterValue
  • string

The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property.

SelectAudioTrackById

Select audio tracks from the input by specifying a track identifier.

Name Type Description
@odata.type string:
  • #Microsoft.Media.SelectAudioTrackById

The discriminator for derived types.

channelMapping

Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks.

trackId
  • integer

Track identifier to select

SelectVideoTrackByAttribute

Select video tracks from the input by specifying an attribute and an attribute filter.

Name Type Description
@odata.type string:
  • #Microsoft.Media.SelectVideoTrackByAttribute

The discriminator for derived types.

attribute

The TrackAttribute to filter the tracks by.

filter

The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks.

filterValue
  • string

The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property. For TrackAttribute.Bitrate, this should be an integer value in bits per second (e.g: '1500000'). The TrackAttribute.Language is not supported for video tracks.

SelectVideoTrackById

Select video tracks from the input by specifying a track identifier.

Name Type Description
@odata.type string:
  • #Microsoft.Media.SelectVideoTrackById

The discriminator for derived types.

trackId
  • integer

Track identifier to select

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt
  • string

The timestamp of resource creation (UTC).

createdBy
  • string

The identity that created the resource.

createdByType

The type of identity that created the resource.

lastModifiedAt
  • string

The timestamp of resource last modification (UTC)

lastModifiedBy
  • string

The identity that last modified the resource.

lastModifiedByType

The type of identity that last modified the resource.

TrackAttribute

The TrackAttribute to filter the tracks by.

Name Type Description
Bitrate
  • string

The bitrate of the track.

Language
  • string

The language of the track.

UtcClipTime

Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

Name Type Description
@odata.type string:
  • #Microsoft.Media.UtcClipTime

The discriminator for derived types.

time
  • string

The time position on the timeline of the input media based on Utc time.

VideoTrackDescriptor

A TrackSelection to select video tracks.

Name Type Description
@odata.type string:
  • #Microsoft.Media.VideoTrackDescriptor

The discriminator for derived types.