az kusto managed-private-endpoint
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 managed-private-endpoint command. Learn more about extensions.
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage managed private endpoint with kusto.
Commands
Name | Description | Type | Status |
---|---|---|---|
az kusto managed-private-endpoint create |
Creates a managed private endpoint. |
Extension | Experimental |
az kusto managed-private-endpoint delete |
Deletes a managed private endpoint. |
Extension | Experimental |
az kusto managed-private-endpoint list |
Returns the list of managed private endpoints. |
Extension | Experimental |
az kusto managed-private-endpoint show |
Gets a managed private endpoint. |
Extension | Experimental |
az kusto managed-private-endpoint update |
Updates a managed private endpoint. |
Extension | Experimental |
az kusto managed-private-endpoint wait |
Place the CLI in a waiting state until a condition of the kusto managed-private-endpoint is met. |
Extension | Experimental |
az kusto managed-private-endpoint create
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates a managed private endpoint.
az kusto managed-private-endpoint create --cluster-name
--managed-private-endpoint-name
--resource-group
[--group-id]
[--no-wait]
[--private-link]
[--private-link-region]
[--request-message]
Examples
KustoManagedPrivateEndpointsCreateOrUpdate
az kusto managed-private-endpoint create --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --group-id "blob" --private-link-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest" --request-message "Please Approve." --resource-group "kustorptest"
Required Parameters
The name of the Kusto cluster.
The name of the managed private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The groupId in which the managed private endpoint is created.
Do not wait for the long-running operation to finish.
The ARM resource ID of the resource for which the managed private endpoint is created.
The region of the resource to which the managed private endpoint is created.
The user request message.
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 kusto managed-private-endpoint delete
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Deletes a managed private endpoint.
az kusto managed-private-endpoint delete [--cluster-name]
[--ids]
[--managed-private-endpoint-name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
Examples
ManagedPrivateEndpointsDelete
az kusto managed-private-endpoint delete --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --resource-group "kustorptest"
Optional Parameters
The name of the Kusto 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 managed 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 kusto managed-private-endpoint list
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Returns the list of managed private endpoints.
az kusto managed-private-endpoint list --cluster-name
--resource-group
Examples
KustoManagedPrivateEndpointsList
az kusto managed-private-endpoint list --cluster-name "kustoCluster" --resource-group "kustorptest"
Required Parameters
The name of the Kusto 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 kusto managed-private-endpoint show
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Gets a managed private endpoint.
az kusto managed-private-endpoint show [--cluster-name]
[--ids]
[--managed-private-endpoint-name]
[--resource-group]
[--subscription]
Examples
KustoManagedPrivateEndpointsGet
az kusto managed-private-endpoint show --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --resource-group "kustorptest"
Optional Parameters
The name of the Kusto 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 managed 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 kusto managed-private-endpoint update
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Updates a managed private endpoint.
az kusto managed-private-endpoint update [--cluster-name]
[--group-id]
[--ids]
[--managed-private-endpoint-name]
[--no-wait]
[--private-link]
[--private-link-region]
[--request-message]
[--resource-group]
[--subscription]
Examples
KustoManagedPrivateEndpointsUpdate
az kusto managed-private-endpoint update --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --group-id "blob" --private-link-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest" --request-message "Please Approve Managed Private Endpoint Request." --resource-group "kustorptest"
Optional Parameters
The name of the Kusto cluster.
The groupId in which the managed private endpoint is created.
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 managed private endpoint.
Do not wait for the long-running operation to finish.
The ARM resource ID of the resource for which the managed private endpoint is created.
The region of the resource to which the managed private endpoint is created.
The user request message.
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 kusto managed-private-endpoint wait
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 managed-private-endpoint is met.
az kusto managed-private-endpoint wait [--cluster-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--managed-private-endpoint-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Examples
Pause executing next line of CLI script until the kusto managed-private-endpoint is successfully created.
az kusto managed-private-endpoint wait --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --resource-group "kustorptest" --created
Pause executing next line of CLI script until the kusto managed-private-endpoint is successfully updated.
az kusto managed-private-endpoint wait --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --resource-group "kustorptest" --updated
Pause executing next line of CLI script until the kusto managed-private-endpoint is successfully deleted.
az kusto managed-private-endpoint wait --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --resource-group "kustorptest" --deleted
Optional Parameters
The name of the Kusto 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 managed 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.