swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PeeringLocations API
schemes:
- https
tags:
- name: PeeringLocations
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringLocations:
    get:
      tags:
      - PeeringLocations
      description: Lists all of the available peering locations for the specified kind of peering.
      operationId: microsoftAzurePeeringlocationsList
      parameters:
      - name: kind
        in: query
        description: The kind of the peering.
        required: true
        type: string
        enum:
        - Direct
        - Exchange
      - name: directPeeringType
        in: query
        description: The type of direct peering.
        required: false
        type: string
        enum:
        - Edge
        - Transit
        - Cdn
        - Internal
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PeeringLocationListResult'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        List direct peering locations:
          $ref: ./examples/ListDirectPeeringLocations.json
        List exchange peering locations:
          $ref: ./examples/ListExchangePeeringLocations.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Peering Peeringlocations
definitions:
  ErrorResponse:
    description: The error response that indicates why an operation has failed.
    type: object
    properties:
      code:
        description: The error code.
        type: string
        readOnly: true
      message:
        description: The error message.
        type: string
        readOnly: true
  PeeringLocationPropertiesExchange:
    description: The properties that define an exchange peering location.
    type: object
    properties:
      peeringFacilities:
        description: The list of exchange peering facilities at the peering location.
        type: array
        items:
          $ref: '#/definitions/ExchangePeeringFacility'
  PeeringBandwidthOffer:
    description: The properties that define a peering bandwidth offer.
    type: object
    properties:
      offerName:
        description: The name of the bandwidth offer.
        type: string
      valueInMbps:
        format: int32
        description: The value of the bandwidth offer in Mbps.
        type: integer
  PeeringLocationProperties:
    description: The properties that define a peering location.
    type: object
    properties:
      direct:
        $ref: '#/definitions/PeeringLocationPropertiesDirect'
        description: The properties that define a direct peering location.
      exchange:
        $ref: '#/definitions/PeeringLocationPropertiesExchange'
        description: The properties that define an exchange peering location.
      peeringLocation:
        description: The name of the peering location.
        type: string
      country:
        description: The country in which the peering location exists.
        type: string
      azureRegion:
        description: The Azure region associated with the peering location.
        type: string
  Resource:
    description: The ARM resource class.
    type: object
    properties:
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      id:
        description: The ID of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  DirectPeeringFacility:
    description: The properties that define a direct peering facility.
    type: object
    properties:
      address:
        description: The address of the direct peering facility.
        type: string
      directPeeringType:
        description: The type of the direct peering.
        enum:
        - Edge
        - Transit
        - Cdn
        - Internal
        type: string
        x-ms-enum:
          name: directPeeringType
          modelAsString: true
      peeringDBFacilityId:
        format: int32
        description: The PeeringDB.com ID of the facility.
        type: integer
      peeringDBFacilityLink:
        description: The PeeringDB.com URL of the facility.
        type: string
  PeeringLocation:
    description: Peering location is where connectivity could be established to the Microsoft Cloud Edge.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      kind:
        description: The kind of peering that the peering location supports.
        enum:
        - Direct
        - Exchange
        type: string
        x-ms-enum:
          name: kind
          modelAsString: true
      properties:
        $ref: '#/definitions/PeeringLocationProperties'
        description: The properties that define a peering location.
        x-ms-client-flatten: true
  PeeringLocationListResult:
    description: The paginated list of peering locations.
    type: object
    properties:
      value:
        description: The list of peering locations.
        type: array
        items:
          $ref: '#/definitions/PeeringLocation'
      nextLink:
        description: The link to fetch the next page of peering locations.
        type: string
  PeeringLocationPropertiesDirect:
    description: The properties that define a direct peering location.
    type: object
    properties:
      peeringFacilities:
        description: The list of direct peering facilities at the peering location.
        type: array
        items:
          $ref: '#/definitions/DirectPeeringFacility'
      bandwidthOffers:
        description: The list of bandwidth offers available at the peering location.
        type: array
        items:
          $ref: '#/definitions/PeeringBandwidthOffer'
  ExchangePeeringFacility:
    description: The properties that define an exchange peering facility.
    type: object
    properties:
      exchangeName:
        description: The name of the exchange peering facility.
        type: string
      bandwidthInMbps:
        format: int32
        description: The bandwidth of the connection between Microsoft and the exchange peering facility.
        type: integer
      microsoftIPv4Address:
        description: The IPv4 address of Microsoft at the exchange peering facility.
        type: string
      microsoftIPv6Address:
        description: The IPv6 address of Microsoft at the exchange peering facility.
        type: string
      facilityIPv4Prefix:
        description: The IPv4 prefixes associated with the exchange peering facility.
        type: string
      facilityIPv6Prefix:
        description: The IPv6 prefixes associated with the exchange peering facility.
        type: string
      peeringDBFacilityId:
        format: int32
        description: The PeeringDB.com ID of the facility.
        type: integer
      peeringDBFacilityLink:
        description: The PeeringDB.com URL of the facility.
        type: string
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: The client API version.
    required: true
    type: string
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Azure subscription ID.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'