swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Peerings API
schemes:
- https
tags:
- name: Peerings
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}:
    get:
      tags:
      - Peerings
      description: Gets an existing peering with the specified name under the given subscription and resource group.
      operationId: microsoftAzurePeeringsGet
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringName
        in: path
        description: The name of the peering.
        required: true
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Peering'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get a peering:
          $ref: ./examples/GetPeering.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peerings Peeringname
    put:
      tags:
      - Peerings
      description: Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.
      operationId: microsoftAzurePeeringsCreateorupdate
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringName
        in: path
        description: The name of the peering.
        required: true
        type: string
      - name: peering
        in: body
        description: The properties needed to create or update a peering.
        required: true
        schema:
          $ref: '#/definitions/Peering'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Peering'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Peering'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Create a direct peering:
          $ref: ./examples/CreateDirectPeering.json
        Create an exchange peering:
          $ref: ./examples/CreateExchangePeering.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peerings Peeringname
    delete:
      tags:
      - Peerings
      description: Deletes an existing peering with the specified name under the given subscription and resource group.
      operationId: microsoftAzurePeeringsDelete
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringName
        in: path
        description: The name of the peering.
        required: true
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete a peering:
          $ref: ./examples/DeletePeering.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peerings Peeringname
    patch:
      tags:
      - Peerings
      description: Updates tags for a peering with the specified name under the given subscription and resource group.
      operationId: microsoftAzurePeeringsUpdate
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - name: peeringName
        in: path
        description: The name of the peering.
        required: true
        type: string
      - name: tags
        in: body
        description: The resource tags.
        required: true
        schema:
          $ref: '#/definitions/ResourceTags'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Peering'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Update peering tags:
          $ref: ./examples/UpdatePeeringTags.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peerings Peeringname
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings:
    get:
      tags:
      - Peerings
      description: Lists all of the peerings under the given subscription and resource group.
      operationId: microsoftAzurePeeringsListbyresourcegroup
      parameters:
      - name: resourceGroupName
        in: path
        description: The name of the resource group.
        required: true
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PeeringListResult'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        List peerings in a resource group:
          $ref: ./examples/ListPeeringsByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Peering Peerings
  /subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerings:
    get:
      tags:
      - Peerings
      description: Lists all of the peerings under the given subscription.
      operationId: microsoftAzurePeeringsListbysubscription
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PeeringListResult'
        default:
          description: Error response describing why the operation has failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        List peerings in a subscription:
          $ref: ./examples/ListPeeringsBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Peering Peerings
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
  PeeringProperties:
    description: The properties that define connectivity to the Microsoft Cloud Edge.
    type: object
    properties:
      direct:
        $ref: '#/definitions/PeeringPropertiesDirect'
        description: The properties that define a direct peering.
      exchange:
        $ref: '#/definitions/PeeringPropertiesExchange'
        description: The properties that define an exchange peering.
      peeringLocation:
        description: The location of the peering.
        type: string
      provisioningState:
        description: The provisioning state of the resource.
        enum:
        - Succeeded
        - Updating
        - Deleting
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: provisioningState
          modelAsString: true
  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
  SubResource:
    description: The sub resource.
    type: object
    properties:
      id:
        description: The identifier of the referenced resource.
        type: string
  ResourceTags:
    description: The resource tags.
    type: object
    properties:
      tags:
        description: Gets or sets the tags, a dictionary of descriptors arm object
        type: object
        additionalProperties:
          type: string
  PeeringSku:
    description: The SKU that defines the tier and kind of the peering.
    type: object
    properties:
      name:
        description: The name of the peering SKU.
        enum:
        - Basic_Exchange_Free
        - Basic_Direct_Free
        - Premium_Exchange_Metered
        - Premium_Direct_Free
        - Premium_Direct_Metered
        - Premium_Direct_Unlimited
        type: string
        x-ms-enum:
          name: name
          modelAsString: true
      tier:
        description: The tier of the peering SKU.
        enum:
        - Basic
        - Premium
        type: string
        x-ms-enum:
          name: tier
          modelAsString: true
      family:
        description: The family of the peering SKU.
        enum:
        - Direct
        - Exchange
        type: string
        x-ms-enum:
          name: family
          modelAsString: true
      size:
        description: The size of the peering SKU.
        enum:
        - Free
        - Metered
        - Unlimited
        type: string
        x-ms-enum:
          name: size
          modelAsString: true
  PeeringListResult:
    description: The paginated list of peerings.
    type: object
    properties:
      value:
        description: The list of peerings.
        type: array
        items:
          $ref: '#/definitions/Peering'
      nextLink:
        description: The link to fetch the next page of peerings.
        type: string
  BgpSession:
    description: The properties that define a BGP session.
    type: object
    properties:
      sessionPrefixV4:
        description: The IPv4 prefix that contains both ends' IPv4 addresses.
        type: string
      sessionPrefixV6:
        description: The IPv6 prefix that contains both ends' IPv6 addresses.
        type: string
      microsoftSessionIPv4Address:
        description: The IPv4 session address on Microsoft's end.
        type: string
        readOnly: true
      microsoftSessionIPv6Address:
        description: The IPv6 session address on Microsoft's end.
        type: string
        readOnly: true
      peerSessionIPv4Address:
        description: The IPv4 session address on peer's end.
        type: string
      peerSessionIPv6Address:
        description: The IPv6 session address on peer's end.
        type: string
      sessionStateV4:
        description: The state of the IPv4 session.
        enum:
        - None
        - Idle
        - Connect
        - Active
        - OpenSent
        - OpenConfirm
        - OpenReceived
        - Established
        - PendingAdd
        - PendingUpdate
        - PendingRemove
        type: string
        readOnly: true
        x-ms-enum:
          name: sessionStateV4
          modelAsString: true
      sessionStateV6:
        description: The state of the IPv6 session.
        enum:
        - None
        - Idle
        - Connect
        - Active
        - OpenSent
        - OpenConfirm
        - OpenReceived
        - Established
        - PendingAdd
        - PendingUpdate
        - PendingRemove
        type: string
        readOnly: true
        x-ms-enum:
          name: sessionStateV6
          modelAsString: true
      maxPrefixesAdvertisedV4:
        format: int32
        description: The maximum number of prefixes advertised over the IPv4 session.
        type: integer
      maxPrefixesAdvertisedV6:
        format: int32
        description: The maximum number of prefixes advertised over the IPv6 session.
        type: integer
      md5AuthenticationKey:
        description: The MD5 authentication key of the session.
        type: string
  PeeringPropertiesExchange:
    description: The properties that define an exchange peering.
    type: object
    properties:
      connections:
        description: The set of connections that constitute an exchange peering.
        type: array
        items:
          $ref: '#/definitions/ExchangeConnection'
      peerAsn:
        $ref: '#/definitions/SubResource'
        description: The reference of the peer ASN.
  Peering:
    description: Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.
    required:
    - sku
    - kind
    - location
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      sku:
        $ref: '#/definitions/PeeringSku'
        description: The SKU that defines the tier and kind of the peering.
      kind:
        description: The kind of the peering.
        enum:
        - Direct
        - Exchange
        type: string
        x-ms-enum:
          name: kind
          modelAsString: true
      properties:
        $ref: '#/definitions/PeeringProperties'
        description: The properties that define a peering.
        x-ms-client-flatten: true
      location:
        description: The location of the resource.
        type: string
        x-ms-mutability:
        - read
        - create
      tags:
        description: The resource tags.
        type: object
        additionalProperties:
          type: string
  DirectConnection:
    description: The properties that define a direct connection.
    type: object
    properties:
      bandwidthInMbps:
        format: int32
        description: The bandwidth of the connection.
        type: integer
      provisionedBandwidthInMbps:
        format: int32
        description: The bandwidth that is actually provisioned.
        type: integer
        readOnly: true
      sessionAddressProvider:
        description: The field indicating if Microsoft provides session ip addresses.
        enum:
        - Microsoft
        - Peer
        type: string
        x-ms-enum:
          name: sessionAddressProvider
          modelAsString: true
      useForPeeringService:
        description: The flag that indicates whether or not the connection is used for peering service.
        type: boolean
      peeringDBFacilityId:
        format: int32
        description: The PeeringDB.com ID of the facility at which the connection has to be set up.
        type: integer
      connectionState:
        description: The state of the connection.
        enum:
        - None
        - PendingApproval
        - Approved
        - ProvisioningStarted
        - ProvisioningFailed
        - ProvisioningCompleted
        - Validating
        - Active
        type: string
        readOnly: true
        x-ms-enum:
          name: connectionState
          modelAsString: true
      bgpSession:
        $ref: '#/definitions/BgpSession'
        description: The BGP session associated with the connection.
      connectionIdentifier:
        description: The unique identifier (GUID) for the connection.
        type: string
      errorMessage:
        description: The error message related to the connection state, if any.
        type: string
        readOnly: true
  PeeringPropertiesDirect:
    description: The properties that define a direct peering.
    type: object
    properties:
      connections:
        description: The set of connections that constitute a direct peering.
        type: array
        items:
          $ref: '#/definitions/DirectConnection'
      useForPeeringService:
        description: The flag that indicates whether or not the peering is used for peering service.
        type: boolean
        readOnly: true
      peerAsn:
        $ref: '#/definitions/SubResource'
        description: The reference of the peer ASN.
      directPeeringType:
        description: The type of direct peering.
        enum:
        - Edge
        - Transit
        - Cdn
        - Internal
        type: string
        x-ms-enum:
          name: directPeeringType
          modelAsString: true
  ExchangeConnection:
    description: The properties that define an exchange connection.
    type: object
    properties:
      peeringDBFacilityId:
        format: int32
        description: The PeeringDB.com ID of the facility at which the connection has to be set up.
        type: integer
      connectionState:
        description: The state of the connection.
        enum:
        - None
        - PendingApproval
        - Approved
        - ProvisioningStarted
        - ProvisioningFailed
        - ProvisioningCompleted
        - Validating
        - Active
        type: string
        readOnly: true
        x-ms-enum:
          name: connectionState
          modelAsString: true
      bgpSession:
        $ref: '#/definitions/BgpSession'
        description: The BGP session associated with the connection.
      connectionIdentifier:
        description: The unique identifier (GUID) for the connection.
        type: string
      errorMessage:
        description: The error message related to the connection state, if any.
        type: string
        readOnly: true
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'