swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ExpressRouteConnections API
schemes:
- https
tags:
- name: ExpressRouteConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}
  : put:
      tags:
      - ExpressRouteConnections
      operationId: microsoftAzureExpressrouteconnectionsCreateorupdate
      x-ms-examples:
        ExpressRouteConnectionCreate:
          $ref: ./examples/ExpressRouteConnectionCreate.json
      description: Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: expressRouteGatewayName
        in: path
        required: true
        type: string
        description: The name of the ExpressRoute gateway.
      - name: connectionName
        in: path
        required: true
        type: string
        description: The name of the connection subresource.
      - name: putExpressRouteConnectionParameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ExpressRouteConnection'
        description: Parameters required in an ExpressRouteConnection PUT operation.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Update successful. The operation returns the ExpressRouteConnection.
          schema:
            $ref: '#/definitions/ExpressRouteConnection'
        '201':
          description: Create successful. The operation returns the ExpressRouteConnection.
          schema:
            $ref: '#/definitions/ExpressRouteConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      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 Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections Connectionname
    get:
      tags:
      - ExpressRouteConnections
      operationId: microsoftAzureExpressrouteconnectionsGet
      x-ms-examples:
        ExpressRouteConnectionGet:
          $ref: ./examples/ExpressRouteConnectionGet.json
      description: Gets the specified ExpressRouteConnection.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: expressRouteGatewayName
        in: path
        required: true
        type: string
        description: The name of the ExpressRoute gateway.
      - name: connectionName
        in: path
        required: true
        type: string
        description: The name of the ExpressRoute connection.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation returns the ExpressRouteConnection.
          schema:
            $ref: '#/definitions/ExpressRouteConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections Connectionname
    delete:
      tags:
      - ExpressRouteConnections
      operationId: microsoftAzureExpressrouteconnectionsDelete
      x-ms-examples:
        ExpressRouteConnectionDelete:
          $ref: ./examples/ExpressRouteConnectionDelete.json
      description: Deletes a connection to a ExpressRoute circuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: expressRouteGatewayName
        in: path
        required: true
        type: string
        description: The name of the ExpressRoute gateway.
      - name: connectionName
        in: path
        required: true
        type: string
        description: The name of the connection subresource.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Delete successful.
        '202':
          description: Accepted, and the operation will continue asynchronously.
        '204':
          description: Delete successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections Connectionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections
  : get:
      tags:
      - ExpressRouteConnections
      operationId: microsoftAzureExpressrouteconnectionsList
      x-ms-examples:
        ExpressRouteConnectionList:
          $ref: ./examples/ExpressRouteConnectionList.json
      description: Lists ExpressRouteConnections.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: expressRouteGatewayName
        in: path
        required: true
        type: string
        description: The name of the ExpressRoute gateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful.
          schema:
            $ref: '#/definitions/ExpressRouteConnectionList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections
definitions:
  VnetLocalRouteOverrideCriteria:
    type: string
    description: Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.
    enum:
    - Contains
    - Equal
    x-ms-enum:
      name: VnetLocalRouteOverrideCriteria
      modelAsString: true
  StaticRoute:
    description: List of all Static Routes.
    properties:
      name:
        type: string
        description: The name of the StaticRoute that is unique within a VnetRoute.
      addressPrefixes:
        type: array
        description: List of all address prefixes.
        items:
          type: string
      nextHopIpAddress:
        type: string
        description: The ip address of the next hop.
  ExpressRouteConnectionList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteConnection'
        description: The list of ExpressRoute connections.
    description: ExpressRouteConnection list.
  VnetRoute:
    description: List of routes that control routing from VirtualHub into a virtual network connection.
    properties:
      staticRoutesConfig:
        $ref: '#/definitions/StaticRoutesConfig'
        description: Configuration for static routes on this HubVnetConnection.
      staticRoutes:
        type: array
        description: List of all Static Routes.
        items:
          $ref: '#/definitions/StaticRoute'
      bgpConnections:
        type: array
        readOnly: true
        description: The list of references to HubBgpConnection objects.
        items:
          $ref: ./network.json#/definitions/SubResource
  PropagatedRouteTable:
    description: The list of RouteTables to advertise the routes to.
    properties:
      labels:
        type: array
        description: The list of labels.
        items:
          type: string
      ids:
        type: array
        description: The list of resource ids of all the RouteTables.
        items:
          $ref: ./network.json#/definitions/SubResource
  ExpressRouteConnection:
    required:
    - name
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ExpressRouteConnectionProperties'
        description: Properties of the express route connection.
      name:
        type: string
        description: The name of the resource.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: ExpressRouteConnection resource.
  StaticRoutesConfig:
    description: Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.
    type: object
    properties:
      propagateStaticRoutes:
        description: Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
        type: boolean
        readOnly: true
      vnetLocalRouteOverrideCriteria:
        description: Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
        $ref: '#/definitions/VnetLocalRouteOverrideCriteria'
  ExpressRouteConnectionProperties:
    required:
    - expressRouteCircuitPeering
    properties:
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the express route connection resource.
      expressRouteCircuitPeering:
        $ref: '#/definitions/ExpressRouteCircuitPeeringId'
        description: The ExpressRoute circuit peering.
      authorizationKey:
        type: string
        description: Authorization key to establish the connection.
      routingWeight:
        type: integer
        description: The routing weight associated to the connection.
      enableInternetSecurity:
        type: boolean
        description: Enable internet security.
      expressRouteGatewayBypass:
        type: boolean
        description: Enable FastPath to vWan Firewall hub.
      enablePrivateLinkFastPath:
        type: boolean
        description: Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
      routingConfiguration:
        $ref: '#/definitions/RoutingConfiguration'
        description: The Routing Configuration indicating the associated and propagated route tables on this connection.
    description: Properties of the ExpressRouteConnection subresource.
  RoutingConfiguration:
    description: Routing Configuration indicating the associated and propagated route tables for this connection.
    properties:
      associatedRouteTable:
        $ref: ./network.json#/definitions/SubResource
        description: The resource id RouteTable associated with this RoutingConfiguration.
      propagatedRouteTables:
        $ref: '#/definitions/PropagatedRouteTable'
        description: The list of RouteTables to advertise the routes to.
      vnetRoutes:
        $ref: '#/definitions/VnetRoute'
        description: List of routes that control routing from VirtualHub into a virtual network connection.
      inboundRouteMap:
        $ref: ./network.json#/definitions/SubResource
        description: The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
      outboundRouteMap:
        $ref: ./network.json#/definitions/SubResource
        description: The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
  ExpressRouteCircuitPeeringId:
    properties:
      id:
        type: string
        description: The ID of the ExpressRoute circuit peering.
    description: ExpressRoute circuit peering identifier.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'