Share via


IEndpointProperties Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.EndpointPropertiesTypeConverter))]
public interface IEndpointProperties : Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IEndpointPropertiesUpdateParameters
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.EndpointPropertiesTypeConverter))>]
type IEndpointProperties = interface
    interface IJsonSerializable
    interface IEndpointPropertiesUpdateParameters
Public Interface IEndpointProperties
Implements IEndpointPropertiesUpdateParameters
Derived
Attributes
Implements

Properties

ContentTypesToCompress

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

(Inherited from IEndpointPropertiesUpdateParameters)
CustomDomain

The custom domains under the endpoint.

DefaultOriginGroupId

Resource ID.

(Inherited from IEndpointPropertiesUpdateParameters)
DeliveryPolicyDescription

User-friendly description of the policy.

(Inherited from IEndpointPropertiesUpdateParameters)
DeliveryPolicyRule

A list of the delivery rules.

(Inherited from IEndpointPropertiesUpdateParameters)
GeoFilter

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/

(Inherited from IEndpointPropertiesUpdateParameters)
HostName

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

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.

(Inherited from IEndpointPropertiesUpdateParameters)
IsHttpAllowed

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

(Inherited from IEndpointPropertiesUpdateParameters)
IsHttpsAllowed

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

(Inherited from IEndpointPropertiesUpdateParameters)
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.

(Inherited from IEndpointPropertiesUpdateParameters)
Origin

The source of the content being delivered via CDN.

OriginGroup

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.

(Inherited from IEndpointPropertiesUpdateParameters)
OriginPath

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

(Inherited from IEndpointPropertiesUpdateParameters)
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.

(Inherited from IEndpointPropertiesUpdateParameters)
ProvisioningState

Provisioning status of the endpoint.

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.

(Inherited from IEndpointPropertiesUpdateParameters)
ResourceState

Resource status of the endpoint.

UrlSigningKey

List of keys used to validate the signed URL hashes.

(Inherited from IEndpointPropertiesUpdateParameters)
WebApplicationFirewallPolicyLinkId

Resource ID.

(Inherited from IEndpointPropertiesUpdateParameters)

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to