Microsoft Azure vNetPeering API

openapi: 3.2.0
info:
  title: Microsoft Azure DatabricksClient V Net Peering API
  version: 2023-09-15-preview
  description: ARM Databricks
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/{peeringName}
  : get:
      tags:
      - vNetPeering
      operationId: microsoftAzureVnetpeeringGet
      description: Gets the workspace vNet Peering.
      x-ms-examples:
        Get a workspace with vNet Peering Configured:
          $ref: ./examples/WorkspaceVirtualNetPeeringGet.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/WorkspaceName'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/PeeringNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeering'
        '204':
          description: OK - NoContent
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    delete:
      tags:
      - vNetPeering
      operationId: microsoftAzureVnetpeeringDelete
      description: Deletes the workspace vNetPeering.
      x-ms-examples:
        Delete a workspace vNet Peering:
          $ref: ./examples/WorkspaceVirtualNetworkPeeringDelete.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/WorkspaceName'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/PeeringNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
        '202':
          description: Accepted - Returns this status until the asynchronous operation has completed.
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - vNetPeering
      operationId: microsoftAzureVnetpeeringCreateorupdate
      description: Creates vNet Peering for workspace.
      x-ms-examples:
        Create vNet Peering for Workspace:
          $ref: ./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/WorkspaceName'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/PeeringNameParameter'
      responses:
        '200':
          description: Update succeeded - Returns information about the workspace vNet peering.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeering'
        '201':
          description: Created - Returns information about the workspace vNet peering, including provisioning status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeering'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualNetworkPeering'
        description: Parameters supplied to the create workspace vNet Peering.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings
  : get:
      tags:
      - vNetPeering
      operationId: microsoftAzureVnetpeeringListbyworkspace
      description: Lists the workspace vNet Peerings.
      x-ms-examples:
        List all vNet Peerings for the workspace:
          $ref: ./examples/WorkspaceVirtualNetPeeringList.json
      parameters:
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/WorkspaceName'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: List succeeded. Returns the resulting resource objects in response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualNetworkPeeringList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    WorkspaceName:
      name: workspaceName
      in: path
      required: true
      description: The name of the workspace.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 64
        minLength: 3
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
    ResourceGroupName:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group. The name is case insensitive.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
        pattern: ^[-\w\._\(\)]+$
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
    PeeringNameParameter:
      name: peeringName
      in: path
      required: true
      description: The name of the workspace vNet peering.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    AddressSpace:
      properties:
        addressPrefixes:
          type: array
          items:
            type: string
          description: A list of address blocks reserved for this virtual network in CIDR notation.
      description: AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
    ErrorDetail:
      title: Error details.
      type: object
      properties:
        code:
          description: The error's code.
          type: string
        message:
          description: A human readable error message.
          type: string
        target:
          description: Indicates which property in the request is responsible for the error.
          type: string
      required:
      - code
      - message
    VirtualNetworkPeering:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/VirtualNetworkPeeringPropertiesFormat'
          description: List of properties for vNet Peering
        name:
          type: string
          description: Name of the virtual network peering resource
          readOnly: true
        id:
          type: string
          description: Resource ID.
          readOnly: true
        type:
          type: string
          description: type of the virtual network peering resource
          readOnly: true
      required:
      - properties
      description: Peerings in a VirtualNetwork resource
      x-ms-azure-resource: true
    PeeringProvisioningState:
      type: string
      readOnly: true
      description: The current provisioning state.
      enum:
      - Succeeded
      - Updating
      - Deleting
      - Failed
      x-ms-enum:
        name: PeeringProvisioningState
        modelAsString: true
    VirtualNetworkPeeringPropertiesFormat:
      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:
          properties:
            id:
              type: string
              description: The Id of the databricks virtual network.
          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:
          properties:
            id:
              type: string
              description: The Id of the remote virtual network.
          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:
          type: string
          description: The status of the virtual network peering.
          enum:
          - Initiated
          - Connected
          - Disconnected
          x-ms-enum:
            name: peeringState
            modelAsString: true
          readOnly: true
        provisioningState:
          readOnly: true
          $ref: '#/components/schemas/PeeringProvisioningState'
          description: The provisioning state of the virtual network peering resource.
      required:
      - remoteVirtualNetwork
      description: Properties of the virtual network peering.
    VirtualNetworkPeeringList:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/VirtualNetworkPeering'
          description: List of virtual network peerings on workspace.
        nextLink:
          type: string
          description: URL to get the next set of virtual network peering list results if there are any.
      description: Gets all virtual network peerings under a workspace.
    ErrorInfo:
      title: The code and message for an error.
      type: object
      properties:
        code:
          description: A machine readable error code.
          type: string
        message:
          description: A human readable error message.
          type: string
        details:
          description: error details.
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        innererror:
          description: Inner error details if they exist.
          type: string
      required:
      - code
      - message
    ErrorResponse:
      title: Error response.
      description: Contains details when the response code indicates an error.
      type: object
      properties:
        error:
          description: The error details.
          $ref: '#/components/schemas/ErrorInfo'
      required:
      - error
  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