EndpointProperties Class

Reference

The JSON object that contains the properties required to create an endpoint.

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 Azure.

Inheritance: azure.mgmt.cdn.models._models_py3.EndpointPropertiesUpdateParameters

EndpointProperties

Constructor

EndpointProperties(*, origins: List[azure.mgmt.cdn.models._models_py3.DeepCreatedOrigin], origin_path: Optional[str] = None, content_types_to_compress: Optional[List[str]] = None, origin_host_header: Optional[str] = None, is_compression_enabled: Optional[bool] = None, is_http_allowed: Optional[bool] = None, is_https_allowed: Optional[bool] = None, query_string_caching_behavior: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.QueryStringCachingBehavior]] = None, optimization_type: Optional[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.OptimizationType]] = None, probe_path: Optional[str] = None, geo_filters: Optional[List[azure.mgmt.cdn.models._models_py3.GeoFilter]] = None, default_origin_group: Optional[azure.mgmt.cdn.models._models_py3.ResourceReference] = None, url_signing_keys: Optional[List[azure.mgmt.cdn.models._models_py3.UrlSigningKey]] = None, delivery_policy: Optional[azure.mgmt.cdn.models._models_py3.EndpointPropertiesUpdateParametersDeliveryPolicy] = None, web_application_firewall_policy_link: Optional[azure.mgmt.cdn.models._models_py3.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink] = None, origin_groups: Optional[List[azure.mgmt.cdn.models._models_py3.DeepCreatedOriginGroup]] = None, **kwargs)

Variables

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: <xref:is_http_allowed>)<xref: >(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: <xref:is_https_allowed>)<xref: >(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. Possible values include: "IgnoreQueryString", "BypassCaching", "UseQueryString", "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. Possible values include: "GeneralWebDelivery", "GeneralMediaStreaming", "VideoOnDemandMediaStreaming", "LargeFileDownload", "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/.