Mediaservices - Create Or Update

Create or update a Media Services account
Creates or updates a Media Services account

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}?api-version=2023-01-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The Media Services account name.

resourceGroupName
path True

string

The name of the resource group within the Azure subscription.

subscriptionId
path True

string

The unique identifier for a Microsoft Azure subscription.

api-version
query True

string

The version of the API to be used with the client request.

Request Body

Name Required Type Description
location True

string

The geo-location where the resource lives

identity

MediaServiceIdentity

The Managed Identity for the Media Services account.

properties.encryption

AccountEncryption

The account encryption properties.

properties.keyDelivery

KeyDelivery

The Key Delivery properties for Media Services account.

properties.minimumTlsVersion

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.

properties.publicNetworkAccess

PublicNetworkAccess

Whether or not public network access is allowed for resources under the Media Services account.

properties.storageAccounts

StorageAccount[]

The storage accounts for this resource.

properties.storageAuthentication

StorageAuthentication

tags

object

Resource tags.

Responses

Name Type Description
200 OK

MediaService

OK

Headers

  • Retry-After: integer
  • Location: string
  • Azure-AsyncOperation: string
201 Created

MediaService

Created

Headers

  • Retry-After: integer
  • Location: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

Detailed error information.

Examples

Create a Media Services account
Create a Media Services account-managed-identity

Create a Media Services account

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports?api-version=2023-01-01

{
  "location": "South Central US",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "storageAccounts": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Storage/storageAccounts/teststorageaccount",
        "type": "Primary"
      }
    ]
  }
}

Sample response

azure-asyncoperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Media/locations/westus2/mediaServicesOperationStatuses/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-01-01
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Media/locations/westus2/mediaServicesOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-01-01
{
  "name": "contososports",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports",
  "type": "Microsoft.Media/mediaservices",
  "location": "South Central US",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  },
  "properties": {
    "provisioningState": "InProgress",
    "storageAccounts": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Storage/storageAccounts/teststorageaccount",
        "type": "Primary"
      }
    ]
  }
}
{
  "name": "contososports",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports",
  "type": "Microsoft.Media/mediaservices",
  "location": "South Central US",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "storageAccounts": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Storage/storageAccounts/contososportsstore",
        "type": "Primary"
      }
    ]
  }
}

Create a Media Services account-managed-identity

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports?api-version=2023-01-01

{
  "location": "South Central US",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  },
  "properties": {
    "encryption": {
      "type": "CustomerKey",
      "identity": {
        "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
        "useSystemAssignedIdentity": false
      }
    },
    "storageAccounts": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Storage/storageAccounts/contososportsstore",
        "type": "Primary",
        "identity": {
          "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
          "useSystemAssignedIdentity": false
        }
      }
    ],
    "storageAuthentication": "ManagedIdentity",
    "publicNetworkAccess": "Enabled",
    "keyDelivery": {
      "accessControl": {
        "defaultAction": "Allow"
      }
    }
  }
}

Sample response

azure-asyncoperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Media/locations/westus2/mediaServicesOperationStatuses/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-01-01
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Media/locations/westus2/mediaServicesOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-01-01
{
  "name": "contososports",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports",
  "type": "Microsoft.Media/mediaservices",
  "location": "South Central US",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  },
  "properties": {
    "provisioningState": "InProgress",
    "encryption": {
      "type": "CustomerKey",
      "keyVaultProperties": {
        "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1",
        "currentKeyIdentifier": "https://keyvault.vault.azure.net/keys/key1/ver1"
      },
      "identity": {
        "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
        "useSystemAssignedIdentity": false
      }
    },
    "storageAccounts": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Storage/storageAccounts/contososportsstore",
        "type": "Primary",
        "identity": {
          "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
          "useSystemAssignedIdentity": false
        }
      }
    ],
    "storageAuthentication": "ManagedIdentity",
    "publicNetworkAccess": "Enabled",
    "keyDelivery": {
      "accessControl": {
        "defaultAction": "Allow"
      }
    },
    "privateEndpointConnections": [
      {
        "name": "00000000-0000-0000-0000-000000000001",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/00000000-0000-0000-0000-000000000001",
        "type": "Microsoft.Media/mediaservices/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "test description"
          },
          "privateEndpoint": {
            "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/pe1"
          }
        }
      },
      {
        "name": "00000000-0000-0000-0000-000000000002",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/00000000-0000-0000-0000-000000000002",
        "type": "Microsoft.Media/mediaservices/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "test description"
          },
          "privateEndpoint": {
            "id": "/subscriptions/22222222-2222-2222-2222-222222222222/resourceGroups/reosuceGroup2/providers/Microsoft.Network/privateEndpoints/pe2"
          }
        }
      }
    ]
  }
}
{
  "name": "contososports",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports",
  "type": "Microsoft.Media/mediaservices",
  "location": "South Central US",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  },
  "properties": {
    "provisioningState": "InProgress",
    "encryption": {
      "type": "CustomerKey",
      "keyVaultProperties": {
        "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1",
        "currentKeyIdentifier": "https://keyvault.vault.azure.net/keys/key1/ver1"
      },
      "identity": {
        "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
        "useSystemAssignedIdentity": false
      }
    },
    "storageAccounts": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Storage/storageAccounts/contososportsstore",
        "type": "Primary",
        "identity": {
          "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
          "useSystemAssignedIdentity": false
        }
      }
    ],
    "storageAuthentication": "ManagedIdentity",
    "publicNetworkAccess": "Enabled",
    "keyDelivery": {
      "accessControl": {
        "defaultAction": "Allow"
      }
    },
    "privateEndpointConnections": [
      {
        "name": "00000000-0000-0000-0000-000000000001",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/00000000-0000-0000-0000-000000000001",
        "type": "Microsoft.Media/mediaservices/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "test description"
          },
          "privateEndpoint": {
            "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/pe1"
          }
        }
      },
      {
        "name": "00000000-0000-0000-0000-000000000002",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/00000000-0000-0000-0000-000000000002",
        "type": "Microsoft.Media/mediaservices/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "test description"
          },
          "privateEndpoint": {
            "id": "/subscriptions/22222222-2222-2222-2222-222222222222/resourceGroups/reosuceGroup2/providers/Microsoft.Network/privateEndpoints/pe2"
          }
        }
      }
    ]
  }
}

Definitions

Name Description
AccessControl
AccountEncryption
AccountEncryptionKeyType

The type of key used to encrypt the Account Key.

createdByType

The type of identity that created the resource.

DefaultAction

The behavior for IP access control in Key Delivery.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

KeyDelivery
KeyVaultProperties
MediaService

A Media Services account.

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

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState

Provisioning state of the Media Services account.

PublicNetworkAccess

Whether or not public network access is allowed for resources under the Media Services account.

ResourceIdentity
StorageAccount

The storage account details.

StorageAccountType

The type of the storage account.

StorageAuthentication
systemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedManagedIdentity

AccessControl

Name Type Description
defaultAction

DefaultAction

The behavior for IP access control in Key Delivery.

ipAllowList

string[]

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.

AccountEncryption

Name Type Description
identity

ResourceIdentity

The Key Vault identity.

keyVaultProperties

KeyVaultProperties

The properties of the key used to encrypt the account.

status

string

The current status of the Key Vault mapping.

type

AccountEncryptionKeyType

The type of key used to encrypt the Account Key.

AccountEncryptionKeyType

The type of key used to encrypt the Account Key.

Name Type Description
CustomerKey

string

The Account Key is encrypted with a Customer Key.

SystemKey

string

The Account Key is encrypted with a System Key.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

The behavior for IP access control in Key Delivery.

Name Type Description
Allow

string

All public IP addresses are allowed.

Deny

string

Public IP addresses are blocked.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

KeyDelivery

Name Type Description
accessControl

AccessControl

The access control properties for Key Delivery.

KeyVaultProperties

Name Type Description
currentKeyIdentifier

string

The current key used to encrypt the Media Services account, including the key version.

keyIdentifier

string

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

MediaService

A Media Services account.

Name Type Default value Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

MediaServiceIdentity

The Managed Identity for the Media Services account.

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.encryption

AccountEncryption

The account encryption properties.

properties.keyDelivery

KeyDelivery

The Key Delivery properties for Media Services account.

properties.mediaServiceId

string

The Media Services account ID.

properties.minimumTlsVersion

MinimumTlsVersion

Tls12

The minimum TLS version allowed for this account's requests. This is an optional property. If unspecified, a secure default value will be used.

properties.privateEndpointConnections

PrivateEndpointConnection[]

The Private Endpoint Connections created for the Media Service account.

properties.provisioningState

ProvisioningState

Provisioning state of the Media Services account.

properties.publicNetworkAccess

PublicNetworkAccess

Whether or not public network access is allowed for resources under the Media Services account.

properties.storageAccounts

StorageAccount[]

The storage accounts for this resource.

properties.storageAuthentication

StorageAuthentication

systemData

systemData

The system metadata relating to this resource.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

MediaServiceIdentity

Name Type Description
principalId

string

The Principal ID of the identity.

tenantId

string

The Tenant ID of the identity.

type

string

The identity type.

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

The user assigned managed identities.

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.

Name Type Description
Tls10

string

Minimum TLS version is TLS 1.0.

Tls11

string

Minimum TLS version is TLS 1.1.

Tls12

string

Minimum TLS version is TLS 1.2.

Tls13

string

Minimum TLS version is TLS 1.3.

PrivateEndpoint

The Private Endpoint resource.

Name Type Description
id

string

The ARM identifier for Private Endpoint

PrivateEndpointConnection

The Private Endpoint Connection resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.privateEndpoint

PrivateEndpoint

The resource of private end point.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Name Type Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionsRequired

string

A message indicating if changes on the service provider require any updates on the consumer.

description

string

The reason for approval/rejection of the connection.

status

PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Provisioning state of the Media Services account.

Name Type Description
Failed

string

Provisioning state failed.

InProgress

string

Provisioning state in progress.

Succeeded

string

Provisioning state succeeded.

PublicNetworkAccess

Whether or not public network access is allowed for resources under the Media Services account.

Name Type Description
Disabled

string

Public network access is disabled.

Enabled

string

Public network access is enabled.

ResourceIdentity

Name Type Description
useSystemAssignedIdentity

boolean

Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity.

userAssignedIdentity

string

The user assigned managed identity's ARM ID to use when accessing a resource.

StorageAccount

The storage account details.

Name Type Description
id

string

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.

identity

ResourceIdentity

The storage account identity.

status

string

The current status of the storage account mapping.

type

StorageAccountType

The type of the storage account.

StorageAccountType

The type of the storage account.

Name Type Description
Primary

string

The primary storage account for the Media Services account.

Secondary

string

A secondary storage account for the Media Services account.

StorageAuthentication

Name Type Description
ManagedIdentity

string

Managed Identity authentication.

System

string

System authentication.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedManagedIdentity

Name Type Description
clientId

string

The client ID.

principalId

string

The principal ID.