transforms

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

Overview

Name	transforms
Type	Resource
Id	azure_extras.media.transforms

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.
created	string (date-time)	The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format.
description	string	An optional verbose description of the Transform.
lastModified	string (date-time)	The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.
outputs	array	An array of one or more TransformOutputs that the Transform should generate.
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.
created	string (date-time)	The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format.
description	string	An optional verbose description of the Transform.
lastModified	string (date-time)	The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.
outputs	array	An array of one or more TransformOutputs that the Transform should generate.
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, transform_name, subscription_id		Get Transform. Gets a Transform.
list	select	resource_group_name, account_name, subscription_id	$filter, $orderby	List Transforms. Lists the Transforms in the account.
create_or_update	insert	resource_group_name, account_name, transform_name, subscription_id		Create or Update Transform. Creates or updates a new Transform.
update	update	resource_group_name, account_name, transform_name, subscription_id		Update Transform. Updates a Transform.
create_or_update	replace	resource_group_name, account_name, transform_name, subscription_id		Create or Update Transform. Creates or updates a new Transform.
delete	delete	resource_group_name, account_name, transform_name, subscription_id		Delete Transform. 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
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
transform_name	string	The Transform name. Required.
$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.

SELECT examples

get

Get Transform. Gets a Transform.

SELECT
id,
name,
created,
description,
lastModified,
outputs,
systemData,
type
FROM azure_extras.media.transforms
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND transform_name = '{{ transform_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Transforms. Lists the Transforms in the account.

SELECT
id,
name,
created,
description,
lastModified,
outputs,
systemData,
type
FROM azure_extras.media.transforms
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or Update Transform. Creates or updates a new Transform.

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

Manifest

# Description fields are for documentation purposes
- name: transforms
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the transforms resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the transforms resource.
  - name: transform_name
    value: "{{ transform_name }}"
    description: Required parameter for the transforms resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the transforms resource.
  - name: properties
    value:
      description: "{{ description }}"
      outputs:
        - onError: "{{ onError }}"
          relativePriority: "{{ relativePriority }}"
          preset:
            @odata:
              type: "{{ type }}"

UPDATE examples

update

Update Transform. Updates a Transform.

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

REPLACE examples

create_or_update

Create or Update Transform. Creates or updates a new Transform.

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

DELETE examples

delete

Delete Transform. Deletes a Transform.

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