Share via

az kusto private-endpoint-connection

  • Experimental
  • Reference

Note

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

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage private endpoint connection with kusto.

Commands

Name Description Type Status
az kusto private-endpoint-connection create

Approve or reject a private endpoint connection with a given name.

 Extension Experimental
az kusto private-endpoint-connection delete

Deletes a private endpoint connection with a given name.

 Extension Experimental
az kusto private-endpoint-connection list

Returns the list of private endpoint connections.

 Extension Experimental
az kusto private-endpoint-connection show

Gets a private endpoint connection.

 Extension Experimental
az kusto private-endpoint-connection update

Approve or reject a private endpoint connection with a given name.

 Extension Experimental
az kusto private-endpoint-connection wait

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

 Extension Experimental

az kusto private-endpoint-connection create

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Approve or reject a private endpoint connection with a given name.

az kusto private-endpoint-connection create --cluster-name
                                            --name
                                            --resource-group
                                            [--connection-state]
                                            [--no-wait]

Examples

Approve or reject a private endpoint connection with a given name.

az kusto private-endpoint-connection create --cluster-name "kustoclusterrptest4" --private-link-service-connection-state description="Approved by johndoe@contoso.com" status="Approved" --name "privateEndpointConnectionName" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto cluster.

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

The name of the private endpoint connection.

--resource-group -g

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

Optional Parameters

--connection-state --private-link-service-connection-state

Connection State of the Private Endpoint Connection.

Usage: --private-link-service-connection-state status=XX description=XX

status: The private link service connection status. description: The private link service connection description.

--no-wait

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

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

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a private endpoint connection with a given name.

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

Examples

Deletes a private endpoint connection with a given name.

az kusto private-endpoint-connection delete --cluster-name "kustoCluster" --name "privateEndpointTest" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto 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-connection-name -n

The name of the private endpoint connection.

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

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Returns the list of private endpoint connections.

az kusto private-endpoint-connection list --cluster-name
                                          --resource-group

Examples

KustoPrivateEndpointConnectionsList

az kusto private-endpoint-connection list --cluster-name "kustoCluster" --resource-group "kustorptest"

Required Parameters

--cluster-name

The name of the Kusto 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 kusto private-endpoint-connection show

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a private endpoint connection.

az kusto private-endpoint-connection show [--cluster-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Examples

Gets private endpoint connection.

az kusto private-endpoint-connection show --cluster-name "kustoCluster" --name "privateEndpointTest" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto 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-connection-name -n

The name of the private endpoint connection.

--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 kusto private-endpoint-connection update

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Approve or reject a private endpoint connection with a given name.

az kusto private-endpoint-connection update [--add]
                                            [--cluster-name]
                                            [--connection-state]
                                            [--force-string]
                                            [--ids]
                                            [--name]
                                            [--no-wait]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--subscription]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--cluster-name

The name of the Kusto cluster.

--connection-state --private-link-service-connection-state

Connection State of the Private Endpoint Connection.

Usage: --private-link-service-connection-state status=XX description=XX

status: The private link service connection status. description: The private link service connection description.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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.

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

The name of the private endpoint connection.

--no-wait

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

Default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
--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 kusto private-endpoint-connection wait

Experimental

Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az kusto private-endpoint-connection 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 kusto private-endpoint-connection is successfully created.

az kusto private-endpoint-connection wait --cluster-name "kustoCluster" --name "privateEndpointTest" --resource-group "kustorptest" --created

Pause executing next line of CLI script until the kusto private-endpoint-connection is successfully updated.

az kusto private-endpoint-connection wait --cluster-name "kustoCluster" --name "privateEndpointTest" --resource-group "kustorptest" --updated

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

az kusto private-endpoint-connection wait --cluster-name "kustoCluster" --name "privateEndpointTest" --resource-group "kustorptest" --deleted

Optional Parameters

--cluster-name

The name of the Kusto 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-connection-name -n

The name of the private endpoint connection.

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