swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Edgenodes API
schemes:
- https
tags:
- name: Edgenodes
paths:
  /providers/Microsoft.Cdn/edgenodes:
    get:
      tags:
      - Edgenodes
      description: Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.
      operationId: microsoftAzureEdgenodesList
      x-ms-examples:
        EdgeNodes_List:
          $ref: ./examples/EdgeNodes_List.json
      parameters:
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/EdgenodeResult'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Cdn Edgenodes
definitions:
  IpAddressGroup:
    description: CDN Ip address group
    type: object
    properties:
      deliveryRegion:
        description: The delivery region of the ip address group
        type: string
      ipv4Addresses:
        description: The list of ip v4 addresses.
        type: array
        items:
          $ref: '#/definitions/cidrIpAddress'
        x-ms-identifiers:
        - baseIpAddress
      ipv6Addresses:
        description: The list of ip v6 addresses.
        type: array
        items:
          $ref: '#/definitions/cidrIpAddress'
        x-ms-identifiers:
        - baseIpAddress
  ErrorResponse:
    title: Error response
    description: Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail
  ProxyResource:
    description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
    allOf:
    - $ref: '#/definitions/Resource'
    properties: {}
  Resource:
    description: The core properties of ARM resources
    properties:
      id:
        description: Resource ID.
        readOnly: true
        type: string
      name:
        description: Resource name.
        readOnly: true
        type: string
      type:
        description: Resource type.
        readOnly: true
        type: string
      systemData:
        $ref: '#/definitions/SystemData'
        readOnly: true
    x-ms-azure-resource: true
  cidrIpAddress:
    description: CIDR Ip address
    type: object
    properties:
      baseIpAddress:
        description: Ip address itself.
        type: string
      prefixLength:
        description: The length of the prefix of the ip address.
        type: integer
        format: int32
  EdgeNode:
    description: Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/EdgeNodeProperties'
  IdentityType:
    description: The type of identity that creates/modifies resources
    type: string
    enum:
    - user
    - application
    - managedIdentity
    - key
    x-ms-enum:
      name: IdentityType
      modelAsString: true
  EdgeNodeProperties:
    description: The JSON object that contains the properties required to create an edgenode.
    required:
    - ipAddressGroups
    properties:
      ipAddressGroups:
        description: List of ip address groups.
        type: array
        items:
          $ref: '#/definitions/IpAddressGroup'
        x-ms-identifiers:
        - deliveryRegion
  SystemData:
    description: Read only system data
    readOnly: true
    type: object
    properties:
      createdBy:
        type: string
        description: An identifier for the identity that created the resource
      createdByType:
        $ref: '#/definitions/IdentityType'
        description: The type of identity that created the resource
      createdAt:
        type: string
        format: date-time
        description: The timestamp of resource creation (UTC)
      lastModifiedBy:
        type: string
        description: An identifier for the identity that last modified the resource
      lastModifiedByType:
        $ref: '#/definitions/IdentityType'
        description: The type of identity that last modified the resource
      lastModifiedAt:
        type: string
        format: date-time
        description: The timestamp of resource last modification (UTC)
  EdgenodeResult:
    description: Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.
    properties:
      value:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/EdgeNode'
        description: Edge node of CDN service.
      nextLink:
        type: string
        description: URL to get the next set of edgenode list results if there are any.
parameters:
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2023-05-01.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'