az databricks workspace private-endpoint-connection

  • Reference

Note

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

Commands to manage databricks workspace private endpoint connections.

Commands

Name Description Type Status
az databricks workspace private-endpoint-connection create

Create the status of a private endpoint connection with the specified name.

 Extension GA
az databricks workspace private-endpoint-connection delete

Delete private endpoint connection with the specified name.

 Extension GA
az databricks workspace private-endpoint-connection list

List private endpoint connections of the workspace.

 Extension GA
az databricks workspace private-endpoint-connection show

Get a private endpoint connection properties for a workspace.

 Extension GA
az databricks workspace private-endpoint-connection update

Update the status of a private endpoint connection with the specified name.

 Extension GA
az databricks workspace private-endpoint-connection wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az databricks workspace private-endpoint-connection create

Create the status of a private endpoint connection with the specified name.

az databricks workspace private-endpoint-connection create --name
                                                           --resource-group
                                                           --status {Approved, Disconnected, Pending, Rejected}
                                                           --workspace-name
                                                           [--actions-required]
                                                           [--description]
                                                           [--group-ids]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Required Parameters

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

--status

The status of a private endpoint connection.

accepted values: Approved, Disconnected, Pending, Rejected
--workspace-name

The name of the workspace.

Optional Parameters

--actions-required

Actions required for a private endpoint connection.

--description

The description for the current state of a private endpoint connection.

--group-ids

GroupIds from the private link service resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 databricks workspace private-endpoint-connection delete

Delete private endpoint connection with the specified name.

az databricks workspace private-endpoint-connection delete [--ids]
                                                           [--name]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--resource-group]
                                                           [--subscription]
                                                           [--workspace-name]

Optional Parameters

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

The name of the private endpoint connection.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--workspace-name

The name of the workspace.

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

List private endpoint connections of the workspace.

az databricks workspace private-endpoint-connection list --resource-group
                                                         --workspace-name

Required Parameters

--resource-group -g

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

--workspace-name

The name of the workspace.

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 databricks workspace private-endpoint-connection show

Get a private endpoint connection properties for a workspace.

az databricks workspace private-endpoint-connection show [--ids]
                                                         [--name]
                                                         [--resource-group]
                                                         [--subscription]
                                                         [--workspace-name]

Optional Parameters

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

--workspace-name

The name of the workspace.

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

Update the status of a private endpoint connection with the specified name.

az databricks workspace private-endpoint-connection update [--actions-required]
                                                           [--add]
                                                           [--description]
                                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--group-ids]
                                                           [--ids]
                                                           [--name]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--remove]
                                                           [--resource-group]
                                                           [--set]
                                                           [--status {Approved, Disconnected, Pending, Rejected}]
                                                           [--subscription]
                                                           [--workspace-name]

Optional Parameters

--actions-required

Actions required for a private endpoint connection.

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

--description

The description for the current state of a private endpoint connection.

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--group-ids

GroupIds from the private link service resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

The name of the private endpoint connection.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

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

--status

The status of a private endpoint connection.

accepted values: Approved, Disconnected, Pending, Rejected
--subscription

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

--workspace-name

The name of the workspace.

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 databricks workspace private-endpoint-connection wait

Place the CLI in a waiting state until a condition is met.

az databricks workspace private-endpoint-connection wait [--created]
                                                         [--custom]
                                                         [--deleted]
                                                         [--exists]
                                                         [--ids]
                                                         [--interval]
                                                         [--name]
                                                         [--resource-group]
                                                         [--subscription]
                                                         [--timeout]
                                                         [--updated]
                                                         [--workspace-name]

Optional Parameters

--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 -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
--workspace-name

The name of the workspace.

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.