Origin Class

  • Reference

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.

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

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

Constructor

Origin(*, host_name: str | None = None, http_port: int | None = None, https_port: int | None = None, origin_host_header: str | None = None, priority: int | None = None, weight: int | None = None, enabled: bool | None = None, private_link_alias: str | None = None, private_link_resource_id: str | None = None, private_link_location: str | None = None, private_link_approval_message: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
host_name
str

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_port
int

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

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

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
int

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.
weight
int

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

Origin is enabled for load balancing or not.
private_link_alias
str

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

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

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

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

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
system_data
SystemData

Read only system data.
host_name
str

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_port
int

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

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

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
int

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.
weight
int

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

Origin is enabled for load balancing or not.
private_link_alias
str

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

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

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

A custom message to be included in the approval request to connect to the Private Link.
resource_state
str or OriginResourceState

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

Provisioning status of the origin. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating".
private_endpoint_status
str or PrivateEndpointStatus

The approval status for the connection to the Private Link. Known values are: "Pending", "Approved", "Rejected", "Disconnected", and "Timeout".