Microsoft.Databricks workspaces/virtualNetworkPeerings template reference

Template format

To create a Microsoft.Databricks/workspaces/virtualNetworkPeerings resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Databricks/workspaces/virtualNetworkPeerings",
  "apiVersion": "2018-04-01",
  "properties": {
    "allowVirtualNetworkAccess": "boolean",
    "allowForwardedTraffic": "boolean",
    "allowGatewayTransit": "boolean",
    "useRemoteGateways": "boolean",
    "databricksVirtualNetwork": {
      "id": "string"
    },
    "databricksAddressSpace": {
      "addressPrefixes": [
        "string"
      ]
    },
    "remoteVirtualNetwork": {
      "id": "string"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "string"
      ]
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Databricks/workspaces/virtualNetworkPeerings object

Name Type Required Value
name string Yes The name of the workspace vNet peering.
type enum Yes virtualNetworkPeerings
-or-
Microsoft.Databricks/workspaces/virtualNetworkPeerings

See Set name and type for child resources.
apiVersion enum Yes 2018-04-01
properties object Yes List of properties for vNet Peering - VirtualNetworkPeeringPropertiesFormat object

VirtualNetworkPeeringPropertiesFormat object

Name Type Required Value
allowVirtualNetworkAccess boolean No Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
allowForwardedTraffic boolean No Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
allowGatewayTransit boolean No If gateway links can be used in remote virtual networking to link to this virtual network.
useRemoteGateways boolean No 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.
databricksVirtualNetwork object No 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). - VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork object
databricksAddressSpace object No The reference to the databricks virtual network address space. - AddressSpace object
remoteVirtualNetwork object Yes 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). - VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork object
remoteAddressSpace object No The reference to the remote virtual network address space. - AddressSpace object

VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork object

Name Type Required Value
id string No The Id of the databricks virtual network.

AddressSpace object

Name Type Required Value
addressPrefixes array No A list of address blocks reserved for this virtual network in CIDR notation. - string

VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork object

Name Type Required Value
id string No The Id of the remote virtual network.