EndpointProperties interface

Package:

@azure/arm-cdn

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

Extends

EndpointPropertiesUpdateParameters

Properties

customDomains	The custom domains under the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
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.
originGroups	The origin groups comprising of origins that are used for load balancing the traffic based on availability.
origins	The source of the content being delivered via CDN.
provisioningState	Provisioning status of the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
resourceState	Resource status of the endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

contentTypesToCompress	List of content types on which compression applies. The value should be a valid MIME type.
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/
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.
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.
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.
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.
urlSigningKeys	List of keys used to validate the signed URL hashes.
webApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for the endpoint (if applicable)

Property Details

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[]

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

originGroups

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

originGroups?: DeepCreatedOriginGroup[]

Property Value

DeepCreatedOriginGroup[]

origins

The source of the content being delivered via CDN.

origins: DeepCreatedOrigin[]

Property Value

DeepCreatedOrigin[]

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

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

Inherited Property Details

contentTypesToCompress

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

contentTypesToCompress?: string[]

Property Value

string[]

Inherited From EndpointPropertiesUpdateParameters.contentTypesToCompress

defaultOriginGroup

A reference to the origin group.

defaultOriginGroup?: ResourceReference

Property Value

ResourceReference

Inherited From EndpointPropertiesUpdateParameters.defaultOriginGroup

deliveryPolicy

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

deliveryPolicy?: EndpointPropertiesUpdateParametersDeliveryPolicy

Property Value

EndpointPropertiesUpdateParametersDeliveryPolicy

Inherited From EndpointPropertiesUpdateParameters.deliveryPolicy

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[]

Inherited From EndpointPropertiesUpdateParameters.geoFilters

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

Inherited From EndpointPropertiesUpdateParameters.isCompressionEnabled

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

Inherited From EndpointPropertiesUpdateParameters.isHttpAllowed

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

Inherited From EndpointPropertiesUpdateParameters.isHttpsAllowed

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

Inherited From EndpointPropertiesUpdateParameters.optimizationType

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

Inherited From EndpointPropertiesUpdateParameters.originHostHeader

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

Inherited From EndpointPropertiesUpdateParameters.originPath

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

Inherited From EndpointPropertiesUpdateParameters.probePath

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

Inherited From EndpointPropertiesUpdateParameters.queryStringCachingBehavior

urlSigningKeys

List of keys used to validate the signed URL hashes.

urlSigningKeys?: UrlSigningKey[]

Property Value

UrlSigningKey[]

Inherited From EndpointPropertiesUpdateParameters.urlSigningKeys

webApplicationFirewallPolicyLink

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

webApplicationFirewallPolicyLink?: EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink

Property Value

EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink

Inherited From EndpointPropertiesUpdateParameters.webApplicationFirewallPolicyLink