OriginUpdateParameters interface
Origin properties needed for origin update.
Properties
enabled | Origin is enabled for load balancing or not |
host |
The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. |
http |
The value of the HTTP port. Must be between 1 and 65535. |
https |
The value of the HTTPS port. Must be between 1 and 65535. |
origin |
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 |
private |
The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' |
private |
A custom message to be included in the approval request to connect to the Private Link. |
private |
The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated |
private |
The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' |
weight | Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 |
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
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
weight
Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
weight?: number
Property Value
number