Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The profiles/endpoints/originGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints/originGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Cdn/profiles/endpoints/originGroups@2025-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
healthProbeSettings: {
probeIntervalInSeconds: int
probePath: 'string'
probeProtocol: 'string'
probeRequestType: 'string'
}
origins: [
{
id: 'string'
}
]
responseBasedOriginErrorDetectionSettings: {
httpErrorRanges: [
{
begin: int
end: int
}
]
responseBasedDetectedErrorTypes: 'string'
responseBasedFailoverThresholdPercentage: int
}
trafficRestorationTimeToHealedOrNewEndpointsInMinutes: int
}
}
Property Values
Microsoft.Cdn/profiles/endpoints/originGroups
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: profiles/endpoints |
| properties | The JSON object that contains the properties of the origin group. | OriginGroupProperties |
HealthProbeParameters
| Name | Description | Value |
|---|---|---|
| probeIntervalInSeconds | The number of seconds between health probes.Default is 240sec. | int Constraints: Min value = 1 Max value = 255 |
| probePath | The path relative to the origin that is used to determine the health of the origin. | string |
| probeProtocol | Protocol to use for health probe. | 'Http' 'Https' 'NotSet' |
| probeRequestType | The type of health probe request that is made. | 'GET' 'HEAD' 'NotSet' |
HttpErrorRangeParameters
| Name | Description | Value |
|---|---|---|
| begin | The inclusive start of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
| end | The inclusive end of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
OriginGroupProperties
| Name | Description | Value |
|---|---|---|
| healthProbeSettings | Health probe settings to the origin that is used to determine the health of the origin. | HealthProbeParameters |
| origins | The source of the content being delivered via CDN within given origin group. | ResourceReference[] |
| responseBasedOriginErrorDetectionSettings | The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. | ResponseBasedOriginErrorDetectionParameters |
| trafficRestorationTimeToHealedOrNewEndpointsInMinutes | 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. | int Constraints: Min value = 0 Max value = 50 |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ResponseBasedOriginErrorDetectionParameters
| Name | Description | Value |
|---|---|---|
| httpErrorRanges | The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. | HttpErrorRangeParameters[] |
| responseBasedDetectedErrorTypes | Type of response errors for real user requests for which origin will be deemed unhealthy | 'None' 'TcpAndHttpErrors' 'TcpErrorsOnly' |
| responseBasedFailoverThresholdPercentage | The percentage of failed requests in the sample where failover should trigger. | int Constraints: Min value = 0 Max value = 100 |
ARM template resource definition
The profiles/endpoints/originGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints/originGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Cdn/profiles/endpoints/originGroups",
"apiVersion": "2025-12-01",
"name": "string",
"properties": {
"healthProbeSettings": {
"probeIntervalInSeconds": "int",
"probePath": "string",
"probeProtocol": "string",
"probeRequestType": "string"
},
"origins": [
{
"id": "string"
}
],
"responseBasedOriginErrorDetectionSettings": {
"httpErrorRanges": [
{
"begin": "int",
"end": "int"
}
],
"responseBasedDetectedErrorTypes": "string",
"responseBasedFailoverThresholdPercentage": "int"
},
"trafficRestorationTimeToHealedOrNewEndpointsInMinutes": "int"
}
}
Property Values
Microsoft.Cdn/profiles/endpoints/originGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-12-01' |
| name | The resource name | string (required) |
| properties | The JSON object that contains the properties of the origin group. | OriginGroupProperties |
| type | The resource type | 'Microsoft.Cdn/profiles/endpoints/originGroups' |
HealthProbeParameters
| Name | Description | Value |
|---|---|---|
| probeIntervalInSeconds | The number of seconds between health probes.Default is 240sec. | int Constraints: Min value = 1 Max value = 255 |
| probePath | The path relative to the origin that is used to determine the health of the origin. | string |
| probeProtocol | Protocol to use for health probe. | 'Http' 'Https' 'NotSet' |
| probeRequestType | The type of health probe request that is made. | 'GET' 'HEAD' 'NotSet' |
HttpErrorRangeParameters
| Name | Description | Value |
|---|---|---|
| begin | The inclusive start of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
| end | The inclusive end of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
OriginGroupProperties
| Name | Description | Value |
|---|---|---|
| healthProbeSettings | Health probe settings to the origin that is used to determine the health of the origin. | HealthProbeParameters |
| origins | The source of the content being delivered via CDN within given origin group. | ResourceReference[] |
| responseBasedOriginErrorDetectionSettings | The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. | ResponseBasedOriginErrorDetectionParameters |
| trafficRestorationTimeToHealedOrNewEndpointsInMinutes | 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. | int Constraints: Min value = 0 Max value = 50 |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ResponseBasedOriginErrorDetectionParameters
| Name | Description | Value |
|---|---|---|
| httpErrorRanges | The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. | HttpErrorRangeParameters[] |
| responseBasedDetectedErrorTypes | Type of response errors for real user requests for which origin will be deemed unhealthy | 'None' 'TcpAndHttpErrors' 'TcpErrorsOnly' |
| responseBasedFailoverThresholdPercentage | The percentage of failed requests in the sample where failover should trigger. | int Constraints: Min value = 0 Max value = 100 |
Usage Examples
Terraform (AzAPI provider) resource definition
The profiles/endpoints/originGroups resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Cdn/profiles/endpoints/originGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Cdn/profiles/endpoints/originGroups@2025-12-01"
name = "string"
parent_id = "string"
body = {
properties = {
healthProbeSettings = {
probeIntervalInSeconds = int
probePath = "string"
probeProtocol = "string"
probeRequestType = "string"
}
origins = [
{
id = "string"
}
]
responseBasedOriginErrorDetectionSettings = {
httpErrorRanges = [
{
begin = int
end = int
}
]
responseBasedDetectedErrorTypes = "string"
responseBasedFailoverThresholdPercentage = int
}
trafficRestorationTimeToHealedOrNewEndpointsInMinutes = int
}
}
}
Property Values
Microsoft.Cdn/profiles/endpoints/originGroups
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: profiles/endpoints |
| properties | The JSON object that contains the properties of the origin group. | OriginGroupProperties |
| type | The resource type | "Microsoft.Cdn/profiles/endpoints/originGroups@2025-12-01" |
HealthProbeParameters
| Name | Description | Value |
|---|---|---|
| probeIntervalInSeconds | The number of seconds between health probes.Default is 240sec. | int Constraints: Min value = 1 Max value = 255 |
| probePath | The path relative to the origin that is used to determine the health of the origin. | string |
| probeProtocol | Protocol to use for health probe. | 'Http' 'Https' 'NotSet' |
| probeRequestType | The type of health probe request that is made. | 'GET' 'HEAD' 'NotSet' |
HttpErrorRangeParameters
| Name | Description | Value |
|---|---|---|
| begin | The inclusive start of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
| end | The inclusive end of the http status code range. | int Constraints: Min value = 100 Max value = 999 |
OriginGroupProperties
| Name | Description | Value |
|---|---|---|
| healthProbeSettings | Health probe settings to the origin that is used to determine the health of the origin. | HealthProbeParameters |
| origins | The source of the content being delivered via CDN within given origin group. | ResourceReference[] |
| responseBasedOriginErrorDetectionSettings | The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. | ResponseBasedOriginErrorDetectionParameters |
| trafficRestorationTimeToHealedOrNewEndpointsInMinutes | 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. | int Constraints: Min value = 0 Max value = 50 |
ResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ResponseBasedOriginErrorDetectionParameters
| Name | Description | Value |
|---|---|---|
| httpErrorRanges | The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. | HttpErrorRangeParameters[] |
| responseBasedDetectedErrorTypes | Type of response errors for real user requests for which origin will be deemed unhealthy | 'None' 'TcpAndHttpErrors' 'TcpErrorsOnly' |
| responseBasedFailoverThresholdPercentage | The percentage of failed requests in the sample where failover should trigger. | int Constraints: Min value = 0 Max value = 100 |