Microsoft.Media mediaservices/liveEvents 2018-03-30-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@2018-03-30-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: {
accessToken: 'string'
endpoints: [
{
protocol: 'string'
url: 'string'
}
]
keyFrameIntervalDuration: 'string'
streamingProtocol: 'string'
}
preview: {
accessControl: {
ip: {
allow: [
{
address: 'string'
name: 'string'
subnetPrefixLength: int
}
]
}
}
endpoints: [
{
protocol: 'string'
url: 'string'
}
]
previewLocator: 'string'
streamingPolicyName: 'string'
}
streamOptions: [
'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 stream options. | String array containing any of: 'Default' 'LowLatency' |
| vanityUrl | The Live Event vanity URL flag. | 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. | 'Basic' 'None' |
| presetName | The encoding preset name. | string |
LiveEventInput
| Name | Description | Value |
|---|---|---|
| accessToken | The access token. | 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. | 'FragmentedMP4' 'RTMP' (required) |
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 |
| endpoints | The endpoints for preview. | LiveEventEndpoint[] |
| previewLocator | The preview locator Guid. | string |
| streamingPolicyName | The name of streaming policy used for LiveEvent preview | string |
LiveEventPreviewAccessControl
| 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 |
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": "2018-03-30-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"crossSiteAccessPolicies": {
"clientAccessPolicy": "string",
"crossDomainPolicy": "string"
},
"description": "string",
"encoding": {
"encodingType": "string",
"presetName": "string"
},
"input": {
"accessToken": "string",
"endpoints": [
{
"protocol": "string",
"url": "string"
}
],
"keyFrameIntervalDuration": "string",
"streamingProtocol": "string"
},
"preview": {
"accessControl": {
"ip": {
"allow": [
{
"address": "string",
"name": "string",
"subnetPrefixLength": "int"
}
]
}
},
"endpoints": [
{
"protocol": "string",
"url": "string"
}
],
"previewLocator": "string",
"streamingPolicyName": "string"
},
"streamOptions": [ "string" ],
"vanityUrl": "bool"
}
}
Property values
mediaservices/liveEvents
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Media/mediaservices/liveEvents' |
| apiVersion | The resource api version | '2018-03-30-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 stream options. | String array containing any of: 'Default' 'LowLatency' |
| vanityUrl | The Live Event vanity URL flag. | 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. | 'Basic' 'None' |
| presetName | The encoding preset name. | string |
LiveEventInput
| Name | Description | Value |
|---|---|---|
| accessToken | The access token. | 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. | 'FragmentedMP4' 'RTMP' (required) |
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 |
| endpoints | The endpoints for preview. | LiveEventEndpoint[] |
| previewLocator | The preview locator Guid. | string |
| streamingPolicyName | The name of streaming policy used for LiveEvent preview | string |
LiveEventPreviewAccessControl
| 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 |
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@2018-03-30-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 = {
accessToken = "string"
endpoints = [
{
protocol = "string"
url = "string"
}
]
keyFrameIntervalDuration = "string"
streamingProtocol = "string"
}
preview = {
accessControl = {
ip = {
allow = [
{
address = "string"
name = "string"
subnetPrefixLength = int
}
]
}
}
endpoints = [
{
protocol = "string"
url = "string"
}
]
previewLocator = "string"
streamingPolicyName = "string"
}
streamOptions = [
"string"
]
vanityUrl = bool
}
})
}
Property values
mediaservices/liveEvents
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Media/mediaservices/liveEvents@2018-03-30-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 stream options. | String array containing any of: "Default" "LowLatency" |
| vanityUrl | The Live Event vanity URL flag. | 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. | "Basic" "None" |
| presetName | The encoding preset name. | string |
LiveEventInput
| Name | Description | Value |
|---|---|---|
| accessToken | The access token. | 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. | "FragmentedMP4" "RTMP" (required) |
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 |
| endpoints | The endpoints for preview. | LiveEventEndpoint[] |
| previewLocator | The preview locator Guid. | string |
| streamingPolicyName | The name of streaming policy used for LiveEvent preview | string |
LiveEventPreviewAccessControl
| 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 |
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