az stream-analytics private-endpoint
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
The name of the cluster.
The name of the private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
A list of connections to the remote resource. Immutable after it is set. Expected value: json-string/json-file/@json-file.
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.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the cluster.
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.
The name of the private endpoint.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the cluster.
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.
The name of the private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.