EndpointPropertiesUpdateParameters interface
The JSON object containing endpoint update parameters.
Properties
| content |
List of content types on which compression applies. The value should be a valid MIME type. |
| default |
A reference to the origin group. |
| delivery |
A policy that specifies the delivery rules to be used for an endpoint. |
| geo |
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/ |
| is |
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 |
Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. |
| is |
Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. |
| optimization |
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. |
| origin |
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. |
| origin |
A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. |
| probe |
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. |
| query |
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. |
| url |
List of keys used to validate the signed URL hashes. |
| web |
Defines the Web Application Firewall policy for the endpoint (if applicable) |
Property Details
contentTypesToCompress
List of content types on which compression applies. The value should be a valid MIME type.
contentTypesToCompress?: string[]Property Value
string[]
defaultOriginGroup
A reference to the origin group.
defaultOriginGroup?: ResourceReferenceProperty Value
deliveryPolicy
A policy that specifies the delivery rules to be used for an endpoint.
deliveryPolicy?: EndpointPropertiesUpdateParametersDeliveryPolicyProperty Value
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
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?: booleanProperty 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?: booleanProperty 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?: booleanProperty 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?: stringProperty Value
string
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?: stringProperty Value
string
originPath
A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
originPath?: stringProperty Value
string
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?: stringProperty 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?: QueryStringCachingBehaviorProperty Value
urlSigningKeys
List of keys used to validate the signed URL hashes.
urlSigningKeys?: UrlSigningKey[]Property Value
webApplicationFirewallPolicyLink
Defines the Web Application Firewall policy for the endpoint (if applicable)
webApplicationFirewallPolicyLink?: EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink