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

Bicep resource definition

The mediaServices/streamingLocators resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.Media/mediaServices/streamingLocators@2018-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    alternativeMediaId: 'string'
    assetName: 'string'
    contentKeys: [
      {
        id: 'string'
        label: 'string'
        tracks: [
          {
            trackSelections: [
              {
                operation: 'string'
                property: 'string'
                value: 'string'
              }
            ]
          }
        ]
        value: 'string'
      }
    ]
    defaultContentKeyPolicyName: 'string'
    endTime: 'string'
    startTime: 'string'
    streamingLocatorId: 'string'
    streamingPolicyName: 'string'
  }
}

Property values

mediaServices/streamingLocators

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
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
properties Class to specify properties of Streaming Locator StreamingLocatorProperties

StreamingLocatorProperties

Name Description Value
alternativeMediaId An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. string
assetName Asset Name string (required)
contentKeys ContentKeys used by this Streaming Locator StreamingLocatorContentKey[]
defaultContentKeyPolicyName Default ContentKeyPolicy used by this Streaming Locator string
endTime EndTime of Streaming Locator string
startTime StartTime of Streaming Locator string
streamingLocatorId StreamingLocatorId of Streaming Locator string
streamingPolicyName Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' string (required)

StreamingLocatorContentKey

Name Description Value
id ID of Content Key string (required)
label Label of Content Key string
tracks Tracks which use this Content Key TrackSelection[]
value Value of Content Key string

TrackSelection

Name Description Value
trackSelections TrackSelections is a track property condition list which can specify track(s) TrackPropertyCondition[]

TrackPropertyCondition

Name Description Value
operation Track property condition operation 'Equal'
'Unknown' (required)
property Track property type 'FourCC'
'Unknown' (required)
value Track property value string

ARM template resource definition

The mediaServices/streamingLocators resource type can be deployed to:

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

Resource format

To create a Microsoft.Media/mediaServices/streamingLocators resource, add the following JSON to your template.

{
  "type": "Microsoft.Media/mediaServices/streamingLocators",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "alternativeMediaId": "string",
    "assetName": "string",
    "contentKeys": [
      {
        "id": "string",
        "label": "string",
        "tracks": [
          {
            "trackSelections": [
              {
                "operation": "string",
                "property": "string",
                "value": "string"
              }
            ]
          }
        ],
        "value": "string"
      }
    ],
    "defaultContentKeyPolicyName": "string",
    "endTime": "string",
    "startTime": "string",
    "streamingLocatorId": "string",
    "streamingPolicyName": "string"
  }
}

Property values

mediaServices/streamingLocators

Name Description Value
type The resource type 'Microsoft.Media/mediaServices/streamingLocators'
apiVersion The resource api version '2018-06-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Class to specify properties of Streaming Locator StreamingLocatorProperties

StreamingLocatorProperties

Name Description Value
alternativeMediaId An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. string
assetName Asset Name string (required)
contentKeys ContentKeys used by this Streaming Locator StreamingLocatorContentKey[]
defaultContentKeyPolicyName Default ContentKeyPolicy used by this Streaming Locator string
endTime EndTime of Streaming Locator string
startTime StartTime of Streaming Locator string
streamingLocatorId StreamingLocatorId of Streaming Locator string
streamingPolicyName Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' string (required)

StreamingLocatorContentKey

Name Description Value
id ID of Content Key string (required)
label Label of Content Key string
tracks Tracks which use this Content Key TrackSelection[]
value Value of Content Key string

TrackSelection

Name Description Value
trackSelections TrackSelections is a track property condition list which can specify track(s) TrackPropertyCondition[]

TrackPropertyCondition

Name Description Value
operation Track property condition operation 'Equal'
'Unknown' (required)
property Track property type 'FourCC'
'Unknown' (required)
value Track property value string

Terraform (AzAPI provider) resource definition

The mediaServices/streamingLocators resource type can be deployed to:

  • Resource groups

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

Resource format

To create a Microsoft.Media/mediaServices/streamingLocators resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Media/mediaServices/streamingLocators@2018-06-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      alternativeMediaId = "string"
      assetName = "string"
      contentKeys = [
        {
          id = "string"
          label = "string"
          tracks = [
            {
              trackSelections = [
                {
                  operation = "string"
                  property = "string"
                  value = "string"
                }
              ]
            }
          ]
          value = "string"
        }
      ]
      defaultContentKeyPolicyName = "string"
      endTime = "string"
      startTime = "string"
      streamingLocatorId = "string"
      streamingPolicyName = "string"
    }
  })
}

Property values

mediaServices/streamingLocators

Name Description Value
type The resource type "Microsoft.Media/mediaServices/streamingLocators@2018-06-01-preview"
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
properties Class to specify properties of Streaming Locator StreamingLocatorProperties

StreamingLocatorProperties

Name Description Value
alternativeMediaId An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. string
assetName Asset Name string (required)
contentKeys ContentKeys used by this Streaming Locator StreamingLocatorContentKey[]
defaultContentKeyPolicyName Default ContentKeyPolicy used by this Streaming Locator string
endTime EndTime of Streaming Locator string
startTime StartTime of Streaming Locator string
streamingLocatorId StreamingLocatorId of Streaming Locator string
streamingPolicyName Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' string (required)

StreamingLocatorContentKey

Name Description Value
id ID of Content Key string (required)
label Label of Content Key string
tracks Tracks which use this Content Key TrackSelection[]
value Value of Content Key string

TrackSelection

Name Description Value
trackSelections TrackSelections is a track property condition list which can specify track(s) TrackPropertyCondition[]

TrackPropertyCondition

Name Description Value
operation Track property condition operation "Equal"
"Unknown" (required)
property Track property type "FourCC"
"Unknown" (required)
value Track property value string