OriginListResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-cdn/json-schema/microsoft-azure-cdn-origin-list-result-schema.json",
  "title": "OriginListResult",
  "description": "The response of a Origin list operation.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-cdn-origins-api-openapi.yml#/components/schemas/OriginListResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The Origin items on this page",
      "items": {
        "$ref": "#/$defs/Origin"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "Origin": {
      "type": "object",
      "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.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/OriginProperties",
          "description": "The JSON object that contains the properties of the origin.",
          "x-ms-client-flatten": true
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource"
        }
      ]
    },
    "OriginProperties": {
      "type": "object",
      "description": "The JSON object that contains the properties of the origin.",
      "properties": {
        "resourceState": {
          "$ref": "#/$defs/OriginResourceState",
          "description": "Resource status of the origin.",
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/$defs/OriginProvisioningState",
          "description": "Provisioning status of the origin.",
          "readOnly": true
        },
        "privateEndpointStatus": {
          "$ref": "#/$defs/PrivateEndpointStatus",
          "description": "The approval status for the connection to the Private Link",
          "readOnly": true
        },
        "hostName": {
          "type": "string",
          "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."
        }
      },
      "required": [
        "hostName"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/OriginUpdatePropertiesParameters"
        }
      ]
    },
    "OriginProvisioningState": {
      "type": "string",
      "description": "Provisioning status of the origin.",
      "enum": [
        "Succeeded",
        "Failed",
        "Updating",
        "Deleting",
        "Creating"
      ],
      "x-ms-enum": {
        "name": "OriginProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Updating",
            "value": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          },
          {
            "name": "Creating",
            "value": "Creating"
          }
        ]
      }
    },
    "OriginResourceState": {
      "type": "string",
      "description": "Resource status of the origin.",
      "enum": [
        "Creating",
        "Active",
        "Deleting"
      ],
      "x-ms-enum": {
        "name": "OriginResourceState",
        "modelAsString": true,
        "values": [
          {
            "name": "Creating",
            "value": "Creating"
          },
          {
            "name": "Active",
            "value": "Active"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          }
        ]
      }
    },
    "OriginUpdatePropertiesParameters": {
      "type": "object",
      "description": "The JSON object that contains the properties of the origin.",
      "properties": {
        "hostName": {
          "type": "string",
          "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."
        },
        "httpPort": {
          "type": "integer",
          "format": "int32",
          "description": "The value of the HTTP port. Must be between 1 and 65535.",
          "minimum": 1,
          "maximum": 65535
        },
        "httpsPort": {
          "type": "integer",
          "format": "int32",
          "description": "The value of the HTTPS port. Must be between 1 and 65535.",
          "minimum": 1,
          "maximum": 65535
        },
        "originHostHeader": {
          "type": "string",
          "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"
        },
        "priority": {
          "type": "integer",
          "format": "int32",
          "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",
          "minimum": 1,
          "maximum": 5
        },
        "weight": {
          "type": "integer",
          "format": "int32",
          "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000",
          "minimum": 1,
          "maximum": 1000
        },
        "enabled": {
          "type": "boolean",
          "description": "Origin is enabled for load balancing or not"
        },
        "privateLinkAlias": {
          "type": "string",
          "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'"
        },
        "privateLinkResourceId": {
          "type": "string",
          "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'"
        },
        "privateLinkLocation": {
          "type": "string",
          "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated"
        },
        "privateLinkApprovalMessage": {
          "type": "string",
          "description": "A custom message to be included in the approval request to connect to the Private Link."
        }
      }
    },
    "PrivateEndpointStatus": {
      "type": "string",
      "description": "The approval status for the connection to the Private Link",
      "enum": [
        "Pending",
        "Approved",
        "Rejected",
        "Disconnected",
        "Timeout"
      ],
      "x-ms-enum": {
        "name": "PrivateEndpointStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "Pending",
            "value": "Pending"
          },
          {
            "name": "Approved",
            "value": "Approved"
          },
          {
            "name": "Rejected",
            "value": "Rejected"
          },
          {
            "name": "Disconnected",
            "value": "Disconnected"
          },
          {
            "name": "Timeout",
            "value": "Timeout"
          }
        ]
      }
    }
  }
}