GetEndpointResult

data class GetEndpointResult(val azureApiVersion: String, val contentTypesToCompress: List<String>? = null, val customDomains: List<DeepCreatedCustomDomainResponse>, val defaultOriginGroup: ResourceReferenceResponse? = null, val deliveryPolicy: EndpointPropertiesUpdateParametersResponseDeliveryPolicy? = null, val geoFilters: List<GeoFilterResponse>? = null, val hostName: String, val id: String, val isCompressionEnabled: Boolean? = null, val isHttpAllowed: Boolean? = null, val isHttpsAllowed: Boolean? = null, val location: String, val name: String, val optimizationType: String? = null, val originGroups: List<DeepCreatedOriginGroupResponse>? = null, val originHostHeader: String? = null, val originPath: String? = null, val origins: List<DeepCreatedOriginResponse>, val probePath: String? = null, val provisioningState: String, val queryStringCachingBehavior: String? = null, val resourceState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val urlSigningKeys: List<UrlSigningKeyResponse>? = null, val webApplicationFirewallPolicyLink: EndpointPropertiesUpdateParametersResponseWebApplicationFirewallPolicyLink? = null)

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.

Constructors

Link copied to clipboard
constructor(azureApiVersion: String, contentTypesToCompress: List<String>? = null, customDomains: List<DeepCreatedCustomDomainResponse>, defaultOriginGroup: ResourceReferenceResponse? = null, deliveryPolicy: EndpointPropertiesUpdateParametersResponseDeliveryPolicy? = null, geoFilters: List<GeoFilterResponse>? = null, hostName: String, id: String, isCompressionEnabled: Boolean? = null, isHttpAllowed: Boolean? = null, isHttpsAllowed: Boolean? = null, location: String, name: String, optimizationType: String? = null, originGroups: List<DeepCreatedOriginGroupResponse>? = null, originHostHeader: String? = null, originPath: String? = null, origins: List<DeepCreatedOriginResponse>, probePath: String? = null, provisioningState: String, queryStringCachingBehavior: String? = null, resourceState: String, systemData: SystemDataResponse, tags: Map<String, String>? = null, type: String, urlSigningKeys: List<UrlSigningKeyResponse>? = null, webApplicationFirewallPolicyLink: EndpointPropertiesUpdateParametersResponseWebApplicationFirewallPolicyLink? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

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

Link copied to clipboard

The custom domains under the endpoint.

Link copied to clipboard

A reference to the origin group.

Link copied to clipboard

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

Link copied to clipboard

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/

Link copied to clipboard

The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net

Link copied to clipboard
val id: String

Resource ID.

Link copied to clipboard

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.

Link copied to clipboard
val isHttpAllowed: Boolean? = null

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

Link copied to clipboard
val isHttpsAllowed: Boolean? = null

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

Link copied to clipboard

Resource location.

Link copied to clipboard

Resource name.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val originPath: String? = null

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

Link copied to clipboard

The source of the content being delivered via CDN.

Link copied to clipboard
val probePath: String? = null

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.

Link copied to clipboard

Provisioning status of the endpoint.

Link copied to clipboard

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.

Link copied to clipboard

Resource status of the endpoint.

Link copied to clipboard

Read only system data

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard

Resource type.

Link copied to clipboard

List of keys used to validate the signed URL hashes.

Link copied to clipboard

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