Endpoint interface

Package:

@azure/arm-cdn

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 .azureedge.net.

Extends

TrackedResource

Properties

contentTypesToCompress	List of content types on which compression applies. The value should be a valid MIME type.
customDomains	The custom domains under the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
defaultOriginGroup	A reference to the origin group.
deliveryPolicy	A policy that specifies the delivery rules to be used for an endpoint.
geoFilters	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/
hostName	The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net NOTE: This property will not be serialized. It can only be populated by the server.
isCompressionEnabled	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.
isHttpAllowed	Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
isHttpsAllowed	Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
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.
originGroups	The origin groups comprising of origins that are used for load balancing the traffic based on availability.
originHostHeader	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.
originPath	A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
origins	The source of the content being delivered via CDN.
probePath	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.
provisioningState	Provisioning status of the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
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.
resourceState	Resource status of the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
urlSigningKeys	List of keys used to validate the signed URL hashes.
webApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for the endpoint (if applicable)

Inherited Properties

id	Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location.
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.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

contentTypesToCompress

List of content types on which compression applies. The value should be a valid MIME type.

contentTypesToCompress?: string[]

Property Value

string[]

customDomains

The custom domains under the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

customDomains?: DeepCreatedCustomDomain[]

Property Value

DeepCreatedCustomDomain[]

defaultOriginGroup

A reference to the origin group.

defaultOriginGroup?: ResourceReference

Property Value

ResourceReference

deliveryPolicy

A policy that specifies the delivery rules to be used for an endpoint.

deliveryPolicy?: EndpointPropertiesUpdateParametersDeliveryPolicy

Property Value

EndpointPropertiesUpdateParametersDeliveryPolicy

geoFilters

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/

geoFilters?: GeoFilter[]

Property Value

GeoFilter[]

hostName

The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

isCompressionEnabled

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.

isCompressionEnabled?: boolean

Property Value

boolean

isHttpAllowed

Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

isHttpAllowed?: boolean

Property Value

boolean

isHttpsAllowed

Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

isHttpsAllowed?: boolean

Property Value

boolean

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.

optimizationType?: string

Property Value

string

originGroups

The origin groups comprising of origins that are used for load balancing the traffic based on availability.

originGroups?: DeepCreatedOriginGroup[]

Property Value

DeepCreatedOriginGroup[]

originHostHeader

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.

originHostHeader?: string

Property Value

string

originPath

A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

originPath?: string

Property Value

string

origins

The source of the content being delivered via CDN.

origins?: DeepCreatedOrigin[]

Property Value

DeepCreatedOrigin[]

probePath

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.

probePath?: string

Property Value

string

provisioningState

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

provisioningState?: string

Property Value

string

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.

queryStringCachingBehavior?: QueryStringCachingBehavior

Property Value

QueryStringCachingBehavior

resourceState

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

resourceState?: string

Property Value

string

urlSigningKeys

List of keys used to validate the signed URL hashes.

urlSigningKeys?: UrlSigningKey[]

Property Value

UrlSigningKey[]

webApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for the endpoint (if applicable)

webApplicationFirewallPolicyLink?: EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink

Property Value

EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink

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 TrackedResource.id

location

Resource location.

location: string

Property Value

string

Inherited From TrackedResource.location

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 TrackedResource.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 TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

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 TrackedResource.type