Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cdn
  5. FrontdoorRoute

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

azure.cdn.FrontdoorRoute

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

    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:

    CdnFrontdoorEndpointId string

    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.

    CdnFrontdoorOriginGroupId string

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    CdnFrontdoorOriginIds List<string>

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    PatternsToMatches List<string>

    The route patterns of the rule.

    SupportedProtocols List<string>

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    Cache FrontdoorRouteCache

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    CdnFrontdoorCustomDomainIds List<string>

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    CdnFrontdoorOriginPath string

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    CdnFrontdoorRuleSetIds List<string>

    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 or false. Defaults to true.

    ForwardingProtocol string

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    HttpsRedirectEnabled bool

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    LinkToDefaultDomain bool

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    CdnFrontdoorEndpointId string

    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.

    CdnFrontdoorOriginGroupId string

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    CdnFrontdoorOriginIds []string

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    PatternsToMatches []string

    The route patterns of the rule.

    SupportedProtocols []string

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    Cache FrontdoorRouteCacheArgs

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    CdnFrontdoorCustomDomainIds []string

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    CdnFrontdoorOriginPath string

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    CdnFrontdoorRuleSetIds []string

    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 or false. Defaults to true.

    ForwardingProtocol string

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    HttpsRedirectEnabled bool

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    LinkToDefaultDomain bool

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    cdnFrontdoorEndpointId String

    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.

    cdnFrontdoorOriginGroupId String

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdnFrontdoorOriginIds List<String>

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    patternsToMatches List<String>

    The route patterns of the rule.

    supportedProtocols List<String>

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache FrontdoorRouteCache

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdnFrontdoorCustomDomainIds List<String>

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdnFrontdoorOriginPath String

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdnFrontdoorRuleSetIds List<String>

    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 or false. Defaults to true.

    forwardingProtocol String

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    httpsRedirectEnabled Boolean

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    linkToDefaultDomain Boolean

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    cdnFrontdoorEndpointId string

    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.

    cdnFrontdoorOriginGroupId string

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdnFrontdoorOriginIds string[]

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    patternsToMatches string[]

    The route patterns of the rule.

    supportedProtocols string[]

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache FrontdoorRouteCache

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdnFrontdoorCustomDomainIds string[]

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdnFrontdoorOriginPath string

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdnFrontdoorRuleSetIds string[]

    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 or false. Defaults to true.

    forwardingProtocol string

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    httpsRedirectEnabled boolean

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    linkToDefaultDomain boolean

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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_endpoint_id str

    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_origin_group_id str

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdn_frontdoor_origin_ids Sequence[str]

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    patterns_to_matches Sequence[str]

    The route patterns of the rule.

    supported_protocols Sequence[str]

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache FrontdoorRouteCacheArgs

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdn_frontdoor_custom_domain_ids Sequence[str]

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdn_frontdoor_origin_path str

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdn_frontdoor_rule_set_ids Sequence[str]

    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 or false. Defaults to true.

    forwarding_protocol str

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    https_redirect_enabled bool

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    link_to_default_domain bool

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    cdnFrontdoorEndpointId String

    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.

    cdnFrontdoorOriginGroupId String

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdnFrontdoorOriginIds List<String>

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    patternsToMatches List<String>

    The route patterns of the rule.

    supportedProtocols List<String>

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache Property Map

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdnFrontdoorCustomDomainIds List<String>

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdnFrontdoorOriginPath String

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdnFrontdoorRuleSetIds List<String>

    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 or false. Defaults to true.

    forwardingProtocol String

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    httpsRedirectEnabled Boolean

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    linkToDefaultDomain Boolean

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.
    The following state arguments are supported:
    Cache FrontdoorRouteCache

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    CdnFrontdoorCustomDomainIds List<string>

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    CdnFrontdoorEndpointId string

    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.

    CdnFrontdoorOriginGroupId string

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    CdnFrontdoorOriginIds List<string>

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    CdnFrontdoorOriginPath string

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    CdnFrontdoorRuleSetIds List<string>

    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 or false. Defaults to true.

    ForwardingProtocol string

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    HttpsRedirectEnabled bool

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    LinkToDefaultDomain bool

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    PatternsToMatches List<string>

    The route patterns of the rule.

    SupportedProtocols List<string>

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    Cache FrontdoorRouteCacheArgs

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    CdnFrontdoorCustomDomainIds []string

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    CdnFrontdoorEndpointId string

    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.

    CdnFrontdoorOriginGroupId string

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    CdnFrontdoorOriginIds []string

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    CdnFrontdoorOriginPath string

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    CdnFrontdoorRuleSetIds []string

    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 or false. Defaults to true.

    ForwardingProtocol string

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    HttpsRedirectEnabled bool

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    LinkToDefaultDomain bool

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    PatternsToMatches []string

    The route patterns of the rule.

    SupportedProtocols []string

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache FrontdoorRouteCache

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdnFrontdoorCustomDomainIds List<String>

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdnFrontdoorEndpointId String

    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.

    cdnFrontdoorOriginGroupId String

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdnFrontdoorOriginIds List<String>

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    cdnFrontdoorOriginPath String

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdnFrontdoorRuleSetIds List<String>

    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 or false. Defaults to true.

    forwardingProtocol String

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    httpsRedirectEnabled Boolean

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    linkToDefaultDomain Boolean

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    patternsToMatches List<String>

    The route patterns of the rule.

    supportedProtocols List<String>

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache FrontdoorRouteCache

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdnFrontdoorCustomDomainIds string[]

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdnFrontdoorEndpointId string

    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.

    cdnFrontdoorOriginGroupId string

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdnFrontdoorOriginIds string[]

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    cdnFrontdoorOriginPath string

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdnFrontdoorRuleSetIds string[]

    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 or false. Defaults to true.

    forwardingProtocol string

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    httpsRedirectEnabled boolean

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    linkToDefaultDomain boolean

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    patternsToMatches string[]

    The route patterns of the rule.

    supportedProtocols string[]

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache FrontdoorRouteCacheArgs

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdn_frontdoor_custom_domain_ids Sequence[str]

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdn_frontdoor_endpoint_id str

    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_origin_group_id str

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdn_frontdoor_origin_ids Sequence[str]

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    cdn_frontdoor_origin_path str

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdn_frontdoor_rule_set_ids Sequence[str]

    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 or false. Defaults to true.

    forwarding_protocol str

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    https_redirect_enabled bool

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    link_to_default_domain bool

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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_matches Sequence[str]

    The route patterns of the rule.

    supported_protocols Sequence[str]

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    cache Property Map

    A cache block as defined below.

    NOTE: To disable caching, do not provide the cache block in the configuration file.

    cdnFrontdoorCustomDomainIds List<String>

    The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

    cdnFrontdoorEndpointId String

    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.

    cdnFrontdoorOriginGroupId String

    The resource ID of the Front Door Origin Group where this Front Door Route should be created.

    cdnFrontdoorOriginIds List<String>

    One or more Front Door Origin resource IDs that this Front Door Route will link to.

    cdnFrontdoorOriginPath String

    A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

    cdnFrontdoorRuleSetIds List<String>

    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 or false. Defaults to true.

    forwardingProtocol String

    The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest.

    httpsRedirectEnabled Boolean

    Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

    NOTE: The https_redirect_enabled rule is the first rule that will be executed.

    linkToDefaultDomain Boolean

    Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

    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.

    patternsToMatches List<String>

    The route patterns of the rule.

    supportedProtocols List<String>

    One or more Protocols supported by this Front Door Route. Possible values are Http or Https.

    NOTE: If https_redirect_enabled is set to true the supported_protocols field must contain both Http and Https values.

    Supporting Types

    FrontdoorRouteCache, FrontdoorRouteCacheArgs

    CompressionEnabled bool

    Is content compression enabled? Possible values are true or false. Defaults to false.

    NOTE: Content won't be compressed when the requested content is smaller than 1 KB or larger than 8 MB(inclusive).

    ContentTypesToCompresses List<string>

    A list of one or more Content types (formerly known as MIME types) to compress. Possible values include application/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 or text/x-java-source.

    QueryStringCachingBehavior string

    Defines how the Front Door Route will cache requests that include query strings. Possible values include IgnoreQueryString, IgnoreSpecifiedQueryStrings, IncludeSpecifiedQueryStrings or UseQueryString. Defaults it IgnoreQueryString.

    NOTE: The value of the query_string_caching_behavior determines if the query_strings field will be used as an include list or an ignore list.

    QueryStrings List<string>

    Query strings to include or ignore.

    CompressionEnabled bool

    Is content compression enabled? Possible values are true or false. Defaults to false.

    NOTE: Content won't be compressed when the requested content is smaller than 1 KB or larger than 8 MB(inclusive).

    ContentTypesToCompresses []string

    A list of one or more Content types (formerly known as MIME types) to compress. Possible values include application/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 or text/x-java-source.

    QueryStringCachingBehavior string

    Defines how the Front Door Route will cache requests that include query strings. Possible values include IgnoreQueryString, IgnoreSpecifiedQueryStrings, IncludeSpecifiedQueryStrings or UseQueryString. Defaults it IgnoreQueryString.

    NOTE: The value of the query_string_caching_behavior determines if the query_strings field will be used as an include list or an ignore list.

    QueryStrings []string

    Query strings to include or ignore.

    compressionEnabled Boolean

    Is content compression enabled? Possible values are true or false. Defaults to false.

    NOTE: Content won't be compressed when the requested content is smaller than 1 KB or larger than 8 MB(inclusive).

    contentTypesToCompresses List<String>

    A list of one or more Content types (formerly known as MIME types) to compress. Possible values include application/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 or text/x-java-source.

    queryStringCachingBehavior String

    Defines how the Front Door Route will cache requests that include query strings. Possible values include IgnoreQueryString, IgnoreSpecifiedQueryStrings, IncludeSpecifiedQueryStrings or UseQueryString. Defaults it IgnoreQueryString.

    NOTE: The value of the query_string_caching_behavior determines if the query_strings field will be used as an include list or an ignore list.

    queryStrings List<String>

    Query strings to include or ignore.

    compressionEnabled boolean

    Is content compression enabled? Possible values are true or false. Defaults to false.

    NOTE: Content won't be compressed when the requested content is smaller than 1 KB or larger than 8 MB(inclusive).

    contentTypesToCompresses string[]

    A list of one or more Content types (formerly known as MIME types) to compress. Possible values include application/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 or text/x-java-source.

    queryStringCachingBehavior string

    Defines how the Front Door Route will cache requests that include query strings. Possible values include IgnoreQueryString, IgnoreSpecifiedQueryStrings, IncludeSpecifiedQueryStrings or UseQueryString. Defaults it IgnoreQueryString.

    NOTE: The value of the query_string_caching_behavior determines if the query_strings field will be used as an include list or an ignore list.

    queryStrings string[]

    Query strings to include or ignore.

    compression_enabled bool

    Is content compression enabled? Possible values are true or false. Defaults to false.

    NOTE: Content won't be compressed when the requested content is smaller than 1 KB or larger than 8 MB(inclusive).

    content_types_to_compresses Sequence[str]

    A list of one or more Content types (formerly known as MIME types) to compress. Possible values include application/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 or text/x-java-source.

    query_string_caching_behavior str

    Defines how the Front Door Route will cache requests that include query strings. Possible values include IgnoreQueryString, IgnoreSpecifiedQueryStrings, IncludeSpecifiedQueryStrings or UseQueryString. Defaults it IgnoreQueryString.

    NOTE: The value of the query_string_caching_behavior determines if the query_strings field will be used as an include list or an ignore list.

    query_strings Sequence[str]

    Query strings to include or ignore.

    compressionEnabled Boolean

    Is content compression enabled? Possible values are true or false. Defaults to false.

    NOTE: Content won't be compressed when the requested content is smaller than 1 KB or larger than 8 MB(inclusive).

    contentTypesToCompresses List<String>

    A list of one or more Content types (formerly known as MIME types) to compress. Possible values include application/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 or text/x-java-source.

    queryStringCachingBehavior String

    Defines how the Front Door Route will cache requests that include query strings. Possible values include IgnoreQueryString, IgnoreSpecifiedQueryStrings, IncludeSpecifiedQueryStrings or UseQueryString. Defaults it IgnoreQueryString.

    NOTE: The value of the query_string_caching_behavior determines if the query_strings field will be used as an include list or an ignore list.

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

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
    pulumi/pulumi-azure