Microsoft Azure ExpressRouteCircuitPeerings API

openapi: 3.2.0
info:
  title: Microsoft Azure NetworkResourceProviderClient Express Route…
  description: The Windows Azure Network management API provides a RESTful set of web services that interact with Windows Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Windows Azure Networks service.
  version: 2015-05-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ExpressRouteCircuitPeerings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}
  : delete:
      tags:
      - ExpressRouteCircuitPeerings
      operationId: microsoftAzureExpressroutecircuitpeeringsDelete
      description: The delete peering operation deletes the specified peering from the ExpressRouteCircuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: circuitName
        in: path
        required: true
        description: The name of the express route circuit.
        schema:
          type: string
      - name: peeringName
        in: path
        required: true
        description: The name of the peering.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    get:
      tags:
      - ExpressRouteCircuitPeerings
      operationId: microsoftAzureExpressroutecircuitpeeringsGet
      description: The GET peering operation retrieves the specified authorization from the ExpressRouteCircuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: circuitName
        in: path
        required: true
        description: The name of the express route circuit.
        schema:
          type: string
      - name: peeringName
        in: path
        required: true
        description: The name of the peering.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
            text/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - ExpressRouteCircuitPeerings
      operationId: microsoftAzureExpressroutecircuitpeeringsCreateorupdate
      description: The Put Peering operation creates/updates an peering in the specified ExpressRouteCircuits
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: circuitName
        in: path
        required: true
        description: The name of the express route circuit.
        schema:
          type: string
      - name: peeringName
        in: path
        required: true
        description: The name of the peering.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
            text/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
            text/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRouteCircuitPeering'
          text/json:
            schema:
              $ref: '#/components/schemas/ExpressRouteCircuitPeering'
        description: Parameters supplied to the create/update ExpressRouteCircuit Peering operation
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings
  : get:
      tags:
      - ExpressRouteCircuitPeerings
      operationId: microsoftAzureExpressroutecircuitpeeringsList
      description: The List peering operation retrieves all the peerings in an ExpressRouteCircuit.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: circuitName
        in: path
        required: true
        description: The name of the circuit.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeeringListResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeeringListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    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
    ExpressRouteCircuitPeeringListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ExpressRouteCircuitPeering'
          description: Gets the peerings in an express route circuit
        nextLink:
          type: string
          description: Gets the URL to get the next set of results.
      description: Response for ListPeering Api service callRetrieves all Peerings that belongs to an ExpressRouteCircuit
    ExpressRouteCircuitPeering:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/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: '#/components/schemas/SubResource'
      description: Peering in a ExpressRouteCircuit resource
    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: '#/components/schemas/ExpressRouteCircuitPeeringConfig'
          description: Gets or sets the Microsoft peering config
        stats:
          $ref: '#/components/schemas/ExpressRouteCircuitStats'
          description: Gets or peering stats
        provisioningState:
          type: string
          description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    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
    SubResource:
      properties:
        id:
          type: string
          description: Resource Id
      x-ms-azure-resource: true
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
  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