1. Packages
  2. Azure Native
  3. API Docs
  4. databricks
  5. VNetPeering
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.databricks.VNetPeering

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    Peerings in a VirtualNetwork resource Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2018-04-01.

    Example Usage

    Create vNet Peering for Workspace

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var vNetPeering = new AzureNative.Databricks.VNetPeering("vNetPeering", new()
        {
            AllowForwardedTraffic = false,
            AllowGatewayTransit = false,
            AllowVirtualNetworkAccess = true,
            PeeringName = "vNetPeeringTest",
            RemoteVirtualNetwork = new AzureNative.Databricks.Inputs.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs
            {
                Id = "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet",
            },
            ResourceGroupName = "rg",
            UseRemoteGateways = false,
            WorkspaceName = "myWorkspace",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/databricks/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := databricks.NewVNetPeering(ctx, "vNetPeering", &databricks.VNetPeeringArgs{
    			AllowForwardedTraffic:     pulumi.Bool(false),
    			AllowGatewayTransit:       pulumi.Bool(false),
    			AllowVirtualNetworkAccess: pulumi.Bool(true),
    			PeeringName:               pulumi.String("vNetPeeringTest"),
    			RemoteVirtualNetwork: &databricks.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs{
    				Id: pulumi.String("/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"),
    			},
    			ResourceGroupName: pulumi.String("rg"),
    			UseRemoteGateways: pulumi.Bool(false),
    			WorkspaceName:     pulumi.String("myWorkspace"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.databricks.VNetPeering;
    import com.pulumi.azurenative.databricks.VNetPeeringArgs;
    import com.pulumi.azurenative.databricks.inputs.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs;
    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 vNetPeering = new VNetPeering("vNetPeering", VNetPeeringArgs.builder()        
                .allowForwardedTraffic(false)
                .allowGatewayTransit(false)
                .allowVirtualNetworkAccess(true)
                .peeringName("vNetPeeringTest")
                .remoteVirtualNetwork(VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs.builder()
                    .id("/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet")
                    .build())
                .resourceGroupName("rg")
                .useRemoteGateways(false)
                .workspaceName("myWorkspace")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    v_net_peering = azure_native.databricks.VNetPeering("vNetPeering",
        allow_forwarded_traffic=False,
        allow_gateway_transit=False,
        allow_virtual_network_access=True,
        peering_name="vNetPeeringTest",
        remote_virtual_network=azure_native.databricks.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs(
            id="/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet",
        ),
        resource_group_name="rg",
        use_remote_gateways=False,
        workspace_name="myWorkspace")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const vNetPeering = new azure_native.databricks.VNetPeering("vNetPeering", {
        allowForwardedTraffic: false,
        allowGatewayTransit: false,
        allowVirtualNetworkAccess: true,
        peeringName: "vNetPeeringTest",
        remoteVirtualNetwork: {
            id: "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet",
        },
        resourceGroupName: "rg",
        useRemoteGateways: false,
        workspaceName: "myWorkspace",
    });
    
    resources:
      vNetPeering:
        type: azure-native:databricks:VNetPeering
        properties:
          allowForwardedTraffic: false
          allowGatewayTransit: false
          allowVirtualNetworkAccess: true
          peeringName: vNetPeeringTest
          remoteVirtualNetwork:
            id: /subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet
          resourceGroupName: rg
          useRemoteGateways: false
          workspaceName: myWorkspace
    

    Create VNetPeering Resource

    new VNetPeering(name: string, args: VNetPeeringArgs, opts?: CustomResourceOptions);
    @overload
    def VNetPeering(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    allow_forwarded_traffic: Optional[bool] = None,
                    allow_gateway_transit: Optional[bool] = None,
                    allow_virtual_network_access: Optional[bool] = None,
                    databricks_address_space: Optional[AddressSpaceArgs] = None,
                    databricks_virtual_network: Optional[VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkArgs] = None,
                    peering_name: Optional[str] = None,
                    remote_address_space: Optional[AddressSpaceArgs] = None,
                    remote_virtual_network: Optional[VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs] = None,
                    resource_group_name: Optional[str] = None,
                    use_remote_gateways: Optional[bool] = None,
                    workspace_name: Optional[str] = None)
    @overload
    def VNetPeering(resource_name: str,
                    args: VNetPeeringArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewVNetPeering(ctx *Context, name string, args VNetPeeringArgs, opts ...ResourceOption) (*VNetPeering, error)
    public VNetPeering(string name, VNetPeeringArgs args, CustomResourceOptions? opts = null)
    public VNetPeering(String name, VNetPeeringArgs args)
    public VNetPeering(String name, VNetPeeringArgs args, CustomResourceOptions options)
    
    type: azure-native:databricks:VNetPeering
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args VNetPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VNetPeeringArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VNetPeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VNetPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VNetPeeringArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VNetPeering Resource Properties

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

    Inputs

    The VNetPeering resource accepts the following input properties:

    RemoteVirtualNetwork Pulumi.AzureNative.Databricks.Inputs.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    AllowForwardedTraffic bool
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    AllowGatewayTransit bool
    If gateway links can be used in remote virtual networking to link to this virtual network.
    AllowVirtualNetworkAccess bool
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    DatabricksAddressSpace Pulumi.AzureNative.Databricks.Inputs.AddressSpace
    The reference to the databricks virtual network address space.
    DatabricksVirtualNetwork Pulumi.AzureNative.Databricks.Inputs.VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    PeeringName string
    The name of the workspace vNet peering.
    RemoteAddressSpace Pulumi.AzureNative.Databricks.Inputs.AddressSpace
    The reference to the remote virtual network address space.
    UseRemoteGateways bool
    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.
    RemoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    AllowForwardedTraffic bool
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    AllowGatewayTransit bool
    If gateway links can be used in remote virtual networking to link to this virtual network.
    AllowVirtualNetworkAccess bool
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    DatabricksAddressSpace AddressSpaceArgs
    The reference to the databricks virtual network address space.
    DatabricksVirtualNetwork VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkArgs
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    PeeringName string
    The name of the workspace vNet peering.
    RemoteAddressSpace AddressSpaceArgs
    The reference to the remote virtual network address space.
    UseRemoteGateways bool
    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.
    remoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    allowForwardedTraffic Boolean
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    allowGatewayTransit Boolean
    If gateway links can be used in remote virtual networking to link to this virtual network.
    allowVirtualNetworkAccess Boolean
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    databricksAddressSpace AddressSpace
    The reference to the databricks virtual network address space.
    databricksVirtualNetwork VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    peeringName String
    The name of the workspace vNet peering.
    remoteAddressSpace AddressSpace
    The reference to the remote virtual network address space.
    useRemoteGateways Boolean
    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.
    remoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the workspace.
    allowForwardedTraffic boolean
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    allowGatewayTransit boolean
    If gateway links can be used in remote virtual networking to link to this virtual network.
    allowVirtualNetworkAccess boolean
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    databricksAddressSpace AddressSpace
    The reference to the databricks virtual network address space.
    databricksVirtualNetwork VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    peeringName string
    The name of the workspace vNet peering.
    remoteAddressSpace AddressSpace
    The reference to the remote virtual network address space.
    useRemoteGateways boolean
    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.
    remote_virtual_network VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the workspace.
    allow_forwarded_traffic bool
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    allow_gateway_transit bool
    If gateway links can be used in remote virtual networking to link to this virtual network.
    allow_virtual_network_access bool
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    databricks_address_space AddressSpaceArgs
    The reference to the databricks virtual network address space.
    databricks_virtual_network VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkArgs
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    peering_name str
    The name of the workspace vNet peering.
    remote_address_space AddressSpaceArgs
    The reference to the remote virtual network address space.
    use_remote_gateways bool
    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.
    remoteVirtualNetwork Property Map
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    allowForwardedTraffic Boolean
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    allowGatewayTransit Boolean
    If gateway links can be used in remote virtual networking to link to this virtual network.
    allowVirtualNetworkAccess Boolean
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    databricksAddressSpace Property Map
    The reference to the databricks virtual network address space.
    databricksVirtualNetwork Property Map
    The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
    peeringName String
    The name of the workspace vNet peering.
    remoteAddressSpace Property Map
    The reference to the remote virtual network address space.
    useRemoteGateways Boolean
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the virtual network peering resource
    PeeringState string
    The status of the virtual network peering.
    ProvisioningState string
    The provisioning state of the virtual network peering resource.
    Type string
    type of the virtual network peering resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the virtual network peering resource
    PeeringState string
    The status of the virtual network peering.
    ProvisioningState string
    The provisioning state of the virtual network peering resource.
    Type string
    type of the virtual network peering resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the virtual network peering resource
    peeringState String
    The status of the virtual network peering.
    provisioningState String
    The provisioning state of the virtual network peering resource.
    type String
    type of the virtual network peering resource
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the virtual network peering resource
    peeringState string
    The status of the virtual network peering.
    provisioningState string
    The provisioning state of the virtual network peering resource.
    type string
    type of the virtual network peering resource
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the virtual network peering resource
    peering_state str
    The status of the virtual network peering.
    provisioning_state str
    The provisioning state of the virtual network peering resource.
    type str
    type of the virtual network peering resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the virtual network peering resource
    peeringState String
    The status of the virtual network peering.
    provisioningState String
    The provisioning state of the virtual network peering resource.
    type String
    type of the virtual network peering resource

    Supporting Types

    AddressSpace, AddressSpaceArgs

    AddressPrefixes List<string>
    A list of address blocks reserved for this virtual network in CIDR notation.
    AddressPrefixes []string
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes string[]
    A list of address blocks reserved for this virtual network in CIDR notation.
    address_prefixes Sequence[str]
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.

    AddressSpaceResponse, AddressSpaceResponseArgs

    AddressPrefixes List<string>
    A list of address blocks reserved for this virtual network in CIDR notation.
    AddressPrefixes []string
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes string[]
    A list of address blocks reserved for this virtual network in CIDR notation.
    address_prefixes Sequence[str]
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.

    VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork, VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkArgs

    Id string
    The Id of the databricks virtual network.
    Id string
    The Id of the databricks virtual network.
    id String
    The Id of the databricks virtual network.
    id string
    The Id of the databricks virtual network.
    id str
    The Id of the databricks virtual network.
    id String
    The Id of the databricks virtual network.

    VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork, VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs

    Id string
    The Id of the remote virtual network.
    Id string
    The Id of the remote virtual network.
    id String
    The Id of the remote virtual network.
    id string
    The Id of the remote virtual network.
    id str
    The Id of the remote virtual network.
    id String
    The Id of the remote virtual network.

    VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork, VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetworkArgs

    Id string
    The Id of the databricks virtual network.
    Id string
    The Id of the databricks virtual network.
    id String
    The Id of the databricks virtual network.
    id string
    The Id of the databricks virtual network.
    id str
    The Id of the databricks virtual network.
    id String
    The Id of the databricks virtual network.

    VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork, VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetworkArgs

    Id string
    The Id of the remote virtual network.
    Id string
    The Id of the remote virtual network.
    id String
    The Id of the remote virtual network.
    id string
    The Id of the remote virtual network.
    id str
    The Id of the remote virtual network.
    id String
    The Id of the remote virtual network.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:databricks:VNetPeering vNetPeeringTest /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi