Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. databricks
  5. VirtualNetworkPeering

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.databricks.VirtualNetworkPeering

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Databricks Virtual Network Peering

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const remote = new azure.network.VirtualNetwork("remote", {
    name: "remote-vnet",
    resourceGroupName: example.name,
    addressSpaces: ["10.0.1.0/24"],
    location: example.location,
});
const exampleWorkspace = new azure.databricks.Workspace("example", {
    name: "example-workspace",
    resourceGroupName: example.name,
    location: example.location,
    sku: "standard",
});
const exampleVirtualNetworkPeering = new azure.databricks.VirtualNetworkPeering("example", {
    name: "databricks-vnet-peer",
    resourceGroupName: example.name,
    workspaceId: exampleWorkspace.id,
    remoteAddressSpacePrefixes: remote.addressSpaces,
    remoteVirtualNetworkId: remote.id,
    allowVirtualNetworkAccess: true,
});
const remoteVirtualNetworkPeering = new azure.network.VirtualNetworkPeering("remote", {
    name: "peer-to-databricks",
    resourceGroupName: example.name,
    virtualNetworkName: remote.name,
    remoteVirtualNetworkId: exampleVirtualNetworkPeering.virtualNetworkId,
    allowVirtualNetworkAccess: true,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
remote = azure.network.VirtualNetwork("remote",
    name="remote-vnet",
    resource_group_name=example.name,
    address_spaces=["10.0.1.0/24"],
    location=example.location)
example_workspace = azure.databricks.Workspace("example",
    name="example-workspace",
    resource_group_name=example.name,
    location=example.location,
    sku="standard")
example_virtual_network_peering = azure.databricks.VirtualNetworkPeering("example",
    name="databricks-vnet-peer",
    resource_group_name=example.name,
    workspace_id=example_workspace.id,
    remote_address_space_prefixes=remote.address_spaces,
    remote_virtual_network_id=remote.id,
    allow_virtual_network_access=True)
remote_virtual_network_peering = azure.network.VirtualNetworkPeering("remote",
    name="peer-to-databricks",
    resource_group_name=example.name,
    virtual_network_name=remote.name,
    remote_virtual_network_id=example_virtual_network_peering.virtual_network_id,
    allow_virtual_network_access=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/databricks"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		remote, err := network.NewVirtualNetwork(ctx, "remote", &network.VirtualNetworkArgs{
			Name:              pulumi.String("remote-vnet"),
			ResourceGroupName: example.Name,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.1.0/24"),
			},
			Location: example.Location,
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := databricks.NewWorkspace(ctx, "example", &databricks.WorkspaceArgs{
			Name:              pulumi.String("example-workspace"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku:               pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetworkPeering, err := databricks.NewVirtualNetworkPeering(ctx, "example", &databricks.VirtualNetworkPeeringArgs{
			Name:                       pulumi.String("databricks-vnet-peer"),
			ResourceGroupName:          example.Name,
			WorkspaceId:                exampleWorkspace.ID(),
			RemoteAddressSpacePrefixes: remote.AddressSpaces,
			RemoteVirtualNetworkId:     remote.ID(),
			AllowVirtualNetworkAccess:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = network.NewVirtualNetworkPeering(ctx, "remote", &network.VirtualNetworkPeeringArgs{
			Name:                      pulumi.String("peer-to-databricks"),
			ResourceGroupName:         example.Name,
			VirtualNetworkName:        remote.Name,
			RemoteVirtualNetworkId:    exampleVirtualNetworkPeering.VirtualNetworkId,
			AllowVirtualNetworkAccess: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var remote = new Azure.Network.VirtualNetwork("remote", new()
    {
        Name = "remote-vnet",
        ResourceGroupName = example.Name,
        AddressSpaces = new[]
        {
            "10.0.1.0/24",
        },
        Location = example.Location,
    });

    var exampleWorkspace = new Azure.DataBricks.Workspace("example", new()
    {
        Name = "example-workspace",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "standard",
    });

    var exampleVirtualNetworkPeering = new Azure.DataBricks.VirtualNetworkPeering("example", new()
    {
        Name = "databricks-vnet-peer",
        ResourceGroupName = example.Name,
        WorkspaceId = exampleWorkspace.Id,
        RemoteAddressSpacePrefixes = remote.AddressSpaces,
        RemoteVirtualNetworkId = remote.Id,
        AllowVirtualNetworkAccess = true,
    });

    var remoteVirtualNetworkPeering = new Azure.Network.VirtualNetworkPeering("remote", new()
    {
        Name = "peer-to-databricks",
        ResourceGroupName = example.Name,
        VirtualNetworkName = remote.Name,
        RemoteVirtualNetworkId = exampleVirtualNetworkPeering.VirtualNetworkId,
        AllowVirtualNetworkAccess = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.databricks.Workspace;
import com.pulumi.azure.databricks.WorkspaceArgs;
import com.pulumi.azure.databricks.VirtualNetworkPeering;
import com.pulumi.azure.databricks.VirtualNetworkPeeringArgs;
import com.pulumi.azure.network.VirtualNetworkPeering;
import com.pulumi.azure.network.VirtualNetworkPeeringArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var remote = new VirtualNetwork("remote", VirtualNetworkArgs.builder()
            .name("remote-vnet")
            .resourceGroupName(example.name())
            .addressSpaces("10.0.1.0/24")
            .location(example.location())
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("example-workspace")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("standard")
            .build());

        var exampleVirtualNetworkPeering = new VirtualNetworkPeering("exampleVirtualNetworkPeering", VirtualNetworkPeeringArgs.builder()
            .name("databricks-vnet-peer")
            .resourceGroupName(example.name())
            .workspaceId(exampleWorkspace.id())
            .remoteAddressSpacePrefixes(remote.addressSpaces())
            .remoteVirtualNetworkId(remote.id())
            .allowVirtualNetworkAccess(true)
            .build());

        var remoteVirtualNetworkPeering = new VirtualNetworkPeering("remoteVirtualNetworkPeering", VirtualNetworkPeeringArgs.builder()
            .name("peer-to-databricks")
            .resourceGroupName(example.name())
            .virtualNetworkName(remote.name())
            .remoteVirtualNetworkId(exampleVirtualNetworkPeering.virtualNetworkId())
            .allowVirtualNetworkAccess(true)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  remote:
    type: azure:network:VirtualNetwork
    properties:
      name: remote-vnet
      resourceGroupName: ${example.name}
      addressSpaces:
        - 10.0.1.0/24
      location: ${example.location}
  exampleWorkspace:
    type: azure:databricks:Workspace
    name: example
    properties:
      name: example-workspace
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: standard
  exampleVirtualNetworkPeering:
    type: azure:databricks:VirtualNetworkPeering
    name: example
    properties:
      name: databricks-vnet-peer
      resourceGroupName: ${example.name}
      workspaceId: ${exampleWorkspace.id}
      remoteAddressSpacePrefixes: ${remote.addressSpaces}
      remoteVirtualNetworkId: ${remote.id}
      allowVirtualNetworkAccess: true
  remoteVirtualNetworkPeering:
    type: azure:network:VirtualNetworkPeering
    name: remote
    properties:
      name: peer-to-databricks
      resourceGroupName: ${example.name}
      virtualNetworkName: ${remote.name}
      remoteVirtualNetworkId: ${exampleVirtualNetworkPeering.virtualNetworkId}
      allowVirtualNetworkAccess: true
Copy

Create VirtualNetworkPeering Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VirtualNetworkPeering(name: string, args: VirtualNetworkPeeringArgs, opts?: CustomResourceOptions);
@overload
def VirtualNetworkPeering(resource_name: str,
                          args: VirtualNetworkPeeringArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def VirtualNetworkPeering(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          remote_address_space_prefixes: Optional[Sequence[str]] = None,
                          remote_virtual_network_id: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          workspace_id: Optional[str] = None,
                          allow_forwarded_traffic: Optional[bool] = None,
                          allow_gateway_transit: Optional[bool] = None,
                          allow_virtual_network_access: Optional[bool] = None,
                          name: Optional[str] = None,
                          use_remote_gateways: Optional[bool] = None)
func NewVirtualNetworkPeering(ctx *Context, name string, args VirtualNetworkPeeringArgs, opts ...ResourceOption) (*VirtualNetworkPeering, error)
public VirtualNetworkPeering(string name, VirtualNetworkPeeringArgs args, CustomResourceOptions? opts = null)
public VirtualNetworkPeering(String name, VirtualNetworkPeeringArgs args)
public VirtualNetworkPeering(String name, VirtualNetworkPeeringArgs args, CustomResourceOptions options)

type: azure:databricks:VirtualNetworkPeering
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VirtualNetworkPeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VirtualNetworkPeeringArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualNetworkPeeringArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualNetworkPeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VirtualNetworkPeeringArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var virtualNetworkPeeringResource = new Azure.DataBricks.VirtualNetworkPeering("virtualNetworkPeeringResource", new()
{
    RemoteAddressSpacePrefixes = new[]
    {
        "string",
    },
    RemoteVirtualNetworkId = "string",
    ResourceGroupName = "string",
    WorkspaceId = "string",
    AllowForwardedTraffic = false,
    AllowGatewayTransit = false,
    AllowVirtualNetworkAccess = false,
    Name = "string",
    UseRemoteGateways = false,
});
Copy
example, err := databricks.NewVirtualNetworkPeering(ctx, "virtualNetworkPeeringResource", &databricks.VirtualNetworkPeeringArgs{
	RemoteAddressSpacePrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	RemoteVirtualNetworkId:    pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	WorkspaceId:               pulumi.String("string"),
	AllowForwardedTraffic:     pulumi.Bool(false),
	AllowGatewayTransit:       pulumi.Bool(false),
	AllowVirtualNetworkAccess: pulumi.Bool(false),
	Name:                      pulumi.String("string"),
	UseRemoteGateways:         pulumi.Bool(false),
})
Copy
var virtualNetworkPeeringResource = new VirtualNetworkPeering("virtualNetworkPeeringResource", VirtualNetworkPeeringArgs.builder()
    .remoteAddressSpacePrefixes("string")
    .remoteVirtualNetworkId("string")
    .resourceGroupName("string")
    .workspaceId("string")
    .allowForwardedTraffic(false)
    .allowGatewayTransit(false)
    .allowVirtualNetworkAccess(false)
    .name("string")
    .useRemoteGateways(false)
    .build());
Copy
virtual_network_peering_resource = azure.databricks.VirtualNetworkPeering("virtualNetworkPeeringResource",
    remote_address_space_prefixes=["string"],
    remote_virtual_network_id="string",
    resource_group_name="string",
    workspace_id="string",
    allow_forwarded_traffic=False,
    allow_gateway_transit=False,
    allow_virtual_network_access=False,
    name="string",
    use_remote_gateways=False)
Copy
const virtualNetworkPeeringResource = new azure.databricks.VirtualNetworkPeering("virtualNetworkPeeringResource", {
    remoteAddressSpacePrefixes: ["string"],
    remoteVirtualNetworkId: "string",
    resourceGroupName: "string",
    workspaceId: "string",
    allowForwardedTraffic: false,
    allowGatewayTransit: false,
    allowVirtualNetworkAccess: false,
    name: "string",
    useRemoteGateways: false,
});
Copy
type: azure:databricks:VirtualNetworkPeering
properties:
    allowForwardedTraffic: false
    allowGatewayTransit: false
    allowVirtualNetworkAccess: false
    name: string
    remoteAddressSpacePrefixes:
        - string
    remoteVirtualNetworkId: string
    resourceGroupName: string
    useRemoteGateways: false
    workspaceId: string
Copy

VirtualNetworkPeering Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VirtualNetworkPeering resource accepts the following input properties:

RemoteAddressSpacePrefixes
This property is required.
Changes to this property will trigger replacement.
List<string>
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
RemoteVirtualNetworkId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
AllowForwardedTraffic bool
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
AllowGatewayTransit bool
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
AllowVirtualNetworkAccess bool
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
UseRemoteGateways bool

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

RemoteAddressSpacePrefixes
This property is required.
Changes to this property will trigger replacement.
[]string
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
RemoteVirtualNetworkId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
AllowForwardedTraffic bool
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
AllowGatewayTransit bool
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
AllowVirtualNetworkAccess bool
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
UseRemoteGateways bool

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

remoteAddressSpacePrefixes
This property is required.
Changes to this property will trigger replacement.
List<String>
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remoteVirtualNetworkId
This property is required.
Changes to this property will trigger replacement.
String

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
allowForwardedTraffic Boolean
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allowGatewayTransit Boolean
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allowVirtualNetworkAccess Boolean
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
useRemoteGateways Boolean

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

remoteAddressSpacePrefixes
This property is required.
Changes to this property will trigger replacement.
string[]
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remoteVirtualNetworkId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
allowForwardedTraffic boolean
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allowGatewayTransit boolean
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allowVirtualNetworkAccess boolean
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
useRemoteGateways boolean

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

remote_address_space_prefixes
This property is required.
Changes to this property will trigger replacement.
Sequence[str]
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remote_virtual_network_id
This property is required.
Changes to this property will trigger replacement.
str

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
allow_forwarded_traffic bool
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allow_gateway_transit bool
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allow_virtual_network_access bool
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. str
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
use_remote_gateways bool

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

remoteAddressSpacePrefixes
This property is required.
Changes to this property will trigger replacement.
List<String>
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remoteVirtualNetworkId
This property is required.
Changes to this property will trigger replacement.
String

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
allowForwardedTraffic Boolean
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allowGatewayTransit Boolean
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allowVirtualNetworkAccess Boolean
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
useRemoteGateways Boolean

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualNetworkPeering resource produces the following output properties:

AddressSpacePrefixes List<string>
A list of address blocks reserved for this virtual network in CIDR notation.
Id string
The provider-assigned unique ID for this managed resource.
VirtualNetworkId string

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

AddressSpacePrefixes []string
A list of address blocks reserved for this virtual network in CIDR notation.
Id string
The provider-assigned unique ID for this managed resource.
VirtualNetworkId string

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

addressSpacePrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
id String
The provider-assigned unique ID for this managed resource.
virtualNetworkId String

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

addressSpacePrefixes string[]
A list of address blocks reserved for this virtual network in CIDR notation.
id string
The provider-assigned unique ID for this managed resource.
virtualNetworkId string

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

address_space_prefixes Sequence[str]
A list of address blocks reserved for this virtual network in CIDR notation.
id str
The provider-assigned unique ID for this managed resource.
virtual_network_id str

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

addressSpacePrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
id String
The provider-assigned unique ID for this managed resource.
virtualNetworkId String

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

Look up Existing VirtualNetworkPeering Resource

Get an existing VirtualNetworkPeering resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VirtualNetworkPeeringState, opts?: CustomResourceOptions): VirtualNetworkPeering
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_space_prefixes: Optional[Sequence[str]] = None,
        allow_forwarded_traffic: Optional[bool] = None,
        allow_gateway_transit: Optional[bool] = None,
        allow_virtual_network_access: Optional[bool] = None,
        name: Optional[str] = None,
        remote_address_space_prefixes: Optional[Sequence[str]] = None,
        remote_virtual_network_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        use_remote_gateways: Optional[bool] = None,
        virtual_network_id: Optional[str] = None,
        workspace_id: Optional[str] = None) -> VirtualNetworkPeering
func GetVirtualNetworkPeering(ctx *Context, name string, id IDInput, state *VirtualNetworkPeeringState, opts ...ResourceOption) (*VirtualNetworkPeering, error)
public static VirtualNetworkPeering Get(string name, Input<string> id, VirtualNetworkPeeringState? state, CustomResourceOptions? opts = null)
public static VirtualNetworkPeering get(String name, Output<String> id, VirtualNetworkPeeringState state, CustomResourceOptions options)
resources:  _:    type: azure:databricks:VirtualNetworkPeering    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AddressSpacePrefixes List<string>
A list of address blocks reserved for this virtual network in CIDR notation.
AllowForwardedTraffic bool
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
AllowGatewayTransit bool
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
AllowVirtualNetworkAccess bool
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
RemoteAddressSpacePrefixes Changes to this property will trigger replacement. List<string>
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
RemoteVirtualNetworkId Changes to this property will trigger replacement. string

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
UseRemoteGateways bool

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

VirtualNetworkId string

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

WorkspaceId Changes to this property will trigger replacement. string
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
AddressSpacePrefixes []string
A list of address blocks reserved for this virtual network in CIDR notation.
AllowForwardedTraffic bool
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
AllowGatewayTransit bool
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
AllowVirtualNetworkAccess bool
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
Name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
RemoteAddressSpacePrefixes Changes to this property will trigger replacement. []string
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
RemoteVirtualNetworkId Changes to this property will trigger replacement. string

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
UseRemoteGateways bool

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

VirtualNetworkId string

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

WorkspaceId Changes to this property will trigger replacement. string
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
addressSpacePrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
allowForwardedTraffic Boolean
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allowGatewayTransit Boolean
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allowVirtualNetworkAccess Boolean
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
remoteAddressSpacePrefixes Changes to this property will trigger replacement. List<String>
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remoteVirtualNetworkId Changes to this property will trigger replacement. String

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
useRemoteGateways Boolean

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

virtualNetworkId String

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

workspaceId Changes to this property will trigger replacement. String
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
addressSpacePrefixes string[]
A list of address blocks reserved for this virtual network in CIDR notation.
allowForwardedTraffic boolean
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allowGatewayTransit boolean
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allowVirtualNetworkAccess boolean
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. string
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
remoteAddressSpacePrefixes Changes to this property will trigger replacement. string[]
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remoteVirtualNetworkId Changes to this property will trigger replacement. string

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
useRemoteGateways boolean

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

virtualNetworkId string

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

workspaceId Changes to this property will trigger replacement. string
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
address_space_prefixes Sequence[str]
A list of address blocks reserved for this virtual network in CIDR notation.
allow_forwarded_traffic bool
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allow_gateway_transit bool
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allow_virtual_network_access bool
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. str
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
remote_address_space_prefixes Changes to this property will trigger replacement. Sequence[str]
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remote_virtual_network_id Changes to this property will trigger replacement. str

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
use_remote_gateways bool

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

virtual_network_id str

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

workspace_id Changes to this property will trigger replacement. str
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.
addressSpacePrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
allowForwardedTraffic Boolean
Can the forwarded traffic from the VMs in the local virtual network be forwarded to the remote virtual network? Defaults to false.
allowGatewayTransit Boolean
Can the gateway links be used in the remote virtual network to link to the Databricks virtual network? Defaults to false.
allowVirtualNetworkAccess Boolean
Can the VMs in the local virtual network space access the VMs in the remote virtual network space? Defaults to true.
name Changes to this property will trigger replacement. String
Specifies the name of the Databricks Virtual Network Peering resource. Changing this forces a new resource to be created.
remoteAddressSpacePrefixes Changes to this property will trigger replacement. List<String>
A list of address blocks reserved for the remote virtual network in CIDR notation. Changing this forces a new resource to be created.
remoteVirtualNetworkId Changes to this property will trigger replacement. String

The ID of the remote virtual network. Changing this forces a new resource to be created.

NOTE: The remote virtual network should be in the same region as the databricks workspace. Please see the product documentation for more information.

resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the Databricks Virtual Network Peering should exist. Changing this forces a new resource to be created.
useRemoteGateways Boolean

Can remote gateways be used on the Databricks virtual network? Defaults to false.

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

virtualNetworkId String

The ID of the internal Virtual Network used by the DataBricks Workspace.

NOTE: The virtual_network_id field is the value you must supply to the azure.network.VirtualNetworkPeering resources remote_virtual_network_id field to successfully peer the Databricks Virtual Network with the remote virtual network.

workspaceId Changes to this property will trigger replacement. String
The ID of the Databricks Workspace that this Databricks Virtual Network Peering is bound. Changing this forces a new resource to be created.

Import

Databrick Virtual Network Peerings can be imported using the resource id, e.g.

$ pulumi import azure:databricks/virtualNetworkPeering:VirtualNetworkPeering example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Databricks/workspaces/workspace1/virtualNetworkPeerings/peering1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure