az databricks workspace vnet-peering

Commands to manage databricks workspace vnet peering.

Commands

az databricks workspace vnet-peering create

Create a vnet peering for a workspace.

az databricks workspace vnet-peering delete

Delete the vnet peering.

az databricks workspace vnet-peering list

List vnet peerings under a workspace.

az databricks workspace vnet-peering show

Show the vnet peering.

az databricks workspace vnet-peering update

Update the vnet peering.

az databricks workspace vnet-peering wait

Place the CLI in a waiting state until a condition of the Databricks workspace vnet peering is met.

az databricks workspace vnet-peering create

Create a vnet peering for a workspace.

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

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.

--remote-vnet

The remote virtual network name or Resource ID.

--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: false, true
--allow-gateway-transit

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

accepted values: false, true
--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: false, true
--no-wait

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

--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: false, true

az databricks workspace vnet-peering delete

Delete the vnet peering.

az databricks workspace vnet-peering delete --name
                                            --resource-group
                                            --workspace-name
                                            [--no-wait]

Examples

Delete the vnet peering.

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

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

--no-wait

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

az databricks workspace vnet-peering list

List vnet peerings under a workspace.

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

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.

az databricks workspace vnet-peering show

Show the vnet peering.

az databricks workspace vnet-peering show --name
                                          --resource-group
                                          --workspace-name

Examples

Show the vnet peering

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

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.

az databricks workspace vnet-peering update

Update the vnet peering.

az databricks workspace vnet-peering update --name
                                            --resource-group
                                            --workspace-name
                                            [--allow-forwarded-traffic {false, true}]
                                            [--allow-gateway-transit {false, true}]
                                            [--allow-virtual-network-access {false, true}]
                                            [--no-wait]
                                            [--use-remote-gateways {false, true}]

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

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: false, true
--allow-gateway-transit

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

accepted values: false, true
--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: false, true
--no-wait

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

--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: false, true

az databricks workspace vnet-peering wait

Place the CLI in a waiting state until a condition of the Databricks workspace vnet peering is met.

az databricks workspace vnet-peering wait --name
                                          --resource-group
                                          --workspace-name
                                          [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--interval]
                                          [--timeout]
                                          [--updated]

Examples

Pause executing next line of CLI script until the Databricks workspace vnet peering is successfully provisioned.

az databricks workspace vnet-peering wait --resource-group MyResourceGroup --workspace-name MyWorkspace \ --name MyPeering --created

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

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.