Microsoft.Media mediaServices/transforms 2018-06-01-preview

2024-12-09

Bicep resource definition

The mediaServices/transforms 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Media/mediaServices/transforms@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    outputs: [
      {
        onError: 'string'
        preset: {
          @odata.type: 'string'
          // For remaining properties, see Preset objects
        }
        relativePriority: 'string'
      }
    ]
  }
}

Format objects

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

For #Microsoft.Media.JpgFormat, use:

{
  @odata.type: '#Microsoft.Media.JpgFormat'
}

For #Microsoft.Media.PngFormat, use:

{
  @odata.type: '#Microsoft.Media.PngFormat'
}

For #Microsoft.Media.Mp4Format, use:

{
  @odata.type: '#Microsoft.Media.Mp4Format'
  outputFiles: [
    {
      labels: [
        'string'
      ]
    }
  ]
}

For #Microsoft.Media.TransportStreamFormat, use:

{
  @odata.type: '#Microsoft.Media.TransportStreamFormat'
  outputFiles: [
    {
      labels: [
        'string'
      ]
    }
  ]
}

Codec objects

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

For #Microsoft.Media.AacAudio, use:

{
  @odata.type: '#Microsoft.Media.AacAudio'
  bitrate: int
  channels: int
  profile: 'string'
  samplingRate: int
}

For #Microsoft.Media.CopyAudio, use:

{
  @odata.type: '#Microsoft.Media.CopyAudio'
}

For #Microsoft.Media.CopyVideo, use:

{
  @odata.type: '#Microsoft.Media.CopyVideo'
}

For #Microsoft.Media.H264Video, use:

{
  @odata.type: '#Microsoft.Media.H264Video'
  complexity: 'string'
  keyFrameInterval: 'string'
  layers: [
    {
      @odata.type: 'string'
      adaptiveBFrame: bool
      bFrames: int
      bitrate: int
      bufferWindow: 'string'
      entropyMode: 'string'
      frameRate: 'string'
      height: 'string'
      label: 'string'
      level: 'string'
      maxBitrate: int
      profile: 'string'
      referenceFrames: int
      slices: int
      width: 'string'
    }
  ]
  sceneChangeDetection: bool
  stretchMode: 'string'
}

For #Microsoft.Media.JpgImage, use:

{
  @odata.type: '#Microsoft.Media.JpgImage'
  keyFrameInterval: 'string'
  layers: [
    {
      @odata.type: 'string'
      height: 'string'
      label: 'string'
      quality: int
      width: 'string'
    }
  ]
  range: 'string'
  start: 'string'
  step: 'string'
  stretchMode: 'string'
}

For #Microsoft.Media.PngImage, use:

{
  @odata.type: '#Microsoft.Media.PngImage'
  keyFrameInterval: 'string'
  layers: [
    {
      @odata.type: 'string'
      height: 'string'
      label: 'string'
      width: 'string'
    }
  ]
  range: 'string'
  start: 'string'
  step: 'string'
  stretchMode: 'string'
}

Preset objects

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

For #Microsoft.Media.VideoAnalyzerPreset, use:

{
  @odata.type: '#Microsoft.Media.VideoAnalyzerPreset'
  audioInsightsOnly: bool
  audioLanguage: 'string'
}

For #Microsoft.Media.BuiltInStandardEncoderPreset, use:

{
  @odata.type: '#Microsoft.Media.BuiltInStandardEncoderPreset'
  presetName: 'string'
}

For #Microsoft.Media.StandardEncoderPreset, use:

{
  @odata.type: '#Microsoft.Media.StandardEncoderPreset'
  codecs: [
    {
      label: 'string'
      @odata.type: 'string'
      // For remaining properties, see Codec objects
    }
  ]
  filters: {
    crop: {
      height: 'string'
      left: 'string'
      top: 'string'
      width: 'string'
    }
    deinterlace: {
      mode: 'string'
      parity: 'string'
    }
    overlays: [
      {
        audioGainLevel: int
        end: 'string'
        fadeInDuration: 'string'
        fadeOutDuration: 'string'
        inputLabel: 'string'
        start: 'string'
        @odata.type: 'string'
        // For remaining properties, see Overlay objects
      }
    ]
    rotation: 'string'
  }
  formats: [
    {
      filenamePattern: 'string'
      @odata.type: 'string'
      // For remaining properties, see Format objects
    }
  ]
}

Overlay objects

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

For #Microsoft.Media.AudioOverlay, use:

{
  @odata.type: '#Microsoft.Media.AudioOverlay'
}

For #Microsoft.Media.VideoOverlay, use:

{
  @odata.type: '#Microsoft.Media.VideoOverlay'
  cropRectangle: {
    height: 'string'
    left: 'string'
    top: 'string'
    width: 'string'
  }
  opacity: int
  position: {
    height: 'string'
    left: 'string'
    top: 'string'
    width: 'string'
  }
}

Property Values

AacAudio

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.AacAudio' (required)
bitrate	The bitrate, in bits per second, of the output encoded audio.	int
channels	The number of channels in the audio.	int
profile	The encoding profile to be used when encoding audio with AAC.	'AacLc' 'HeAacV1' 'HeAacV2'
samplingRate	The sampling rate to use for encoding in hertz.	int

AudioOverlay

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.AudioOverlay' (required)

BuiltInStandardEncoderPreset

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.BuiltInStandardEncoderPreset' (required)
presetName	The built-in preset to be used for encoding videos.	'AACGoodQualityAudio' 'AdaptiveStreaming' 'H264MultipleBitrate1080p' 'H264MultipleBitrate720p' 'H264MultipleBitrateSD' (required)

Codec

Name	Description	Value
@odata.type	Set to '#Microsoft.Media.AacAudio' for type AacAudio. Set to '#Microsoft.Media.CopyAudio' for type CopyAudio. Set to '#Microsoft.Media.CopyVideo' for type CopyVideo. Set to '#Microsoft.Media.H264Video' for type H264Video. Set to '#Microsoft.Media.JpgImage' for type JpgImage. Set to '#Microsoft.Media.PngImage' for type PngImage.	'#Microsoft.Media.AacAudio' '#Microsoft.Media.CopyAudio' '#Microsoft.Media.CopyVideo' '#Microsoft.Media.H264Video' '#Microsoft.Media.JpgImage' '#Microsoft.Media.PngImage' (required)
label	An optional label for the codec. The label can be used to control muxing behavior.	string

CopyAudio

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.CopyAudio' (required)

CopyVideo

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.CopyVideo' (required)

Deinterlace

Name	Description	Value
mode	The deinterlacing mode. Defaults to AutoPixelAdaptive.	'AutoPixelAdaptive' 'Off'
parity	The field parity for de-interlacing, defaults to Auto.	'Auto' 'BottomFieldFirst' 'TopFieldFirst'

Filters

Name	Description	Value
crop	The parameters for the rectangular window with which to crop the input video.	Rectangle
deinterlace	The de-interlacing settings.	Deinterlace
overlays	The properties of overlays to be applied to the input video. These could be audio, image or video overlays.	Overlay[]
rotation	The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto	'Auto' 'None' 'Rotate0' 'Rotate180' 'Rotate270' 'Rotate90'

Format

Name	Description	Value
@odata.type	Set to '#Microsoft.Media.JpgFormat' for type JpgFormat. Set to '#Microsoft.Media.PngFormat' for type PngFormat. Set to '#Microsoft.Media.Mp4Format' for type Mp4Format. Set to '#Microsoft.Media.TransportStreamFormat' for type TransportStreamFormat.	'#Microsoft.Media.JpgFormat' '#Microsoft.Media.Mp4Format' '#Microsoft.Media.PngFormat' '#Microsoft.Media.TransportStreamFormat' (required)
filenamePattern	The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.	string

H264Layer

Name	Description	Value
@odata.type	The discriminator for derived types.	string (required)
adaptiveBFrame	Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use.	bool
bFrames	The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level.	int
bitrate	The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field.	int
bufferWindow	The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S).	string
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.	'Cabac' 'Cavlc'
frameRate	The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video.	string
height	The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.	string
label	The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.	string
level	Which level of the H.264 standard should be used when encoding this layer. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer.	string
maxBitrate	The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate.	int
profile	Which profile of the H.264 standard should be used when encoding this layer. Default is Auto.	'Auto' 'Baseline' 'High' 'High422' 'High444' 'Main'
referenceFrames	The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting.	int
slices	The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame.	int
width	The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.	string

H264Video

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.H264Video' (required)
complexity	Tells the encoder how to choose its encoding settings. The default value is Balanced.	'Balanced' 'Quality' 'Speed'
keyFrameInterval	The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).	string
layers	The collection of output H.264 layers to be produced by the encoder.	H264Layer[]
sceneChangeDetection	Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video.	bool
stretchMode	The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize	'AutoFit' 'AutoSize' 'None'

JpgFormat

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.JpgFormat' (required)

JpgImage

Name	Description	Value
@odata.type	The discriminator for derived types.	'#Microsoft.Media.JpgImage' (required)
keyFrameInterval	The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).	string
layers	A collection of output JPEG image layers to be produced by the encoder.	JpgLayer[]
range	The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%).	string
start	The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video.	string
step	The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%).	string
stretchMode	The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize	'AutoFit' 'AutoSize' 'None'

JpgLayer

Name	Description	Value
@odata.type	The discriminator for derived types.	string (required)
height	The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.	string
label	The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.	string
quality	The compression quality of the JPEG output. Range is from 0-100 and the default is 70.	int
width	The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.	string