Microsoft.Databricks workspaces/virtualNetworkPeerings

The workspaces/virtualNetworkPeerings resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Databricks/workspaces/virtualNetworkPeerings resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Databricks/workspaces/virtualNetworkPeerings@2021-04-01-preview' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    allowForwardedTraffic: bool
    allowGatewayTransit: bool
    allowVirtualNetworkAccess: bool
    databricksAddressSpace: {
      addressPrefixes: [ 'string' ]
    }
    databricksVirtualNetwork: {
      id: 'string'
    }
    remoteAddressSpace: {
      addressPrefixes: [ 'string' ]
    }
    remoteVirtualNetwork: {
      id: 'string'
    }
    useRemoteGateways: bool
  }
}

Property values

workspaces/virtualNetworkPeerings

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Databricks/workspaces/virtualNetworkPeerings'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-04-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
properties Properties of the virtual network peering. VirtualNetworkPeeringPropertiesFormat (required)

VirtualNetworkPeeringPropertiesFormat

Name Description Value
allowForwardedTraffic Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. bool
allowGatewayTransit If gateway links can be used in remote virtual networking to link to this virtual network. bool
allowVirtualNetworkAccess Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. bool
databricksAddressSpace AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. AddressSpace
databricksVirtualNetwork The remote virtual network should be in the same region. See here to learn more (/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork
remoteAddressSpace AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. AddressSpace
remoteVirtualNetwork The remote virtual network should be in the same region. See here to learn more (/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork (required)
useRemoteGateways 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. bool

AddressSpace

Name Description Value
addressPrefixes A list of address blocks reserved for this virtual network in CIDR notation. string[]

VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork

Name Description Value
id The Id of the databricks virtual network. string

VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork

Name Description Value
id The Id of the remote virtual network. string