Article 10/25/2024
1 contributor
Feedback
In this article
Bicep resource definition
The mediaservices resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Media/mediaservices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Media/mediaservices@2023-01-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
encryption: {
identity: {
userAssignedIdentity: 'string'
useSystemAssignedIdentity: bool
}
keyVaultProperties: {
keyIdentifier: 'string'
}
type: 'string'
}
keyDelivery: {
accessControl: {
defaultAction: 'string'
ipAllowList: [
'string'
]
}
}
minimumTlsVersion: 'string'
publicNetworkAccess: 'string'
storageAccounts: [
{
id: 'string'
identity: {
userAssignedIdentity: 'string'
useSystemAssignedIdentity: bool
}
type: 'string'
}
]
storageAuthentication: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
AccessControl
Name
Description
Value
defaultAction
The behavior for IP access control in Key Delivery.
'Allow' 'Deny'
ipAllowList
The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty.
string[]
AccountEncryption
Name
Description
Value
identity
The Key Vault identity.
ResourceIdentity
keyVaultProperties
The properties of the key used to encrypt the account.
KeyVaultProperties
type
The type of key used to encrypt the Account Key.
'CustomerKey' 'SystemKey' (required)
KeyDelivery
Name
Description
Value
accessControl
The access control properties for Key Delivery.
AccessControl
KeyVaultProperties
Name
Description
Value
keyIdentifier
The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey).
string
Name
Description
Value
type
The identity type.
string (required)
userAssignedIdentities
The user assigned managed identities.
UserAssignedManagedIdentities
Name
Description
Value
encryption
The account encryption properties.
AccountEncryption
keyDelivery
The Key Delivery properties for Media Services account.
KeyDelivery
minimumTlsVersion
The minimum TLS version allowed for this account's requests. This is an optional property. If unspecified, a secure default value will be used.
'Tls10' 'Tls11' 'Tls12' 'Tls13'
publicNetworkAccess
Whether or not public network access is allowed for resources under the Media Services account.
'Disabled' 'Enabled'
storageAccounts
The storage accounts for this resource.
StorageAccount []
storageAuthentication
'ManagedIdentity' 'System'
Name
Description
Value
identity
The Managed Identity for the Media Services account.
MediaServiceIdentity
location
The geo-location where the resource lives
string (required)
name
The resource name
string (required)
properties
The resource properties.
MediaServiceProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
ResourceIdentity
Name
Description
Value
userAssignedIdentity
The user assigned managed identity's ARM ID to use when accessing a resource.
string
useSystemAssignedIdentity
Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity.
bool (required)
StorageAccount
Name
Description
Value
id
The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts.
string
identity
The storage account identity.
ResourceIdentity
type
The type of the storage account.
'Primary' 'Secondary' (required)
UserAssignedManagedIdentities
UserAssignedManagedIdentity
Quickstart samples
The following quickstart samples deploy this resource type.
ARM template resource definition
The mediaservices resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Media/mediaservices resource, add the following JSON to your template.
{
"type": "Microsoft.Media/mediaservices",
"apiVersion": "2023-01-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"encryption": {
"identity": {
"userAssignedIdentity": "string",
"useSystemAssignedIdentity": "bool"
},
"keyVaultProperties": {
"keyIdentifier": "string"
},
"type": "string"
},
"keyDelivery": {
"accessControl": {
"defaultAction": "string",
"ipAllowList": [ "string" ]
}
},
"minimumTlsVersion": "string",
"publicNetworkAccess": "string",
"storageAccounts": [
{
"id": "string",
"identity": {
"userAssignedIdentity": "string",
"useSystemAssignedIdentity": "bool"
},
"type": "string"
}
],
"storageAuthentication": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
AccessControl
Name
Description
Value
defaultAction
The behavior for IP access control in Key Delivery.
'Allow' 'Deny'
ipAllowList
The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty.
string[]
AccountEncryption
Name
Description
Value
identity
The Key Vault identity.
ResourceIdentity
keyVaultProperties
The properties of the key used to encrypt the account.
KeyVaultProperties
type
The type of key used to encrypt the Account Key.
'CustomerKey' 'SystemKey' (required)
KeyDelivery
Name
Description
Value
accessControl
The access control properties for Key Delivery.
AccessControl
KeyVaultProperties
Name
Description
Value
keyIdentifier
The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey).
string
Name
Description
Value
type
The identity type.
string (required)
userAssignedIdentities
The user assigned managed identities.
UserAssignedManagedIdentities
Name
Description
Value
encryption
The account encryption properties.
AccountEncryption
keyDelivery
The Key Delivery properties for Media Services account.
KeyDelivery
minimumTlsVersion
The minimum TLS version allowed for this account's requests. This is an optional property. If unspecified, a secure default value will be used.
'Tls10' 'Tls11' 'Tls12' 'Tls13'
publicNetworkAccess
Whether or not public network access is allowed for resources under the Media Services account.
'Disabled' 'Enabled'
storageAccounts
The storage accounts for this resource.
StorageAccount []
storageAuthentication
'ManagedIdentity' 'System'
Name
Description
Value
apiVersion
The api version
'2023-01-01'
identity
The Managed Identity for the Media Services account.
MediaServiceIdentity
location
The geo-location where the resource lives
string (required)
name
The resource name
string (required)
properties
The resource properties.
MediaServiceProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.Media/mediaservices'
ResourceIdentity
Name
Description
Value
userAssignedIdentity
The user assigned managed identity's ARM ID to use when accessing a resource.
string
useSystemAssignedIdentity
Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity.
bool (required)
StorageAccount
Name
Description
Value
id
The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts.
string
identity
The storage account identity.
ResourceIdentity
type
The type of the storage account.
'Primary' 'Secondary' (required)
UserAssignedManagedIdentities
UserAssignedManagedIdentity
Quickstart templates
The following quickstart templates deploy this resource type.
The mediaservices resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Media/mediaservices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Media/mediaservices@2023-01-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
body = jsonencode({
properties = {
encryption = {
identity = {
userAssignedIdentity = "string"
useSystemAssignedIdentity = bool
}
keyVaultProperties = {
keyIdentifier = "string"
}
type = "string"
}
keyDelivery = {
accessControl = {
defaultAction = "string"
ipAllowList = [
"string"
]
}
}
minimumTlsVersion = "string"
publicNetworkAccess = "string"
storageAccounts = [
{
id = "string"
identity = {
userAssignedIdentity = "string"
useSystemAssignedIdentity = bool
}
type = "string"
}
]
storageAuthentication = "string"
}
})
tags = {
{customized property} = "string"
}
}
Property values
AccessControl
Name
Description
Value
defaultAction
The behavior for IP access control in Key Delivery.
'Allow' 'Deny'
ipAllowList
The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty.
string[]
AccountEncryption
Name
Description
Value
identity
The Key Vault identity.
ResourceIdentity
keyVaultProperties
The properties of the key used to encrypt the account.
KeyVaultProperties
type
The type of key used to encrypt the Account Key.
'CustomerKey' 'SystemKey' (required)
KeyDelivery
Name
Description
Value
accessControl
The access control properties for Key Delivery.
AccessControl
KeyVaultProperties
Name
Description
Value
keyIdentifier
The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey).
string
Name
Description
Value
type
The identity type.
string (required)
userAssignedIdentities
The user assigned managed identities.
UserAssignedManagedIdentities
Name
Description
Value
encryption
The account encryption properties.
AccountEncryption
keyDelivery
The Key Delivery properties for Media Services account.
KeyDelivery
minimumTlsVersion
The minimum TLS version allowed for this account's requests. This is an optional property. If unspecified, a secure default value will be used.
'Tls10' 'Tls11' 'Tls12' 'Tls13'
publicNetworkAccess
Whether or not public network access is allowed for resources under the Media Services account.
'Disabled' 'Enabled'
storageAccounts
The storage accounts for this resource.
StorageAccount []
storageAuthentication
'ManagedIdentity' 'System'
Name
Description
Value
identity
The Managed Identity for the Media Services account.
MediaServiceIdentity
location
The geo-location where the resource lives
string (required)
name
The resource name
string (required)
properties
The resource properties.
MediaServiceProperties
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.Media/mediaservices@2023-01-01"
ResourceIdentity
Name
Description
Value
userAssignedIdentity
The user assigned managed identity's ARM ID to use when accessing a resource.
string
useSystemAssignedIdentity
Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity.
bool (required)
StorageAccount
Name
Description
Value
id
The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts.
string
identity
The storage account identity.
ResourceIdentity
type
The type of the storage account.
'Primary' 'Secondary' (required)
UserAssignedManagedIdentities
UserAssignedManagedIdentity