Share via

OriginGroup Class

  • Reference

Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.cdn.models._models_py3.ProxyResource
OriginGroup

Constructor

OriginGroup(*, health_probe_settings: _models.HealthProbeParameters | None = None, origins: List[_models.ResourceReference] | None = None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes: int | None = None, response_based_origin_error_detection_settings: _models.ResponseBasedOriginErrorDetectionParameters | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
health_probe_settings
HealthProbeParameters

Health probe settings to the origin that is used to determine the health of the origin.
origins
list[ResourceReference]

The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes
int

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.
response_based_origin_error_detection_settings
ResponseBasedOriginErrorDetectionParameters

The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
system_data
SystemData

Read only system data.
health_probe_settings
HealthProbeParameters

Health probe settings to the origin that is used to determine the health of the origin.
origins
list[ResourceReference]

The source of the content being delivered via CDN within given origin group.
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes
int

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.
response_based_origin_error_detection_settings
ResponseBasedOriginErrorDetectionParameters

The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
resource_state
str or OriginGroupResourceState

Resource status of the origin group. Known values are: "Creating", "Active", and "Deleting".
provisioning_state
str or OriginGroupProvisioningState

Provisioning status of the origin group. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating".