az stream-analytics private-endpoint

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

Manage private endpoint with stream analytics.

Commands

Name Description Type Status
az stream-analytics private-endpoint create

Create a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.

 Extension GA
az stream-analytics private-endpoint delete

Delete the specified private endpoint.

 Extension GA
az stream-analytics private-endpoint list

List the private endpoints in the cluster.

 Extension GA
az stream-analytics private-endpoint show

Get information about the specified Private Endpoint.

 Extension GA
az stream-analytics private-endpoint wait

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

 Extension GA

az stream-analytics private-endpoint create

Create a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.

az stream-analytics private-endpoint create --cluster-name
                                            --name
                                            --resource-group
                                            [--connections]
                                            [--if-match]
                                            [--if-none-match]

Examples

Create a private endpoint

az stream-analytics private-endpoint create --cluster-name "testcluster" --connections "[{\"privateLinkServiceId\":\"/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls\",\"groupIds\":[\"groupIdFromResource\"]}]" --name "testpe" --resource-group "sjrg"

Required Parameters

--cluster-name

The name of the cluster.

--name --private-endpoint-name -n

The name of the private endpoint.

--resource-group -g

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

Optional Parameters

--connections

A list of connections to the remote resource. Immutable after it is set. Expected value: json-string/json-file/@json-file.

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

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 private-endpoint delete

Delete the specified private endpoint.

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

Examples

Delete a private endpoint

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

Optional Parameters

--cluster-name

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.

--name --private-endpoint-name -n

The name of the private endpoint.

--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 private-endpoint list

List the private endpoints in the cluster.

az stream-analytics private-endpoint list --cluster-name
                                          --resource-group

Examples

Get the private endpoints in a cluster

az stream-analytics private-endpoint list --cluster-name "testcluster" --resource-group "sjrg"

Required Parameters

--cluster-name

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 private-endpoint show

Get information about the specified Private Endpoint.

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

Examples

Get a private endpoint

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

Optional Parameters

--cluster-name

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.

--name --private-endpoint-name -n

The name of the private endpoint.

--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 private-endpoint wait

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

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

Examples

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

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

Optional Parameters

--cluster-name

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
--name --private-endpoint-name -n

The name of the private endpoint.

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