az databricks workspace vnet-peering

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 vnet-peering command. Learn more about extensions.

Commands to manage databricks workspace vnet peering.

Commands

Name	Description	Type	Status
az databricks workspace vnet-peering create	Create a vnet peering for a workspace.	Extension	GA
az databricks workspace vnet-peering delete	Delete the vnet peering.	Extension	GA
az databricks workspace vnet-peering list	List vnet peerings under a workspace.	Extension	GA
az databricks workspace vnet-peering show	Show the vnet peering.	Extension	GA
az databricks workspace vnet-peering update	Update the vnet peering.	Extension	GA
az databricks workspace vnet-peering wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az databricks workspace vnet-peering create

Create a vnet peering for a workspace.

az databricks workspace vnet-peering create --name
                                            --resource-group
                                            --workspace-name
                                            [--allow-forwarded-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--allow-gateway-transit {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--allow-virtual-network-access {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--remote-vnet]
                                            [--use-remote-gateways {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a vnet peering for a workspace

az databricks workspace vnet-peering create --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyPeering --remote-vnet /subscriptions/000000-0000-0000/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVNet

Required Parameters

--name -n

The name of the vnet peering.

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

Optional Parameters

--allow-forwarded-traffic

Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--allow-gateway-transit

If gateway links can be used in remote virtual networking to link to this virtual network.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--allow-virtual-network-access

Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remote-vnet

The remote virtual network name or Resource ID.

--use-remote-gateways

If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

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 vnet-peering delete

Delete the vnet peering.

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

Examples

Delete the vnet peering.

az databricks workspace vnet-peering delete --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyPeering

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

--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 vnet-peering list

List vnet peerings under a workspace.

az databricks workspace vnet-peering list --resource-group
                                          --workspace-name
                                          [--max-items]
                                          [--next-token]

Examples

List vnet peerings under a workspace.

az databricks workspace vnet-peering list --resource-group MyResourceGroup --workspace-name MyWorkspace

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.

Optional Parameters

--max-items

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.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 vnet-peering show

Show the vnet peering.

az databricks workspace vnet-peering show [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--workspace-name]

Examples

Show the vnet peering

az databricks workspace vnet-peering show --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyPeering

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

--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 vnet-peering update

Update the vnet peering.

az databricks workspace vnet-peering update [--add]
                                            [--allow-forwarded-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--allow-gateway-transit {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--allow-virtual-network-access {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--subscription]
                                            [--use-remote-gateways {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--workspace-name]

Examples

Update the vnet peering (enable gateway transit and disable virtual network access).

az databricks workspace vnet-peering update --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyPeering --allow-gateway-transit --allow-virtual-network-access false

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

--allow-forwarded-traffic

Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--allow-gateway-transit

If gateway links can be used in remote virtual networking to link to this virtual network.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--allow-virtual-network-access

Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

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

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

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

--subscription

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

--use-remote-gateways

If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--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 vnet-peering wait

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

az databricks workspace vnet-peering 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 vnet peering.

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