AFDOriginProperties interface

The JSON object that contains the properties of the origin.

Extends

Inherited Properties

azureOrigin

Resource reference to the Azure origin resource.

deploymentStatus

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

enabledState

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.

enforceCertificateNameCheck

Whether to enable certificate name check at origin level

hostName

The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.

httpPort

The value of the HTTP port. Must be between 1 and 65535.

httpsPort

The value of the HTTPS port. Must be between 1 and 65535.

originGroupName

The name of the origin group which contains this origin. NOTE: This property will not be serialized. It can only be populated by the server.

originHostHeader

The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint

priority

Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5

provisioningState

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

sharedPrivateLinkResource

The properties of the private link resource for private origin.

weight

Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

Inherited Property Details

azureOrigin

Resource reference to the Azure origin resource.

azureOrigin?: ResourceReference

Property Value

Inherited From AFDOriginUpdatePropertiesParameters.azureOrigin

deploymentStatus

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

deploymentStatus?: string

Property Value

string

Inherited From AFDStateProperties.deploymentStatus

enabledState

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.

enabledState?: string

Property Value

string

Inherited From AFDOriginUpdatePropertiesParameters.enabledState

enforceCertificateNameCheck

Whether to enable certificate name check at origin level

enforceCertificateNameCheck?: boolean

Property Value

boolean

Inherited From AFDOriginUpdatePropertiesParameters.enforceCertificateNameCheck

hostName

The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.

hostName?: string

Property Value

string

Inherited From AFDOriginUpdatePropertiesParameters.hostName

httpPort

The value of the HTTP port. Must be between 1 and 65535.

httpPort?: number

Property Value

number

Inherited From AFDOriginUpdatePropertiesParameters.httpPort

httpsPort

The value of the HTTPS port. Must be between 1 and 65535.

httpsPort?: number

Property Value

number

Inherited From AFDOriginUpdatePropertiesParameters.httpsPort

originGroupName

The name of the origin group which contains this origin. NOTE: This property will not be serialized. It can only be populated by the server.

originGroupName?: string

Property Value

string

Inherited From AFDOriginUpdatePropertiesParameters.originGroupName

originHostHeader

The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint

originHostHeader?: string

Property Value

string

Inherited From AFDOriginUpdatePropertiesParameters.originHostHeader

priority

Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5

priority?: number

Property Value

number

Inherited From AFDOriginUpdatePropertiesParameters.priority

provisioningState

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

provisioningState?: string

Property Value

string

Inherited From AFDStateProperties.provisioningState

sharedPrivateLinkResource

The properties of the private link resource for private origin.

sharedPrivateLinkResource?: SharedPrivateLinkResourceProperties

Property Value

Inherited From AFDOriginUpdatePropertiesParameters.sharedPrivateLinkResource

weight

Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

weight?: number

Property Value

number

Inherited From AFDOriginUpdatePropertiesParameters.weight