Azure Databricks V Net Peering API

The vNetPeering API from Azure Databricks — 2 operation(s) for vnetpeering.

GitHub OpenAPI

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings V net peering list by workspace #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName} V net peering get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName} V net peering create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName} V net peering delete #

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/microsoft-azure-databricks:microsoft-azure-databricks-vnetpeering-api"
All apis
curl "https://apis.io/api/v1/apis?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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

microsoft-azure-databricks-vnetpeering-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: DatabricksClient V Net Peering API
  version: '2026-01-01'
  description: ARM Databricks
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: vNetPeering
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings
  : get:
      operationId: vNetPeering_ListByWorkspace
      tags:
      - vNetPeering
      description: Lists the workspace vNet Peerings.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the workspace.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeeringList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: V net peering list by workspace
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}
  : get:
      operationId: vNetPeering_Get
      tags:
      - vNetPeering
      description: Gets the workspace vNet Peering.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the workspace.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      - name: peeringName
        in: path
        description: The name of the workspace vNet peering.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeering'
        '204':
          description: Operation completed successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: V net peering get
      x-summary-source: derived
    put:
      operationId: vNetPeering_CreateOrUpdate
      tags:
      - vNetPeering
      description: Creates vNet Peering for workspace.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the workspace.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      - name: peeringName
        in: path
        description: The name of the workspace vNet peering.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'VirtualNetworkPeering' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeering'
        '201':
          description: Resource 'VirtualNetworkPeering' create operation succeeded
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeering'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/VirtualNetworkPeering'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualNetworkPeering'
        description: Parameters supplied to the create workspace vNet Peering.
        required: true
      summary: V net peering create or update
      x-summary-source: derived
    delete:
      operationId: vNetPeering_Delete
      tags:
      - vNetPeering
      description: Deletes the workspace vNetPeering.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the workspace.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      - name: peeringName
        in: path
        description: The name of the workspace vNet peering.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: V net peering delete
      x-summary-source: derived
components:
  schemas:
    Resource:
      type: object
      description: The core properties of ARM resources
      properties:
        id:
          type: string
          description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
          readOnly: true
    ErrorResponse:
      type: object
      description: Contains details when the response code indicates an error.
      properties:
        error:
          $ref: '#/components/schemas/ErrorInfo'
          description: The error details.
      required:
      - error
    VirtualNetworkPeering:
      type: object
      description: Peerings in a VirtualNetwork resource
      properties:
        properties:
          $ref: '#/components/schemas/VirtualNetworkPeeringPropertiesFormat'
          description: List of properties for vNet Peering
          x-ms-client-flatten: true
      required:
      - properties
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    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.
    ErrorDetail:
      type: object
      description: Error details.
      properties:
        code:
          type: string
          description: The error's code.
        message:
          type: string
          description: A human readable error message.
        target:
          type: string
          description: Indicates which property in the request is responsible for the error.
      required:
      - code
      - message
    VirtualNetworkPeeringList:
      type: object
      description: Gets all virtual network peerings under a workspace.
      properties:
        value:
          type: array
          description: The VirtualNetworkPeering items on this page
          items:
            $ref: '#/components/schemas/VirtualNetworkPeering'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    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
    ErrorInfo:
      type: object
      description: The code and message for an error.
      properties:
        code:
          type: string
          description: A machine readable error code.
        message:
          type: string
          description: A human readable error message.
        details:
          type: array
          description: error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        innererror:
          type: string
          description: Inner error details if they exist.
      required:
      - code
      - message
    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
    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.
    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: '#/components/schemas/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: '#/components/schemas/AddressSpace'
          description: The reference to the databricks virtual network address space.
        remoteVirtualNetwork:
          $ref: '#/components/schemas/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: '#/components/schemas/AddressSpace'
          description: The reference to the remote virtual network address space.
        peeringState:
          $ref: '#/components/schemas/PeeringState'
          description: The status of the virtual network peering.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/PeeringProvisioningState'
          description: The provisioning state of the virtual network peering resource.
          readOnly: true
      required:
      - remoteVirtualNetwork
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    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
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.