mediaservices

Creates, updates, deletes, gets or lists a mediaservices resource.

Overview

Name	mediaservices
Type	Resource
Id	azure_extras.media.mediaservices

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
encryption	object	The account encryption properties.
identity	object	The Managed Identity for the Media Services account.
keyDelivery	object	The Key Delivery properties for Media Services account.
location	string	The geo-location where the resource lives. Required.
mediaServiceId	string	The Media Services account ID.
privateEndpointConnections	array	The Private Endpoint Connections created for the Media Service account.
provisioningState	string	Provisioning state of the Media Services account. Known values are: "Failed", "InProgress", and "Succeeded".
publicNetworkAccess	string	Whether or not public network access is allowed for resources under the Media Services account. Known values are: "Enabled" and "Disabled".
storageAccounts	array	The storage accounts for this resource.
storageAuthentication	string	Known values are: "System" and "ManagedIdentity".
systemData	object	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".

list

Name	Datatype	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.
encryption	object	The account encryption properties.
identity	object	The Managed Identity for the Media Services account.
keyDelivery	object	The Key Delivery properties for Media Services account.
location	string	The geo-location where the resource lives. Required.
mediaServiceId	string	The Media Services account ID.
privateEndpointConnections	array	The Private Endpoint Connections created for the Media Service account.
provisioningState	string	Provisioning state of the Media Services account. Known values are: "Failed", "InProgress", and "Succeeded".
publicNetworkAccess	string	Whether or not public network access is allowed for resources under the Media Services account. Known values are: "Enabled" and "Disabled".
storageAccounts	array	The storage accounts for this resource.
storageAuthentication	string	Known values are: "System" and "ManagedIdentity".
systemData	object	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".

list_by_subscription

Name	Datatype	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.
encryption	object	The account encryption properties.
identity	object	The Managed Identity for the Media Services account.
keyDelivery	object	The Key Delivery properties for Media Services account.
location	string	The geo-location where the resource lives. Required.
mediaServiceId	string	The Media Services account ID.
privateEndpointConnections	array	The Private Endpoint Connections created for the Media Service account.
provisioningState	string	Provisioning state of the Media Services account. Known values are: "Failed", "InProgress", and "Succeeded".
publicNetworkAccess	string	Whether or not public network access is allowed for resources under the Media Services account. Known values are: "Enabled" and "Disabled".
storageAccounts	array	The storage accounts for this resource.
storageAuthentication	string	Known values are: "System" and "ManagedIdentity".
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, subscription_id		Get a Media Services account. Get the details of a Media Services account.
list	select	resource_group_name, subscription_id		List Media Services accounts. List Media Services accounts in the resource group.
list_by_subscription	select	subscription_id		List Media Services accounts. List Media Services accounts in the subscription.
create_or_update	insert	resource_group_name, account_name, subscription_id, location		Create or update a Media Services account. Creates or updates a Media Services account.
update	update	resource_group_name, account_name, subscription_id		Update a Media Services account. Updates an existing Media Services account.
create_or_update	replace	resource_group_name, account_name, subscription_id, location		Create or update a Media Services account. Creates or updates a Media Services account.
delete	delete	resource_group_name, account_name, subscription_id		Delete a Media Services account. Deletes a Media Services account.
list_edge_policies	exec	resource_group_name, account_name, subscription_id		List the media edge policies associated with the Media Services account. List all the media edge policies associated with the Media Services account.
sync_storage_keys	exec	resource_group_name, account_name, subscription_id		Synchronizes Storage Account Keys. Synchronizes storage account keys for a storage account associated with the Media Service account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The Media Services account name. Required.
resource_group_name	string	The name of the resource group within the Azure subscription. Required.
subscription_id	string

SELECT examples

get

Get a Media Services account. Get the details of a Media Services account.

SELECT
id,
name,
encryption,
identity,
keyDelivery,
location,
mediaServiceId,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
storageAccounts,
storageAuthentication,
systemData,
tags,
type
FROM azure_extras.media.mediaservices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Media Services accounts. List Media Services accounts in the resource group.

SELECT
id,
name,
encryption,
identity,
keyDelivery,
location,
mediaServiceId,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
storageAccounts,
storageAuthentication,
systemData,
tags,
type
FROM azure_extras.media.mediaservices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Media Services accounts. List Media Services accounts in the subscription.

SELECT
id,
name,
encryption,
identity,
keyDelivery,
location,
mediaServiceId,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
storageAccounts,
storageAuthentication,
systemData,
tags,
type
FROM azure_extras.media.mediaservices
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.media.mediaservices (
tags,
location,
identity,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: mediaservices
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the mediaservices resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the mediaservices resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the mediaservices resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The Managed Identity for the Media Services account.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      storageAccounts:
        - id: "{{ id }}"
          type: "{{ type }}"
          identity:
            userAssignedIdentity: "{{ userAssignedIdentity }}"
            useSystemAssignedIdentity: {{ useSystemAssignedIdentity }}
          status: "{{ status }}"
      storageAuthentication: "{{ storageAuthentication }}"
      encryption:
        type: "{{ type }}"
        keyVaultProperties:
          keyIdentifier: "{{ keyIdentifier }}"
          currentKeyIdentifier: "{{ currentKeyIdentifier }}"
        identity:
          userAssignedIdentity: "{{ userAssignedIdentity }}"
          useSystemAssignedIdentity: {{ useSystemAssignedIdentity }}
        status: "{{ status }}"
      keyDelivery:
        accessControl:
          defaultAction: "{{ defaultAction }}"
          ipAllowList:
            - "{{ ipAllowList }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"

UPDATE examples

update

Update a Media Services account. Updates an existing Media Services account.

UPDATE azure_extras.media.mediaservices
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.media.mediaservices
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Media Services account. Deletes a Media Services account.

DELETE FROM azure_extras.media.mediaservices
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_edge_policies

List the media edge policies associated with the Media Services account. List all the media edge policies associated with the Media Services account.

EXEC azure_extras.media.mediaservices.list_edge_policies 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"deviceId": "{{ deviceId }}"
}'
;

sync_storage_keys

Synchronizes Storage Account Keys. Synchronizes storage account keys for a storage account associated with the Media Service account.

EXEC azure_extras.media.mediaservices.sync_storage_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;