EndpointProperties Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201

Assembly:

Az.Cdn.private.dll

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

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.EndpointPropertiesTypeConverter))]
public class EndpointProperties : Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IEndpointProperties, Microsoft.Azure.PowerShell.Cmdlets.Cdn.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.EndpointPropertiesTypeConverter))>]
type EndpointProperties = class
    interface IEndpointProperties
    interface IJsonSerializable
    interface IEndpointPropertiesUpdateParameters
    interface IValidates

Public Class EndpointProperties
Implements IEndpointProperties, IValidates

Inheritance

Object

EndpointProperties

Attributes

TypeConverterAttribute

Implements

IEndpointProperties IEndpointPropertiesUpdateParameters IJsonSerializable IValidates

Constructors

EndpointProperties()

Creates an new EndpointProperties instance.

Properties

ContentTypesToCompress	List of content types on which compression applies. The value should be a valid MIME type.
CustomDomain	The custom domains under the endpoint.
DefaultOriginGroup	A reference to the origin group.
DefaultOriginGroupId	Resource ID.
DeliveryPolicy	A policy that specifies the delivery rules to be used for an endpoint.
DeliveryPolicyDescription	User-friendly description of the policy.
DeliveryPolicyRule	A list of the delivery rules.
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/
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.
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.
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.
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.
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.
ResourceState	Resource status of the endpoint.
UrlSigningKey	List of keys used to validate the signed URL hashes.
WebApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for the endpoint (if applicable)
WebApplicationFirewallPolicyLinkId	Resource ID.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of EndpointProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of EndpointProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IEndpointProperties.
FromJsonString(String)	Creates a new instance of EndpointProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of EndpointProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.