v Net Peering - Create Or Update

Reference

Service:: Databricks

API Version:: 2024-05-01

Creates vNet Peering for workspace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
peeringName	path	True	string	The name of the workspace vNet peering.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string	The API version to use for this operation.

Request Body

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

Responses

Name	Type	Description
200 OK	VirtualNetworkPeering	Update succeeded - Returns information about the workspace vNet peering.
201 Created	VirtualNetworkPeering	Created - Returns information about the workspace vNet peering, including provisioning status.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create vNet Peering for Workspace

Sample request

HTTP

PUT https://management.azure.com/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6//resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest?api-version=2024-05-01

{
  "properties": {
    "allowForwardedTraffic": false,
    "allowGatewayTransit": false,
    "allowVirtualNetworkAccess": true,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
    },
    "useRemoteGateways": false
  }
}

Sample response

Status code:: 201

{
  "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest",
  "name": "vNetPeeringTest",
  "properties": {
    "allowVirtualNetworkAccess": true,
    "allowForwardedTraffic": false,
    "allowGatewayTransit": false,
    "useRemoteGateways": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "10.203.0.0/16"
      ]
    },
    "databricksVirtualNetwork": {
      "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet"
    },
    "databricksAddressSpace": {
      "addressPrefixes": [
        "10.139.0.0/16"
      ]
    },
    "peeringState": "Initiated",
    "provisioningState": "Updating"
  }
}

Status code:: 200

{
  "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest",
  "name": "vNetPeeringTest",
  "properties": {
    "allowVirtualNetworkAccess": true,
    "allowForwardedTraffic": false,
    "allowGatewayTransit": false,
    "useRemoteGateways": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "10.203.0.0/16"
      ]
    },
    "databricksVirtualNetwork": {
      "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet"
    },
    "databricksAddressSpace": {
      "addressPrefixes": [
        "10.139.0.0/16"
      ]
    },
    "peeringState": "Initiated",
    "provisioningState": "Updating"
  }
}

Definitions

Name	Description
AddressSpace	AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
DatabricksVirtualNetwork	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).
ErrorDetail	Error details.
ErrorInfo	The code and message for an error.
ErrorResponse	Error response.
PeeringProvisioningState	The current provisioning state.
peeringState	The status of the virtual network peering.
RemoteVirtualNetwork	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).
VirtualNetworkPeering	Peerings in a VirtualNetwork resource

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

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

DatabricksVirtualNetwork

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).

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

ErrorDetail

Error details.

Name	Type	Description
code	string	The error's code.
message	string	A human readable error message.
target	string	Indicates which property in the request is responsible for the error.

ErrorInfo

The code and message for an error.

Name	Type	Description
code	string	A machine readable error code.
details	ErrorDetail[]	error details.
innererror	string	Inner error details if they exist.
message	string	A human readable error message.

ErrorResponse

Error response.

Name	Type	Description
error	ErrorInfo	The code and message for an error. The error details.

PeeringProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

peeringState

The status of the virtual network peering.

Name	Type	Description
Connected	string
Disconnected	string
Initiated	string

RemoteVirtualNetwork