transforms

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

Overview

Name	transforms
Type	Resource
Id	azure.media_services.transforms

Fields

The following fields are returned by SELECT queries:

get

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

list

Name	Datatype	Description
properties	object	The resource 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, transformName	api-version	Gets a Transform.
list	select	subscriptionId, resourceGroupName, accountName	api-version, $filter, $orderby	Lists the Transforms in the account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, transformName	api-version	Creates or updates a new Transform.
update	update	subscriptionId, resourceGroupName, accountName, transformName	api-version	Updates a Transform.
delete	delete	subscriptionId, resourceGroupName, accountName, transformName	api-version	Deletes a Transform.

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.
resourceGroupName	string	The name of the resource group within the Azure subscription.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription.
transformName	string	The Transform name.
$filter	string	Restricts the set of items returned.
$orderby	string	Specifies the key by which the result collection should be ordered.
api-version	string	The version of the API to be used with the client request.

SELECT examples

get

Gets a Transform.

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

list

Lists the Transforms in the account.

SELECT
properties,
systemData
FROM azure.media_services.transforms
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Creates or updates a new Transform.

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

Manifest

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

UPDATE examples

update

Updates a Transform.

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

DELETE examples

delete

Deletes a Transform.

DELETE FROM azure.media_services.transforms
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND transformName = '{{ transformName }}' --required
AND api-version = '{{ api-version }}'
;