Module cdn

cdn

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.
class pulumi_azure.cdn.AwaitableGetProfileResult(location=None, name=None, resource_group_name=None, sku=None, tags=None, id=None)
class pulumi_azure.cdn.Endpoint(resource_name, opts=None, content_types_to_compresses=None, geo_filters=None, is_compression_enabled=None, is_http_allowed=None, is_https_allowed=None, location=None, name=None, optimization_type=None, origins=None, origin_host_header=None, origin_path=None, probe_path=None, profile_name=None, querystring_caching_behaviour=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • content_types_to_compresses (pulumi.Input[list]) – An array of strings that indicates a content types on which compression will be applied. The value for the elements should be MIME types.
  • geo_filters (pulumi.Input[list]) – A set of Geo Filters for this CDN Endpoint. Each geo_filter block supports fields documented below.
  • is_compression_enabled (pulumi.Input[bool]) – Indicates whether compression is to be enabled. Defaults to false.
  • is_http_allowed (pulumi.Input[bool]) – Defaults to true.
  • is_https_allowed (pulumi.Input[bool]) – Defaults to true.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the CDN Endpoint. Changing this forces a new resource to be created.
  • optimization_type (pulumi.Input[str]) – What types of optimization should this CDN Endpoint optimize for? Possible values include DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload and VideoOnDemandMediaStreaming.
  • origins (pulumi.Input[list]) – 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.
  • origin_host_header (pulumi.Input[str]) – The host header CDN provider will send along with content requests to origins. Defaults to the host name of the origin.
  • origin_path (pulumi.Input[str]) – The path used at for origin requests.
  • probe_path (pulumi.Input[str]) – 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.
  • profile_name (pulumi.Input[str]) – The CDN Profile to which to attach the CDN Endpoint.
  • querystring_caching_behaviour (pulumi.Input[str]) – Sets query string caching behavior. Allowed values are IgnoreQueryString, BypassCaching and UseQueryString. Defaults to IgnoreQueryString.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the CDN Endpoint.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
content_types_to_compresses = None

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

geo_filters = None

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

is_compression_enabled = None

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

is_http_allowed = None

Defaults to true.

is_https_allowed = None

Defaults to true.

location = None

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

name = None

Specifies the name of the CDN Endpoint. Changing this forces a new resource to be created.

optimization_type = None

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

origins = None

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.

origin_host_header = None

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

origin_path = None

The path used at for origin requests.

probe_path = None

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.

profile_name = None

The CDN Profile to which to attach the CDN Endpoint.

querystring_caching_behaviour = None

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

resource_group_name = None

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

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, content_types_to_compresses=None, geo_filters=None, host_name=None, is_compression_enabled=None, is_http_allowed=None, is_https_allowed=None, location=None, name=None, optimization_type=None, origins=None, origin_host_header=None, origin_path=None, probe_path=None, profile_name=None, querystring_caching_behaviour=None, resource_group_name=None, tags=None)

Get an existing Endpoint resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] content_types_to_compresses: An array of strings that indicates a content types on which compression will be applied. The value for the elements should be MIME types. :param pulumi.Input[list] geo_filters: A set of Geo Filters for this CDN Endpoint. Each geo_filter block supports fields documented below. :param pulumi.Input[bool] is_compression_enabled: Indicates whether compression is to be enabled. Defaults to false. :param pulumi.Input[bool] is_http_allowed: Defaults to true. :param pulumi.Input[bool] is_https_allowed: Defaults to true. :param pulumi.Input[str] location: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. :param pulumi.Input[str] name: Specifies the name of the CDN Endpoint. Changing this forces a new resource to be created. :param pulumi.Input[str] optimization_type: What types of optimization should this CDN Endpoint optimize for? Possible values include DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload and VideoOnDemandMediaStreaming. :param pulumi.Input[list] 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. :param pulumi.Input[str] origin_host_header: The host header CDN provider will send along with content requests to origins. Defaults to the host name of the origin. :param pulumi.Input[str] origin_path: The path used at for origin requests. :param pulumi.Input[str] probe_path: 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. :param pulumi.Input[str] profile_name: The CDN Profile to which to attach the CDN Endpoint. :param pulumi.Input[str] querystring_caching_behaviour: Sets query string caching behavior. Allowed values are IgnoreQueryString, BypassCaching and UseQueryString. Defaults to IgnoreQueryString. :param pulumi.Input[str] resource_group_name: The name of the resource group in which to create the CDN Endpoint. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.cdn.GetProfileResult(location=None, name=None, resource_group_name=None, sku=None, tags=None, id=None)

A collection of values returned by getProfile.

location = None

The Azure Region where the resource exists.

sku = None

The pricing related information of current CDN profile.

tags = None

A mapping of tags assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.cdn.Profile(resource_name, opts=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manage a CDN Profile to create a collection of CDN Endpoints.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the CDN Profile. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the CDN Profile.
  • sku (pulumi.Input[str]) – The pricing related information of current CDN profile. Accepted values are Standard_Akamai, Standard_ChinaCdn, Standard_Microsoft, Standard_Verizon or Premium_Verizon.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location = None

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

name = None

Specifies the name of the CDN Profile. Changing this forces a new resource to be created.

resource_group_name = None

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

sku = None

The pricing related information of current CDN profile. Accepted values are Standard_Akamai, Standard_ChinaCdn, Standard_Microsoft, Standard_Verizon or Premium_Verizon.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, sku=None, tags=None)

Get an existing Profile resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] location: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. :param pulumi.Input[str] name: Specifies the name of the CDN Profile. Changing this forces a

new resource to be created.
Parameters:
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the CDN Profile.
  • sku (pulumi.Input[str]) – The pricing related information of current CDN profile. Accepted values are Standard_Akamai, Standard_ChinaCdn, Standard_Microsoft, Standard_Verizon or Premium_Verizon.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.cdn.get_profile(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing CDN Profile.