Microsoft.Cdn profiles/originGroups

Template format

To create a Microsoft.Cdn/profiles/originGroups resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Cdn/profiles/originGroups",
  "apiVersion": "2020-09-01",
  "properties": {
    "loadBalancingSettings": {
      "sampleSize": "integer",
      "successfulSamplesRequired": "integer",
      "additionalLatencyInMilliseconds": "integer"
    },
    "healthProbeSettings": {
      "probePath": "string",
      "probeRequestType": "string",
      "probeProtocol": "string",
      "probeIntervalInSeconds": "integer"
    },
    "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": "integer",
    "responseBasedAfdOriginErrorDetectionSettings": {
      "responseBasedDetectedErrorTypes": "string",
      "responseBasedFailoverThresholdPercentage": "integer",
      "httpErrorRanges": [
        {
          "begin": "integer",
          "end": "integer"
        }
      ]
    },
    "sessionAffinityState": "string"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Cdn/profiles/originGroups object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the origin group which is unique within the endpoint.
type enum Yes For JSON -originGroups
-or-
Microsoft.Cdn/profiles/originGroups

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-09-01
properties object Yes AFDOriginGroupProperties object
resources array No origins

AFDOriginGroupProperties object

Name Type Required Value
loadBalancingSettings object No Load balancing settings for a backend pool - LoadBalancingSettingsParameters object
healthProbeSettings object No Health probe settings to the origin that is used to determine the health of the origin. - HealthProbeParameters object
trafficRestorationTimeToHealedOrNewEndpointsInMinutes integer No 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.
responseBasedAfdOriginErrorDetectionSettings object No The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. - ResponseBasedOriginErrorDetectionParameters object
sessionAffinityState enum No Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. - Enabled or Disabled

LoadBalancingSettingsParameters object

Name Type Required Value
sampleSize integer No The number of samples to consider for load balancing decisions
successfulSamplesRequired integer No The number of samples within the sample period that must succeed
additionalLatencyInMilliseconds integer No The additional latency in milliseconds for probes to fall into the lowest latency bucket

HealthProbeParameters object

Name Type Required Value
probePath string No The path relative to the origin that is used to determine the health of the origin.
probeRequestType enum No The type of health probe request that is made. - NotSet, GET, HEAD
probeProtocol enum No Protocol to use for health probe. - NotSet, Http, Https
probeIntervalInSeconds integer No The number of seconds between health probes.Default is 240sec.

ResponseBasedOriginErrorDetectionParameters object

Name Type Required Value
responseBasedDetectedErrorTypes enum No Type of response errors for real user requests for which origin will be deemed unhealthy. - None, TcpErrorsOnly, TcpAndHttpErrors
responseBasedFailoverThresholdPercentage integer No The percentage of failed requests in the sample where failover should trigger.
httpErrorRanges array No The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. - HttpErrorRangeParameters object

HttpErrorRangeParameters object

Name Type Required Value
begin integer No The inclusive start of the http status code range.
end integer No The inclusive end of the http status code range.