Microsoft.Media mediaservices/streamingEndpoints 2018-06-01-preview
Bicep resource definition
The mediaservices/streamingEndpoints 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/streamingEndpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Media/mediaservices/streamingEndpoints@2018-06-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
accessControl: {
akamai: {
akamaiSignatureHeaderAuthenticationKeyList: [
{
base64Key: 'string'
expiration: 'string'
identifier: 'string'
}
]
}
ip: {
allow: [
{
address: 'string'
name: 'string'
subnetPrefixLength: int
}
]
}
}
availabilitySetName: 'string'
cdnEnabled: bool
cdnProfile: 'string'
cdnProvider: 'string'
crossSiteAccessPolicies: {
clientAccessPolicy: 'string'
crossDomainPolicy: 'string'
}
customHostNames: [
'string'
]
description: 'string'
maxCacheAge: int
scaleUnits: int
}
}
Property values
mediaservices/streamingEndpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-24 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 StreamingEndpoint properties. | StreamingEndpointProperties |
StreamingEndpointProperties
| Name | Description | Value |
|---|---|---|
| accessControl | The access control definition of the StreamingEndpoint. | StreamingEndpointAccessControl |
| availabilitySetName | AvailabilitySet name | string |
| cdnEnabled | The CDN enabled flag. | bool |
| cdnProfile | The CDN profile name. | string |
| cdnProvider | The CDN provider name. | string |
| crossSiteAccessPolicies | The StreamingEndpoint access policies. | CrossSiteAccessPolicies |
| customHostNames | The custom host names of the StreamingEndpoint | string[] |
| description | The StreamingEndpoint description. | string |
| maxCacheAge | Max cache age | int |
| scaleUnits | The number of scale units. | int |
StreamingEndpointAccessControl
| Name | Description | Value |
|---|---|---|
| akamai | The access control of Akamai | AkamaiAccessControl |
| ip | The IP access control of the StreamingEndpoint. | IPAccessControl |
AkamaiAccessControl
| Name | Description | Value |
|---|---|---|
| akamaiSignatureHeaderAuthenticationKeyList | authentication key list | AkamaiSignatureHeaderAuthenticationKey[] |
AkamaiSignatureHeaderAuthenticationKey
| Name | Description | Value |
|---|---|---|
| base64Key | authentication key | string |
| expiration | The exact time the authentication key. | string |
| identifier | identifier of the key | string |
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 |
CrossSiteAccessPolicies
| Name | Description | Value |
|---|---|---|
| clientAccessPolicy | The content of clientaccesspolicy.xml used by Silverlight. | string |
| crossDomainPolicy | The content of crossdomain.xml used by Silverlight. | string |
ARM template resource definition
The mediaservices/streamingEndpoints 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/streamingEndpoints resource, add the following JSON to your template.
{
"type": "Microsoft.Media/mediaservices/streamingEndpoints",
"apiVersion": "2018-06-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"accessControl": {
"akamai": {
"akamaiSignatureHeaderAuthenticationKeyList": [
{
"base64Key": "string",
"expiration": "string",
"identifier": "string"
}
]
},
"ip": {
"allow": [
{
"address": "string",
"name": "string",
"subnetPrefixLength": "int"
}
]
}
},
"availabilitySetName": "string",
"cdnEnabled": "bool",
"cdnProfile": "string",
"cdnProvider": "string",
"crossSiteAccessPolicies": {
"clientAccessPolicy": "string",
"crossDomainPolicy": "string"
},
"customHostNames": [ "string" ],
"description": "string",
"maxCacheAge": "int",
"scaleUnits": "int"
}
}
Property values
mediaservices/streamingEndpoints
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Media/mediaservices/streamingEndpoints' |
| 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) Character limit: 1-24 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 StreamingEndpoint properties. | StreamingEndpointProperties |
StreamingEndpointProperties
| Name | Description | Value |
|---|---|---|
| accessControl | The access control definition of the StreamingEndpoint. | StreamingEndpointAccessControl |
| availabilitySetName | AvailabilitySet name | string |
| cdnEnabled | The CDN enabled flag. | bool |
| cdnProfile | The CDN profile name. | string |
| cdnProvider | The CDN provider name. | string |
| crossSiteAccessPolicies | The StreamingEndpoint access policies. | CrossSiteAccessPolicies |
| customHostNames | The custom host names of the StreamingEndpoint | string[] |
| description | The StreamingEndpoint description. | string |
| maxCacheAge | Max cache age | int |
| scaleUnits | The number of scale units. | int |
StreamingEndpointAccessControl
| Name | Description | Value |
|---|---|---|
| akamai | The access control of Akamai | AkamaiAccessControl |
| ip | The IP access control of the StreamingEndpoint. | IPAccessControl |
AkamaiAccessControl
| Name | Description | Value |
|---|---|---|
| akamaiSignatureHeaderAuthenticationKeyList | authentication key list | AkamaiSignatureHeaderAuthenticationKey[] |
AkamaiSignatureHeaderAuthenticationKey
| Name | Description | Value |
|---|---|---|
| base64Key | authentication key | string |
| expiration | The exact time the authentication key. | string |
| identifier | identifier of the key | string |
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 |
CrossSiteAccessPolicies
| Name | Description | Value |
|---|---|---|
| clientAccessPolicy | The content of clientaccesspolicy.xml used by Silverlight. | string |
| crossDomainPolicy | The content of crossdomain.xml used by Silverlight. | string |
Terraform (AzAPI provider) resource definition
The mediaservices/streamingEndpoints 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/streamingEndpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Media/mediaservices/streamingEndpoints@2018-06-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
accessControl = {
akamai = {
akamaiSignatureHeaderAuthenticationKeyList = [
{
base64Key = "string"
expiration = "string"
identifier = "string"
}
]
}
ip = {
allow = [
{
address = "string"
name = "string"
subnetPrefixLength = int
}
]
}
}
availabilitySetName = "string"
cdnEnabled = bool
cdnProfile = "string"
cdnProvider = "string"
crossSiteAccessPolicies = {
clientAccessPolicy = "string"
crossDomainPolicy = "string"
}
customHostNames = [
"string"
]
description = "string"
maxCacheAge = int
scaleUnits = int
}
})
}
Property values
mediaservices/streamingEndpoints
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Media/mediaservices/streamingEndpoints@2018-06-01-preview" |
| name | The resource name | string (required) Character limit: 1-24 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 StreamingEndpoint properties. | StreamingEndpointProperties |
StreamingEndpointProperties
| Name | Description | Value |
|---|---|---|
| accessControl | The access control definition of the StreamingEndpoint. | StreamingEndpointAccessControl |
| availabilitySetName | AvailabilitySet name | string |
| cdnEnabled | The CDN enabled flag. | bool |
| cdnProfile | The CDN profile name. | string |
| cdnProvider | The CDN provider name. | string |
| crossSiteAccessPolicies | The StreamingEndpoint access policies. | CrossSiteAccessPolicies |
| customHostNames | The custom host names of the StreamingEndpoint | string[] |
| description | The StreamingEndpoint description. | string |
| maxCacheAge | Max cache age | int |
| scaleUnits | The number of scale units. | int |
StreamingEndpointAccessControl
| Name | Description | Value |
|---|---|---|
| akamai | The access control of Akamai | AkamaiAccessControl |
| ip | The IP access control of the StreamingEndpoint. | IPAccessControl |
AkamaiAccessControl
| Name | Description | Value |
|---|---|---|
| akamaiSignatureHeaderAuthenticationKeyList | authentication key list | AkamaiSignatureHeaderAuthenticationKey[] |
AkamaiSignatureHeaderAuthenticationKey
| Name | Description | Value |
|---|---|---|
| base64Key | authentication key | string |
| expiration | The exact time the authentication key. | string |
| identifier | identifier of the key | string |
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 |
CrossSiteAccessPolicies
| Name | Description | Value |
|---|---|---|
| clientAccessPolicy | The content of clientaccesspolicy.xml used by Silverlight. | string |
| crossDomainPolicy | The content of crossdomain.xml used by Silverlight. | 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