az databricks workspace private-endpoint-connection
Note
This reference is part of the databricks extension for the Azure CLI (version 2.57.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
The name of the private endpoint connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The status of a private endpoint connection.
The name of the workspace.
Optional Parameters
Actions required for a private endpoint connection.
The description for the current state of a private endpoint connection.
GroupIds from the private link service resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
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 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
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 connection.
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.
The name of the workspace.
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 databricks workspace private-endpoint-connection list
List private endpoint connections of the workspace.
az databricks workspace private-endpoint-connection list --resource-group
--workspace-name
[--max-items]
[--next-token]Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the workspace.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated 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 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
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 connection.
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.
The name of the workspace.
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 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 for a private endpoint connection.
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>.
The description for the current state of a private endpoint connection.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
GroupIds from the private link service resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 connection.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
The status of a private endpoint connection.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the workspace.
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 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
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 connection.
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'.
The name of the workspace.
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.
Azure CLI