Microsoft.Cdn (preview:2025-09-01)

2025/10/09 • 4 updated methods

AFDOrigins_ListByOriginGroup (updated)
Description :  Lists all of the existing origins within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_ListByOriginGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "originCapacityResource": [
                  {
                    "#name": "originIngressRateThreshold",
                    "Description": {
                      "new": "The ingress rate limit threshold for an origin per minute in bytes",
                      "old": "The ingress rate limit threshold for an origin per minute in MB"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AFDOrigin items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Get (updated)
Description :  Gets an existing origin within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Create (updated)
Description :  Creates a new origin within the specified origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Create",
  "$parameters": {
    "origin": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
Required: True ,
}
string ,
origin:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Azure Front Door origin is the source of the content being delivered via Azure Front Door. 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:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Azure Front Door origin is the source of the content being delivered via Azure Front Door. 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:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Update (updated)
Description :  Updates an existing origin within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Update",
  "$parameters": {
    "originUpdateProperties": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "originCapacityResource": [
              {
                "#name": "originIngressRateThreshold",
                "Description": {
                  "new": "The ingress rate limit threshold for an origin per minute in bytes",
                  "old": "The ingress rate limit threshold for an origin per minute in MB"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Azure Front Door origin is the source of the content being delivered via Azure Front Door. 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:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
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. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
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 Front Door 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 ,
Required: False ,
}
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 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
originCapacityResource:
{
Description: Origin capacity settings for an origin ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable origin capacity for a specific origin ,
Required: False ,
}
boolean ,
region:
{
Description: The nearest origin capacity pop region for an origin ,
Required: False ,
}
string ,
originRequestRateThreshold:
{
Description: The request rate limit threshold for an origin per minute ,
Format: int64 ,
Required: False ,
}
integer ,
originIngressRateThreshold:
{
Description: The ingress rate limit threshold for an origin per minute in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning status ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentStatus:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}