azure-native.cdn.Route
Explore with Pulumi AI
Friendly Routes name mapping to the any Routes or secret related information. Azure REST API version: 2023-05-01. Prior API version in Azure Native 1.x: 2020-09-01.
Other available API versions: 2020-09-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01.
Example Usage
Routes_Create
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var route = new AzureNative.Cdn.Route("route", new()
    {
        CacheConfiguration = new AzureNative.Cdn.Inputs.AfdRouteCacheConfigurationArgs
        {
            CompressionSettings = new AzureNative.Cdn.Inputs.CompressionSettingsArgs
            {
                ContentTypesToCompress = new[]
                {
                    "text/html",
                    "application/octet-stream",
                },
                IsCompressionEnabled = true,
            },
            QueryParameters = "querystring=test",
            QueryStringCachingBehavior = AzureNative.Cdn.AfdQueryStringCachingBehavior.IgnoreSpecifiedQueryStrings,
        },
        CustomDomains = new[]
        {
            new AzureNative.Cdn.Inputs.ActivatedResourceReferenceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1",
            },
        },
        EnabledState = AzureNative.Cdn.EnabledState.Enabled,
        EndpointName = "endpoint1",
        ForwardingProtocol = AzureNative.Cdn.ForwardingProtocol.MatchRequest,
        HttpsRedirect = AzureNative.Cdn.HttpsRedirect.Enabled,
        LinkToDefaultDomain = AzureNative.Cdn.LinkToDefaultDomain.Enabled,
        OriginGroup = new AzureNative.Cdn.Inputs.ResourceReferenceArgs
        {
            Id = "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1",
        },
        PatternsToMatch = new[]
        {
            "/*",
        },
        ProfileName = "profile1",
        ResourceGroupName = "RG",
        RouteName = "route1",
        RuleSets = new[]
        {
            new AzureNative.Cdn.Inputs.ResourceReferenceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1",
            },
        },
        SupportedProtocols = new[]
        {
            AzureNative.Cdn.AFDEndpointProtocols.Https,
            AzureNative.Cdn.AFDEndpointProtocols.Http,
        },
    });
});
package main
import (
	cdn "github.com/pulumi/pulumi-azure-native-sdk/cdn/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cdn.NewRoute(ctx, "route", &cdn.RouteArgs{
			CacheConfiguration: &cdn.AfdRouteCacheConfigurationArgs{
				CompressionSettings: &cdn.CompressionSettingsArgs{
					ContentTypesToCompress: pulumi.StringArray{
						pulumi.String("text/html"),
						pulumi.String("application/octet-stream"),
					},
					IsCompressionEnabled: pulumi.Bool(true),
				},
				QueryParameters:            pulumi.String("querystring=test"),
				QueryStringCachingBehavior: pulumi.String(cdn.AfdQueryStringCachingBehaviorIgnoreSpecifiedQueryStrings),
			},
			CustomDomains: cdn.ActivatedResourceReferenceArray{
				&cdn.ActivatedResourceReferenceArgs{
					Id: pulumi.String("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"),
				},
			},
			EnabledState:        pulumi.String(cdn.EnabledStateEnabled),
			EndpointName:        pulumi.String("endpoint1"),
			ForwardingProtocol:  pulumi.String(cdn.ForwardingProtocolMatchRequest),
			HttpsRedirect:       pulumi.String(cdn.HttpsRedirectEnabled),
			LinkToDefaultDomain: pulumi.String(cdn.LinkToDefaultDomainEnabled),
			OriginGroup: &cdn.ResourceReferenceArgs{
				Id: pulumi.String("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"),
			},
			PatternsToMatch: pulumi.StringArray{
				pulumi.String("/*"),
			},
			ProfileName:       pulumi.String("profile1"),
			ResourceGroupName: pulumi.String("RG"),
			RouteName:         pulumi.String("route1"),
			RuleSets: cdn.ResourceReferenceArray{
				&cdn.ResourceReferenceArgs{
					Id: pulumi.String("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"),
				},
			},
			SupportedProtocols: pulumi.StringArray{
				pulumi.String(cdn.AFDEndpointProtocolsHttps),
				pulumi.String(cdn.AFDEndpointProtocolsHttp),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cdn.Route;
import com.pulumi.azurenative.cdn.RouteArgs;
import com.pulumi.azurenative.cdn.inputs.AfdRouteCacheConfigurationArgs;
import com.pulumi.azurenative.cdn.inputs.CompressionSettingsArgs;
import com.pulumi.azurenative.cdn.inputs.ActivatedResourceReferenceArgs;
import com.pulumi.azurenative.cdn.inputs.ResourceReferenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var route = new Route("route", RouteArgs.builder()
            .cacheConfiguration(AfdRouteCacheConfigurationArgs.builder()
                .compressionSettings(CompressionSettingsArgs.builder()
                    .contentTypesToCompress(                    
                        "text/html",
                        "application/octet-stream")
                    .isCompressionEnabled(true)
                    .build())
                .queryParameters("querystring=test")
                .queryStringCachingBehavior("IgnoreSpecifiedQueryStrings")
                .build())
            .customDomains(ActivatedResourceReferenceArgs.builder()
                .id("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1")
                .build())
            .enabledState("Enabled")
            .endpointName("endpoint1")
            .forwardingProtocol("MatchRequest")
            .httpsRedirect("Enabled")
            .linkToDefaultDomain("Enabled")
            .originGroup(ResourceReferenceArgs.builder()
                .id("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1")
                .build())
            .patternsToMatch("/*")
            .profileName("profile1")
            .resourceGroupName("RG")
            .routeName("route1")
            .ruleSets(ResourceReferenceArgs.builder()
                .id("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1")
                .build())
            .supportedProtocols(            
                "Https",
                "Http")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const route = new azure_native.cdn.Route("route", {
    cacheConfiguration: {
        compressionSettings: {
            contentTypesToCompress: [
                "text/html",
                "application/octet-stream",
            ],
            isCompressionEnabled: true,
        },
        queryParameters: "querystring=test",
        queryStringCachingBehavior: azure_native.cdn.AfdQueryStringCachingBehavior.IgnoreSpecifiedQueryStrings,
    },
    customDomains: [{
        id: "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1",
    }],
    enabledState: azure_native.cdn.EnabledState.Enabled,
    endpointName: "endpoint1",
    forwardingProtocol: azure_native.cdn.ForwardingProtocol.MatchRequest,
    httpsRedirect: azure_native.cdn.HttpsRedirect.Enabled,
    linkToDefaultDomain: azure_native.cdn.LinkToDefaultDomain.Enabled,
    originGroup: {
        id: "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1",
    },
    patternsToMatch: ["/*"],
    profileName: "profile1",
    resourceGroupName: "RG",
    routeName: "route1",
    ruleSets: [{
        id: "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1",
    }],
    supportedProtocols: [
        azure_native.cdn.AFDEndpointProtocols.Https,
        azure_native.cdn.AFDEndpointProtocols.Http,
    ],
});
import pulumi
import pulumi_azure_native as azure_native
route = azure_native.cdn.Route("route",
    cache_configuration={
        "compression_settings": {
            "content_types_to_compress": [
                "text/html",
                "application/octet-stream",
            ],
            "is_compression_enabled": True,
        },
        "query_parameters": "querystring=test",
        "query_string_caching_behavior": azure_native.cdn.AfdQueryStringCachingBehavior.IGNORE_SPECIFIED_QUERY_STRINGS,
    },
    custom_domains=[{
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1",
    }],
    enabled_state=azure_native.cdn.EnabledState.ENABLED,
    endpoint_name="endpoint1",
    forwarding_protocol=azure_native.cdn.ForwardingProtocol.MATCH_REQUEST,
    https_redirect=azure_native.cdn.HttpsRedirect.ENABLED,
    link_to_default_domain=azure_native.cdn.LinkToDefaultDomain.ENABLED,
    origin_group={
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1",
    },
    patterns_to_match=["/*"],
    profile_name="profile1",
    resource_group_name="RG",
    route_name="route1",
    rule_sets=[{
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1",
    }],
    supported_protocols=[
        azure_native.cdn.AFDEndpointProtocols.HTTPS,
        azure_native.cdn.AFDEndpointProtocols.HTTP,
    ])
resources:
  route:
    type: azure-native:cdn:Route
    properties:
      cacheConfiguration:
        compressionSettings:
          contentTypesToCompress:
            - text/html
            - application/octet-stream
          isCompressionEnabled: true
        queryParameters: querystring=test
        queryStringCachingBehavior: IgnoreSpecifiedQueryStrings
      customDomains:
        - id: /subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1
      enabledState: Enabled
      endpointName: endpoint1
      forwardingProtocol: MatchRequest
      httpsRedirect: Enabled
      linkToDefaultDomain: Enabled
      originGroup:
        id: /subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1
      patternsToMatch:
        - /*
      profileName: profile1
      resourceGroupName: RG
      routeName: route1
      ruleSets:
        - id: /subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1
      supportedProtocols:
        - Https
        - Http
Create Route Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Route(name: string, args: RouteArgs, opts?: CustomResourceOptions);@overload
def Route(resource_name: str,
          args: RouteArgs,
          opts: Optional[ResourceOptions] = None)
@overload
def Route(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          origin_group: Optional[ResourceReferenceArgs] = None,
          resource_group_name: Optional[str] = None,
          profile_name: Optional[str] = None,
          endpoint_name: Optional[str] = None,
          link_to_default_domain: Optional[Union[str, LinkToDefaultDomain]] = None,
          https_redirect: Optional[Union[str, HttpsRedirect]] = None,
          cache_configuration: Optional[AfdRouteCacheConfigurationArgs] = None,
          forwarding_protocol: Optional[Union[str, ForwardingProtocol]] = None,
          origin_path: Optional[str] = None,
          patterns_to_match: Optional[Sequence[str]] = None,
          enabled_state: Optional[Union[str, EnabledState]] = None,
          custom_domains: Optional[Sequence[ActivatedResourceReferenceArgs]] = None,
          route_name: Optional[str] = None,
          rule_sets: Optional[Sequence[ResourceReferenceArgs]] = None,
          supported_protocols: Optional[Sequence[Union[str, AFDEndpointProtocols]]] = None)func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)type: azure-native:cdn:Route
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RouteArgs
- 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 RouteArgs
- 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 RouteArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RouteArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var routeResource = new AzureNative.Cdn.Route("routeResource", new()
{
    OriginGroup = new AzureNative.Cdn.Inputs.ResourceReferenceArgs
    {
        Id = "string",
    },
    ResourceGroupName = "string",
    ProfileName = "string",
    EndpointName = "string",
    LinkToDefaultDomain = "string",
    HttpsRedirect = "string",
    CacheConfiguration = new AzureNative.Cdn.Inputs.AfdRouteCacheConfigurationArgs
    {
        CompressionSettings = new AzureNative.Cdn.Inputs.CompressionSettingsArgs
        {
            ContentTypesToCompress = new[]
            {
                "string",
            },
            IsCompressionEnabled = false,
        },
        QueryParameters = "string",
        QueryStringCachingBehavior = "string",
    },
    ForwardingProtocol = "string",
    OriginPath = "string",
    PatternsToMatch = new[]
    {
        "string",
    },
    EnabledState = "string",
    CustomDomains = new[]
    {
        new AzureNative.Cdn.Inputs.ActivatedResourceReferenceArgs
        {
            Id = "string",
        },
    },
    RouteName = "string",
    RuleSets = new[]
    {
        new AzureNative.Cdn.Inputs.ResourceReferenceArgs
        {
            Id = "string",
        },
    },
    SupportedProtocols = new[]
    {
        "string",
    },
});
example, err := cdn.NewRoute(ctx, "routeResource", &cdn.RouteArgs{
	OriginGroup: &cdn.ResourceReferenceArgs{
		Id: pulumi.String("string"),
	},
	ResourceGroupName:   pulumi.String("string"),
	ProfileName:         pulumi.String("string"),
	EndpointName:        pulumi.String("string"),
	LinkToDefaultDomain: pulumi.String("string"),
	HttpsRedirect:       pulumi.String("string"),
	CacheConfiguration: &cdn.AfdRouteCacheConfigurationArgs{
		CompressionSettings: &cdn.CompressionSettingsArgs{
			ContentTypesToCompress: pulumi.StringArray{
				pulumi.String("string"),
			},
			IsCompressionEnabled: pulumi.Bool(false),
		},
		QueryParameters:            pulumi.String("string"),
		QueryStringCachingBehavior: pulumi.String("string"),
	},
	ForwardingProtocol: pulumi.String("string"),
	OriginPath:         pulumi.String("string"),
	PatternsToMatch: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnabledState: pulumi.String("string"),
	CustomDomains: cdn.ActivatedResourceReferenceArray{
		&cdn.ActivatedResourceReferenceArgs{
			Id: pulumi.String("string"),
		},
	},
	RouteName: pulumi.String("string"),
	RuleSets: cdn.ResourceReferenceArray{
		&cdn.ResourceReferenceArgs{
			Id: pulumi.String("string"),
		},
	},
	SupportedProtocols: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var routeResource = new Route("routeResource", RouteArgs.builder()
    .originGroup(ResourceReferenceArgs.builder()
        .id("string")
        .build())
    .resourceGroupName("string")
    .profileName("string")
    .endpointName("string")
    .linkToDefaultDomain("string")
    .httpsRedirect("string")
    .cacheConfiguration(AfdRouteCacheConfigurationArgs.builder()
        .compressionSettings(CompressionSettingsArgs.builder()
            .contentTypesToCompress("string")
            .isCompressionEnabled(false)
            .build())
        .queryParameters("string")
        .queryStringCachingBehavior("string")
        .build())
    .forwardingProtocol("string")
    .originPath("string")
    .patternsToMatch("string")
    .enabledState("string")
    .customDomains(ActivatedResourceReferenceArgs.builder()
        .id("string")
        .build())
    .routeName("string")
    .ruleSets(ResourceReferenceArgs.builder()
        .id("string")
        .build())
    .supportedProtocols("string")
    .build());
route_resource = azure_native.cdn.Route("routeResource",
    origin_group={
        "id": "string",
    },
    resource_group_name="string",
    profile_name="string",
    endpoint_name="string",
    link_to_default_domain="string",
    https_redirect="string",
    cache_configuration={
        "compression_settings": {
            "content_types_to_compress": ["string"],
            "is_compression_enabled": False,
        },
        "query_parameters": "string",
        "query_string_caching_behavior": "string",
    },
    forwarding_protocol="string",
    origin_path="string",
    patterns_to_match=["string"],
    enabled_state="string",
    custom_domains=[{
        "id": "string",
    }],
    route_name="string",
    rule_sets=[{
        "id": "string",
    }],
    supported_protocols=["string"])
const routeResource = new azure_native.cdn.Route("routeResource", {
    originGroup: {
        id: "string",
    },
    resourceGroupName: "string",
    profileName: "string",
    endpointName: "string",
    linkToDefaultDomain: "string",
    httpsRedirect: "string",
    cacheConfiguration: {
        compressionSettings: {
            contentTypesToCompress: ["string"],
            isCompressionEnabled: false,
        },
        queryParameters: "string",
        queryStringCachingBehavior: "string",
    },
    forwardingProtocol: "string",
    originPath: "string",
    patternsToMatch: ["string"],
    enabledState: "string",
    customDomains: [{
        id: "string",
    }],
    routeName: "string",
    ruleSets: [{
        id: "string",
    }],
    supportedProtocols: ["string"],
});
type: azure-native:cdn:Route
properties:
    cacheConfiguration:
        compressionSettings:
            contentTypesToCompress:
                - string
            isCompressionEnabled: false
        queryParameters: string
        queryStringCachingBehavior: string
    customDomains:
        - id: string
    enabledState: string
    endpointName: string
    forwardingProtocol: string
    httpsRedirect: string
    linkToDefaultDomain: string
    originGroup:
        id: string
    originPath: string
    patternsToMatch:
        - string
    profileName: string
    resourceGroupName: string
    routeName: string
    ruleSets:
        - id: string
    supportedProtocols:
        - string
Route Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Route resource accepts the following input properties:
- EndpointName string
- Name of the endpoint under the profile which is unique globally.
- OriginGroup Pulumi.Azure Native. Cdn. Inputs. Resource Reference 
- A reference to the origin group.
- ProfileName string
- Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- ResourceGroup stringName 
- Name of the Resource group within the Azure subscription.
- CacheConfiguration Pulumi.Azure Native. Cdn. Inputs. Afd Route Cache Configuration 
- The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- CustomDomains List<Pulumi.Azure Native. Cdn. Inputs. Activated Resource Reference> 
- Domains referenced by this endpoint.
- EnabledState string | Pulumi.Azure Native. Cdn. Enabled State 
- Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- ForwardingProtocol string | Pulumi.Azure Native. Cdn. Forwarding Protocol 
- Protocol this rule will use when forwarding traffic to backends.
- HttpsRedirect string | Pulumi.Azure Native. Cdn. Https Redirect 
- Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
- LinkTo string | Pulumi.Default Domain Azure Native. Cdn. Link To Default Domain 
- whether this route will be linked to the default endpoint domain.
- OriginPath string
- A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- PatternsTo List<string>Match 
- The route patterns of the rule.
- RouteName string
- Name of the routing rule.
- RuleSets List<Pulumi.Azure Native. Cdn. Inputs. Resource Reference> 
- rule sets referenced by this endpoint.
- SupportedProtocols List<Union<string, Pulumi.Azure Native. Cdn. AFDEndpoint Protocols>> 
- List of supported protocols for this route.
- EndpointName string
- Name of the endpoint under the profile which is unique globally.
- OriginGroup ResourceReference Args 
- A reference to the origin group.
- ProfileName string
- Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- ResourceGroup stringName 
- Name of the Resource group within the Azure subscription.
- CacheConfiguration AfdRoute Cache Configuration Args 
- The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- CustomDomains []ActivatedResource Reference Args 
- Domains referenced by this endpoint.
- EnabledState string | EnabledState 
- Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- ForwardingProtocol string | ForwardingProtocol 
- Protocol this rule will use when forwarding traffic to backends.
- HttpsRedirect string | HttpsRedirect 
- Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
- LinkTo string | LinkDefault Domain To Default Domain 
- whether this route will be linked to the default endpoint domain.
- OriginPath string
- A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- PatternsTo []stringMatch 
- The route patterns of the rule.
- RouteName string
- Name of the routing rule.
- RuleSets []ResourceReference Args 
- rule sets referenced by this endpoint.
- SupportedProtocols []string
- List of supported protocols for this route.
- endpointName String
- Name of the endpoint under the profile which is unique globally.
- originGroup ResourceReference 
- A reference to the origin group.
- profileName String
- Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resourceGroup StringName 
- Name of the Resource group within the Azure subscription.
- cacheConfiguration AfdRoute Cache Configuration 
- The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- customDomains List<ActivatedResource Reference> 
- Domains referenced by this endpoint.
- enabledState String | EnabledState 
- Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwardingProtocol String | ForwardingProtocol 
- Protocol this rule will use when forwarding traffic to backends.
- httpsRedirect String | HttpsRedirect 
- Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
- linkTo String | LinkDefault Domain To Default Domain 
- whether this route will be linked to the default endpoint domain.
- originPath String
- A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patternsTo List<String>Match 
- The route patterns of the rule.
- routeName String
- Name of the routing rule.
- ruleSets List<ResourceReference> 
- rule sets referenced by this endpoint.
- supportedProtocols List<Either<String,AFDEndpointProtocols>> 
- List of supported protocols for this route.
- endpointName string
- Name of the endpoint under the profile which is unique globally.
- originGroup ResourceReference 
- A reference to the origin group.
- profileName string
- Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resourceGroup stringName 
- Name of the Resource group within the Azure subscription.
- cacheConfiguration AfdRoute Cache Configuration 
- The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- customDomains ActivatedResource Reference[] 
- Domains referenced by this endpoint.
- enabledState string | EnabledState 
- Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwardingProtocol string | ForwardingProtocol 
- Protocol this rule will use when forwarding traffic to backends.
- httpsRedirect string | HttpsRedirect 
- Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
- linkTo string | LinkDefault Domain To Default Domain 
- whether this route will be linked to the default endpoint domain.
- originPath string
- A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patternsTo string[]Match 
- The route patterns of the rule.
- routeName string
- Name of the routing rule.
- ruleSets ResourceReference[] 
- rule sets referenced by this endpoint.
- supportedProtocols (string | AFDEndpointProtocols)[] 
- List of supported protocols for this route.
- endpoint_name str
- Name of the endpoint under the profile which is unique globally.
- origin_group ResourceReference Args 
- A reference to the origin group.
- profile_name str
- Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource_group_ strname 
- Name of the Resource group within the Azure subscription.
- cache_configuration AfdRoute Cache Configuration Args 
- The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- custom_domains Sequence[ActivatedResource Reference Args] 
- Domains referenced by this endpoint.
- enabled_state str | EnabledState 
- Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwarding_protocol str | ForwardingProtocol 
- Protocol this rule will use when forwarding traffic to backends.
- https_redirect str | HttpsRedirect 
- Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
- link_to_ str | Linkdefault_ domain To Default Domain 
- whether this route will be linked to the default endpoint domain.
- origin_path str
- A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patterns_to_ Sequence[str]match 
- The route patterns of the rule.
- route_name str
- Name of the routing rule.
- rule_sets Sequence[ResourceReference Args] 
- rule sets referenced by this endpoint.
- supported_protocols Sequence[Union[str, AFDEndpointProtocols]] 
- List of supported protocols for this route.
- endpointName String
- Name of the endpoint under the profile which is unique globally.
- originGroup Property Map
- A reference to the origin group.
- profileName String
- Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resourceGroup StringName 
- Name of the Resource group within the Azure subscription.
- cacheConfiguration Property Map
- The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- customDomains List<Property Map>
- Domains referenced by this endpoint.
- enabledState String | "Enabled" | "Disabled"
- Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwardingProtocol String | "HttpOnly" | "Https Only" | "Match Request" 
- Protocol this rule will use when forwarding traffic to backends.
- httpsRedirect String | "Enabled" | "Disabled"
- Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
- linkTo String | "Enabled" | "Disabled"Default Domain 
- whether this route will be linked to the default endpoint domain.
- originPath String
- A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patternsTo List<String>Match 
- The route patterns of the rule.
- routeName String
- Name of the routing rule.
- ruleSets List<Property Map>
- rule sets referenced by this endpoint.
- supportedProtocols List<String | "Http" | "Https">
- List of supported protocols for this route.
Outputs
All input properties are implicitly available as output properties. Additionally, the Route resource produces the following output properties:
- DeploymentStatus string
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- ProvisioningState string
- Provisioning status
- SystemData Pulumi.Azure Native. Cdn. Outputs. System Data Response 
- Read only system data
- Type string
- Resource type.
- DeploymentStatus string
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- ProvisioningState string
- Provisioning status
- SystemData SystemData Response 
- Read only system data
- Type string
- Resource type.
- deploymentStatus String
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioningState String
- Provisioning status
- systemData SystemData Response 
- Read only system data
- type String
- Resource type.
- deploymentStatus string
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name.
- provisioningState string
- Provisioning status
- systemData SystemData Response 
- Read only system data
- type string
- Resource type.
- deployment_status str
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name.
- provisioning_state str
- Provisioning status
- system_data SystemData Response 
- Read only system data
- type str
- Resource type.
- deploymentStatus String
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioningState String
- Provisioning status
- systemData Property Map
- Read only system data
- type String
- Resource type.
Supporting Types
AFDEndpointProtocols, AFDEndpointProtocolsArgs    
- Http
- Http
- Https
- Https
- AFDEndpointProtocols Http 
- Http
- AFDEndpointProtocols Https 
- Https
- Http
- Http
- Https
- Https
- Http
- Http
- Https
- Https
- HTTP
- Http
- HTTPS
- Https
- "Http"
- Http
- "Https"
- Https
ActivatedResourceReference, ActivatedResourceReferenceArgs      
- Id string
- Resource ID.
- Id string
- Resource ID.
- id String
- Resource ID.
- id string
- Resource ID.
- id str
- Resource ID.
- id String
- Resource ID.
ActivatedResourceReferenceResponse, ActivatedResourceReferenceResponseArgs        
AfdQueryStringCachingBehavior, AfdQueryStringCachingBehaviorArgs          
- IgnoreQuery String 
- IgnoreQueryString
- UseQuery String 
- UseQueryString
- IgnoreSpecified Query Strings 
- IgnoreSpecifiedQueryStrings
- IncludeSpecified Query Strings 
- IncludeSpecifiedQueryStrings
- AfdQuery String Caching Behavior Ignore Query String 
- IgnoreQueryString
- AfdQuery String Caching Behavior Use Query String 
- UseQueryString
- AfdQuery String Caching Behavior Ignore Specified Query Strings 
- IgnoreSpecifiedQueryStrings
- AfdQuery String Caching Behavior Include Specified Query Strings 
- IncludeSpecifiedQueryStrings
- IgnoreQuery String 
- IgnoreQueryString
- UseQuery String 
- UseQueryString
- IgnoreSpecified Query Strings 
- IgnoreSpecifiedQueryStrings
- IncludeSpecified Query Strings 
- IncludeSpecifiedQueryStrings
- IgnoreQuery String 
- IgnoreQueryString
- UseQuery String 
- UseQueryString
- IgnoreSpecified Query Strings 
- IgnoreSpecifiedQueryStrings
- IncludeSpecified Query Strings 
- IncludeSpecifiedQueryStrings
- IGNORE_QUERY_STRING
- IgnoreQueryString
- USE_QUERY_STRING
- UseQueryString
- IGNORE_SPECIFIED_QUERY_STRINGS
- IgnoreSpecifiedQueryStrings
- INCLUDE_SPECIFIED_QUERY_STRINGS
- IncludeSpecifiedQueryStrings
- "IgnoreQuery String" 
- IgnoreQueryString
- "UseQuery String" 
- UseQueryString
- "IgnoreSpecified Query Strings" 
- IgnoreSpecifiedQueryStrings
- "IncludeSpecified Query Strings" 
- IncludeSpecifiedQueryStrings
AfdRouteCacheConfiguration, AfdRouteCacheConfigurationArgs        
- CompressionSettings Pulumi.Azure Native. Cdn. Inputs. Compression Settings 
- compression settings.
- QueryParameters string
- query parameters to include or exclude (comma separated).
- QueryString string | Pulumi.Caching Behavior Azure Native. Cdn. Afd Query String Caching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- CompressionSettings CompressionSettings 
- compression settings.
- QueryParameters string
- query parameters to include or exclude (comma separated).
- QueryString string | AfdCaching Behavior Query String Caching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compressionSettings CompressionSettings 
- compression settings.
- queryParameters String
- query parameters to include or exclude (comma separated).
- queryString String | AfdCaching Behavior Query String Caching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compressionSettings CompressionSettings 
- compression settings.
- queryParameters string
- query parameters to include or exclude (comma separated).
- queryString string | AfdCaching Behavior Query String Caching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compression_settings CompressionSettings 
- compression settings.
- query_parameters str
- query parameters to include or exclude (comma separated).
- query_string_ str | Afdcaching_ behavior Query String Caching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compressionSettings Property Map
- compression settings.
- queryParameters String
- query parameters to include or exclude (comma separated).
- queryString String | "IgnoreCaching Behavior Query String" | "Use Query String" | "Ignore Specified Query Strings" | "Include Specified Query Strings" 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
AfdRouteCacheConfigurationResponse, AfdRouteCacheConfigurationResponseArgs          
- CompressionSettings Pulumi.Azure Native. Cdn. Inputs. Compression Settings Response 
- compression settings.
- QueryParameters string
- query parameters to include or exclude (comma separated).
- QueryString stringCaching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- CompressionSettings CompressionSettings Response 
- compression settings.
- QueryParameters string
- query parameters to include or exclude (comma separated).
- QueryString stringCaching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compressionSettings CompressionSettings Response 
- compression settings.
- queryParameters String
- query parameters to include or exclude (comma separated).
- queryString StringCaching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compressionSettings CompressionSettings Response 
- compression settings.
- queryParameters string
- query parameters to include or exclude (comma separated).
- queryString stringCaching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compression_settings CompressionSettings Response 
- compression settings.
- query_parameters str
- query parameters to include or exclude (comma separated).
- query_string_ strcaching_ behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
- compressionSettings Property Map
- compression settings.
- queryParameters String
- query parameters to include or exclude (comma separated).
- queryString StringCaching Behavior 
- Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
CompressionSettings, CompressionSettingsArgs    
- ContentTypes List<string>To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- IsCompression boolEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- ContentTypes []stringTo Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- IsCompression boolEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- contentTypes List<String>To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- isCompression BooleanEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- contentTypes string[]To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- isCompression booleanEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- content_types_ Sequence[str]to_ compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- is_compression_ boolenabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- contentTypes List<String>To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- isCompression BooleanEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
CompressionSettingsResponse, CompressionSettingsResponseArgs      
- ContentTypes List<string>To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- IsCompression boolEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- ContentTypes []stringTo Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- IsCompression boolEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- contentTypes List<String>To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- isCompression BooleanEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- contentTypes string[]To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- isCompression booleanEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- content_types_ Sequence[str]to_ compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- is_compression_ boolenabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
- contentTypes List<String>To Compress 
- List of content types on which compression applies. The value should be a valid MIME type.
- isCompression BooleanEnabled 
- Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
EnabledState, EnabledStateArgs    
- Enabled
- Enabled
- Disabled
- Disabled
- EnabledState Enabled 
- Enabled
- EnabledState Disabled 
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- ENABLED
- Enabled
- DISABLED
- Disabled
- "Enabled"
- Enabled
- "Disabled"
- Disabled
ForwardingProtocol, ForwardingProtocolArgs    
- HttpOnly 
- HttpOnly
- HttpsOnly 
- HttpsOnly
- MatchRequest 
- MatchRequest
- ForwardingProtocol Http Only 
- HttpOnly
- ForwardingProtocol Https Only 
- HttpsOnly
- ForwardingProtocol Match Request 
- MatchRequest
- HttpOnly 
- HttpOnly
- HttpsOnly 
- HttpsOnly
- MatchRequest 
- MatchRequest
- HttpOnly 
- HttpOnly
- HttpsOnly 
- HttpsOnly
- MatchRequest 
- MatchRequest
- HTTP_ONLY
- HttpOnly
- HTTPS_ONLY
- HttpsOnly
- MATCH_REQUEST
- MatchRequest
- "HttpOnly" 
- HttpOnly
- "HttpsOnly" 
- HttpsOnly
- "MatchRequest" 
- MatchRequest
HttpsRedirect, HttpsRedirectArgs    
- Enabled
- Enabled
- Disabled
- Disabled
- HttpsRedirect Enabled 
- Enabled
- HttpsRedirect Disabled 
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- ENABLED
- Enabled
- DISABLED
- Disabled
- "Enabled"
- Enabled
- "Disabled"
- Disabled
LinkToDefaultDomain, LinkToDefaultDomainArgs        
- Enabled
- Enabled
- Disabled
- Disabled
- LinkTo Default Domain Enabled 
- Enabled
- LinkTo Default Domain Disabled 
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- ENABLED
- Enabled
- DISABLED
- Disabled
- "Enabled"
- Enabled
- "Disabled"
- Disabled
ResourceReference, ResourceReferenceArgs    
- Id string
- Resource ID.
- Id string
- Resource ID.
- id String
- Resource ID.
- id string
- Resource ID.
- id str
- Resource ID.
- id String
- Resource ID.
ResourceReferenceResponse, ResourceReferenceResponseArgs      
- Id string
- Resource ID.
- Id string
- Resource ID.
- id String
- Resource ID.
- id string
- Resource ID.
- id str
- Resource ID.
- id String
- Resource ID.
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC)
- CreatedBy string
- An identifier for the identity that created the resource
- CreatedBy stringType 
- The type of identity that created the resource
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- An identifier for the identity that last modified the resource
- LastModified stringBy Type 
- The type of identity that last modified the resource
- CreatedAt string
- The timestamp of resource creation (UTC)
- CreatedBy string
- An identifier for the identity that created the resource
- CreatedBy stringType 
- The type of identity that created the resource
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- An identifier for the identity that last modified the resource
- LastModified stringBy Type 
- The type of identity that last modified the resource
- createdAt String
- The timestamp of resource creation (UTC)
- createdBy String
- An identifier for the identity that created the resource
- createdBy StringType 
- The type of identity that created the resource
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- An identifier for the identity that last modified the resource
- lastModified StringBy Type 
- The type of identity that last modified the resource
- createdAt string
- The timestamp of resource creation (UTC)
- createdBy string
- An identifier for the identity that created the resource
- createdBy stringType 
- The type of identity that created the resource
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- An identifier for the identity that last modified the resource
- lastModified stringBy Type 
- The type of identity that last modified the resource
- created_at str
- The timestamp of resource creation (UTC)
- created_by str
- An identifier for the identity that created the resource
- created_by_ strtype 
- The type of identity that created the resource
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- An identifier for the identity that last modified the resource
- last_modified_ strby_ type 
- The type of identity that last modified the resource
- createdAt String
- The timestamp of resource creation (UTC)
- createdBy String
- An identifier for the identity that created the resource
- createdBy StringType 
- The type of identity that created the resource
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- An identifier for the identity that last modified the resource
- lastModified StringBy Type 
- The type of identity that last modified the resource
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cdn:Route route1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0