Microsoft.Media mediaServices/streamingLocators 2018-07-01
Bicep resource definition
The mediaServices/streamingLocators resource type can be deployed to:
- 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/streamingLocators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Media/mediaServices/streamingLocators@2018-07-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
alternativeMediaId: 'string'
assetName: 'string'
contentKeys: [
{
id: 'string'
labelReferenceInStreamingPolicy: 'string'
value: 'string'
}
]
defaultContentKeyPolicyName: 'string'
endTime: 'string'
filters: [
'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 | Properties of the Streaming Locator. | StreamingLocatorProperties |
StreamingLocatorProperties
| Name | Description | Value |
|---|---|---|
| alternativeMediaId | Alternative Media ID of this Streaming Locator | string |
| assetName | Asset Name | string (required) |
| contentKeys | The ContentKeys used by this Streaming Locator. | StreamingLocatorContentKey[] |
| defaultContentKeyPolicyName | Name of the default ContentKeyPolicy used by this Streaming Locator. | string |
| endTime | The end time of the Streaming Locator. | string |
| filters | A list of asset or account filters which apply to this streaming locator | string[] |
| startTime | The start time of the Streaming Locator. | string |
| streamingLocatorId | The StreamingLocatorId of the Streaming Locator. | string |
| streamingPolicyName | Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming' | string (required) |
StreamingLocatorContentKey
| Name | Description | Value |
|---|---|---|
| id | ID of Content Key | string (required) |
| labelReferenceInStreamingPolicy | Label of Content Key as specified in the Streaming Policy | string |
| value | Value of Content Key | string |
ARM template resource definition
The mediaServices/streamingLocators resource type can be deployed to:
- 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/streamingLocators resource, add the following JSON to your template.
{
"type": "Microsoft.Media/mediaServices/streamingLocators",
"apiVersion": "2018-07-01",
"name": "string",
"properties": {
"alternativeMediaId": "string",
"assetName": "string",
"contentKeys": [
{
"id": "string",
"labelReferenceInStreamingPolicy": "string",
"value": "string"
}
],
"defaultContentKeyPolicyName": "string",
"endTime": "string",
"filters": [ "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-07-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Properties of the Streaming Locator. | StreamingLocatorProperties |
StreamingLocatorProperties
| Name | Description | Value |
|---|---|---|
| alternativeMediaId | Alternative Media ID of this Streaming Locator | string |
| assetName | Asset Name | string (required) |
| contentKeys | The ContentKeys used by this Streaming Locator. | StreamingLocatorContentKey[] |
| defaultContentKeyPolicyName | Name of the default ContentKeyPolicy used by this Streaming Locator. | string |
| endTime | The end time of the Streaming Locator. | string |
| filters | A list of asset or account filters which apply to this streaming locator | string[] |
| startTime | The start time of the Streaming Locator. | string |
| streamingLocatorId | The StreamingLocatorId of the Streaming Locator. | string |
| streamingPolicyName | Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming' | string (required) |
StreamingLocatorContentKey
| Name | Description | Value |
|---|---|---|
| id | ID of Content Key | string (required) |
| labelReferenceInStreamingPolicy | Label of Content Key as specified in the Streaming Policy | string |
| value | Value of Content Key | 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-07-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
alternativeMediaId = "string"
assetName = "string"
contentKeys = [
{
id = "string"
labelReferenceInStreamingPolicy = "string"
value = "string"
}
]
defaultContentKeyPolicyName = "string"
endTime = "string"
filters = [
"string"
]
startTime = "string"
streamingLocatorId = "string"
streamingPolicyName = "string"
}
})
}
Property values
mediaServices/streamingLocators
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Media/mediaServices/streamingLocators@2018-07-01" |
| 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 | Properties of the Streaming Locator. | StreamingLocatorProperties |
StreamingLocatorProperties
| Name | Description | Value |
|---|---|---|
| alternativeMediaId | Alternative Media ID of this Streaming Locator | string |
| assetName | Asset Name | string (required) |
| contentKeys | The ContentKeys used by this Streaming Locator. | StreamingLocatorContentKey[] |
| defaultContentKeyPolicyName | Name of the default ContentKeyPolicy used by this Streaming Locator. | string |
| endTime | The end time of the Streaming Locator. | string |
| filters | A list of asset or account filters which apply to this streaming locator | string[] |
| startTime | The start time of the Streaming Locator. | string |
| streamingLocatorId | The StreamingLocatorId of the Streaming Locator. | string |
| streamingPolicyName | Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming' | string (required) |
StreamingLocatorContentKey
| Name | Description | Value |
|---|---|---|
| id | ID of Content Key | string (required) |
| labelReferenceInStreamingPolicy | Label of Content Key as specified in the Streaming Policy | string |
| value | Value of Content Key | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for