Endpoint Class

Definition

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

[Microsoft.Rest.Serialization.JsonTransformation]
public class Endpoint : Microsoft.Azure.Management.Cdn.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Endpoint = class
    inherit TrackedResource
Public Class Endpoint
Inherits TrackedResource
Inheritance
Attributes

Constructors

Endpoint()

Initializes a new instance of the Endpoint class.

Endpoint(String, IList<DeepCreatedOrigin>, String, String, String, SystemData, IDictionary<String,String>, String, IList<String>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<QueryStringCachingBehavior>, String, String, IList<GeoFilter>, ResourceReference, IList<UrlSigningKey>, EndpointPropertiesUpdateParametersDeliveryPolicy, EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink, String, IList<DeepCreatedOriginGroup>, String, String)

Initializes a new instance of the Endpoint class.

Properties

ContentTypesToCompress

Gets or sets list of content types on which compression applies. The value should be a valid MIME type.

DefaultOriginGroup

Gets or sets a reference to the origin group.

DeliveryPolicy

Gets or sets a policy that specifies the delivery rules to be used for an endpoint.

GeoFilters

Gets or sets 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

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

Id

Gets resource ID.

(Inherited from Resource)
IsCompressionEnabled

Gets or sets 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

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

IsHttpsAllowed

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

Location

Gets or sets resource location.

(Inherited from TrackedResource)
Name

Gets resource name.

(Inherited from Resource)
OptimizationType

Gets or sets 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'

OriginGroups

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

OriginHostHeader

Gets or sets 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

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

Origins

Gets or sets the source of the content being delivered via CDN.

ProbePath

Gets or sets 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

Gets provisioning status of the endpoint.

QueryStringCachingBehavior

Gets or sets 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'

ResourceState

Gets resource status of the endpoint. Possible values include: 'Creating', 'Deleting', 'Running', 'Starting', 'Stopped', 'Stopping'

SystemData (Inherited from Resource)
Tags

Gets or sets resource tags.

(Inherited from TrackedResource)
Type

Gets resource type.

(Inherited from Resource)
UrlSigningKeys

Gets or sets list of keys used to validate the signed URL hashes.

WebApplicationFirewallPolicyLink

Gets or sets defines the Web Application Firewall policy for the endpoint (if applicable)

Methods

Validate()

Validate the object.

Applies to