Endpoint Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.EndpointTypeConverter))]
public class Endpoint : Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IEndpoint, Microsoft.Azure.PowerShell.Cmdlets.Cdn.Runtime.IHeaderSerializable, Microsoft.Azure.PowerShell.Cmdlets.Cdn.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.EndpointTypeConverter))>]
type Endpoint = class
interface IEndpoint
interface IJsonSerializable
interface ITrackedResource
interface IResource
interface IValidates
interface IHeaderSerializable
Public Class Endpoint
Implements IEndpoint, IHeaderSerializable, IValidates
- Inheritance
-
Endpoint
- Attributes
- Implements
Constructors
Endpoint() |
Creates an new Endpoint 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. |
DefaultOriginGroupId |
Resource ID. |
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 |
Id |
Resource ID. |
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. |
Location |
Resource location. |
Name |
Resource name. |
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. |
ResourceGroupName |
Gets the resource group name |
ResourceState |
Resource status of the endpoint. |
SystemData |
Read only system data |
SystemDataCreatedAt |
The timestamp of resource creation (UTC) |
SystemDataCreatedBy |
An identifier for the identity that created the resource |
SystemDataCreatedByType |
The type of identity that created the resource |
SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) |
SystemDataLastModifiedBy |
An identifier for the identity that last modified the resource |
SystemDataLastModifiedByType |
The type of identity that last modified the resource |
Tag |
Resource tags. |
Type |
Resource type. |
UrlSigningKey |
List of keys used to validate the signed URL hashes. |
WebApplicationFirewallPolicyLinkId |
Resource ID. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of Endpoint. |
DeserializeFromPSObject(PSObject) | |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IEndpoint. |
FromJsonString(String) |
Creates a new instance of Endpoint, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) | |
ToJsonString() |
Serializes this instance to a json string. |
ToString() | |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |
Explicit Interface Implementations
IHeaderSerializable.ReadHeaders(HttpResponseHeaders) |