Share via

Microsoft.Media mediaservices 2021-05-01

  • 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.

Resource format

To create a Microsoft.Media/mediaservices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Media/mediaservices@2021-05-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    encryption: {
      keyVaultProperties: {
        keyIdentifier: 'string'
      }
      type: 'string'
    }
    keyDelivery: {
      accessControl: {
        defaultAction: 'string'
        ipAllowList: [
          'string'
        ]
      }
    }
    storageAccounts: [
      {
        id: 'string'
        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
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

MediaServiceIdentity

Name Description Value
type The identity type. 'None'
'SystemAssigned' (required)

MediaServiceProperties

Name Description Value
encryption The account encryption properties. AccountEncryption
keyDelivery The Key Delivery properties for Media Services account. KeyDelivery
storageAccounts The storage accounts for this resource. StorageAccount[]
storageAuthentication 'ManagedIdentity'
'System'

Microsoft.Media/mediaservices

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

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
type The type of the storage account. 'Primary'
'Secondary' (required)

TrackedResourceTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Create a Media Services Account using a template This template creates an Azure Media Services Account with its Storage account.

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.

Resource format

To create a Microsoft.Media/mediaservices resource, add the following JSON to your template.

{
  "type": "Microsoft.Media/mediaservices",
  "apiVersion": "2021-05-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "encryption": {
      "keyVaultProperties": {
        "keyIdentifier": "string"
      },
      "type": "string"
    },
    "keyDelivery": {
      "accessControl": {
        "defaultAction": "string",
        "ipAllowList": [ "string" ]
      }
    },
    "storageAccounts": [
      {
        "id": "string",
        "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
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

MediaServiceIdentity

Name Description Value
type The identity type. 'None'
'SystemAssigned' (required)

MediaServiceProperties

Name Description Value
encryption The account encryption properties. AccountEncryption
keyDelivery The Key Delivery properties for Media Services account. KeyDelivery
storageAccounts The storage accounts for this resource. StorageAccount[]
storageAuthentication 'ManagedIdentity'
'System'

Microsoft.Media/mediaservices

Name Description Value
apiVersion The api version '2021-05-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'

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
type The type of the storage account. 'Primary'
'Secondary' (required)

TrackedResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Media Services Account using a template

Deploy to Azure		 This template creates an Azure Media Services Account with its Storage account.
Orchard CMS Video Portal Web App

Deploy to Azure		 This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured.

Terraform (AzAPI provider) resource definition

The mediaservices resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Media/mediaservices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Media/mediaservices@2021-05-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      encryption = {
        keyVaultProperties = {
          keyIdentifier = "string"
        }
        type = "string"
      }
      keyDelivery = {
        accessControl = {
          defaultAction = "string"
          ipAllowList = [
            "string"
          ]
        }
      }
      storageAccounts = [
        {
          id = "string"
          type = "string"
        }
      ]
      storageAuthentication = "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
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

MediaServiceIdentity

Name Description Value
type The identity type. 'None'
'SystemAssigned' (required)

MediaServiceProperties

Name Description Value
encryption The account encryption properties. AccountEncryption
keyDelivery The Key Delivery properties for Media Services account. KeyDelivery
storageAccounts The storage accounts for this resource. StorageAccount[]
storageAuthentication 'ManagedIdentity'
'System'

Microsoft.Media/mediaservices

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@2021-05-01"

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
type The type of the storage account. 'Primary'
'Secondary' (required)

TrackedResourceTags

Name Description Value