assets

Creates, updates, deletes, gets or lists an assets resource.

Overview

Name	assets
Type	Resource
Id	azure_extras.media.assets

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.
alternateId	string	The alternate ID of the Asset.
assetId	string	The Asset ID.
container	string	The name of the asset blob container.
created	string (date-time)	The creation date of the Asset.
description	string	The Asset description.
lastModified	string (date-time)	The last modified date of the Asset.
storageAccountName	string	The name of the storage account.
storageEncryptionFormat	string	The Asset encryption format. One of None or MediaStorageEncryption. Known values are: "None" and "MediaStorageClientEncryption".
systemData	object	The system metadata relating to this resource.
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.
alternateId	string	The alternate ID of the Asset.
assetId	string	The Asset ID.
container	string	The name of the asset blob container.
created	string (date-time)	The creation date of the Asset.
description	string	The Asset description.
lastModified	string (date-time)	The last modified date of the Asset.
storageAccountName	string	The name of the storage account.
storageEncryptionFormat	string	The Asset encryption format. One of None or MediaStorageEncryption. Known values are: "None" and "MediaStorageClientEncryption".
systemData	object	The system metadata relating to this resource.
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, asset_name, subscription_id		Get an Asset. Get the details of an Asset in the Media Services account.
list	select	resource_group_name, account_name, subscription_id	$filter, $top, $orderby	List Assets. List Assets in the Media Services account with optional filtering and ordering.
create_or_update	insert	resource_group_name, account_name, asset_name, subscription_id		Create or update an Asset. Creates or updates an Asset in the Media Services account.
update	update	resource_group_name, account_name, asset_name, subscription_id		Update an Asset. Updates an existing Asset in the Media Services account.
create_or_update	replace	resource_group_name, account_name, asset_name, subscription_id		Create or update an Asset. Creates or updates an Asset in the Media Services account.
delete	delete	resource_group_name, account_name, asset_name, subscription_id		Delete an Asset. Deletes an Asset in the Media Services account.
list_container_sas	exec	resource_group_name, account_name, asset_name, subscription_id		List the Asset URLs. Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.
list_streaming_locators	exec	resource_group_name, account_name, asset_name, subscription_id		List Streaming Locators. Lists Streaming Locators which are associated with this asset.
get_encryption_key	exec	resource_group_name, account_name, asset_name, subscription_id		Gets the Asset storage key. Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API.

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.
asset_name	string	The Asset name. Required.
resource_group_name	string	The name of the resource group within the Azure subscription. Required.
subscription_id	string
$filter	string	Restricts the set of items returned. Default value is None.
$orderby	string	Specifies the key by which the result collection should be ordered. Default value is None.
$top	integer	Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. Default value is None.

SELECT examples

get

Get an Asset. Get the details of an Asset in the Media Services account.

SELECT
id,
name,
alternateId,
assetId,
container,
created,
description,
lastModified,
storageAccountName,
storageEncryptionFormat,
systemData,
type
FROM azure_extras.media.assets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND asset_name = '{{ asset_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Assets. List Assets in the Media Services account with optional filtering and ordering.

SELECT
id,
name,
alternateId,
assetId,
container,
created,
description,
lastModified,
storageAccountName,
storageEncryptionFormat,
systemData,
type
FROM azure_extras.media.assets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or update an Asset. Creates or updates an Asset in the Media Services account.

INSERT INTO azure_extras.media.assets (
properties,
resource_group_name,
account_name,
asset_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ asset_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: assets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the assets resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the assets resource.
  - name: asset_name
    value: "{{ asset_name }}"
    description: Required parameter for the assets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the assets resource.
  - name: properties
    value:
      alternateId: "{{ alternateId }}"
      description: "{{ description }}"
      container: "{{ container }}"
      storageAccountName: "{{ storageAccountName }}"

UPDATE examples

update

Update an Asset. Updates an existing Asset in the Media Services account.

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

REPLACE examples

create_or_update

Create or update an Asset. Creates or updates an Asset in the Media Services account.

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

DELETE examples

delete

Delete an Asset. Deletes an Asset in the Media Services account.

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

Lifecycle Methods

list_container_sas

List the Asset URLs. Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.

EXEC azure_extras.media.assets.list_container_sas 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@asset_name='{{ asset_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"permissions": "{{ permissions }}", 
"expiryTime": "{{ expiryTime }}"
}'
;

list_streaming_locators

List Streaming Locators. Lists Streaming Locators which are associated with this asset.

EXEC azure_extras.media.assets.list_streaming_locators 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@asset_name='{{ asset_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_encryption_key

Gets the Asset storage key. Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API.

EXEC azure_extras.media.assets.get_encryption_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@asset_name='{{ asset_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;