Share via

az stream-analytics cluster

  • 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 cluster command. Learn more about extensions.

Manage cluster with stream analytics.

Commands

Name Description Type Status
az stream-analytics cluster create

Create a Stream Analytics Cluster or replaces an already existing cluster.

 Extension GA
az stream-analytics cluster delete

Delete the specified cluster.

 Extension GA
az stream-analytics cluster list

List all of the clusters in the given resource group. And Lists all of the clusters in the given subscription.

 Extension GA
az stream-analytics cluster list-streaming-job

List all of the streaming jobs in the given cluster.

 Extension GA
az stream-analytics cluster show

Get information about the specified cluster.

 Extension GA
az stream-analytics cluster update

Update an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

 Extension GA
az stream-analytics cluster wait

Place the CLI in a waiting state until a condition of the stream-analytics cluster is met.

 Extension GA

az stream-analytics cluster create

Create a Stream Analytics Cluster or replaces an already existing cluster.

az stream-analytics cluster create --cluster-name
                                   --resource-group
                                   [--if-match]
                                   [--if-none-match]
                                   [--location]
                                   [--no-wait]
                                   [--sku]
                                   [--tags]

Examples

Create a new cluster

az stream-analytics cluster create --location "North US" --sku name="Default" capacity=36 --tags key="value" --name "An Example Cluster" --resource-group "sjrg"

Required Parameters

--cluster-name --name -n

The name of the cluster.

--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 resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--sku

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

Usage: --sku name=XX capacity=XX

name: Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. capacity: Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 cluster delete

Delete the specified cluster.

az stream-analytics cluster delete [--cluster-name]
                                   [--ids]
                                   [--no-wait]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Examples

Delete a cluster

az stream-analytics cluster delete --name "testcluster" --resource-group "sjrg"

Optional Parameters

--cluster-name --name -n

The name of the cluster.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 cluster list

List all of the clusters in the given resource group. And Lists all of the clusters in the given subscription.

az stream-analytics cluster list [--resource-group]

Examples

List clusters in resource group

az stream-analytics cluster list --resource-group "sjrg"

List the clusters in a subscription

az stream-analytics cluster list

Optional Parameters

--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 cluster list-streaming-job

List all of the streaming jobs in the given cluster.

az stream-analytics cluster list-streaming-job --cluster-name
                                               --resource-group

Examples

List all streaming jobs in cluster

az stream-analytics cluster list-streaming-job --name "testcluster" --resource-group "sjrg"

Required Parameters

--cluster-name --name -n

The name of the cluster.

--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 cluster show

Get information about the specified cluster.

az stream-analytics cluster show [--cluster-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Examples

Get a cluster

az stream-analytics cluster show --name "testcluster" --resource-group "sjrg"

Optional Parameters

--cluster-name --name -n

The name of the cluster.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

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

--subscription

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

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 cluster update

Update an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

az stream-analytics cluster update [--cluster-name]
                                   [--ids]
                                   [--if-match]
                                   [--location]
                                   [--no-wait]
                                   [--resource-group]
                                   [--sku]
                                   [--subscription]
                                   [--tags]

Examples

Update a cluster

az stream-analytics cluster update --location "Central US" --sku capacity=72 --name "testcluster" --resource-group "sjrg"

Optional Parameters

--cluster-name --name -n

The name of the cluster.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--if-match

The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

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

--sku

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

Usage: --sku name=XX capacity=XX

name: Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. capacity: Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 cluster wait

Place the CLI in a waiting state until a condition of the stream-analytics cluster is met.

az stream-analytics cluster wait [--cluster-name]
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

Examples

Pause executing next line of CLI script until the stream-analytics cluster is successfully created.

az stream-analytics cluster wait --name "testcluster" --resource-group "sjrg" --created

Pause executing next line of CLI script until the stream-analytics cluster is successfully updated.

az stream-analytics cluster wait --name "testcluster" --resource-group "sjrg" --updated

Pause executing next line of CLI script until the stream-analytics cluster is successfully deleted.

az stream-analytics cluster wait --name "testcluster" --resource-group "sjrg" --deleted

Optional Parameters

--cluster-name --name -n

The name of the cluster.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.