Share via

az kusto managed-private-endpoint

  • Experimental

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

Experimental

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 --name
                                         --resource-group
                                         [--group-id]
                                         [--no-wait]
                                         [--private-link --private-link-resource-id]
                                         [--private-link-region --private-link-resource-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

--cluster-name

The name of the Kusto cluster.

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

The name of the managed private endpoint.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--group-id

The groupId in which the managed private endpoint is created.

--no-wait

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

Property Value
Default value: False
--private-link --private-link-resource-id

The ARM resource ID of the resource for which the managed private endpoint is created.

--private-link-region --private-link-resource-region

The region of the resource to which the managed private endpoint is created.

--request-message

The user request message.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az kusto managed-private-endpoint delete

Experimental

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 --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--managed-private-endpoint-name --name -n

The name of the managed private endpoint.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto managed-private-endpoint list

Experimental

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

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az kusto managed-private-endpoint show

Experimental

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 --name]
                                       [--resource-group]
                                       [--subscription]

Examples

KustoManagedPrivateEndpointsGet

az kusto managed-private-endpoint show --cluster-name "kustoCluster" --name "managedPrivateEndpointTest" --resource-group "kustorptest"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--managed-private-endpoint-name --name -n

The name of the managed private endpoint.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto managed-private-endpoint update

Experimental

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 --name]
                                         [--no-wait]
                                         [--private-link --private-link-resource-id]
                                         [--private-link-region --private-link-resource-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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--group-id

The groupId in which the managed private endpoint is created.

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

Property Value
Parameter group: Resource Id Arguments
--managed-private-endpoint-name --name -n

The name of the managed private endpoint.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--private-link --private-link-resource-id

The ARM resource ID of the resource for which the managed private endpoint is created.

--private-link-region --private-link-resource-region

The region of the resource to which the managed private endpoint is created.

--request-message

The user request message.

--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az kusto managed-private-endpoint 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 managed-private-endpoint is met.

az kusto managed-private-endpoint wait [--cluster-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--managed-private-endpoint-name --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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--managed-private-endpoint-name --name -n

The name of the managed private endpoint.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False