Endpoint Class

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format <endpointname>.azureedge.net.

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

All required parameters must be populated in order to send to server.

Inheritance

azure.mgmt.cdn.models._models_py3.TrackedResource

Endpoint

Constructor

Endpoint(*, location: str, tags: Dict[str, str] | None = None, origin_path: str | None = None, content_types_to_compress: List[str] | None = None, origin_host_header: str | None = None, is_compression_enabled: bool | None = None, is_http_allowed: bool = True, is_https_allowed: bool = True, query_string_caching_behavior: str | _models.QueryStringCachingBehavior | None = None, optimization_type: str | _models.OptimizationType | None = None, probe_path: str | None = None, geo_filters: List[_models.GeoFilter] | None = None, default_origin_group: _models.ResourceReference | None = None, url_signing_keys: List[_models.UrlSigningKey] | None = None, delivery_policy: _models.EndpointPropertiesUpdateParametersDeliveryPolicy | None = None, web_application_firewall_policy_link: _models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink | None = None, origins: List[_models.DeepCreatedOrigin] | None = None, origin_groups: List[_models.DeepCreatedOriginGroup] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
origin_path	str A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress	list[str] List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header	str The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.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.
is_compression_enabled	bool Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed	bool Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. Default value: True
is_https_allowed	bool Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. Default value: True
query_string_caching_behavior	str or QueryStringCachingBehavior Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: "IgnoreQueryString", "BypassCaching", "UseQueryString", and "NotSet".
optimization_type	str or OptimizationType Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: "GeneralWebDelivery", "GeneralMediaStreaming", "VideoOnDemandMediaStreaming", "LargeFileDownload", and "DynamicSiteAcceleration".
probe_path	str Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters	list[GeoFilter] List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group	ResourceReference A reference to the origin group.
url_signing_keys	list[UrlSigningKey] List of keys used to validate the signed URL hashes.
delivery_policy	EndpointPropertiesUpdateParametersDeliveryPolicy A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link	EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink Defines the Web Application Firewall policy for the endpoint (if applicable).
origins	list[DeepCreatedOrigin] The source of the content being delivered via CDN.
origin_groups	list[DeepCreatedOriginGroup] The origin groups comprising of origins that are used for load balancing the traffic based on availability.

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
system_data	SystemData Read only system data.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
origin_path	str A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
content_types_to_compress	list[str] List of content types on which compression applies. The value should be a valid MIME type.
origin_host_header	str The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.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.
is_compression_enabled	bool Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
is_http_allowed	bool Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
is_https_allowed	bool Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
query_string_caching_behavior	str or QueryStringCachingBehavior Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Known values are: "IgnoreQueryString", "BypassCaching", "UseQueryString", and "NotSet".
optimization_type	str or OptimizationType Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. Known values are: "GeneralWebDelivery", "GeneralMediaStreaming", "VideoOnDemandMediaStreaming", "LargeFileDownload", and "DynamicSiteAcceleration".
probe_path	str Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
geo_filters	list[GeoFilter] List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
default_origin_group	ResourceReference A reference to the origin group.
url_signing_keys	list[UrlSigningKey] List of keys used to validate the signed URL hashes.
delivery_policy	EndpointPropertiesUpdateParametersDeliveryPolicy A policy that specifies the delivery rules to be used for an endpoint.
web_application_firewall_policy_link	EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink Defines the Web Application Firewall policy for the endpoint (if applicable).
host_name	str The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
origins	list[DeepCreatedOrigin] The source of the content being delivered via CDN.
origin_groups	list[DeepCreatedOriginGroup] The origin groups comprising of origins that are used for load balancing the traffic based on availability.
custom_domains	list[DeepCreatedCustomDomain] The custom domains under the endpoint.
resource_state	str or EndpointResourceState Resource status of the endpoint. Known values are: "Creating", "Deleting", "Running", "Starting", "Stopped", and "Stopping".
provisioning_state	str or EndpointProvisioningState Provisioning status of the endpoint. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating".