Microsoft Azure L2 Connection API

openapi: 3.2.0
info:
  version: 2024-03-01-preview
  title: Microsoft Azure Azure Orbital L2 Connection API
  description: Azure Orbital service.
  license:
    name: Microsoft
servers:
- url: https://management.azure.com
tags:
- name: L2 Connection
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/l2Connections/{l2ConnectionName}
  : get:
      tags:
      - L2 Connection
      operationId: microsoftAzureL2connectionsGet
      description: Gets the specified L2 connection in a specified resource group.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/l2ConnectionNameParameter'
      responses:
        '200':
          description: Request successful. The operation returns the resulting L2Connection resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2Connection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get L2 Connection:
          $ref: ./examples/L2ConnectionGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - L2 Connection
      description: Creates or updates an L2 Connection.
      operationId: microsoftAzureL2connectionsCreateorupdate
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/l2ConnectionNameParameter'
      responses:
        '200':
          description: Update successful. The operation returns the resulting L2Connection resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2Connection'
        '201':
          description: Create successful. The operation returns the resulting L2Connection resource.
          headers:
            Azure-AsyncOperation:
              description: URL for checking the ongoing status of the operation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2Connection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create L2 Connection:
          $ref: ./examples/L2ConnectionCreate.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/L2Connection'
        description: The parameters to provide for the created L2 Connection.
        required: true
    delete:
      tags:
      - L2 Connection
      operationId: microsoftAzureL2connectionsDelete
      description: Deletes a specified L2 Connection resource.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/l2ConnectionNameParameter'
      responses:
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            Location:
              description: URL for determining when an operation has completed.
              schema:
                type: string
        '204':
          description: Request successful. Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete L2 Connection:
          $ref: ./examples/L2ConnectionDelete.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    patch:
      tags:
      - L2 Connection
      operationId: microsoftAzureL2connectionsUpdatetags
      x-ms-examples:
        Update L2 Connection tags:
          $ref: ./examples/L2ConnectionUpdateTag.json
      description: Updates the specified L2 Connection's tags.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/l2ConnectionNameParameter'
      responses:
        '200':
          description: Update successful. The operation returns the resulting L2 Connection resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2Connection'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            Location:
              description: URL for determining when an operation has completed.
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsObject'
        description: Parameters supplied to update the L2 Connection's tags.
        required: true
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/l2Connections:
    get:
      tags:
      - L2 Connection
      description: Returns a list of L2 Connections attached to an orbital gateway.
      operationId: microsoftAzureL2connectionsList
      x-ms-examples:
        List of L2 Connections by Resource Group:
          $ref: ./examples/L2ConnectionsByResourceGroupList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/skipTokenParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of L2 Connection resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2ConnectionListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.Orbital/l2Connections:
    get:
      tags:
      - L2 Connection
      description: Returns a list of L2 Connections attached to a subscription.
      operationId: microsoftAzureL2connectionsListbysubscription
      x-ms-examples:
        List of L2 Connections by Subscription:
          $ref: ./examples/L2ConnectionsBySubscriptionList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/skipTokenParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of L2 Connection resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/L2ConnectionListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Orbital…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites/{edgeSiteName}/listL2Connections
  : post:
      tags:
      - L2 Connection
      description: Returns a list of L2 Connections attached to an edge site.
      operationId: microsoftAzureEdgesitesListl2connections
      x-ms-examples:
        List of L2 Connections by Edge site:
          $ref: ./examples/L2ConnectionsByEdgeSiteNameList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/edgeSiteNameParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of L2 Connection resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceIdListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations/{groundStationName}/listL2Connections
  : post:
      tags:
      - L2 Connection
      description: Returns a list of L2 Connections attached to an ground station.
      operationId: microsoftAzureGroundstationsListl2connections
      x-ms-examples:
        List of L2 Connections by Ground Station:
          $ref: ./examples/L2ConnectionsByGroundStationNameList.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/groundStationNameParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of L2 Connection resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceIdListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProvisioningState:
      type: string
      enum:
      - Creating
      - Succeeded
      - Failed
      - Canceled
      - Updating
      - Deleting
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
      description: The current state of the resource's creation, deletion, or modification.
      readOnly: true
    TagsObject:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
      description: Tags object for patch operations.
    L2Connection:
      type: object
      required:
      - properties
      properties:
        properties:
          x-ms-client-flatten: true
          allOf:
          - $ref: '#/components/schemas/L2ConnectionsProperties'
          description: The properties bag for this resource.
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
      description: Connects an edge site to an orbital gateway and describes what layer 2 traffic to forward between them.
    L2ConnectionListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/L2Connection'
          description: A list of L2 Connection resources.
        nextLink:
          type: string
          description: The URL to get the next set of results.
          readOnly: true
      description: Response for an API service call that lists L2 Connections.
    ResourceReference:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: Resource ID.
      description: Resource Reference.
    ResourceIdListResult:
      type: object
      properties:
        value:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Azure Resource ID.
          description: A list of Azure Resource IDs.
        nextLink:
          type: string
          description: The URL to get the next set of results.
          readOnly: true
      description: Response for an API service call that lists the resource IDs of resources associated with another resource.
    L2ConnectionsProperties:
      type: object
      required:
      - edgeSite
      - edgeSitePartnerRouter
      - groundStation
      - groundStationPartnerRouter
      - vlanId
      properties:
        provisioningState:
          type: string
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/ProvisioningState'
          description: The current state of the resource's creation, deletion, or modification.
        circuitId:
          type: string
          readOnly: true
          description: Globally-unique identifier for this connection that is to be used as a circuit ID.
        edgeSite:
          allOf:
          - $ref: '#/components/schemas/ResourceReference'
          description: A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
        edgeSitePartnerRouter:
          type: object
          x-ms-client-flatten: true
          required:
          - name
          x-ms-mutability:
          - read
          - create
          properties:
            name:
              type: string
              description: The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
          description: The name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
        groundStation:
          allOf:
          - $ref: '#/components/schemas/ResourceReference'
          description: A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
        groundStationPartnerRouter:
          type: object
          x-ms-client-flatten: true
          required:
          - name
          x-ms-mutability:
          - read
          - create
          properties:
            name:
              type: string
              description: The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
          description: The name of the partner router to establish a connection to within the ground station.
        vlanId:
          type: integer
          format: int32
          minimum: 1
          maximum: 4094
          description: The VLAN ID for the L2 connection.
      description: Properties object for an L2 Connection.
  parameters:
    edgeSiteNameParameter:
      name: edgeSiteName
      in: path
      description: Edge site name.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 64
        minLength: 2
        pattern: ^[A-Za-z][A-Za-z0-9-_]+$
    skipTokenParameter:
      name: $skiptoken
      description: An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
      in: query
      required: false
      schema:
        type: string
    groundStationNameParameter:
      name: groundStationName
      in: path
      required: true
      description: Ground Station name.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 64
        minLength: 2
        pattern: ^[A-Za-z][A-Za-z0-9-_]+$
    l2ConnectionNameParameter:
      name: l2ConnectionName
      in: path
      description: L2 Connection name.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 64
        minLength: 2
        pattern: ^[A-Za-z][A-Za-z0-9-_]+$
  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.