Microsoft.Cdn profiles/endpoints/originGroups

The profiles/endpoints/originGroups resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Cdn/profiles/endpoints/originGroups resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Cdn/profiles/endpoints/originGroups@2020-09-01' = {
  name: 'string'
  parent: parentSymbolicName
  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

profiles/endpoints/originGroups

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Cdn/profiles/endpoints/originGroups'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-09-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
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.
parentSymbolicName
properties The JSON object that contains the properties of the origin group. OriginGroupProperties

OriginGroupProperties

Name Description Value
healthProbeSettings The JSON object that contains the properties to send health probes to 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. 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

HealthProbeParameters

Name Description Value
probeIntervalInSeconds The number of seconds between health probes.Default is 240sec. int
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'

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

HttpErrorRangeParameters

Name Description Value
begin The inclusive start of the http status code range. int
end The inclusive end of the http status code range. int