swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ExpressRouteCircuits API
schemes:
- https
tags:
- name: ExpressRouteCircuits
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/
  : delete:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsDelete
      description: The delete ExpressRouteCircuit operation deletes the specified ExpressRouteCircuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: circuitName
        in: path
        required: true
        type: string
        description: The name of the express route Circuit.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits Circuitname
    get:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsGet
      description: The Get ExpressRouteCircuit operation retrieves information about the specified ExpressRouteCircuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: circuitName
        in: path
        required: true
        type: string
        description: The name of the circuit.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuit'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits Circuitname
    put:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsCreateorupdate
      description: The Put ExpressRouteCircuit operation creates/updates a ExpressRouteCircuit
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: circuitName
        in: path
        required: true
        type: string
        description: The name of the circuit.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ExpressRouteCircuit'
        description: Parameters supplied to the create/delete ExpressRouteCircuit operation
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuit'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuit'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits Circuitname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}arpTable
  : get:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsListarptable
      description: The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: circuitName
        in: path
        required: true
        type: string
        description: The name of the circuit.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuitsArpTableListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits Circuitnamearptable
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}routesTable
  : get:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsListroutestable
      description: The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: circuitName
        in: path
        required: true
        type: string
        description: The name of the circuit.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuitsRoutesTableListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits Circuitnameroutestable
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}stats
  : get:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsListstats
      description: The ListStats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: circuitName
        in: path
        required: true
        type: string
        description: The name of the loadBalancer.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuitsStatsListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits Circuitnamestats
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits:
    get:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsList
      description: The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuitListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutecircuits
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits:
    get:
      tags:
      - ExpressRouteCircuits
      operationId: microsoftAzureExpressroutecircuitsListall
      description: The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ExpressRouteCircuitListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Expressroutecircuits
definitions:
  ExpressRouteCircuitSku:
    properties:
      name:
        type: string
        description: Gets or sets name of the sku.
      tier:
        type: string
        description: Gets or sets tier of the sku.
        enum:
        - Standard
        - Premium
        x-ms-enum:
          name: ExpressRouteCircuitSkuTier
          modelAsString: true
      family:
        type: string
        description: Gets or sets family of the sku.
        enum:
        - UnlimitedData
        - MeteredData
        x-ms-enum:
          name: ExpressRouteCircuitSkuFamily
          modelAsString: true
    description: Contains sku in an ExpressRouteCircuit
  ExpressRouteCircuitPeeringConfig:
    properties:
      advertisedPublicPrefixes:
        type: array
        items:
          type: string
        description: Gets or sets the reference of AdvertisedPublicPrefixes
      advertisedPublicPrefixesState:
        type: string
        description: 'Gets or sets AdvertisedPublicPrefixState of the Peering resource '
        enum:
        - NotConfigured
        - Configuring
        - Configured
        - ValidationNeeded
        x-ms-enum:
          name: ExpressRouteCircuitPeeringAdvertisedPublicPrefixState
          modelAsString: true
      customerASN:
        type: integer
        format: int32
        description: Gets or Sets CustomerAsn of the peering.
      routingRegistryName:
        type: string
        description: Gets or Sets RoutingRegistryName of the config.
    description: Specifies the peering config
  ExpressRouteCircuitRoutesTable:
    properties:
      addressPrefix:
        type: string
        description: Gets AddressPrefix.
      nextHopType:
        type: string
        description: Gets NextHopType.
        enum:
        - VirtualNetworkGateway
        - VnetLocal
        - Internet
        - VirtualAppliance
        - None
        x-ms-enum:
          name: RouteNextHopType
          modelAsString: true
      nextHopIP:
        type: string
        description: Gets NextHopIP.
      asPath:
        type: string
        description: Gets AsPath.
    required:
    - nextHopType
    description: The routes table associated with the ExpressRouteCircuit
  ExpressRouteCircuitsRoutesTableListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteCircuitRoutesTable'
        description: Gets List of RoutesTable
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListRoutesTable associated with the Express Route Circuits Api
  ExpressRouteCircuitAuthorization:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/AuthorizationPropertiesFormat'
      name:
        type: string
        description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource
      etag:
        type: string
        description: A unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/SubResource'
    description: Authorization in a ExpressRouteCircuit resource
  ExpressRouteCircuitsArpTableListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteCircuitArpTable'
        description: Gets List of ArpTable
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListArpTable associated with the Express Route Circuits Api
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  ExpressRouteCircuitPropertiesFormat:
    properties:
      circuitProvisioningState:
        type: string
        description: 'Gets or sets CircuitProvisioningState state of the resource '
      serviceProviderProvisioningState:
        type: string
        description: 'Gets or sets ServiceProviderProvisioningState state of the resource '
        enum:
        - NotProvisioned
        - Provisioning
        - Provisioned
        - Deprovisioning
        x-ms-enum:
          name: ServiceProviderProvisioningState
          modelAsString: true
      authorizations:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteCircuitAuthorization'
        description: Gets or sets list of authorizations
      peerings:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteCircuitPeering'
        description: Gets or sets list of peerings
      serviceKey:
        type: string
        description: Gets or sets ServiceKey
      serviceProviderNotes:
        type: string
        description: Gets or sets ServiceProviderNotes
      serviceProviderProperties:
        $ref: '#/definitions/ExpressRouteCircuitServiceProviderProperties'
        description: Gets or sets ServiceProviderProperties
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    description: Properties of ExpressRouteCircuit
  ExpressRouteCircuitsStatsListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteCircuitStats'
        description: Gets List of Stats
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListStats from Express Route Circuits Api service call
  ExpressRouteCircuitArpTable:
    properties:
      ipAddress:
        type: string
        description: Gets ipAddress.
      macAddress:
        type: string
        description: Gets macAddress.
    description: The arp table associated with the ExpressRouteCircuit
  SubResource:
    properties:
      id:
        type: string
        description: Resource Id
    x-ms-azure-resource: true
  ExpressRouteCircuit:
    properties:
      sku:
        $ref: '#/definitions/ExpressRouteCircuitSku'
        description: Gets or sets sku
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ExpressRouteCircuitPropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: ExpressRouteCircuit resource
  ExpressRouteCircuitServiceProviderProperties:
    properties:
      serviceProviderName:
        type: string
        description: Gets or sets serviceProviderName.
      peeringLocation:
        type: string
        description: Gets or sets peering location.
      bandwidthInMbps:
        type: integer
        format: int32
        description: Gets or sets BandwidthInMbps.
    description: Contains ServiceProviderProperties in an ExpressRouteCircuit
  ExpressRouteCircuitPeeringPropertiesFormat:
    properties:
      peeringType:
        type: string
        description: Gets or sets PeeringType
        enum:
        - AzurePublicPeering
        - AzurePrivatePeering
        - MicrosoftPeering
        x-ms-enum:
          name: ExpressRouteCircuitPeeringType
          modelAsString: true
      state:
        type: string
        description: Gets or sets state of Peering
        enum:
        - Disabled
        - Enabled
        x-ms-enum:
          name: ExpressRouteCircuitPeeringState
          modelAsString: true
      azureASN:
        type: integer
        format: int32
        description: Gets or sets the azure ASN
      peerASN:
        type: integer
        format: int32
        description: Gets or sets the peer ASN
      primaryPeerAddressPrefix:
        type: string
        description: Gets or sets the primary address prefix
      secondaryPeerAddressPrefix:
        type: string
        description: Gets or sets the secondary address prefix
      primaryAzurePort:
        type: string
        description: Gets or sets the primary port
      secondaryAzurePort:
        type: string
        description: Gets or sets the secondary port
      sharedKey:
        type: string
        description: Gets or sets the shared key
      vlanId:
        type: integer
        format: int32
        description: Gets or sets the vlan id
      microsoftPeeringConfig:
        $ref: '#/definitions/ExpressRouteCircuitPeeringConfig'
        description: Gets or sets the Microsoft peering config
      stats:
        $ref: '#/definitions/ExpressRouteCircuitStats'
        description: Gets or peering stats
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
  ExpressRouteCircuitPeering:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ExpressRouteCircuitPeeringPropertiesFormat'
      name:
        type: string
        description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource
      etag:
        type: string
        description: A unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/SubResource'
    description: Peering in a ExpressRouteCircuit resource
  ExpressRouteCircuitListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ExpressRouteCircuit'
        description: Gets a list of ExpressRouteCircuits in a resource group
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListExpressRouteCircuit Api service call
  AuthorizationPropertiesFormat:
    properties:
      authorizationKey:
        type: string
        description: Gets or sets the authorization key
      authorizationUseStatus:
        type: string
        description: Gets or sets AuthorizationUseStatus
        enum:
        - Available
        - InUse
        x-ms-enum:
          name: AuthorizationUseStatus
          modelAsString: true
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
  ExpressRouteCircuitStats:
    properties:
      bytesIn:
        type: integer
        format: int32
        description: Gets BytesIn of the peering.
      bytesOut:
        type: integer
        format: int32
        description: Gets BytesOut of the peering.
    description: Contains Stats associated with the peering
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'