asset_filters

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

Overview

Name	asset_filters
Type	Resource
Id	azure.media_services.asset_filters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The Media Filter properties.
systemData	object	The system metadata relating to this resource.

list

Name	Datatype	Description
properties	object	The Media Filter properties.
systemData	object	The system metadata relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, assetName, filterName	api-version	Get the details of an Asset Filter associated with the specified Asset.
list	select	subscriptionId, resourceGroupName, accountName, assetName	api-version	List Asset Filters associated with the specified Asset.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, assetName, filterName	api-version	Creates or updates an Asset Filter associated with the specified Asset.
update	update	subscriptionId, resourceGroupName, accountName, assetName, filterName	api-version	Updates an existing Asset Filter associated with the specified Asset.
delete	delete	subscriptionId, resourceGroupName, accountName, assetName, filterName	api-version	Deletes an Asset Filter associated with the specified Asset.

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
accountName	string	The Media Services account name.
assetName	string	The Asset name.
filterName	string	The Asset Filter name
resourceGroupName	string	The name of the resource group within the Azure subscription.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription.
api-version	string	The version of the API to be used with the client request.

SELECT examples

get

Get the details of an Asset Filter associated with the specified Asset.

SELECT
properties,
systemData
FROM azure.media_services.asset_filters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND assetName = '{{ assetName }}' -- required
AND filterName = '{{ filterName }}' -- required
AND api-version = '{{ api-version }}'
;

list

List Asset Filters associated with the specified Asset.

SELECT
properties,
systemData
FROM azure.media_services.asset_filters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND assetName = '{{ assetName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates an Asset Filter associated with the specified Asset.

INSERT INTO azure.media_services.asset_filters (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
assetName,
filterName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ assetName }}',
'{{ filterName }}',
'{{ api-version }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: asset_filters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the asset_filters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the asset_filters resource.
    - name: accountName
      value: string
      description: Required parameter for the asset_filters resource.
    - name: assetName
      value: string
      description: Required parameter for the asset_filters resource.
    - name: filterName
      value: string
      description: Required parameter for the asset_filters resource.
    - name: properties
      value: object
      description: |
        The Media Filter properties.
    - name: api-version
      value: string
      description: The version of the API to be used with the client request.

UPDATE examples

update

Updates an existing Asset Filter associated with the specified Asset.

UPDATE azure.media_services.asset_filters
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND assetName = '{{ assetName }}' --required
AND filterName = '{{ filterName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes an Asset Filter associated with the specified Asset.

DELETE FROM azure.media_services.asset_filters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND assetName = '{{ assetName }}' --required
AND filterName = '{{ filterName }}' --required
AND api-version = '{{ api-version }}'
;