Microsoft.Media mediaservices/liveEvents 2019-05-01-preview
Bicep resource definition
The mediaservices/liveEvents 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/liveEvents resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Media/mediaservices/liveEvents@2019-05-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
crossSiteAccessPolicies: {
clientAccessPolicy: 'string'
crossDomainPolicy: 'string'
}
description: 'string'
encoding: {
encodingType: 'string'
presetName: 'string'
}
input: {
accessControl: {
ip: {
allow: [
{
address: 'string'
name: 'string'
subnetPrefixLength: int
}
]
}
}
accessToken: 'string'
endpoints: [
{
protocol: 'string'
url: 'string'
}
]
keyFrameIntervalDuration: 'string'
streamingProtocol: 'string'
}
preview: {
accessControl: {
ip: {
allow: [
{
address: 'string'
name: 'string'
subnetPrefixLength: int
}
]
}
}
alternativeMediaId: 'string'
endpoints: [
{
protocol: 'string'
url: 'string'
}
]
previewLocator: 'string'
streamingPolicyName: 'string'
}
streamOptions: [
'string'
]
transcriptions: [
{
inputTrackSelection: [
{
operation: 'string'
property: 'string'
value: 'string'
}
]
language: 'string'
outputTranscriptionTrack: {
trackName: 'string'
}
}
]
vanityUrl: bool
}
}
Property values
mediaservices/liveEvents
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-32 Valid characters: Alphanumerics and hyphens. Start with alphanumeric. |
| location | The Azure Region of the resource. | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| 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 | The Live Event properties. | LiveEventProperties |
LiveEventProperties
| Name | Description | Value |
|---|---|---|
| crossSiteAccessPolicies | The Live Event access policies. | CrossSiteAccessPolicies |
| description | The Live Event description. | string |
| encoding | The Live Event encoding. | LiveEventEncoding |
| input | The Live Event input. | LiveEventInput (required) |
| preview | The Live Event preview. | LiveEventPreview |
| streamOptions | The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. | String array containing any of: 'Default' 'LowLatency' |
| transcriptions | The Live Event transcription. | LiveEventTranscription[] |
| vanityUrl | Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. | bool |
CrossSiteAccessPolicies
| Name | Description | Value |
|---|---|---|
| clientAccessPolicy | The content of clientaccesspolicy.xml used by Silverlight. | string |
| crossDomainPolicy | The content of crossdomain.xml used by Silverlight. | string |
LiveEventEncoding
| Name | Description | Value |
|---|---|---|
| encodingType | The encoding type for Live Event. This value is specified at creation time and cannot be updated. | 'Basic' 'None' 'Premium1080p' 'Standard' |
| presetName | The encoding preset name. This value is specified at creation time and cannot be updated. | string |
LiveEventInput
| Name | Description | Value |
|---|---|---|
| accessControl | The access control for LiveEvent Input. | LiveEventInputAccessControl |
| accessToken | A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. | string |
| endpoints | The input endpoints for the Live Event. | LiveEventEndpoint[] |
| keyFrameIntervalDuration | ISO 8601 timespan duration of the key frame interval duration. | string |
| streamingProtocol | The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. | 'FragmentedMP4' 'RTMP' (required) |
LiveEventInputAccessControl
| Name | Description | Value |
|---|---|---|
| ip | The IP access control properties. | IPAccessControl |
IPAccessControl
| Name | Description | Value |
|---|---|---|
| allow | The IP allow list. | IPRange[] |
IPRange
| Name | Description | Value |
|---|---|---|
| address | The IP address. | string |
| name | The friendly name for the IP address range. | string |
| subnetPrefixLength | The subnet mask prefix length (see CIDR notation). | int |
LiveEventEndpoint
| Name | Description | Value |
|---|---|---|
| protocol | The endpoint protocol. | string |
| url | The endpoint URL. | string |
LiveEventPreview
| Name | Description | Value |
|---|---|---|
| accessControl | The access control for LiveEvent preview. | LiveEventPreviewAccessControl |
| alternativeMediaId | An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. | string |
| endpoints | The endpoints for preview. | LiveEventEndpoint[] |
| previewLocator | The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. | string |
| streamingPolicyName | The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. | string |
LiveEventPreviewAccessControl
| Name | Description | Value |
|---|---|---|
| ip | The IP access control properties. | IPAccessControl |
LiveEventTranscription
| Name | Description | Value |
|---|---|---|
| inputTrackSelection | Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. | LiveEventInputTrackSelection[] |
| language | Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. | string |
| outputTranscriptionTrack | Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. | LiveEventOutputTranscriptionTrack |
LiveEventInputTrackSelection
| Name | Description | Value |
|---|---|---|
| operation | Comparing operation. | string |
| property | Property name to select. | string |
| value | Property value to select. | string |
LiveEventOutputTranscriptionTrack
| Name | Description | Value |
|---|---|---|
| trackName | The output track name. | string (required) |
ARM template resource definition
The mediaservices/liveEvents 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/liveEvents resource, add the following JSON to your template.
{
"type": "Microsoft.Media/mediaservices/liveEvents",
"apiVersion": "2019-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"crossSiteAccessPolicies": {
"clientAccessPolicy": "string",
"crossDomainPolicy": "string"
},
"description": "string",
"encoding": {
"encodingType": "string",
"presetName": "string"
},
"input": {
"accessControl": {
"ip": {
"allow": [
{
"address": "string",
"name": "string",
"subnetPrefixLength": "int"
}
]
}
},
"accessToken": "string",
"endpoints": [
{
"protocol": "string",
"url": "string"
}
],
"keyFrameIntervalDuration": "string",
"streamingProtocol": "string"
},
"preview": {
"accessControl": {
"ip": {
"allow": [
{
"address": "string",
"name": "string",
"subnetPrefixLength": "int"
}
]
}
},
"alternativeMediaId": "string",
"endpoints": [
{
"protocol": "string",
"url": "string"
}
],
"previewLocator": "string",
"streamingPolicyName": "string"
},
"streamOptions": [ "string" ],
"transcriptions": [
{
"inputTrackSelection": [
{
"operation": "string",
"property": "string",
"value": "string"
}
],
"language": "string",
"outputTranscriptionTrack": {
"trackName": "string"
}
}
],
"vanityUrl": "bool"
}
}
Property values
mediaservices/liveEvents
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Media/mediaservices/liveEvents' |
| apiVersion | The resource api version | '2019-05-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-32 Valid characters: Alphanumerics and hyphens. Start with alphanumeric. |
| location | The Azure Region of the resource. | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | The Live Event properties. | LiveEventProperties |
LiveEventProperties
| Name | Description | Value |
|---|---|---|
| crossSiteAccessPolicies | The Live Event access policies. | CrossSiteAccessPolicies |
| description | The Live Event description. | string |
| encoding | The Live Event encoding. | LiveEventEncoding |
| input | The Live Event input. | LiveEventInput (required) |
| preview | The Live Event preview. | LiveEventPreview |
| streamOptions | The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. | String array containing any of: 'Default' 'LowLatency' |
| transcriptions | The Live Event transcription. | LiveEventTranscription[] |
| vanityUrl | Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. | bool |
CrossSiteAccessPolicies
| Name | Description | Value |
|---|---|---|
| clientAccessPolicy | The content of clientaccesspolicy.xml used by Silverlight. | string |
| crossDomainPolicy | The content of crossdomain.xml used by Silverlight. | string |
LiveEventEncoding
| Name | Description | Value |
|---|---|---|
| encodingType | The encoding type for Live Event. This value is specified at creation time and cannot be updated. | 'Basic' 'None' 'Premium1080p' 'Standard' |
| presetName | The encoding preset name. This value is specified at creation time and cannot be updated. | string |
LiveEventInput
| Name | Description | Value |
|---|---|---|
| accessControl | The access control for LiveEvent Input. | LiveEventInputAccessControl |
| accessToken | A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. | string |
| endpoints | The input endpoints for the Live Event. | LiveEventEndpoint[] |
| keyFrameIntervalDuration | ISO 8601 timespan duration of the key frame interval duration. | string |
| streamingProtocol | The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. | 'FragmentedMP4' 'RTMP' (required) |
LiveEventInputAccessControl
| Name | Description | Value |
|---|---|---|
| ip | The IP access control properties. | IPAccessControl |
IPAccessControl
| Name | Description | Value |
|---|---|---|
| allow | The IP allow list. | IPRange[] |
IPRange
| Name | Description | Value |
|---|---|---|
| address | The IP address. | string |
| name | The friendly name for the IP address range. | string |
| subnetPrefixLength | The subnet mask prefix length (see CIDR notation). | int |
LiveEventEndpoint
| Name | Description | Value |
|---|---|---|
| protocol | The endpoint protocol. | string |
| url | The endpoint URL. | string |
LiveEventPreview
| Name | Description | Value |
|---|---|---|
| accessControl | The access control for LiveEvent preview. | LiveEventPreviewAccessControl |
| alternativeMediaId | An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. | string |
| endpoints | The endpoints for preview. | LiveEventEndpoint[] |
| previewLocator | The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. | string |
| streamingPolicyName | The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. | string |
LiveEventPreviewAccessControl
| Name | Description | Value |
|---|---|---|
| ip | The IP access control properties. | IPAccessControl |
LiveEventTranscription
| Name | Description | Value |
|---|---|---|
| inputTrackSelection | Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. | LiveEventInputTrackSelection[] |
| language | Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. | string |
| outputTranscriptionTrack | Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. | LiveEventOutputTranscriptionTrack |
LiveEventInputTrackSelection
| Name | Description | Value |
|---|---|---|
| operation | Comparing operation. | string |
| property | Property name to select. | string |
| value | Property value to select. | string |
LiveEventOutputTranscriptionTrack
| Name | Description | Value |
|---|---|---|
| trackName | The output track name. | string (required) |
Terraform (AzAPI provider) resource definition
The mediaservices/liveEvents 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/liveEvents resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Media/mediaservices/liveEvents@2019-05-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
crossSiteAccessPolicies = {
clientAccessPolicy = "string"
crossDomainPolicy = "string"
}
description = "string"
encoding = {
encodingType = "string"
presetName = "string"
}
input = {
accessControl = {
ip = {
allow = [
{
address = "string"
name = "string"
subnetPrefixLength = int
}
]
}
}
accessToken = "string"
endpoints = [
{
protocol = "string"
url = "string"
}
]
keyFrameIntervalDuration = "string"
streamingProtocol = "string"
}
preview = {
accessControl = {
ip = {
allow = [
{
address = "string"
name = "string"
subnetPrefixLength = int
}
]
}
}
alternativeMediaId = "string"
endpoints = [
{
protocol = "string"
url = "string"
}
]
previewLocator = "string"
streamingPolicyName = "string"
}
streamOptions = [
"string"
]
transcriptions = [
{
inputTrackSelection = [
{
operation = "string"
property = "string"
value = "string"
}
]
language = "string"
outputTranscriptionTrack = {
trackName = "string"
}
}
]
vanityUrl = bool
}
})
}
Property values
mediaservices/liveEvents
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Media/mediaservices/liveEvents@2019-05-01-preview" |
| name | The resource name | string (required) Character limit: 1-32 Valid characters: Alphanumerics and hyphens. Start with alphanumeric. |
| location | The Azure Region of the resource. | string |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: mediaservices |
| tags | Resource tags. | Dictionary of tag names and values. |
| properties | The Live Event properties. | LiveEventProperties |
LiveEventProperties
| Name | Description | Value |
|---|---|---|
| crossSiteAccessPolicies | The Live Event access policies. | CrossSiteAccessPolicies |
| description | The Live Event description. | string |
| encoding | The Live Event encoding. | LiveEventEncoding |
| input | The Live Event input. | LiveEventInput (required) |
| preview | The Live Event preview. | LiveEventPreview |
| streamOptions | The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. | String array containing any of: "Default" "LowLatency" |
| transcriptions | The Live Event transcription. | LiveEventTranscription[] |
| vanityUrl | Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. | bool |
CrossSiteAccessPolicies
| Name | Description | Value |
|---|---|---|
| clientAccessPolicy | The content of clientaccesspolicy.xml used by Silverlight. | string |
| crossDomainPolicy | The content of crossdomain.xml used by Silverlight. | string |
LiveEventEncoding
| Name | Description | Value |
|---|---|---|
| encodingType | The encoding type for Live Event. This value is specified at creation time and cannot be updated. | "Basic" "None" "Premium1080p" "Standard" |
| presetName | The encoding preset name. This value is specified at creation time and cannot be updated. | string |
LiveEventInput
| Name | Description | Value |
|---|---|---|
| accessControl | The access control for LiveEvent Input. | LiveEventInputAccessControl |
| accessToken | A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. | string |
| endpoints | The input endpoints for the Live Event. | LiveEventEndpoint[] |
| keyFrameIntervalDuration | ISO 8601 timespan duration of the key frame interval duration. | string |
| streamingProtocol | The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. | "FragmentedMP4" "RTMP" (required) |
LiveEventInputAccessControl
| Name | Description | Value |
|---|---|---|
| ip | The IP access control properties. | IPAccessControl |
IPAccessControl
| Name | Description | Value |
|---|---|---|
| allow | The IP allow list. | IPRange[] |
IPRange
| Name | Description | Value |
|---|---|---|
| address | The IP address. | string |
| name | The friendly name for the IP address range. | string |
| subnetPrefixLength | The subnet mask prefix length (see CIDR notation). | int |
LiveEventEndpoint
| Name | Description | Value |
|---|---|---|
| protocol | The endpoint protocol. | string |
| url | The endpoint URL. | string |
LiveEventPreview
| Name | Description | Value |
|---|---|---|
| accessControl | The access control for LiveEvent preview. | LiveEventPreviewAccessControl |
| alternativeMediaId | An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. | string |
| endpoints | The endpoints for preview. | LiveEventEndpoint[] |
| previewLocator | The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. | string |
| streamingPolicyName | The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. | string |
LiveEventPreviewAccessControl
| Name | Description | Value |
|---|---|---|
| ip | The IP access control properties. | IPAccessControl |
LiveEventTranscription
| Name | Description | Value |
|---|---|---|
| inputTrackSelection | Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. | LiveEventInputTrackSelection[] |
| language | Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. | string |
| outputTranscriptionTrack | Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. | LiveEventOutputTranscriptionTrack |
LiveEventInputTrackSelection
| Name | Description | Value |
|---|---|---|
| operation | Comparing operation. | string |
| property | Property name to select. | string |
| value | Property value to select. | string |
LiveEventOutputTranscriptionTrack
| Name | Description | Value |
|---|---|---|
| trackName | The output track name. | string (required) |
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