In this article:

• URI Parameters
• Request Body
• Responses
• Examples
• Definitions

Create Job
Creates a Job.

PUT https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}?api-version={{api-version}}

URI Parameters

Request Body

Responses

Examples

Create a Job

PUT https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs/job1?api-version={{api-version}}

{
  "properties": {
    "input": {
      "@odata.type": "#Microsoft.Media.JobInputAsset",
      "assetName": "job1-InputAsset"
    },
    "outputs": [
      {
        "@odata.type": "#Microsoft.Media.JobOutputAsset",
        "assetName": "job1-OutputAsset"
      }
    ],
    "correlationData": {
      "key1": "value1",
      "Key 2": "Value 2"
    }
  }
}

import com.azure.resourcemanager.mediaservices.models.JobInputAsset;
import com.azure.resourcemanager.mediaservices.models.JobOutputAsset;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Jobs Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-create.json
     */
    /**
     * Sample code: Create a Job.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void createAJob(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.jobs().define("job1").withExistingTransform("contosoresources", "contosomedia", "exampleTransform")
            .withInput(new JobInputAsset().withAssetName("job1-InputAsset"))
            .withOutputs(Arrays.asList(new JobOutputAsset().withAssetName("job1-OutputAsset")))
            .withCorrelationData(mapOf("Key 2", "fakeTokenPlaceholder", "key1", "fakeTokenPlaceholder")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static  Map<string, t="T"> mapOf(Object... inputs) {
        Map<string, t="T"> map = new HashMap<>();
        for (int i = 0; i <inputs.length; i="i" +="+" {="{" string="String" key="(String)" inputs[i];="inputs[i];" t="T" value="(T)" inputs[i="inputs[i" 1];="1];" map.put(key,="map.put(key," value);="value);" }="}" return="return" map;="map;"></inputs.length;></></string,></string,>

from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-media
# USAGE
    python jobscreate.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureMediaServices(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.jobs.create(
        resource_group_name="contosoresources",
        account_name="contosomedia",
        transform_name="exampleTransform",
        job_name="job1",
        parameters={
            "properties": {
                "correlationData": {"Key 2": "Value 2", "key1": "value1"},
                "input": {"@odata.type": "#Microsoft.Media.JobInputAsset", "assetName": "job1-InputAsset"},
                "outputs": [{"@odata.type": "#Microsoft.Media.JobOutputAsset", "assetName": "job1-OutputAsset"}],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-create.json
if __name__ == "__main__":
    main()

package armmediaservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-create.json
func ExampleJobsClient_Create() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewJobsClient().Create(ctx, "contosoresources", "contosomedia", "exampleTransform", "job1", armmediaservices.Job{
		Properties: &armmediaservices.JobProperties{
			CorrelationData: map[string]*string{
				"Key 2": to.Ptr("Value 2"),
				"key1":  to.Ptr("value1"),
			},
			Input: &armmediaservices.JobInputAsset{
				ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
				AssetName: to.Ptr("job1-InputAsset"),
			},
			Outputs: []armmediaservices.JobOutputClassification{
				&armmediaservices.JobOutputAsset{
					ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
					AssetName: to.Ptr("job1-OutputAsset"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a Job.
 *
 * @summary Creates a Job.
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-create.json
 */
async function createAJob() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
  const accountName = "contosomedia";
  const transformName = "exampleTransform";
  const jobName = "job1";
  const parameters = {
    correlationData: { key2: "Value 2", key1: "value1" },
    input: {
      odataType: "#Microsoft.Media.JobInputAsset",
      assetName: "job1-InputAsset",
    },
    outputs: [
      {
        odataType: "#Microsoft.Media.JobOutputAsset",
        assetName: "job1-OutputAsset",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const result = await client.jobs.create(
    resourceGroupName,
    accountName,
    transformName,
    jobName,
    parameters
  );
  console.log(result);
}

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-create.json
// this example is just showing the usage of "Jobs_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);

// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();

// invoke the operation
string jobName = "job1";
MediaJobData data = new MediaJobData()
{
    Input = new MediaJobInputAsset("job1-InputAsset"),
    Outputs =
    {
    new MediaJobOutputAsset("job1-OutputAsset")
    },
    CorrelationData =
    {
    ["Key 2"] = "Value 2",
    ["key1"] = "value1",
    },
};
ArmOperation lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobName, data);
MediaJobResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

Sample response

Status code: 201

{
  "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": "2022-10-17T23:14:33.6140749Z",
    "state": "Queued",
    "input": {
      "@odata.type": "#Microsoft.Media.JobInputAsset",
      "files": [],
      "inputDefinitions": [],
      "assetName": "job1-InputAsset"
    },
    "lastModified": "2022-10-17T23:14:33.6140749Z",
    "outputs": [
      {
        "@odata.type": "#Microsoft.Media.JobOutputAsset",
        "state": "Queued",
        "progress": 0,
        "label": "BuiltInStandardEncoderPreset_0",
        "assetName": "job1-OutputAsset"
      }
    ],
    "priority": "Normal",
    "correlationData": {
      "key1": "value1",
      "Key 2": "Value 2"
    }
  },
  "systemData": {
    "createdBy": "contoso@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-17T23:14:33.6140749Z",
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-17T23:14:33.6140749Z"
  }
}

Definitions

AacAudio

Describes Advanced Audio Codec (AAC) audio encoding settings.

AacAudioProfile

The encoding profile to be used when encoding audio with AAC.

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.

AttributeFilter

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

Audio

Defines the common properties for all audio codecs.

AudioAnalysisMode

Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.

AudioAnalyzerPreset

The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track.

AudioTrackDescriptor

A TrackSelection to select audio tracks.

BlurType

BuiltInStandardEncoderPreset

Describes a built-in preset for encoding the input video with the Standard Encoder.

Complexity

Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency.

CopyAudio

A codec flag, which tells the encoder to copy the input audio bitstream.

CopyVideo

A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.

createdByType

The type of identity that created the resource.

DDAudio

Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps.

Deinterlace

Describes the de-interlacing settings.

DeinterlaceMode

The deinterlacing mode. Defaults to AutoPixelAdaptive.

DeinterlaceParity

The field parity for de-interlacing, defaults to Auto.

EncoderNamedPreset

The built-in preset to be used for encoding videos.

EntropyMode

The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Fade

Describes the properties of a Fade effect applied to the input media.

Filters

Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.

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.

H264Complexity

Tells the encoder how to choose its encoding settings. The default value is Balanced.

H264Layer

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.

H264RateControlMode

The video rate control mode

H264Video

Describes all the properties for encoding a video with the H.264 codec.

H264VideoProfile

We currently support Baseline, Main, High, High422, High444. Default is Auto.

H265Complexity

Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced.

H265Layer

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec.

H265Video

Describes all the properties for encoding a video with the H.265 codec.

H265VideoProfile

We currently support Main. Default is Auto.

Image

Describes the basic properties for generating thumbnails from the input video

ImageFormat

Describes the properties for an output image file.

InputFile

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

InterleaveOutput

Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files.

Job

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

/subscriptions/{subscriptionId}/resource
Groups/{resourceGroupName}/providers/
{resourceProviderNamespace}/{resource
Type}/{resourceName}

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.

JpgFormat

Describes the settings for producing JPEG thumbnails.

JpgImage

Describes the properties for producing a series of JPEG images from the input video.

JpgLayer

Describes the settings to produce a JPEG image from the input video.

Mp4Format

Describes the properties for an output ISO MP4 file.

MultiBitrateFormat

Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection.

OutputFile

Represents an output file produced.

PngFormat

Describes the settings for producing PNG thumbnails.

PngImage

Describes the properties for producing a series of PNG images from the input video.

PngLayer

Describes the settings to produce a PNG image from the input video.

PresetConfigurations

An object of optional configuration settings for encoder.

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.

Rectangle

Describes the properties of a rectangular window applied to the input media before processing it.

Rotation

The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto

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.

StandardEncoderPreset

Describes all the settings to be used when encoding the input video with the Standard Encoder.

StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize

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.

Video

Describes the basic properties for encoding the input video.

VideoOverlay

Describes the properties of a video overlay.

VideoSyncMode

The Video Sync Mode

VideoTrackDescriptor

A TrackSelection to select video tracks.table