Path-based routing in Azure Container Apps

This repo demonstrates how to use the new path-based routing feature in Azure Container Apps. It consists of three container apps and the bicep files to deploy them.

Quickstart

Prerequisites

• AZD

Deploy

1. Clone the repo
2. Run azd up to get started and follow the prompts to deploy the repo.

Configure path-based routing

The new-path based routing feature introduces the httpRoutingConfig which informs how traffic is routed in the application. For an example of the httpRoutingConfig, visit infra/shared/apps-env.bicep in this repo.

To use path-based routing, you will need to be on the 2024-10-02-preview version of the Azure Container Apps API.

The following is an example of how you can configure path based routing in your ARM/bicep templates.

Example ARM/bicep

resource httpRouteConfig 'Microsoft.App/managedEnvironments/httpRouteConfigs@2024-10-02-preview' = {
  parent: containerAppsEnvironment
  name: 'routeconfig1'
  location: location
  properties: {
    rules: [
        {
            description: 'App 1 rule'
            routes: [
                {
                    match: {
                        prefix: '/app1'
                    }
                    action: {
                        prefixRewrite: '/'
                    }
                }
            ]
            targets: [
                {
                    containerApp: 'app1'
                }
            ]
        }
        {
            description: 'App 2 rule'
            routes: [
                {
                    match: {
                        exact: '/app2'
                    }
                    action: {
                        prefixRewrite: '/'
                    }
                }
            ]
            targets: [
                {
                    containerApp: 'app2'
                }
            ]
        }
    ]
  }
}

Details: The following properties are currently supported.

• {name} for an httpRouteComponent should be unique across containerAppNames + containerAppJobNames in the cluster.
• rules is an array of routing rules and their targets. They are evaluated in prority order based on the order they are defined.
• routes is an array of routes that will be matched against the incoming request. The first route that matches will be used.
• matches is an array of matching rules. These can have type prefix,exact or pathseparatedprefix. Any request that doesn't have a match will 404.
• prefixRewrite the URL path to modify the URL prefix path to
• targets takes one target application for which the routes in a rule will be forwaded to. These can only be container app names.

What's next?

• Support for custom domains for the HTTProutingConfig
• Targeting of apps/revisions
• Header-based routing

Feedback

For general feedback and questions please use Roadmap: URL Based Routing. To report bugs please use Container Apps Issues.