Share via


CdnEndpointData Class

Definition

A class representing the CdnEndpoint data model. 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.

public class CdnEndpointData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Cdn.CdnEndpointData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Cdn.CdnEndpointData>
public class CdnEndpointData : Azure.ResourceManager.Models.TrackedResourceData
type CdnEndpointData = class
    inherit TrackedResourceData
    interface IJsonModel<CdnEndpointData>
    interface IPersistableModel<CdnEndpointData>
type CdnEndpointData = class
    inherit TrackedResourceData
Public Class CdnEndpointData
Inherits TrackedResourceData
Implements IJsonModel(Of CdnEndpointData), IPersistableModel(Of CdnEndpointData)
Public Class CdnEndpointData
Inherits TrackedResourceData
Inheritance
Implements

Constructors

CdnEndpointData(AzureLocation)

Initializes a new instance of CdnEndpointData.

Properties

ContentTypesToCompress

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

DeepCreatedCustomDomains

The custom domains under the endpoint.

DefaultOriginGroupId

Resource ID.

DeliveryPolicy

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

GeoFilters

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

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
Name

The name of the resource.

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

OriginGroups

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.

Origins

The source of the content being delivered via CDN.

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.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
UriSigningKeys

List of keys used to validate the signed URL hashes.

WebApplicationFirewallPolicyLinkId

Resource ID.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<CdnEndpointData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CdnEndpointData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CdnEndpointData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CdnEndpointData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CdnEndpointData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to