We recommend using Azure Native.
azure.cdn.FrontdoorRoute
Explore with Pulumi AI
Manages a Front Door (standard/premium) Route.
Create FrontdoorRoute Resource
new FrontdoorRoute(name: string, args: FrontdoorRouteArgs, opts?: CustomResourceOptions);
@overload
def FrontdoorRoute(resource_name: str,
opts: Optional[ResourceOptions] = None,
cache: Optional[FrontdoorRouteCacheArgs] = None,
cdn_frontdoor_custom_domain_ids: Optional[Sequence[str]] = None,
cdn_frontdoor_endpoint_id: Optional[str] = None,
cdn_frontdoor_origin_group_id: Optional[str] = None,
cdn_frontdoor_origin_ids: Optional[Sequence[str]] = None,
cdn_frontdoor_origin_path: Optional[str] = None,
cdn_frontdoor_rule_set_ids: Optional[Sequence[str]] = None,
enabled: Optional[bool] = None,
forwarding_protocol: Optional[str] = None,
https_redirect_enabled: Optional[bool] = None,
link_to_default_domain: Optional[bool] = None,
name: Optional[str] = None,
patterns_to_matches: Optional[Sequence[str]] = None,
supported_protocols: Optional[Sequence[str]] = None)
@overload
def FrontdoorRoute(resource_name: str,
args: FrontdoorRouteArgs,
opts: Optional[ResourceOptions] = None)
func NewFrontdoorRoute(ctx *Context, name string, args FrontdoorRouteArgs, opts ...ResourceOption) (*FrontdoorRoute, error)
public FrontdoorRoute(string name, FrontdoorRouteArgs args, CustomResourceOptions? opts = null)
public FrontdoorRoute(String name, FrontdoorRouteArgs args)
public FrontdoorRoute(String name, FrontdoorRouteArgs args, CustomResourceOptions options)
type: azure:cdn:FrontdoorRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FrontdoorRouteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FrontdoorRouteArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FrontdoorRouteArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FrontdoorRouteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FrontdoorRouteArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
FrontdoorRoute Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The FrontdoorRoute resource accepts the following input properties:
- Cdn
Frontdoor stringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- Cdn
Frontdoor stringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- Cdn
Frontdoor List<string>Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- Patterns
To List<string>Matches The route patterns of the rule.
- Supported
Protocols List<string> One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.- Cache
Frontdoor
Route Cache A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- Cdn
Frontdoor List<string>Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- Cdn
Frontdoor stringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- Cdn
Frontdoor List<string>Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- Enabled bool
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- Forwarding
Protocol string The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- Https
Redirect boolEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- Link
To boolDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- Name string
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- Cdn
Frontdoor stringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- Cdn
Frontdoor stringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- Cdn
Frontdoor []stringOrigin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- Patterns
To []stringMatches The route patterns of the rule.
- Supported
Protocols []string One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.- Cache
Frontdoor
Route Cache Args A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- Cdn
Frontdoor []stringCustom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- Cdn
Frontdoor stringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- Cdn
Frontdoor []stringRule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- Enabled bool
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- Forwarding
Protocol string The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- Https
Redirect boolEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- Link
To boolDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- Name string
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor StringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor StringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn
Frontdoor List<String>Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- patterns
To List<String>Matches The route patterns of the rule.
- supported
Protocols List<String> One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.- cache
Frontdoor
Route Cache A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn
Frontdoor List<String>Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn
Frontdoor StringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn
Frontdoor List<String>Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled Boolean
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding
Protocol String The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https
Redirect BooleanEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link
To BooleanDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name String
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor stringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor stringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn
Frontdoor string[]Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- patterns
To string[]Matches The route patterns of the rule.
- supported
Protocols string[] One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.- cache
Frontdoor
Route Cache A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn
Frontdoor string[]Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn
Frontdoor stringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn
Frontdoor string[]Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled boolean
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding
Protocol string The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https
Redirect booleanEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link
To booleanDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name string
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- cdn_
frontdoor_ strendpoint_ id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn_
frontdoor_ strorigin_ group_ id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn_
frontdoor_ Sequence[str]origin_ ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- patterns_
to_ Sequence[str]matches The route patterns of the rule.
- supported_
protocols Sequence[str] One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.- cache
Frontdoor
Route Cache Args A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn_
frontdoor_ Sequence[str]custom_ domain_ ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn_
frontdoor_ strorigin_ path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn_
frontdoor_ Sequence[str]rule_ set_ ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled bool
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding_
protocol str The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https_
redirect_ boolenabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link_
to_ booldefault_ domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name str
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor StringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor StringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn
Frontdoor List<String>Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- patterns
To List<String>Matches The route patterns of the rule.
- supported
Protocols List<String> One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.- cache Property Map
A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn
Frontdoor List<String>Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn
Frontdoor StringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn
Frontdoor List<String>Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled Boolean
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding
Protocol String The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https
Redirect BooleanEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link
To BooleanDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name String
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the FrontdoorRoute resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing FrontdoorRoute Resource
Get an existing FrontdoorRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FrontdoorRouteState, opts?: CustomResourceOptions): FrontdoorRoute
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cache: Optional[FrontdoorRouteCacheArgs] = None,
cdn_frontdoor_custom_domain_ids: Optional[Sequence[str]] = None,
cdn_frontdoor_endpoint_id: Optional[str] = None,
cdn_frontdoor_origin_group_id: Optional[str] = None,
cdn_frontdoor_origin_ids: Optional[Sequence[str]] = None,
cdn_frontdoor_origin_path: Optional[str] = None,
cdn_frontdoor_rule_set_ids: Optional[Sequence[str]] = None,
enabled: Optional[bool] = None,
forwarding_protocol: Optional[str] = None,
https_redirect_enabled: Optional[bool] = None,
link_to_default_domain: Optional[bool] = None,
name: Optional[str] = None,
patterns_to_matches: Optional[Sequence[str]] = None,
supported_protocols: Optional[Sequence[str]] = None) -> FrontdoorRoute
func GetFrontdoorRoute(ctx *Context, name string, id IDInput, state *FrontdoorRouteState, opts ...ResourceOption) (*FrontdoorRoute, error)
public static FrontdoorRoute Get(string name, Input<string> id, FrontdoorRouteState? state, CustomResourceOptions? opts = null)
public static FrontdoorRoute get(String name, Output<String> id, FrontdoorRouteState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cache
Frontdoor
Route Cache A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- Cdn
Frontdoor List<string>Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- Cdn
Frontdoor stringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- Cdn
Frontdoor stringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- Cdn
Frontdoor List<string>Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- Cdn
Frontdoor stringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- Cdn
Frontdoor List<string>Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- Enabled bool
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- Forwarding
Protocol string The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- Https
Redirect boolEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- Link
To boolDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- Name string
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- Patterns
To List<string>Matches The route patterns of the rule.
- Supported
Protocols List<string> One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.
- Cache
Frontdoor
Route Cache Args A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- Cdn
Frontdoor []stringCustom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- Cdn
Frontdoor stringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- Cdn
Frontdoor stringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- Cdn
Frontdoor []stringOrigin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- Cdn
Frontdoor stringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- Cdn
Frontdoor []stringRule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- Enabled bool
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- Forwarding
Protocol string The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- Https
Redirect boolEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- Link
To boolDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- Name string
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- Patterns
To []stringMatches The route patterns of the rule.
- Supported
Protocols []string One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.
- cache
Frontdoor
Route Cache A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn
Frontdoor List<String>Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn
Frontdoor StringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor StringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn
Frontdoor List<String>Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- cdn
Frontdoor StringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn
Frontdoor List<String>Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled Boolean
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding
Protocol String The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https
Redirect BooleanEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link
To BooleanDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name String
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- patterns
To List<String>Matches The route patterns of the rule.
- supported
Protocols List<String> One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.
- cache
Frontdoor
Route Cache A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn
Frontdoor string[]Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn
Frontdoor stringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor stringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn
Frontdoor string[]Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- cdn
Frontdoor stringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn
Frontdoor string[]Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled boolean
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding
Protocol string The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https
Redirect booleanEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link
To booleanDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name string
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- patterns
To string[]Matches The route patterns of the rule.
- supported
Protocols string[] One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.
- cache
Frontdoor
Route Cache Args A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn_
frontdoor_ Sequence[str]custom_ domain_ ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn_
frontdoor_ strendpoint_ id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn_
frontdoor_ strorigin_ group_ id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn_
frontdoor_ Sequence[str]origin_ ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- cdn_
frontdoor_ strorigin_ path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn_
frontdoor_ Sequence[str]rule_ set_ ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled bool
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding_
protocol str The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https_
redirect_ boolenabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link_
to_ booldefault_ domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name str
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- patterns_
to_ Sequence[str]matches The route patterns of the rule.
- supported_
protocols Sequence[str] One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.
- cache Property Map
A
cache
block as defined below.NOTE: To disable caching, do not provide the
cache
block in the configuration file.- cdn
Frontdoor List<String>Custom Domain Ids The IDs of the Front Door Custom Domains which are associated with this Front Door Route.
- cdn
Frontdoor StringEndpoint Id The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.
- cdn
Frontdoor StringOrigin Group Id The resource ID of the Front Door Origin Group where this Front Door Route should be created.
- cdn
Frontdoor List<String>Origin Ids One or more Front Door Origin resource IDs that this Front Door Route will link to.
- cdn
Frontdoor StringOrigin Path A directory path on the Front Door Origin that can be used to retrieve content (e.g.
contoso.cloudapp.net/originpath
).- cdn
Frontdoor List<String>Rule Set Ids A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.
- enabled Boolean
Is this Front Door Route enabled? Possible values are
true
orfalse
. Defaults totrue
.- forwarding
Protocol String The Protocol that will be use when forwarding traffic to backends. Possible values are
HttpOnly
,HttpsOnly
orMatchRequest
.- https
Redirect BooleanEnabled Automatically redirect HTTP traffic to HTTPS traffic? Possible values are
true
orfalse
. Defaults totrue
.NOTE: The
https_redirect_enabled
rule is the first rule that will be executed.- link
To BooleanDefault Domain Should this Front Door Route be linked to the default endpoint? Possible values include
true
orfalse
. Defaults totrue
.- name String
The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.
- patterns
To List<String>Matches The route patterns of the rule.
- supported
Protocols List<String> One or more Protocols supported by this Front Door Route. Possible values are
Http
orHttps
.NOTE: If
https_redirect_enabled
is set totrue
thesupported_protocols
field must contain bothHttp
andHttps
values.
Supporting Types
FrontdoorRouteCache, FrontdoorRouteCacheArgs
- Compression
Enabled bool Is content compression enabled? Possible values are
true
orfalse
. Defaults tofalse
.NOTE: Content won't be compressed when the requested content is smaller than
1 KB
or larger than8 MB
(inclusive).- Content
Types List<string>To Compresses A list of one or more
Content types
(formerly known asMIME types
) to compress. Possible values includeapplication/eot
,application/font
,application/font-sfnt
,application/javascript
,application/json
,application/opentype
,application/otf
,application/pkcs7-mime
,application/truetype
,application/ttf
,application/vnd.ms-fontobject
,application/xhtml+xml
,application/xml
,application/xml+rss
,application/x-font-opentype
,application/x-font-truetype
,application/x-font-ttf
,application/x-httpd-cgi
,application/x-mpegurl
,application/x-opentype
,application/x-otf
,application/x-perl
,application/x-ttf
,application/x-javascript
,font/eot
,font/ttf
,font/otf
,font/opentype
,image/svg+xml
,text/css
,text/csv
,text/html
,text/javascript
,text/js
,text/plain
,text/richtext
,text/tab-separated-values
,text/xml
,text/x-script
,text/x-component
ortext/x-java-source
.- Query
String stringCaching Behavior Defines how the Front Door Route will cache requests that include query strings. Possible values include
IgnoreQueryString
,IgnoreSpecifiedQueryStrings
,IncludeSpecifiedQueryStrings
orUseQueryString
. Defaults itIgnoreQueryString
.NOTE: The value of the
query_string_caching_behavior
determines if thequery_strings
field will be used as an include list or an ignore list.- Query
Strings List<string> Query strings to include or ignore.
- Compression
Enabled bool Is content compression enabled? Possible values are
true
orfalse
. Defaults tofalse
.NOTE: Content won't be compressed when the requested content is smaller than
1 KB
or larger than8 MB
(inclusive).- Content
Types []stringTo Compresses A list of one or more
Content types
(formerly known asMIME types
) to compress. Possible values includeapplication/eot
,application/font
,application/font-sfnt
,application/javascript
,application/json
,application/opentype
,application/otf
,application/pkcs7-mime
,application/truetype
,application/ttf
,application/vnd.ms-fontobject
,application/xhtml+xml
,application/xml
,application/xml+rss
,application/x-font-opentype
,application/x-font-truetype
,application/x-font-ttf
,application/x-httpd-cgi
,application/x-mpegurl
,application/x-opentype
,application/x-otf
,application/x-perl
,application/x-ttf
,application/x-javascript
,font/eot
,font/ttf
,font/otf
,font/opentype
,image/svg+xml
,text/css
,text/csv
,text/html
,text/javascript
,text/js
,text/plain
,text/richtext
,text/tab-separated-values
,text/xml
,text/x-script
,text/x-component
ortext/x-java-source
.- Query
String stringCaching Behavior Defines how the Front Door Route will cache requests that include query strings. Possible values include
IgnoreQueryString
,IgnoreSpecifiedQueryStrings
,IncludeSpecifiedQueryStrings
orUseQueryString
. Defaults itIgnoreQueryString
.NOTE: The value of the
query_string_caching_behavior
determines if thequery_strings
field will be used as an include list or an ignore list.- Query
Strings []string Query strings to include or ignore.
- compression
Enabled Boolean Is content compression enabled? Possible values are
true
orfalse
. Defaults tofalse
.NOTE: Content won't be compressed when the requested content is smaller than
1 KB
or larger than8 MB
(inclusive).- content
Types List<String>To Compresses A list of one or more
Content types
(formerly known asMIME types
) to compress. Possible values includeapplication/eot
,application/font
,application/font-sfnt
,application/javascript
,application/json
,application/opentype
,application/otf
,application/pkcs7-mime
,application/truetype
,application/ttf
,application/vnd.ms-fontobject
,application/xhtml+xml
,application/xml
,application/xml+rss
,application/x-font-opentype
,application/x-font-truetype
,application/x-font-ttf
,application/x-httpd-cgi
,application/x-mpegurl
,application/x-opentype
,application/x-otf
,application/x-perl
,application/x-ttf
,application/x-javascript
,font/eot
,font/ttf
,font/otf
,font/opentype
,image/svg+xml
,text/css
,text/csv
,text/html
,text/javascript
,text/js
,text/plain
,text/richtext
,text/tab-separated-values
,text/xml
,text/x-script
,text/x-component
ortext/x-java-source
.- query
String StringCaching Behavior Defines how the Front Door Route will cache requests that include query strings. Possible values include
IgnoreQueryString
,IgnoreSpecifiedQueryStrings
,IncludeSpecifiedQueryStrings
orUseQueryString
. Defaults itIgnoreQueryString
.NOTE: The value of the
query_string_caching_behavior
determines if thequery_strings
field will be used as an include list or an ignore list.- query
Strings List<String> Query strings to include or ignore.
- compression
Enabled boolean Is content compression enabled? Possible values are
true
orfalse
. Defaults tofalse
.NOTE: Content won't be compressed when the requested content is smaller than
1 KB
or larger than8 MB
(inclusive).- content
Types string[]To Compresses A list of one or more
Content types
(formerly known asMIME types
) to compress. Possible values includeapplication/eot
,application/font
,application/font-sfnt
,application/javascript
,application/json
,application/opentype
,application/otf
,application/pkcs7-mime
,application/truetype
,application/ttf
,application/vnd.ms-fontobject
,application/xhtml+xml
,application/xml
,application/xml+rss
,application/x-font-opentype
,application/x-font-truetype
,application/x-font-ttf
,application/x-httpd-cgi
,application/x-mpegurl
,application/x-opentype
,application/x-otf
,application/x-perl
,application/x-ttf
,application/x-javascript
,font/eot
,font/ttf
,font/otf
,font/opentype
,image/svg+xml
,text/css
,text/csv
,text/html
,text/javascript
,text/js
,text/plain
,text/richtext
,text/tab-separated-values
,text/xml
,text/x-script
,text/x-component
ortext/x-java-source
.- query
String stringCaching Behavior Defines how the Front Door Route will cache requests that include query strings. Possible values include
IgnoreQueryString
,IgnoreSpecifiedQueryStrings
,IncludeSpecifiedQueryStrings
orUseQueryString
. Defaults itIgnoreQueryString
.NOTE: The value of the
query_string_caching_behavior
determines if thequery_strings
field will be used as an include list or an ignore list.- query
Strings string[] Query strings to include or ignore.
- compression_
enabled bool Is content compression enabled? Possible values are
true
orfalse
. Defaults tofalse
.NOTE: Content won't be compressed when the requested content is smaller than
1 KB
or larger than8 MB
(inclusive).- content_
types_ Sequence[str]to_ compresses A list of one or more
Content types
(formerly known asMIME types
) to compress. Possible values includeapplication/eot
,application/font
,application/font-sfnt
,application/javascript
,application/json
,application/opentype
,application/otf
,application/pkcs7-mime
,application/truetype
,application/ttf
,application/vnd.ms-fontobject
,application/xhtml+xml
,application/xml
,application/xml+rss
,application/x-font-opentype
,application/x-font-truetype
,application/x-font-ttf
,application/x-httpd-cgi
,application/x-mpegurl
,application/x-opentype
,application/x-otf
,application/x-perl
,application/x-ttf
,application/x-javascript
,font/eot
,font/ttf
,font/otf
,font/opentype
,image/svg+xml
,text/css
,text/csv
,text/html
,text/javascript
,text/js
,text/plain
,text/richtext
,text/tab-separated-values
,text/xml
,text/x-script
,text/x-component
ortext/x-java-source
.- query_
string_ strcaching_ behavior Defines how the Front Door Route will cache requests that include query strings. Possible values include
IgnoreQueryString
,IgnoreSpecifiedQueryStrings
,IncludeSpecifiedQueryStrings
orUseQueryString
. Defaults itIgnoreQueryString
.NOTE: The value of the
query_string_caching_behavior
determines if thequery_strings
field will be used as an include list or an ignore list.- query_
strings Sequence[str] Query strings to include or ignore.
- compression
Enabled Boolean Is content compression enabled? Possible values are
true
orfalse
. Defaults tofalse
.NOTE: Content won't be compressed when the requested content is smaller than
1 KB
or larger than8 MB
(inclusive).- content
Types List<String>To Compresses A list of one or more
Content types
(formerly known asMIME types
) to compress. Possible values includeapplication/eot
,application/font
,application/font-sfnt
,application/javascript
,application/json
,application/opentype
,application/otf
,application/pkcs7-mime
,application/truetype
,application/ttf
,application/vnd.ms-fontobject
,application/xhtml+xml
,application/xml
,application/xml+rss
,application/x-font-opentype
,application/x-font-truetype
,application/x-font-ttf
,application/x-httpd-cgi
,application/x-mpegurl
,application/x-opentype
,application/x-otf
,application/x-perl
,application/x-ttf
,application/x-javascript
,font/eot
,font/ttf
,font/otf
,font/opentype
,image/svg+xml
,text/css
,text/csv
,text/html
,text/javascript
,text/js
,text/plain
,text/richtext
,text/tab-separated-values
,text/xml
,text/x-script
,text/x-component
ortext/x-java-source
.- query
String StringCaching Behavior Defines how the Front Door Route will cache requests that include query strings. Possible values include
IgnoreQueryString
,IgnoreSpecifiedQueryStrings
,IncludeSpecifiedQueryStrings
orUseQueryString
. Defaults itIgnoreQueryString
.NOTE: The value of the
query_string_caching_behavior
determines if thequery_strings
field will be used as an include list or an ignore list.- query
Strings List<String> Query strings to include or ignore.
Import
Front Door Routes can be imported using the resource id
, e.g.
$ pulumi import azure:cdn/frontdoorRoute:FrontdoorRoute example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.