Azure Databricks · Schema

VirtualNetworkPeeringList

Gets all virtual network peerings under a workspace.

AnalyticsApache SparkBig DataData EngineeringMachine Learning

Properties

Name Type Description
value array The VirtualNetworkPeering items on this page
nextLink string The link to the next page of items
View JSON Schema on GitHub

JSON Schema

microsoft-azure-databricks-virtual-network-peering-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-databricks/json-schema/microsoft-azure-databricks-virtual-network-peering-list-schema.json",
  "title": "VirtualNetworkPeeringList",
  "description": "Gets all virtual network peerings under a workspace.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-databricks-vnetpeering-api-openapi.yml#/components/schemas/VirtualNetworkPeeringList",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The VirtualNetworkPeering items on this page",
      "items": {
        "$ref": "#/$defs/VirtualNetworkPeering"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "AddressSpace": {
      "type": "object",
      "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.",
      "properties": {
        "addressPrefixes": {
          "type": "array",
          "description": "A list of address blocks reserved for this virtual network in CIDR notation.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "PeeringProvisioningState": {
      "type": "string",
      "description": "The current provisioning state.",
      "enum": [
        "Succeeded",
        "Updating",
        "Deleting",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "PeeringProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Succeeded"
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "Deleting"
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Failed"
          }
        ]
      }
    },
    "PeeringState": {
      "type": "string",
      "description": "The status of the virtual network peering.",
      "enum": [
        "Initiated",
        "Connected",
        "Disconnected"
      ],
      "x-ms-enum": {
        "name": "PeeringState",
        "modelAsString": true,
        "values": [
          {
            "name": "Initiated",
            "value": "Initiated",
            "description": "Initiated"
          },
          {
            "name": "Connected",
            "value": "Connected",
            "description": "Connected"
          },
          {
            "name": "Disconnected",
            "value": "Disconnected",
            "description": "Disconnected"
          }
        ]
      }
    },
    "VirtualNetworkPeering": {
      "type": "object",
      "description": "Peerings in a VirtualNetwork resource",
      "properties": {
        "properties": {
          "$ref": "#/$defs/VirtualNetworkPeeringPropertiesFormat",
          "description": "List of properties for vNet Peering",
          "x-ms-client-flatten": true
        }
      },
      "required": [
        "properties"
      ],
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
        }
      ]
    },
    "VirtualNetworkPeeringPropertiesFormat": {
      "type": "object",
      "description": "Properties of the virtual network peering.",
      "properties": {
        "allowVirtualNetworkAccess": {
          "type": "boolean",
          "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space."
        },
        "allowForwardedTraffic": {
          "type": "boolean",
          "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network."
        },
        "allowGatewayTransit": {
          "type": "boolean",
          "description": "If gateway links can be used in remote virtual networking to link to this virtual network."
        },
        "useRemoteGateways": {
          "type": "boolean",
          "description": "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": {
          "$ref": "#/$defs/VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork",
          "description": "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)."
        },
        "databricksAddressSpace": {
          "$ref": "#/$defs/AddressSpace",
          "description": "The reference to the databricks virtual network address space."
        },
        "remoteVirtualNetwork": {
          "$ref": "#/$defs/VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork",
          "description": "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)."
        },
        "remoteAddressSpace": {
          "$ref": "#/$defs/AddressSpace",
          "description": "The reference to the remote virtual network address space."
        },
        "peeringState": {
          "$ref": "#/$defs/PeeringState",
          "description": "The status of the virtual network peering.",
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/$defs/PeeringProvisioningState",
          "description": "The provisioning state of the virtual network peering resource.",
          "readOnly": true
        }
      },
      "required": [
        "remoteVirtualNetwork"
      ]
    },
    "VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork": {
      "type": "object",
      "description": "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": {
        "id": {
          "type": "string",
          "description": "The Id of the databricks virtual network."
        }
      }
    },
    "VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork": {
      "type": "object",
      "description": "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": {
        "id": {
          "type": "string",
          "description": "The Id of the remote virtual network."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-azure-databricks-virtual-network-peering-list"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.