Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. cdn
  5. Route
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.cdn.Route

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Friendly Routes name mapping to the any Routes or secret related information. API Version: 2020-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()
    {
        CompressionSettings = new AzureNative.Cdn.Inputs.CompressionSettingsArgs
        {
            ContentTypesToCompress = new[]
            {
                "text/html",
                "application/octet-stream",
            },
            IsCompressionEnabled = true,
        },
        CustomDomains = new[]
        {
            new AzureNative.Cdn.Inputs.ResourceReferenceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1",
            },
        },
        EnabledState = "Enabled",
        EndpointName = "endpoint1",
        ForwardingProtocol = "MatchRequest",
        HttpsRedirect = "Enabled",
        LinkToDefaultDomain = "Enabled",
        OriginGroup = new AzureNative.Cdn.Inputs.ResourceReferenceArgs
        {
            Id = "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1",
        },
        PatternsToMatch = new[]
        {
            "/*",
        },
        ProfileName = "profile1",
        QueryStringCachingBehavior = AzureNative.Cdn.AfdQueryStringCachingBehavior.IgnoreQueryString,
        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[]
        {
            "Https",
            "Http",
        },
    });

});

    package main

import (
	cdn "github.com/pulumi/pulumi-azure-native-sdk/cdn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cdn.NewRoute(ctx, "route", &cdn.RouteArgs{
			CompressionSettings: &cdn.CompressionSettingsArgs{
				ContentTypesToCompress: pulumi.StringArray{
					pulumi.String("text/html"),
					pulumi.String("application/octet-stream"),
				},
				IsCompressionEnabled: pulumi.Bool(true),
			},
			CustomDomains: []cdn.ResourceReferenceArgs{
				{
					Id: pulumi.String("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"),
				},
			},
			EnabledState:        pulumi.String("Enabled"),
			EndpointName:        pulumi.String("endpoint1"),
			ForwardingProtocol:  pulumi.String("MatchRequest"),
			HttpsRedirect:       pulumi.String("Enabled"),
			LinkToDefaultDomain: pulumi.String("Enabled"),
			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"),
			QueryStringCachingBehavior: cdn.AfdQueryStringCachingBehaviorIgnoreQueryString,
			ResourceGroupName:          pulumi.String("RG"),
			RouteName:                  pulumi.String("route1"),
			RuleSets: []cdn.ResourceReferenceArgs{
				{
					Id: pulumi.String("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"),
				},
			},
			SupportedProtocols: pulumi.StringArray{
				pulumi.String("Https"),
				pulumi.String("Http"),
			},
		})
		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 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()        
            .compressionSettings(Map.ofEntries(
                Map.entry("contentTypesToCompress",                 
                    "text/html",
                    "application/octet-stream"),
                Map.entry("isCompressionEnabled", true)
            ))
            .customDomains(Map.of("id", "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"))
            .enabledState("Enabled")
            .endpointName("endpoint1")
            .forwardingProtocol("MatchRequest")
            .httpsRedirect("Enabled")
            .linkToDefaultDomain("Enabled")
            .originGroup(Map.of("id", "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"))
            .patternsToMatch("/*")
            .profileName("profile1")
            .queryStringCachingBehavior("IgnoreQueryString")
            .resourceGroupName("RG")
            .routeName("route1")
            .ruleSets(Map.of("id", "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"))
            .supportedProtocols(            
                "Https",
                "Http")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

route = azure_native.cdn.Route("route",
    compression_settings=azure_native.cdn.CompressionSettingsArgs(
        content_types_to_compress=[
            "text/html",
            "application/octet-stream",
        ],
        is_compression_enabled=True,
    ),
    custom_domains=[azure_native.cdn.ResourceReferenceArgs(
        id="/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1",
    )],
    enabled_state="Enabled",
    endpoint_name="endpoint1",
    forwarding_protocol="MatchRequest",
    https_redirect="Enabled",
    link_to_default_domain="Enabled",
    origin_group=azure_native.cdn.ResourceReferenceArgs(
        id="/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1",
    ),
    patterns_to_match=["/*"],
    profile_name="profile1",
    query_string_caching_behavior=azure_native.cdn.AfdQueryStringCachingBehavior.IGNORE_QUERY_STRING,
    resource_group_name="RG",
    route_name="route1",
    rule_sets=[azure_native.cdn.ResourceReferenceArgs(
        id="/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1",
    )],
    supported_protocols=[
        "Https",
        "Http",
    ])

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const route = new azure_native.cdn.Route("route", {
    compressionSettings: {
        contentTypesToCompress: [
            "text/html",
            "application/octet-stream",
        ],
        isCompressionEnabled: true,
    },
    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",
    queryStringCachingBehavior: azure_native.cdn.AfdQueryStringCachingBehavior.IgnoreQueryString,
    resourceGroupName: "RG",
    routeName: "route1",
    ruleSets: [{
        id: "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1",
    }],
    supportedProtocols: [
        "Https",
        "Http",
    ],
});

    resources:
  route:
    type: azure-native:cdn:Route
    properties:
      compressionSettings:
        contentTypesToCompress:
          - text/html
          - application/octet-stream
        isCompressionEnabled: true
      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
      queryStringCachingBehavior: IgnoreQueryString
      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,
          forwarding_protocol: Optional[Union[str, ForwardingProtocol]] = None,
          https_redirect: Optional[Union[str, HttpsRedirect]] = None,
          link_to_default_domain: Optional[Union[str, LinkToDefaultDomain]] = None,
          compression_settings: Optional[CompressionSettingsArgs] = None,
          origin_path: Optional[str] = None,
          patterns_to_match: Optional[Sequence[str]] = None,
          enabled_state: Optional[Union[str, EnabledState]] = None,
          query_string_caching_behavior: Optional[AfdQueryStringCachingBehavior] = None,
          custom_domains: Optional[Sequence[ResourceReferenceArgs]] = 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)
    public Route(String name, RouteArgs args)
public Route(String name, RouteArgs args, CustomResourceOptions options)

    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 = 
    {
        { "id", "string" },
    },
    ResourceGroupName = "string",
    ProfileName = "string",
    EndpointName = "string",
    ForwardingProtocol = "string",
    HttpsRedirect = "string",
    LinkToDefaultDomain = "string",
    CompressionSettings = 
    {
        { "contentTypesToCompress", new[]
        {
            "string",
        } },
        { "isCompressionEnabled", false },
    },
    OriginPath = "string",
    PatternsToMatch = new[]
    {
        "string",
    },
    EnabledState = "string",
    QueryStringCachingBehavior = "IgnoreQueryString",
    CustomDomains = new[]
    {
        
        {
            { "id", "string" },
        },
    },
    RouteName = "string",
    RuleSets = new[]
    {
        
        {
            { "id", "string" },
        },
    },
    SupportedProtocols = new[]
    {
        "string",
    },
});

    example, err := cdn.NewRoute(ctx, "routeResource", &cdn.RouteArgs{
	OriginGroup: map[string]interface{}{
		"id": "string",
	},
	ResourceGroupName:   "string",
	ProfileName:         "string",
	EndpointName:        "string",
	ForwardingProtocol:  "string",
	HttpsRedirect:       "string",
	LinkToDefaultDomain: "string",
	CompressionSettings: map[string]interface{}{
		"contentTypesToCompress": []string{
			"string",
		},
		"isCompressionEnabled": false,
	},
	OriginPath: "string",
	PatternsToMatch: []string{
		"string",
	},
	EnabledState:               "string",
	QueryStringCachingBehavior: "IgnoreQueryString",
	CustomDomains: []map[string]interface{}{
		map[string]interface{}{
			"id": "string",
		},
	},
	RouteName: "string",
	RuleSets: []map[string]interface{}{
		map[string]interface{}{
			"id": "string",
		},
	},
	SupportedProtocols: []string{
		"string",
	},
})

    var routeResource = new Route("routeResource", RouteArgs.builder()
    .originGroup(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .profileName("string")
    .endpointName("string")
    .forwardingProtocol("string")
    .httpsRedirect("string")
    .linkToDefaultDomain("string")
    .compressionSettings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .originPath("string")
    .patternsToMatch("string")
    .enabledState("string")
    .queryStringCachingBehavior("IgnoreQueryString")
    .customDomains(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .routeName("string")
    .ruleSets(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .supportedProtocols("string")
    .build());

    route_resource = azure_native.cdn.Route("routeResource",
    origin_group={
        id: string,
    },
    resource_group_name=string,
    profile_name=string,
    endpoint_name=string,
    forwarding_protocol=string,
    https_redirect=string,
    link_to_default_domain=string,
    compression_settings={
        contentTypesToCompress: [string],
        isCompressionEnabled: False,
    },
    origin_path=string,
    patterns_to_match=[string],
    enabled_state=string,
    query_string_caching_behavior=IgnoreQueryString,
    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",
    forwardingProtocol: "string",
    httpsRedirect: "string",
    linkToDefaultDomain: "string",
    compressionSettings: {
        contentTypesToCompress: ["string"],
        isCompressionEnabled: false,
    },
    originPath: "string",
    patternsToMatch: ["string"],
    enabledState: "string",
    queryStringCachingBehavior: "IgnoreQueryString",
    customDomains: [{
        id: "string",
    }],
    routeName: "string",
    ruleSets: [{
        id: "string",
    }],
    supportedProtocols: ["string"],
});

    type: azure-native:cdn:Route
properties:
    compressionSettings:
        contentTypesToCompress:
            - string
        isCompressionEnabled: false
    customDomains:
        - id: string
    enabledState: string
    endpointName: string
    forwardingProtocol: string
    httpsRedirect: string
    linkToDefaultDomain: string
    originGroup:
        id: string
    originPath: string
    patternsToMatch:
        - string
    profileName: string
    queryStringCachingBehavior: IgnoreQueryString
    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.AzureNative.Cdn.Inputs.ResourceReference
    A reference to the origin group.
    ProfileName string
    Name of the CDN profile which is unique within the resource group.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    CompressionSettings Pulumi.AzureNative.Cdn.Inputs.CompressionSettings
    compression settings.
    CustomDomains List<Pulumi.AzureNative.Cdn.Inputs.ResourceReference>
    Domains referenced by this endpoint.
    EnabledState string | Pulumi.AzureNative.Cdn.EnabledState
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    ForwardingProtocol string | Pulumi.AzureNative.Cdn.ForwardingProtocol
    Protocol this rule will use when forwarding traffic to backends.
    HttpsRedirect string | Pulumi.AzureNative.Cdn.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.
    LinkToDefaultDomain string | Pulumi.AzureNative.Cdn.LinkToDefaultDomain
    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.
    PatternsToMatch List<string>
    The route patterns of the rule.
    QueryStringCachingBehavior Pulumi.AzureNative.Cdn.AfdQueryStringCachingBehavior
    Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
    RouteName string
    Name of the routing rule.
    RuleSets List<Pulumi.AzureNative.Cdn.Inputs.ResourceReference>
    rule sets referenced by this endpoint.
    SupportedProtocols List<Union<string, Pulumi.AzureNative.Cdn.AFDEndpointProtocols>>
    List of supported protocols for this route.
    EndpointName string
    Name of the endpoint under the profile which is unique globally.
    OriginGroup ResourceReferenceArgs
    A reference to the origin group.
    ProfileName string
    Name of the CDN profile which is unique within the resource group.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    CompressionSettings CompressionSettingsArgs
    compression settings.
    CustomDomains []ResourceReferenceArgs
    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.
    LinkToDefaultDomain string | LinkToDefaultDomain
    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.
    PatternsToMatch []string
    The route patterns of the rule.
    QueryStringCachingBehavior AfdQueryStringCachingBehavior
    Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
    RouteName string
    Name of the routing rule.
    RuleSets []ResourceReferenceArgs
    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 CDN profile which is unique within the resource group.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    compressionSettings CompressionSettings
    compression settings.
    customDomains List<ResourceReference>
    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.
    linkToDefaultDomain String | LinkToDefaultDomain
    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.
    patternsToMatch List<String>
    The route patterns of the rule.
    queryStringCachingBehavior AfdQueryStringCachingBehavior
    Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
    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 CDN profile which is unique within the resource group.
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    compressionSettings CompressionSettings
    compression settings.
    customDomains ResourceReference[]
    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.
    linkToDefaultDomain string | LinkToDefaultDomain
    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.
    patternsToMatch string[]
    The route patterns of the rule.
    queryStringCachingBehavior AfdQueryStringCachingBehavior
    Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
    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 ResourceReferenceArgs
    A reference to the origin group.
    profile_name str
    Name of the CDN profile which is unique within the resource group.
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    compression_settings CompressionSettingsArgs
    compression settings.
    custom_domains Sequence[ResourceReferenceArgs]
    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_default_domain str | LinkToDefaultDomain
    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_match Sequence[str]
    The route patterns of the rule.
    query_string_caching_behavior AfdQueryStringCachingBehavior
    Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
    route_name str
    Name of the routing rule.
    rule_sets Sequence[ResourceReferenceArgs]
    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 CDN profile which is unique within the resource group.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    compressionSettings Property Map
    compression settings.
    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" | "HttpsOnly" | "MatchRequest"
    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.
    linkToDefaultDomain String | "Enabled" | "Disabled"
    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.
    patternsToMatch List<String>
    The route patterns of the rule.
    queryStringCachingBehavior "IgnoreQueryString" | "UseQueryString" | "NotSet"
    Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
    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.AzureNative.Cdn.Outputs.SystemDataResponse
    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 SystemDataResponse
    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 SystemDataResponse
    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 SystemDataResponse
    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 SystemDataResponse
    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
    AFDEndpointProtocolsHttp
    Http
    AFDEndpointProtocolsHttps
    Https
    Http
    Http
    Https
    Https
    Http
    Http
    Https
    Https
    HTTP
    Http
    HTTPS
    Https
    "Http"
    Http
    "Https"
    Https

    AfdQueryStringCachingBehavior, AfdQueryStringCachingBehaviorArgs

    IgnoreQueryString
    IgnoreQueryString
    UseQueryString
    UseQueryString
    NotSet
    NotSet
    AfdQueryStringCachingBehaviorIgnoreQueryString
    IgnoreQueryString
    AfdQueryStringCachingBehaviorUseQueryString
    UseQueryString
    AfdQueryStringCachingBehaviorNotSet
    NotSet
    IgnoreQueryString
    IgnoreQueryString
    UseQueryString
    UseQueryString
    NotSet
    NotSet
    IgnoreQueryString
    IgnoreQueryString
    UseQueryString
    UseQueryString
    NotSet
    NotSet
    IGNORE_QUERY_STRING
    IgnoreQueryString
    USE_QUERY_STRING
    UseQueryString
    NOT_SET
    NotSet
    "IgnoreQueryString"
    IgnoreQueryString
    "UseQueryString"
    UseQueryString
    "NotSet"
    NotSet

    CompressionSettings, CompressionSettingsArgs

    ContentTypesToCompress List<string>
    List of content types on which compression applies. The value should be a valid MIME type.
    IsCompressionEnabled bool
    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.
    ContentTypesToCompress []string
    List of content types on which compression applies. The value should be a valid MIME type.
    IsCompressionEnabled bool
    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.
    contentTypesToCompress List<String>
    List of content types on which compression applies. The value should be a valid MIME type.
    isCompressionEnabled Boolean
    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.
    contentTypesToCompress string[]
    List of content types on which compression applies. The value should be a valid MIME type.
    isCompressionEnabled boolean
    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_to_compress Sequence[str]
    List of content types on which compression applies. The value should be a valid MIME type.
    is_compression_enabled bool
    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.
    contentTypesToCompress List<String>
    List of content types on which compression applies. The value should be a valid MIME type.
    isCompressionEnabled Boolean
    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

    ContentTypesToCompress List<string>
    List of content types on which compression applies. The value should be a valid MIME type.
    IsCompressionEnabled bool
    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.
    ContentTypesToCompress []string
    List of content types on which compression applies. The value should be a valid MIME type.
    IsCompressionEnabled bool
    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.
    contentTypesToCompress List<String>
    List of content types on which compression applies. The value should be a valid MIME type.
    isCompressionEnabled Boolean
    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.
    contentTypesToCompress string[]
    List of content types on which compression applies. The value should be a valid MIME type.
    isCompressionEnabled boolean
    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_to_compress Sequence[str]
    List of content types on which compression applies. The value should be a valid MIME type.
    is_compression_enabled bool
    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.
    contentTypesToCompress List<String>
    List of content types on which compression applies. The value should be a valid MIME type.
    isCompressionEnabled Boolean
    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
    EnabledStateEnabled
    Enabled
    EnabledStateDisabled
    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
    ForwardingProtocolHttpOnly
    HttpOnly
    ForwardingProtocolHttpsOnly
    HttpsOnly
    ForwardingProtocolMatchRequest
    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
    HttpsRedirectEnabled
    Enabled
    HttpsRedirectDisabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    ENABLED
    Enabled
    DISABLED
    Disabled
    "Enabled"
    Enabled
    "Disabled"
    Disabled

    LinkToDefaultDomain, LinkToDefaultDomainArgs

    Enabled
    Enabled
    Disabled
    Disabled
    LinkToDefaultDomainEnabled
    Enabled
    LinkToDefaultDomainDisabled
    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
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    An identifier for the identity that last modified the resource
    LastModifiedByType string
    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
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    An identifier for the identity that last modified the resource
    LastModifiedByType string
    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
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    An identifier for the identity that last modified the resource
    lastModifiedByType String
    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
    createdByType string
    The type of identity that created the resource
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    An identifier for the identity that last modified the resource
    lastModifiedByType string
    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_type str
    The type of identity that created the resource
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    An identifier for the identity that last modified the resource
    last_modified_by_type str
    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
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    An identifier for the identity that last modified the resource
    lastModifiedByType String
    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/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native