Share via

OriginGroup interface

  • Reference
Package:
@azure/arm-cdn

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

Extends
ProxyResource

Properties

healthProbeSettings

Health probe settings to the origin that is used to determine the health of the origin.
origins

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

Provisioning status of the origin group. NOTE: This property will not be serialized. It can only be populated by the server.
resourceState

Resource status of the origin group. NOTE: This property will not be serialized. It can only be populated by the server.
responseBasedOriginErrorDetectionSettings

The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
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.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Read only system data NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

healthProbeSettings

Health probe settings to the origin that is used to determine the health of the origin.

healthProbeSettings?: HealthProbeParameters

Property Value

HealthProbeParameters

origins

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

origins?: ResourceReference[]

Property Value

ResourceReference[]

provisioningState

Provisioning status of the origin group. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceState

Resource status of the origin group. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

responseBasedOriginErrorDetectionSettings

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

responseBasedOriginErrorDetectionSettings?: ResponseBasedOriginErrorDetectionParameters

Property Value

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.

trafficRestorationTimeToHealedOrNewEndpointsInMinutes?: number

Property Value

number

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Read only system data NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type