Microsoft Azure OriginGroups API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector OriginGroups API
schemes:
- https
tags:
- name: OriginGroups
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups
  : get:
      tags:
      - OriginGroups
      description: Lists all of the existing origin groups within an endpoint.
      operationId: microsoftAzureOrigingroupsListbyendpoint
      x-ms-examples:
        OriginsGroups_ListByEndpoint:
          $ref: ./examples/OriginGroups_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/OriginGroupListResult'
        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 Origingroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
  : get:
      tags:
      - OriginGroups
      description: Gets an existing origin group within an endpoint.
      operationId: microsoftAzureOrigingroupsGet
      x-ms-examples:
        OriginGroups_Get:
          $ref: ./examples/OriginGroups_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: originGroupName
        in: path
        description: Name of the origin group 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/OriginGroup'
        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 Origingroups Origingroupname
    put:
      tags:
      - OriginGroups
      description: Creates a new origin group within the specified endpoint.
      operationId: microsoftAzureOrigingroupsCreate
      x-ms-examples:
        OriginGroups_Create:
          $ref: ./examples/OriginGroups_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: originGroupName
        in: path
        description: Name of the origin group which is unique within the endpoint.
        required: true
        type: string
      - name: originGroup
        in: body
        description: Origin group properties
        required: true
        schema:
          $ref: '#/definitions/OriginGroup'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/OriginGroup'
        '201':
          description: Created. The request has been fulfilled and a new origin group has been created.
          schema:
            $ref: '#/definitions/OriginGroup'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              type: string
          schema:
            $ref: '#/definitions/OriginGroup'
        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 Origingroups Origingroupname
    patch:
      tags:
      - OriginGroups
      description: Updates an existing origin group within an endpoint.
      operationId: microsoftAzureOrigingroupsUpdate
      x-ms-examples:
        OriginGroups_Update:
          $ref: ./examples/OriginGroups_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: originGroupName
        in: path
        description: Name of the origin group which is unique within the endpoint.
        required: true
        type: string
      - name: originGroupUpdateProperties
        in: body
        description: Origin group properties
        required: true
        schema:
          $ref: '#/definitions/OriginGroupUpdateParameters'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/OriginGroup'
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            location:
              type: string
          schema:
            $ref: '#/definitions/OriginGroup'
        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 Origingroups Origingroupname
    delete:
      tags:
      - OriginGroups
      description: Deletes an existing origin group within an endpoint.
      operationId: microsoftAzureOrigingroupsDelete
      x-ms-examples:
        OriginGroups_Delete:
          $ref: ./examples/OriginGroups_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: originGroupName
        in: path
        description: Name of the origin group 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 Origingroups Origingroupname
definitions:
  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
  OriginGroup:
    description: Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/OriginGroupProperties'
  HttpErrorRangeParameters:
    description: The JSON object that represents the range for http status codes
    properties:
      begin:
        description: The inclusive start of the http status code range.
        type: integer
        format: int32
        maximum: 999
        minimum: 100
      end:
        description: The inclusive end of the http status code range.
        type: integer
        format: int32
        maximum: 999
        minimum: 100
  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)
  OriginGroupProperties:
    description: The JSON object that contains the properties of the origin group.
    type: object
    required:
    - origins
    allOf:
    - $ref: '#/definitions/OriginGroupUpdatePropertiesParameters'
    properties:
      resourceState:
        description: Resource status of the origin group.
        readOnly: true
        enum:
        - Creating
        - Active
        - Deleting
        type: string
        x-ms-enum:
          name: OriginGroupResourceState
          modelAsString: true
      provisioningState:
        readOnly: true
        description: Provisioning status of the origin group.
        type: string
        enum:
        - Succeeded
        - Failed
        - Updating
        - Deleting
        - Creating
        x-ms-enum:
          name: OriginGroupProvisioningState
          modelAsString: true
  IdentityType:
    description: The type of identity that creates/modifies resources
    type: string
    enum:
    - user
    - application
    - managedIdentity
    - key
    x-ms-enum:
      name: IdentityType
      modelAsString: true
  OriginGroupUpdateParameters:
    type: object
    description: Origin group properties needed for origin group creation or update.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/OriginGroupUpdatePropertiesParameters'
    x-ms-azure-resource: true
  OriginGroupUpdatePropertiesParameters:
    description: The JSON object that contains the properties of the origin group.
    properties:
      healthProbeSettings:
        description: Health probe settings to the origin that is used to determine the health of the origin.
        type: object
        $ref: '#/definitions/HealthProbeParameters'
      origins:
        description: The source of the content being delivered via CDN within given origin group.
        type: array
        items:
          description: A reference to a origin.
          $ref: '#/definitions/ResourceReference'
      trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
        description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
        type: integer
        format: int32
        maximum: 50
        minimum: 0
      responseBasedOriginErrorDetectionSettings:
        description: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
        type: object
        $ref: '#/definitions/ResponseBasedOriginErrorDetectionParameters'
  OriginGroupListResult:
    description: Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.
    properties:
      value:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/OriginGroup'
        description: List of CDN origin groups within an endpoint
      nextLink:
        type: string
        description: URL to get the next set of origin objects if there are any.
  ResponseBasedOriginErrorDetectionParameters:
    description: The JSON object that contains the properties to determine origin health using real requests/responses.
    properties:
      responseBasedDetectedErrorTypes:
        description: Type of response errors for real user requests for which origin will be deemed unhealthy
        type: string
        enum:
        - None
        - TcpErrorsOnly
        - TcpAndHttpErrors
        x-ms-enum:
          name: ResponseBasedDetectedErrorTypes
          modelAsString: false
      responseBasedFailoverThresholdPercentage:
        description: The percentage of failed requests in the sample where failover should trigger.
        type: integer
        format: int32
        maximum: 100
        minimum: 0
      httpErrorRanges:
        description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
        type: array
        items:
          $ref: '#/definitions/HttpErrorRangeParameters'
        x-ms-identifiers: []
  ResourceReference:
    properties:
      id:
        type: string
        description: Resource ID.
    description: Reference to another resource.
    x-ms-azure-resource: true
  HealthProbeParameters:
    description: The JSON object that contains the properties to send health probes to origin.
    properties:
      probePath:
        description: The path relative to the origin that is used to determine the health of the origin.
        type: string
      probeRequestType:
        description: The type of health probe request that is made.
        enum:
        - NotSet
        - GET
        - HEAD
        type: string
        x-ms-enum:
          name: HealthProbeRequestType
          modelAsString: false
      probeProtocol:
        description: Protocol to use for health probe.
        type: string
        enum:
        - NotSet
        - Http
        - Https
        x-ms-enum:
          name: ProbeProtocol
          modelAsString: false
      probeIntervalInSeconds:
        description: The number of seconds between health probes.Default is 240sec.
        type: integer
        format: int32
        maximum: 255
        minimum: 1
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'