Microsoft Azure Origins API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Origins API
schemes:
- https
tags:
- name: Origins
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins
  : get:
      tags:
      - Origins
      description: Lists all of the existing origins within an endpoint.
      operationId: microsoftAzureOriginsListbyendpoint
      x-ms-examples:
        Origins_ListByEndpoint:
          $ref: ./examples/Origins_ListByEndpoint.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/OriginListResult'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Origins
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
  : get:
      tags:
      - Origins
      description: Gets an existing origin within an endpoint.
      operationId: microsoftAzureOriginsGet
      x-ms-examples:
        Origins_Get:
          $ref: ./examples/Origins_Get.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        type: string
      - name: originName
        in: path
        description: Name of the origin which is unique within the endpoint.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Origin'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Origins Originname
    put:
      tags:
      - Origins
      description: Creates a new origin within the specified endpoint.
      operationId: microsoftAzureOriginsCreate
      x-ms-examples:
        Origins_Create:
          $ref: ./examples/Origins_Create.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        type: string
      - name: originName
        in: path
        description: Name of the origin that is unique within the endpoint.
        required: true
        type: string
      - name: origin
        in: body
        description: Origin properties
        required: true
        schema:
          $ref: '#/definitions/Origin'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Origin'
        '201':
          description: Created. The request has been fulfilled and a new origin has been created.
          schema:
            $ref: '#/definitions/Origin'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              type: string
          schema:
            $ref: '#/definitions/Origin'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Origins Originname
    patch:
      tags:
      - Origins
      description: Updates an existing origin within an endpoint.
      operationId: microsoftAzureOriginsUpdate
      x-ms-examples:
        Origins_Update:
          $ref: ./examples/Origins_Update.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        type: string
      - name: originName
        in: path
        description: Name of the origin which is unique within the endpoint.
        required: true
        type: string
      - name: originUpdateProperties
        in: body
        description: Origin properties
        required: true
        schema:
          $ref: '#/definitions/OriginUpdateParameters'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Origin'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              type: string
          schema:
            $ref: '#/definitions/Origin'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Origins Originname
    delete:
      tags:
      - Origins
      description: Deletes an existing origin within an endpoint.
      operationId: microsoftAzureOriginsDelete
      x-ms-examples:
        Origins_Delete:
          $ref: ./examples/Origins_Delete.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: profileName
        in: path
        description: Name of the CDN profile which is unique within the resource group.
        required: true
        type: string
      - name: endpointName
        in: path
        description: Name of the endpoint under the profile which is unique globally.
        required: true
        type: string
      - name: originName
        in: path
        description: Name of the origin which is unique within the endpoint.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              type: string
        '204':
          description: No Content. The request has been accepted but the origin was not found.
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Origins Originname
definitions:
  OriginListResult:
    description: Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.
    properties:
      value:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Origin'
        description: List of CDN origins within an endpoint
      nextLink:
        type: string
        description: URL to get the next set of origin objects if there are any.
  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
  OriginUpdatePropertiesParameters:
    description: The JSON object that contains the properties of the origin.
    properties:
      hostName:
        description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
        type: string
      httpPort:
        description: The value of the HTTP port. Must be between 1 and 65535.
        type: integer
        format: int32
        maximum: 65535
        exclusiveMaximum: false
        minimum: 1
        exclusiveMinimum: false
      httpsPort:
        description: The value of the HTTPS port. Must be between 1 and 65535.
        type: integer
        format: int32
        maximum: 65535
        exclusiveMaximum: false
        minimum: 1
        exclusiveMinimum: false
      originHostHeader:
        description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
        type: string
      priority:
        description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
        type: integer
        format: int32
        maximum: 5
        minimum: 1
      weight:
        description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
        type: integer
        format: int32
        maximum: 1000
        minimum: 1
      enabled:
        description: Origin is enabled for load balancing or not
        type: boolean
      privateLinkAlias:
        description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
        type: string
      privateLinkResourceId:
        description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
        type: string
      privateLinkLocation:
        description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
        type: string
      privateLinkApprovalMessage:
        description: A custom message to be included in the approval request to connect to the Private Link.
        type: string
  OriginUpdateParameters:
    type: object
    description: Origin properties needed for origin update.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/OriginUpdatePropertiesParameters'
    x-ms-azure-resource: true
  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)
  PrivateEndpointStatus:
    description: The approval status for the connection to the Private Link
    type: string
    enum:
    - Pending
    - Approved
    - Rejected
    - Disconnected
    - Timeout
    x-ms-enum:
      name: PrivateEndpointStatus
      modelAsString: true
  Origin:
    description: CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/OriginProperties'
  IdentityType:
    description: The type of identity that creates/modifies resources
    type: string
    enum:
    - user
    - application
    - managedIdentity
    - key
    x-ms-enum:
      name: IdentityType
      modelAsString: true
  OriginProperties:
    description: The JSON object that contains the properties of the origin.
    required:
    - hostName
    allOf:
    - $ref: '#/definitions/OriginUpdatePropertiesParameters'
    properties:
      resourceState:
        description: Resource status of the origin.
        readOnly: true
        enum:
        - Creating
        - Active
        - Deleting
        type: string
        x-ms-enum:
          name: OriginResourceState
          modelAsString: true
      provisioningState:
        readOnly: true
        description: Provisioning status of the origin.
        type: string
        enum:
        - Succeeded
        - Failed
        - Updating
        - Deleting
        - Creating
        x-ms-enum:
          name: OriginProvisioningState
          modelAsString: true
      privateEndpointStatus:
        description: The approval status for the connection to the Private Link
        $ref: '#/definitions/PrivateEndpointStatus'
        type: string
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  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.
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
    description: Name of the Resource group within the Azure subscription.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'