transformations

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

Overview

Name	transformations
Type	Resource
Id	azure.stream_analytics.transformations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified transformation.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	The properties that are associated with a transformation. Required on PUT (CreateOrReplace) requests.
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, jobName, transformationName		Gets details about the specified transformation.
create_or_replace	insert	subscriptionId, resourceGroupName, jobName, transformationName	If-Match, If-None-Match	Creates a transformation or replaces an already existing transformation under an existing streaming job.
update	update	subscriptionId, resourceGroupName, jobName, transformationName	If-Match	Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.

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
jobName	string	The name of the streaming job.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
transformationName	string	The name of the transformation.
If-Match	string	The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new transformation to be created, but to prevent updating an existing transformation. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets details about the specified transformation.

SELECT
id,
name,
properties,
type
FROM azure.stream_analytics.transformations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND transformationName = '{{ transformationName }}' -- required
;

INSERT examples

create_or_replace

Creates a transformation or replaces an already existing transformation under an existing streaming job.

INSERT INTO azure.stream_analytics.transformations (
data__name,
data__properties,
subscriptionId,
resourceGroupName,
jobName,
transformationName,
If-Match,
If-None-Match
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ jobName }}',
'{{ transformationName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: transformations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the transformations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the transformations resource.
    - name: jobName
      value: string
      description: Required parameter for the transformations resource.
    - name: transformationName
      value: string
      description: Required parameter for the transformations resource.
    - name: name
      value: string
      description: |
        Resource name
    - name: properties
      value: object
      description: |
        The properties that are associated with a transformation. Required on PUT (CreateOrReplace) requests.
    - name: If-Match
      value: string
      description: The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new transformation to be created, but to prevent updating an existing transformation. Other values will result in a 412 Pre-condition Failed response.

UPDATE examples

update

Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.

UPDATE azure.stream_analytics.transformations
SET 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND jobName = '{{ jobName }}' --required
AND transformationName = '{{ transformationName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
properties,
type;