Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The mediaServices/assets/tracks 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/assets/tracks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Media/mediaServices/assets/tracks@2023-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
track: {
@odata.type: 'string'
// For remaining properties, see TrackBase objects
}
}
}
TrackBase objects
Set the @odata.type property to specify the type of object.
For #Microsoft.Media.AudioTrack, use:
{
@odata.type: '#Microsoft.Media.AudioTrack'
dashSettings: {
role: 'string'
}
displayName: 'string'
fileName: 'string'
hlsSettings: {
characteristics: 'string'
default: bool
forced: bool
}
languageCode: 'string'
mpeg4TrackId: int
}
For #Microsoft.Media.TextTrack, use:
{
@odata.type: '#Microsoft.Media.TextTrack'
displayName: 'string'
fileName: 'string'
hlsSettings: {
characteristics: 'string'
default: bool
forced: bool
}
playerVisibility: 'string'
}
For #Microsoft.Media.VideoTrack, use:
{
@odata.type: '#Microsoft.Media.VideoTrack'
}
Property Values
AssetTrackProperties
| Name | Description | Value |
|---|---|---|
| track | Detailed information about a track in the asset. | TrackBase |
AudioTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.AudioTrack' (required) |
| dashSettings | The DASH specific setting for the audio track. | DashSettings |
| displayName | The display name of the audio track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. | string |
| fileName | The file name to the source file. This file is located in the storage container of the asset. | string |
| hlsSettings | The HLS specific setting for the audio track. | HlsSettings |
| languageCode | The RFC5646 language code for the audio track. | string |
| mpeg4TrackId | The MPEG-4 audio track ID for the audio track. | int |
DashSettings
| Name | Description | Value |
|---|---|---|
| role | The role for the DASH setting. | string |
HlsSettings
| Name | Description | Value |
|---|---|---|
| characteristics | The characteristics for the HLS setting. | string |
| default | The default for the HLS setting. | bool |
| forced | The forced for the HLS setting. | bool |
Microsoft.Media/mediaServices/assets/tracks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: mediaServices/assets |
| properties | The resource properties. | AssetTrackProperties |
TextTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.TextTrack' (required) |
| displayName | The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. | string |
| fileName | The file name to the source file. This file is located in the storage container of the asset. | string |
| hlsSettings | The HLS specific setting for the text track. | HlsSettings |
| playerVisibility | When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible". | 'Hidden' 'Visible' |
TrackBase
| Name | Description | Value |
|---|---|---|
| @odata.type | Set to '#Microsoft.Media.AudioTrack' for type AudioTrack. Set to '#Microsoft.Media.TextTrack' for type TextTrack. Set to '#Microsoft.Media.VideoTrack' for type VideoTrack. | '#Microsoft.Media.AudioTrack' '#Microsoft.Media.TextTrack' '#Microsoft.Media.VideoTrack' (required) |
VideoTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.VideoTrack' (required) |
ARM template resource definition
The mediaServices/assets/tracks 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/assets/tracks resource, add the following JSON to your template.
{
"type": "Microsoft.Media/mediaServices/assets/tracks",
"apiVersion": "2023-01-01",
"name": "string",
"properties": {
"track": {
"@odata.type": "string"
// For remaining properties, see TrackBase objects
}
}
}
TrackBase objects
Set the @odata.type property to specify the type of object.
For #Microsoft.Media.AudioTrack, use:
{
"@odata.type": "#Microsoft.Media.AudioTrack",
"dashSettings": {
"role": "string"
},
"displayName": "string",
"fileName": "string",
"hlsSettings": {
"characteristics": "string",
"default": "bool",
"forced": "bool"
},
"languageCode": "string",
"mpeg4TrackId": "int"
}
For #Microsoft.Media.TextTrack, use:
{
"@odata.type": "#Microsoft.Media.TextTrack",
"displayName": "string",
"fileName": "string",
"hlsSettings": {
"characteristics": "string",
"default": "bool",
"forced": "bool"
},
"playerVisibility": "string"
}
For #Microsoft.Media.VideoTrack, use:
{
"@odata.type": "#Microsoft.Media.VideoTrack"
}
Property Values
AssetTrackProperties
| Name | Description | Value |
|---|---|---|
| track | Detailed information about a track in the asset. | TrackBase |
AudioTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.AudioTrack' (required) |
| dashSettings | The DASH specific setting for the audio track. | DashSettings |
| displayName | The display name of the audio track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. | string |
| fileName | The file name to the source file. This file is located in the storage container of the asset. | string |
| hlsSettings | The HLS specific setting for the audio track. | HlsSettings |
| languageCode | The RFC5646 language code for the audio track. | string |
| mpeg4TrackId | The MPEG-4 audio track ID for the audio track. | int |
DashSettings
| Name | Description | Value |
|---|---|---|
| role | The role for the DASH setting. | string |
HlsSettings
| Name | Description | Value |
|---|---|---|
| characteristics | The characteristics for the HLS setting. | string |
| default | The default for the HLS setting. | bool |
| forced | The forced for the HLS setting. | bool |
Microsoft.Media/mediaServices/assets/tracks
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-01-01' |
| name | The resource name | string (required) |
| properties | The resource properties. | AssetTrackProperties |
| type | The resource type | 'Microsoft.Media/mediaServices/assets/tracks' |
TextTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.TextTrack' (required) |
| displayName | The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. | string |
| fileName | The file name to the source file. This file is located in the storage container of the asset. | string |
| hlsSettings | The HLS specific setting for the text track. | HlsSettings |
| playerVisibility | When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible". | 'Hidden' 'Visible' |
TrackBase
| Name | Description | Value |
|---|---|---|
| @odata.type | Set to '#Microsoft.Media.AudioTrack' for type AudioTrack. Set to '#Microsoft.Media.TextTrack' for type TextTrack. Set to '#Microsoft.Media.VideoTrack' for type VideoTrack. | '#Microsoft.Media.AudioTrack' '#Microsoft.Media.TextTrack' '#Microsoft.Media.VideoTrack' (required) |
VideoTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.VideoTrack' (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The mediaServices/assets/tracks resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Media/mediaServices/assets/tracks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Media/mediaServices/assets/tracks@2023-01-01"
name = "string"
parent_id = "string"
body = {
properties = {
track = {
@odata.type = "string"
// For remaining properties, see TrackBase objects
}
}
}
}
TrackBase objects
Set the @odata.type property to specify the type of object.
For #Microsoft.Media.AudioTrack, use:
{
@odata.type = "#Microsoft.Media.AudioTrack"
dashSettings = {
role = "string"
}
displayName = "string"
fileName = "string"
hlsSettings = {
characteristics = "string"
default = bool
forced = bool
}
languageCode = "string"
mpeg4TrackId = int
}
For #Microsoft.Media.TextTrack, use:
{
@odata.type = "#Microsoft.Media.TextTrack"
displayName = "string"
fileName = "string"
hlsSettings = {
characteristics = "string"
default = bool
forced = bool
}
playerVisibility = "string"
}
For #Microsoft.Media.VideoTrack, use:
{
@odata.type = "#Microsoft.Media.VideoTrack"
}
Property Values
AssetTrackProperties
| Name | Description | Value |
|---|---|---|
| track | Detailed information about a track in the asset. | TrackBase |
AudioTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.AudioTrack' (required) |
| dashSettings | The DASH specific setting for the audio track. | DashSettings |
| displayName | The display name of the audio track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. | string |
| fileName | The file name to the source file. This file is located in the storage container of the asset. | string |
| hlsSettings | The HLS specific setting for the audio track. | HlsSettings |
| languageCode | The RFC5646 language code for the audio track. | string |
| mpeg4TrackId | The MPEG-4 audio track ID for the audio track. | int |
DashSettings
| Name | Description | Value |
|---|---|---|
| role | The role for the DASH setting. | string |
HlsSettings
| Name | Description | Value |
|---|---|---|
| characteristics | The characteristics for the HLS setting. | string |
| default | The default for the HLS setting. | bool |
| forced | The forced for the HLS setting. | bool |
Microsoft.Media/mediaServices/assets/tracks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: mediaServices/assets |
| properties | The resource properties. | AssetTrackProperties |
| type | The resource type | "Microsoft.Media/mediaServices/assets/tracks@2023-01-01" |
TextTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.TextTrack' (required) |
| displayName | The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. | string |
| fileName | The file name to the source file. This file is located in the storage container of the asset. | string |
| hlsSettings | The HLS specific setting for the text track. | HlsSettings |
| playerVisibility | When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible". | 'Hidden' 'Visible' |
TrackBase
| Name | Description | Value |
|---|---|---|
| @odata.type | Set to '#Microsoft.Media.AudioTrack' for type AudioTrack. Set to '#Microsoft.Media.TextTrack' for type TextTrack. Set to '#Microsoft.Media.VideoTrack' for type VideoTrack. | '#Microsoft.Media.AudioTrack' '#Microsoft.Media.TextTrack' '#Microsoft.Media.VideoTrack' (required) |
VideoTrack
| Name | Description | Value |
|---|---|---|
| @odata.type | The discriminator for derived types. | '#Microsoft.Media.VideoTrack' (required) |