Share via

az stream-analytics transformation

  • Reference

Note

This reference is part of the stream-analytics extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stream-analytics transformation command. Learn more about extensions.

Manage transformation with stream analytics.

Commands

Name Description Type Status
az stream-analytics transformation create

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

 Extension GA
az stream-analytics transformation show

Get details about the specified transformation.

 Extension GA
az stream-analytics transformation update

Update 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.

 Extension GA

az stream-analytics transformation create

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

az stream-analytics transformation create --job-name
                                          --name
                                          --resource-group
                                          [--if-match]
                                          [--if-none-match]
                                          [--saql]
                                          [--streaming-units]
                                          [--valid-streaming-units]

Examples

Create a transformation

az stream-analytics transformation create --job-name "sj8374" --resource-group "sjrg4423" --saql "Select Id, Name from inputtest" --streaming-units 6 --transformation-name "transformation952"

Required Parameters

--job-name

The name of the streaming job.

--name --transformation-name -n

The name of the transformation.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--if-match

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

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.

--saql

Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests.

--streaming-units

Specifies the number of streaming units that the streaming job uses.

--valid-streaming-units

Specifies the valid streaming units a streaming job can scale to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az stream-analytics transformation show

Get details about the specified transformation.

az stream-analytics transformation show --job-name
                                        --name
                                        --resource-group

Examples

Get a transformation

az stream-analytics transformation show --job-name "sj8374" --resource-group "sjrg4423" --name "transformation952"

Required Parameters

--job-name

The name of the streaming job.

--name --transformation-name -n

The name of the transformation.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az stream-analytics transformation update

Update 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.

az stream-analytics transformation update --job-name
                                          --name
                                          --resource-group
                                          [--if-match]
                                          [--saql]
                                          [--streaming-units]
                                          [--valid-streaming-units]

Examples

Update a transformation

az stream-analytics transformation update --job-name "sj8374" --resource-group "sjrg4423" --saql "New query" --transformation-name "transformation952"

Required Parameters

--job-name

The name of the streaming job.

--name --transformation-name -n

The name of the transformation.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--if-match

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.

--saql

Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests.

--streaming-units

Specifies the number of streaming units that the streaming job uses.

--valid-streaming-units

Specifies the valid streaming units a streaming job can scale to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.