Class Endpoint

A CDN Endpoint is the entity within a CDN Profile containing configuration information regarding caching behaviours and origins. The CDN Endpoint is exposed using the URL format <endpointname>.azureedge.net.

Inheritance

System.Object

Resource

CustomResource

Endpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Cdn

Assembly: Pulumi.Azure.dll

Syntax

public class Endpoint : CustomResource

Constructors

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration

public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ContentTypesToCompresses

An array of strings that indicates a content types on which compression will be applied. The value for the elements should be MIME types.

Declaration

public Output<ImmutableArray<string>> ContentTypesToCompresses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

DeliveryRules

Rules for the rules engine. An endpoint can contain up until 4 of those rules that consist of conditions and actions. A delivery_rule blocks as defined below.

Declaration

public Output<ImmutableArray<EndpointDeliveryRule>> DeliveryRules { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<EndpointDeliveryRule>>

GeoFilters

A set of Geo Filters for this CDN Endpoint. Each geo_filter block supports fields documented below.

Declaration

public Output<ImmutableArray<EndpointGeoFilter>> GeoFilters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<EndpointGeoFilter>>

GlobalDeliveryRule

Actions that are valid for all resources regardless of any conditions. A global_delivery_rule block as defined below.

Declaration

public Output<EndpointGlobalDeliveryRule> GlobalDeliveryRule { get; }

Property Value

Type	Description
Output<EndpointGlobalDeliveryRule>

HostName

A string that determines the hostname/IP address of the origin server. This string can be a domain name, Storage Account endpoint, Web App endpoint, IPv4 address or IPv6 address. Changing this forces a new resource to be created.

Declaration

public Output<string> HostName { get; }

Property Value

Type	Description
Output<System.String>

IsCompressionEnabled

Indicates whether compression is to be enabled. Defaults to false.

Declaration

public Output<bool?> IsCompressionEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

IsHttpAllowed

Defaults to true.

Declaration

public Output<bool?> IsHttpAllowed { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

IsHttpsAllowed

Defaults to true.

Declaration

public Output<bool?> IsHttpsAllowed { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Location

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the origin. This is an arbitrary value. However, this value needs to be unique under the endpoint. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

OptimizationType

What types of optimization should this CDN Endpoint optimize for? Possible values include DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload and VideoOnDemandMediaStreaming.

Declaration

public Output<string> OptimizationType { get; }

Property Value

Type	Description
Output<System.String>

OriginHostHeader

The host header CDN provider will send along with content requests to origins. Defaults to the host name of the origin.

Declaration

public Output<string> OriginHostHeader { get; }

Property Value

Type	Description
Output<System.String>

OriginPath

The path used at for origin requests.

Declaration

public Output<string> OriginPath { get; }

Property Value

Type	Description
Output<System.String>

Origins

The set of origins of the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. Each origin block supports fields documented below.

Declaration

public Output<ImmutableArray<EndpointOrigin>> Origins { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<EndpointOrigin>>

ProbePath

the 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.

Declaration

public Output<string> ProbePath { get; }

Property Value

Type	Description
Output<System.String>

ProfileName

The CDN Profile to which to attach the CDN Endpoint.

Declaration

public Output<string> ProfileName { get; }

Property Value

Type	Description
Output<System.String>

QuerystringCachingBehaviour

Sets query string caching behavior. Allowed values are IgnoreQueryString, BypassCaching and UseQueryString. Defaults to IgnoreQueryString.

Declaration

public Output<string> QuerystringCachingBehaviour { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the CDN Endpoint.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, EndpointState, CustomResourceOptions)

Get an existing Endpoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Endpoint