Share via

Origin interface

  • Reference
Package:
@azure/arm-cdn

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Extends
ProxyResource

Properties

enabled

Origin is enabled for load balancing or not
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.
originHostHeader

The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN 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
privateEndpointStatus

The approval status for the connection to the Private Link NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkAlias

The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
privateLinkApprovalMessage

A custom message to be included in the approval request to connect to the Private Link.
privateLinkLocation

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
privateLinkResourceId

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
provisioningState

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

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

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

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

enabled

Origin is enabled for load balancing or not

enabled?: boolean

Property Value

boolean

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

httpPort

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

httpPort?: number

Property Value

number

httpsPort

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

httpsPort?: number

Property Value

number

originHostHeader

The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN 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

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

privateEndpointStatus

The approval status for the connection to the Private Link NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointStatus?: string

Property Value

string

privateLinkAlias

The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'

privateLinkAlias?: string

Property Value

string

privateLinkApprovalMessage

A custom message to be included in the approval request to connect to the Private Link.

privateLinkApprovalMessage?: string

Property Value

string

privateLinkLocation

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated

privateLinkLocation?: string

Property Value

string

privateLinkResourceId

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'

privateLinkResourceId?: string

Property Value

string

provisioningState

Provisioning status of the origin. 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. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

weight

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

weight?: 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