This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.
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(id=None, location=None, name=None, resource_group_name=None, sku=None, tags=None)¶
- class
pulumi_azure.cdn.Endpoint(resource_name, opts=None, content_types_to_compresses=None, delivery_rules=None, geo_filters=None, global_delivery_rule=None, is_compression_enabled=None, is_http_allowed=None, is_https_allowed=None, location=None, name=None, optimization_type=None, origin_host_header=None, origin_path=None, origins=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 behaviours and origins. The CDN Endpoint is exposed using the URL format
.azureedge.net. import pulumi import pulumi_azure as azure example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe") example_profile = azure.cdn.Profile("exampleProfile", location=example_resource_group.location, resource_group_name=example_resource_group.name, sku="Standard_Verizon") example_endpoint = azure.cdn.Endpoint("exampleEndpoint", profile_name=example_profile.name, location=example_resource_group.location, resource_group_name=example_resource_group.name, origin=[{ "name": "example", "host_name": "www.example.com", }])
- 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.
delivery_rules (pulumi.Input[list]) – Rules for the rules engine. An endpoint can contain up until 4 of those rules that consist of conditions and actions. A
delivery_ruleblocks as defined below.geo_filters (pulumi.Input[list]) – A set of Geo Filters for this CDN Endpoint. Each
geo_filterblock supports fields documented below.global_delivery_rule (pulumi.Input[dict]) – Actions that are valid for all resources regardless of any conditions. A
global_delivery_ruleblock as defined 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]) – 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.
optimization_type (pulumi.Input[str]) – What types of optimization should this CDN Endpoint optimize for? Possible values include
DynamicSiteAcceleration,GeneralMediaStreaming,GeneralWebDelivery,LargeFileDownloadandVideoOnDemandMediaStreaming.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.
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
originblock supports fields documented below.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,BypassCachingandUseQueryString. Defaults toIgnoreQueryString.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.
The delivery_rules object supports the following:
cacheExpirationAction(pulumi.Input[dict]) - Acache_expiration_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache. Valid values areBypassCache,OverrideandSetIfMissing.duration(pulumi.Input[str]) - Duration of the cache. Only allowed whenbehavioris set toOverrideorSetIfMissing. Format:[d.]hh:mm:ss
cacheKeyQueryStringAction(pulumi.Input[dict]) - Acache_key_query_string_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache key for query strings. Valid values areExclude,ExcludeAll,IncludeandIncludeAll.parameters(pulumi.Input[str]) - Comma separated list of parameter values.
cookiesConditions(pulumi.Input[list]) - Acookies_conditionblock as defined above.matchValues(pulumi.Input[list]) - List of values for the cookie.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(pulumi.Input[str]) - Name of the cookie.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
deviceCondition(pulumi.Input[dict]) - Adevice_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values areDesktopandMobile.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
httpVersionConditions(pulumi.Input[list]) - Ahttp_version_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values are0.9,1.0,1.1and2.0.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
modifyRequestHeaderActions(pulumi.Input[list]) - Amodify_request_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
modifyResponseHeaderActions(pulumi.Input[list]) - Amodify_response_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
name(pulumi.Input[str]) - The Name which should be used for this Delivery Rule.order(pulumi.Input[float]) - The order used for this rule, which must be larger than 1.postArgConditions(pulumi.Input[list]) - Apost_arg_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(pulumi.Input[str]) - Name of the post arg.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
queryStringConditions(pulumi.Input[list]) - Aquery_string_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
remoteAddressConditions(pulumi.Input[list]) - Aremote_address_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values. ForGeoMatchoperatorthis should be a list of country codes (e.g.USorDE). List of IP address ifoperatorequals toIPMatch.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,GeoMatchandIPMatch.
requestBodyConditions(pulumi.Input[list]) - Arequest_body_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
requestHeaderConditions(pulumi.Input[list]) - Arequest_header_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of header values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(pulumi.Input[str]) - Header name.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
requestMethodCondition(pulumi.Input[dict]) - Arequest_method_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values areDELETE,GET,HEAD,OPTIONS,POSTandPUT.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
requestSchemeCondition(pulumi.Input[dict]) - Arequest_scheme_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values areHTTPandHTTPS.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
requestUriConditions(pulumi.Input[list]) - Arequest_uri_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlFileExtensionConditions(pulumi.Input[list]) - Aurl_file_extension_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlFileNameConditions(pulumi.Input[list]) - Aurl_file_name_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlPathConditions(pulumi.Input[list]) - Aurl_path_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlRedirectAction(pulumi.Input[dict]) - Aurl_redirect_actionblock as defined below.fragment(pulumi.Input[str]) - Specifies the fragment part of the URL. This value must not start with a#.hostname(pulumi.Input[str]) - Specifies the hostname part of the URL.path(pulumi.Input[str]) - Specifies the path part of the URL. This value must begin with a/.protocol(pulumi.Input[str]) - Specifies the protocol part of the URL. Valid values areHttpandHttps.queryString(pulumi.Input[str]) - Specifies the query string part of the URL. This value must not start with a?or&and must be in<key>=<value>format separated by&.redirectType(pulumi.Input[str]) - Type of the redirect. Valid values areFound,Moved,PermanentRedirectandTemporaryRedirect.
urlRewriteAction(pulumi.Input[dict]) - Aurl_rewrite_actionblock as defined below.destination(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.preserveUnmatchedPath(pulumi.Input[bool]) - Defaults totrue.sourcePattern(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.
The geo_filters object supports the following:
action(pulumi.Input[str]) - The Action of the Geo Filter. Possible values includeAllowandBlock.countryCodes(pulumi.Input[list]) - A List of two letter country codes (e.g.US,GB) to be associated with this Geo Filter.relative_path(pulumi.Input[str]) - The relative path applicable to geo filter.
The global_delivery_rule object supports the following:
cacheExpirationAction(pulumi.Input[dict]) - Acache_expiration_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache. Valid values areBypassCache,OverrideandSetIfMissing.duration(pulumi.Input[str]) - Duration of the cache. Only allowed whenbehavioris set toOverrideorSetIfMissing. Format:[d.]hh:mm:ss
cacheKeyQueryStringAction(pulumi.Input[dict]) - Acache_key_query_string_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache key for query strings. Valid values areExclude,ExcludeAll,IncludeandIncludeAll.parameters(pulumi.Input[str]) - Comma separated list of parameter values.
modifyRequestHeaderActions(pulumi.Input[list]) - Amodify_request_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
modifyResponseHeaderActions(pulumi.Input[list]) - Amodify_response_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
urlRedirectAction(pulumi.Input[dict]) - Aurl_redirect_actionblock as defined below.fragment(pulumi.Input[str]) - Specifies the fragment part of the URL. This value must not start with a#.hostname(pulumi.Input[str]) - Specifies the hostname part of the URL.path(pulumi.Input[str]) - Specifies the path part of the URL. This value must begin with a/.protocol(pulumi.Input[str]) - Specifies the protocol part of the URL. Valid values areHttpandHttps.queryString(pulumi.Input[str]) - Specifies the query string part of the URL. This value must not start with a?or&and must be in<key>=<value>format separated by&.redirectType(pulumi.Input[str]) - Type of the redirect. Valid values areFound,Moved,PermanentRedirectandTemporaryRedirect.
urlRewriteAction(pulumi.Input[dict]) - Aurl_rewrite_actionblock as defined below.destination(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.preserveUnmatchedPath(pulumi.Input[bool]) - Defaults totrue.sourcePattern(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.
The origins object supports the following:
host_name(pulumi.Input[str]) - 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.httpPort(pulumi.Input[float]) - The HTTP port of the origin. Defaults to80. Changing this forces a new resource to be created.httpsPort(pulumi.Input[float]) - The HTTPS port of the origin. Defaults to443. Changing this forces a new resource to be created.name(pulumi.Input[str]) - 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.
content_types_to_compresses: pulumi.Output[list] = 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.
delivery_rules: pulumi.Output[list] = None¶Rules for the rules engine. An endpoint can contain up until 4 of those rules that consist of conditions and actions. A
delivery_ruleblocks as defined below.cacheExpirationAction(dict) - Acache_expiration_actionblock as defined above.behavior(str) - The behavior of the cache. Valid values areBypassCache,OverrideandSetIfMissing.duration(str) - Duration of the cache. Only allowed whenbehavioris set toOverrideorSetIfMissing. Format:[d.]hh:mm:ss
cacheKeyQueryStringAction(dict) - Acache_key_query_string_actionblock as defined above.behavior(str) - The behavior of the cache key for query strings. Valid values areExclude,ExcludeAll,IncludeandIncludeAll.parameters(str) - Comma separated list of parameter values.
cookiesConditions(list) - Acookies_conditionblock as defined above.matchValues(list) - List of values for the cookie.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(str) - Name of the cookie.transforms(list) - Valid values areLowercaseandUppercase.
deviceCondition(dict) - Adevice_conditionblock as defined below.matchValues(list) - Valid values areDesktopandMobile.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areEqual.
httpVersionConditions(list) - Ahttp_version_conditionblock as defined below.matchValues(list) - Valid values are0.9,1.0,1.1and2.0.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areEqual.
modifyRequestHeaderActions(list) - Amodify_request_header_actionblock as defined below.action(str) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(str) - The header name.value(str) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
modifyResponseHeaderActions(list) - Amodify_response_header_actionblock as defined below.action(str) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(str) - The header name.value(str) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
name(str) - The Name which should be used for this Delivery Rule.order(float) - The order used for this rule, which must be larger than 1.postArgConditions(list) - Apost_arg_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(str) - Name of the post arg.transforms(list) - Valid values areLowercaseandUppercase.
queryStringConditions(list) - Aquery_string_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(list) - Valid values areLowercaseandUppercase.
remoteAddressConditions(list) - Aremote_address_conditionblock as defined below.matchValues(list) - List of string values. ForGeoMatchoperatorthis should be a list of country codes (e.g.USorDE). List of IP address ifoperatorequals toIPMatch.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,GeoMatchandIPMatch.
requestBodyConditions(list) - Arequest_body_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(list) - Valid values areLowercaseandUppercase.
requestHeaderConditions(list) - Arequest_header_conditionblock as defined below.matchValues(list) - List of header values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(str) - Header name.transforms(list) - Valid values areLowercaseandUppercase.
requestMethodCondition(dict) - Arequest_method_conditionblock as defined below.matchValues(list) - Valid values areDELETE,GET,HEAD,OPTIONS,POSTandPUT.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areEqual.
requestSchemeCondition(dict) - Arequest_scheme_conditionblock as defined below.matchValues(list) - Valid values areHTTPandHTTPS.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areEqual.
requestUriConditions(list) - Arequest_uri_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(list) - Valid values areLowercaseandUppercase.
urlFileExtensionConditions(list) - Aurl_file_extension_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(list) - Valid values areLowercaseandUppercase.
urlFileNameConditions(list) - Aurl_file_name_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(list) - Valid values areLowercaseandUppercase.
urlPathConditions(list) - Aurl_path_conditionblock as defined below.matchValues(list) - List of string values.negateCondition(bool) - Defaults tofalse.operator(str) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(list) - Valid values areLowercaseandUppercase.
urlRedirectAction(dict) - Aurl_redirect_actionblock as defined below.fragment(str) - Specifies the fragment part of the URL. This value must not start with a#.hostname(str) - Specifies the hostname part of the URL.path(str) - Specifies the path part of the URL. This value must begin with a/.protocol(str) - Specifies the protocol part of the URL. Valid values areHttpandHttps.queryString(str) - Specifies the query string part of the URL. This value must not start with a?or&and must be in<key>=<value>format separated by&.redirectType(str) - Type of the redirect. Valid values areFound,Moved,PermanentRedirectandTemporaryRedirect.
urlRewriteAction(dict) - Aurl_rewrite_actionblock as defined below.destination(str) - This value must start with a/and can’t be longer than 260 characters.preserveUnmatchedPath(bool) - Defaults totrue.sourcePattern(str) - This value must start with a/and can’t be longer than 260 characters.
geo_filters: pulumi.Output[list] = None¶A set of Geo Filters for this CDN Endpoint. Each
geo_filterblock supports fields documented below.action(str) - The Action of the Geo Filter. Possible values includeAllowandBlock.countryCodes(list) - A List of two letter country codes (e.g.US,GB) to be associated with this Geo Filter.relative_path(str) - The relative path applicable to geo filter.
global_delivery_rule: pulumi.Output[dict] = None¶Actions that are valid for all resources regardless of any conditions. A
global_delivery_ruleblock as defined below.cacheExpirationAction(dict) - Acache_expiration_actionblock as defined above.behavior(str) - The behavior of the cache. Valid values areBypassCache,OverrideandSetIfMissing.duration(str) - Duration of the cache. Only allowed whenbehavioris set toOverrideorSetIfMissing. Format:[d.]hh:mm:ss
cacheKeyQueryStringAction(dict) - Acache_key_query_string_actionblock as defined above.behavior(str) - The behavior of the cache key for query strings. Valid values areExclude,ExcludeAll,IncludeandIncludeAll.parameters(str) - Comma separated list of parameter values.
modifyRequestHeaderActions(list) - Amodify_request_header_actionblock as defined below.action(str) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(str) - The header name.value(str) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
modifyResponseHeaderActions(list) - Amodify_response_header_actionblock as defined below.action(str) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(str) - The header name.value(str) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
urlRedirectAction(dict) - Aurl_redirect_actionblock as defined below.fragment(str) - Specifies the fragment part of the URL. This value must not start with a#.hostname(str) - Specifies the hostname part of the URL.path(str) - Specifies the path part of the URL. This value must begin with a/.protocol(str) - Specifies the protocol part of the URL. Valid values areHttpandHttps.queryString(str) - Specifies the query string part of the URL. This value must not start with a?or&and must be in<key>=<value>format separated by&.redirectType(str) - Type of the redirect. Valid values areFound,Moved,PermanentRedirectandTemporaryRedirect.
urlRewriteAction(dict) - Aurl_rewrite_actionblock as defined below.destination(str) - This value must start with a/and can’t be longer than 260 characters.preserveUnmatchedPath(bool) - Defaults totrue.sourcePattern(str) - This value must start with a/and can’t be longer than 260 characters.
host_name: pulumi.Output[str] = None¶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.
is_compression_enabled: pulumi.Output[bool] = None¶Indicates whether compression is to be enabled. Defaults to false.
is_http_allowed: pulumi.Output[bool] = None¶Defaults to
true.
is_https_allowed: pulumi.Output[bool] = None¶Defaults to
true.
location: pulumi.Output[str] = None¶Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name: pulumi.Output[str] = None¶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.
optimization_type: pulumi.Output[str] = None¶What types of optimization should this CDN Endpoint optimize for? Possible values include
DynamicSiteAcceleration,GeneralMediaStreaming,GeneralWebDelivery,LargeFileDownloadandVideoOnDemandMediaStreaming.
origin_host_header: pulumi.Output[str] = None¶The host header CDN provider will send along with content requests to origins. Defaults to the host name of the origin.
origin_path: pulumi.Output[str] = None¶The path used at for origin requests.
origins: pulumi.Output[list] = 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
originblock supports fields documented below.host_name(str) - 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.httpPort(float) - The HTTP port of the origin. Defaults to80. Changing this forces a new resource to be created.httpsPort(float) - The HTTPS port of the origin. Defaults to443. Changing this forces a new resource to be created.name(str) - 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.
probe_path: pulumi.Output[str] = 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: pulumi.Output[str] = None¶The CDN Profile to which to attach the CDN Endpoint.
querystring_caching_behaviour: pulumi.Output[str] = None¶Sets query string caching behavior. Allowed values are
IgnoreQueryString,BypassCachingandUseQueryString. Defaults toIgnoreQueryString.
resource_group_name: pulumi.Output[str] = None¶The name of the resource group in which to create the CDN Endpoint.
A mapping of tags to assign to the resource.
- static
get(resource_name, id, opts=None, content_types_to_compresses=None, delivery_rules=None, geo_filters=None, global_delivery_rule=None, host_name=None, is_compression_enabled=None, is_http_allowed=None, is_https_allowed=None, location=None, name=None, optimization_type=None, origin_host_header=None, origin_path=None, origins=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.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
delivery_rules (pulumi.Input[list]) – Rules for the rules engine. An endpoint can contain up until 4 of those rules that consist of conditions and actions. A
delivery_ruleblocks as defined below.geo_filters (pulumi.Input[list]) – A set of Geo Filters for this CDN Endpoint. Each
geo_filterblock supports fields documented below.global_delivery_rule (pulumi.Input[dict]) – Actions that are valid for all resources regardless of any conditions. A
global_delivery_ruleblock as defined below.host_name (pulumi.Input[str]) – 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.
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]) – 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.
optimization_type (pulumi.Input[str]) – What types of optimization should this CDN Endpoint optimize for? Possible values include
DynamicSiteAcceleration,GeneralMediaStreaming,GeneralWebDelivery,LargeFileDownloadandVideoOnDemandMediaStreaming.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.
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
originblock supports fields documented below.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,BypassCachingandUseQueryString. Defaults toIgnoreQueryString.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.
The delivery_rules object supports the following:
cacheExpirationAction(pulumi.Input[dict]) - Acache_expiration_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache. Valid values areBypassCache,OverrideandSetIfMissing.duration(pulumi.Input[str]) - Duration of the cache. Only allowed whenbehavioris set toOverrideorSetIfMissing. Format:[d.]hh:mm:ss
cacheKeyQueryStringAction(pulumi.Input[dict]) - Acache_key_query_string_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache key for query strings. Valid values areExclude,ExcludeAll,IncludeandIncludeAll.parameters(pulumi.Input[str]) - Comma separated list of parameter values.
cookiesConditions(pulumi.Input[list]) - Acookies_conditionblock as defined above.matchValues(pulumi.Input[list]) - List of values for the cookie.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(pulumi.Input[str]) - Name of the cookie.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
deviceCondition(pulumi.Input[dict]) - Adevice_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values areDesktopandMobile.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
httpVersionConditions(pulumi.Input[list]) - Ahttp_version_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values are0.9,1.0,1.1and2.0.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
modifyRequestHeaderActions(pulumi.Input[list]) - Amodify_request_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
modifyResponseHeaderActions(pulumi.Input[list]) - Amodify_response_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
name(pulumi.Input[str]) - The Name which should be used for this Delivery Rule.order(pulumi.Input[float]) - The order used for this rule, which must be larger than 1.postArgConditions(pulumi.Input[list]) - Apost_arg_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(pulumi.Input[str]) - Name of the post arg.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
queryStringConditions(pulumi.Input[list]) - Aquery_string_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
remoteAddressConditions(pulumi.Input[list]) - Aremote_address_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values. ForGeoMatchoperatorthis should be a list of country codes (e.g.USorDE). List of IP address ifoperatorequals toIPMatch.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,GeoMatchandIPMatch.
requestBodyConditions(pulumi.Input[list]) - Arequest_body_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
requestHeaderConditions(pulumi.Input[list]) - Arequest_header_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of header values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.selector(pulumi.Input[str]) - Header name.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
requestMethodCondition(pulumi.Input[dict]) - Arequest_method_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values areDELETE,GET,HEAD,OPTIONS,POSTandPUT.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
requestSchemeCondition(pulumi.Input[dict]) - Arequest_scheme_conditionblock as defined below.matchValues(pulumi.Input[list]) - Valid values areHTTPandHTTPS.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areEqual.
requestUriConditions(pulumi.Input[list]) - Arequest_uri_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlFileExtensionConditions(pulumi.Input[list]) - Aurl_file_extension_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlFileNameConditions(pulumi.Input[list]) - Aurl_file_name_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlPathConditions(pulumi.Input[list]) - Aurl_path_conditionblock as defined below.matchValues(pulumi.Input[list]) - List of string values.negateCondition(pulumi.Input[bool]) - Defaults tofalse.operator(pulumi.Input[str]) - Valid values areAny,BeginsWith,Contains,EndsWith,Equal,GreaterThan,GreaterThanOrEqual,LessThanandLessThanOrEqual.transforms(pulumi.Input[list]) - Valid values areLowercaseandUppercase.
urlRedirectAction(pulumi.Input[dict]) - Aurl_redirect_actionblock as defined below.fragment(pulumi.Input[str]) - Specifies the fragment part of the URL. This value must not start with a#.hostname(pulumi.Input[str]) - Specifies the hostname part of the URL.path(pulumi.Input[str]) - Specifies the path part of the URL. This value must begin with a/.protocol(pulumi.Input[str]) - Specifies the protocol part of the URL. Valid values areHttpandHttps.queryString(pulumi.Input[str]) - Specifies the query string part of the URL. This value must not start with a?or&and must be in<key>=<value>format separated by&.redirectType(pulumi.Input[str]) - Type of the redirect. Valid values areFound,Moved,PermanentRedirectandTemporaryRedirect.
urlRewriteAction(pulumi.Input[dict]) - Aurl_rewrite_actionblock as defined below.destination(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.preserveUnmatchedPath(pulumi.Input[bool]) - Defaults totrue.sourcePattern(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.
The geo_filters object supports the following:
action(pulumi.Input[str]) - The Action of the Geo Filter. Possible values includeAllowandBlock.countryCodes(pulumi.Input[list]) - A List of two letter country codes (e.g.US,GB) to be associated with this Geo Filter.relative_path(pulumi.Input[str]) - The relative path applicable to geo filter.
The global_delivery_rule object supports the following:
cacheExpirationAction(pulumi.Input[dict]) - Acache_expiration_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache. Valid values areBypassCache,OverrideandSetIfMissing.duration(pulumi.Input[str]) - Duration of the cache. Only allowed whenbehavioris set toOverrideorSetIfMissing. Format:[d.]hh:mm:ss
cacheKeyQueryStringAction(pulumi.Input[dict]) - Acache_key_query_string_actionblock as defined above.behavior(pulumi.Input[str]) - The behavior of the cache key for query strings. Valid values areExclude,ExcludeAll,IncludeandIncludeAll.parameters(pulumi.Input[str]) - Comma separated list of parameter values.
modifyRequestHeaderActions(pulumi.Input[list]) - Amodify_request_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
modifyResponseHeaderActions(pulumi.Input[list]) - Amodify_response_header_actionblock as defined below.action(pulumi.Input[str]) - Action to be executed on a header value. Valid values areAppend,DeleteandOverwrite.name(pulumi.Input[str]) - The header name.value(pulumi.Input[str]) - The value of the header. Only needed whenactionis set toAppendoroverwrite.
urlRedirectAction(pulumi.Input[dict]) - Aurl_redirect_actionblock as defined below.fragment(pulumi.Input[str]) - Specifies the fragment part of the URL. This value must not start with a#.hostname(pulumi.Input[str]) - Specifies the hostname part of the URL.path(pulumi.Input[str]) - Specifies the path part of the URL. This value must begin with a/.protocol(pulumi.Input[str]) - Specifies the protocol part of the URL. Valid values areHttpandHttps.queryString(pulumi.Input[str]) - Specifies the query string part of the URL. This value must not start with a?or&and must be in<key>=<value>format separated by&.redirectType(pulumi.Input[str]) - Type of the redirect. Valid values areFound,Moved,PermanentRedirectandTemporaryRedirect.
urlRewriteAction(pulumi.Input[dict]) - Aurl_rewrite_actionblock as defined below.destination(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.preserveUnmatchedPath(pulumi.Input[bool]) - Defaults totrue.sourcePattern(pulumi.Input[str]) - This value must start with a/and can’t be longer than 260 characters.
The origins object supports the following:
host_name(pulumi.Input[str]) - 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.httpPort(pulumi.Input[float]) - The HTTP port of the origin. Defaults to80. Changing this forces a new resource to be created.httpsPort(pulumi.Input[float]) - The HTTPS port of the origin. Defaults to443. Changing this forces a new resource to be created.name(pulumi.Input[str]) - 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.
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(id=None, location=None, name=None, resource_group_name=None, sku=None, tags=None)¶ A collection of values returned by getProfile.
id= None¶The provider-assigned unique ID for this managed resource.
location= None¶The Azure Region where the resource exists.
sku= None¶The pricing related information of current CDN profile.
A mapping of tags assigned to the 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)¶ Manages a CDN Profile to create a collection of CDN Endpoints.
import pulumi import pulumi_azure as azure example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US") example_profile = azure.cdn.Profile("exampleProfile", location="West US", resource_group_name=example_resource_group.name, sku="Standard_Verizon", tags={ "environment": "Production", "cost_center": "MSFT", })
- 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_VerizonorPremium_Verizon.tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location: pulumi.Output[str] = None¶Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name: pulumi.Output[str] = None¶Specifies the name of the CDN Profile. Changing this forces a new resource to be created.
resource_group_name: pulumi.Output[str] = None¶The name of the resource group in which to create the CDN Profile.
sku: pulumi.Output[str] = None¶The pricing related information of current CDN profile. Accepted values are
Standard_Akamai,Standard_ChinaCdn,Standard_Microsoft,Standard_VerizonorPremium_Verizon.
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.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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_VerizonorPremium_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.
import pulumi import pulumi_azure as azure example = azure.cdn.get_profile(name="myfirstcdnprofile", resource_group_name="example-resources") pulumi.export("cdnProfileId", example.id)
- Parameters
name (str) – The name of the CDN Profile.
resource_group_name (str) – The name of the resource group in which the CDN Profile exists.