Microsoft.App managedEnvironments/httpRouteConfigs 2024-10-02-preview

• Latest
• 2024-10-02-preview

Bicep resource definition

The managedEnvironments/httpRouteConfigs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/managedEnvironments/httpRouteConfigs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.App/managedEnvironments/httpRouteConfigs@2024-10-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    customDomains: [
      {
        bindingType: 'string'
        certificateId: 'string'
        name: 'string'
      }
    ]
    rules: [
      {
        description: 'string'
        routes: [
          {
            action: {
              prefixRewrite: 'string'
            }
            match: {
              caseSensitive: bool
              path: 'string'
              pathSeparatedPrefix: 'string'
              prefix: 'string'
            }
          }
        ]
        targets: [
          {
            containerApp: 'string'
            label: 'string'
            revision: 'string'
            weight: int
          }
        ]
      }
    ]
  }
}

Property values

CustomDomain

Name	Description	Value
bindingType	Custom Domain binding type.	'Auto' 'Disabled' 'SniEnabled'
certificateId	Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.	string
name	Hostname.	string (required)

HttpRoute

Name	Description	Value
action	Once route is matched, what is the desired action	HttpRouteAction
match	Conditions route will match on	HttpRouteMatch

HttpRouteAction

Name	Description	Value
prefixRewrite	Rewrite prefix, default is no rewrites	string

HttpRouteConfigProperties

Name	Description	Value
customDomains	Custom domain bindings for http Routes' hostnames.	CustomDomain[]
rules	Routing Rules for http route resource.	HttpRouteRule[]

HttpRouteMatch

Name	Description	Value
caseSensitive	path case sensitive, default is true	bool
path	match on exact path	string
pathSeparatedPrefix	match on all prefix's. Not exact	string
prefix	match on all prefix's. Not exact	string

HttpRouteRule

Name	Description	Value
description	Description of rule. Optional.	string
routes	Routing configuration that will allow matches on specific paths/headers.	HttpRoute[]
targets	Targets- container apps, revisions, labels	HttpRouteTarget[]

HttpRouteTarget

Name	Description	Value
containerApp	Container App Name to route requests to	string (required)
label	Label/Revision to route requests to	string
revision	Revision to route requests to	string
weight	Weighted routing	int Constraints: Min value = 0 Max value = 100

Microsoft.App/managedEnvironments/httpRouteConfigs

Name	Description	Value
name	The resource name	string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z][a-z0-9]*$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: managedEnvironments
properties	Http Route Config properties	HttpRouteConfigProperties

ARM template resource definition

The managedEnvironments/httpRouteConfigs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/managedEnvironments/httpRouteConfigs resource, add the following JSON to your template.

{
  "type": "Microsoft.App/managedEnvironments/httpRouteConfigs",
  "apiVersion": "2024-10-02-preview",
  "name": "string",
  "properties": {
    "customDomains": [
      {
        "bindingType": "string",
        "certificateId": "string",
        "name": "string"
      }
    ],
    "rules": [
      {
        "description": "string",
        "routes": [
          {
            "action": {
              "prefixRewrite": "string"
            },
            "match": {
              "caseSensitive": "bool",
              "path": "string",
              "pathSeparatedPrefix": "string",
              "prefix": "string"
            }
          }
        ],
        "targets": [
          {
            "containerApp": "string",
            "label": "string",
            "revision": "string",
            "weight": "int"
          }
        ]
      }
    ]
  }
}

Property values

CustomDomain

Name	Description	Value
bindingType	Custom Domain binding type.	'Auto' 'Disabled' 'SniEnabled'
certificateId	Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.	string
name	Hostname.	string (required)

HttpRoute

Name	Description	Value
action	Once route is matched, what is the desired action	HttpRouteAction
match	Conditions route will match on	HttpRouteMatch

HttpRouteAction

Name	Description	Value
prefixRewrite	Rewrite prefix, default is no rewrites	string

HttpRouteConfigProperties

Name	Description	Value
customDomains	Custom domain bindings for http Routes' hostnames.	CustomDomain[]
rules	Routing Rules for http route resource.	HttpRouteRule[]

HttpRouteMatch

Name	Description	Value
caseSensitive	path case sensitive, default is true	bool
path	match on exact path	string
pathSeparatedPrefix	match on all prefix's. Not exact	string
prefix	match on all prefix's. Not exact	string

HttpRouteRule

Name	Description	Value
description	Description of rule. Optional.	string
routes	Routing configuration that will allow matches on specific paths/headers.	HttpRoute[]
targets	Targets- container apps, revisions, labels	HttpRouteTarget[]

HttpRouteTarget

Name	Description	Value
containerApp	Container App Name to route requests to	string (required)
label	Label/Revision to route requests to	string
revision	Revision to route requests to	string
weight	Weighted routing	int Constraints: Min value = 0 Max value = 100

Microsoft.App/managedEnvironments/httpRouteConfigs

Name	Description	Value
apiVersion	The api version	'2024-10-02-preview'
name	The resource name	string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z][a-z0-9]*$ (required)
properties	Http Route Config properties	HttpRouteConfigProperties
type	The resource type	'Microsoft.App/managedEnvironments/httpRouteConfigs'

Terraform (AzAPI provider) resource definition

The managedEnvironments/httpRouteConfigs resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/managedEnvironments/httpRouteConfigs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/managedEnvironments/httpRouteConfigs@2024-10-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      customDomains = [
        {
          bindingType = "string"
          certificateId = "string"
          name = "string"
        }
      ]
      rules = [
        {
          description = "string"
          routes = [
            {
              action = {
                prefixRewrite = "string"
              }
              match = {
                caseSensitive = bool
                path = "string"
                pathSeparatedPrefix = "string"
                prefix = "string"
              }
            }
          ]
          targets = [
            {
              containerApp = "string"
              label = "string"
              revision = "string"
              weight = int
            }
          ]
        }
      ]
    }
  })
}

Property values

CustomDomain

Name	Description	Value
bindingType	Custom Domain binding type.	'Auto' 'Disabled' 'SniEnabled'
certificateId	Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.	string
name	Hostname.	string (required)

HttpRoute

Name	Description	Value
action	Once route is matched, what is the desired action	HttpRouteAction
match	Conditions route will match on	HttpRouteMatch

HttpRouteAction

Name	Description	Value
prefixRewrite	Rewrite prefix, default is no rewrites	string

HttpRouteConfigProperties

Name	Description	Value
customDomains	Custom domain bindings for http Routes' hostnames.	CustomDomain[]
rules	Routing Rules for http route resource.	HttpRouteRule[]

HttpRouteMatch

Name	Description	Value
caseSensitive	path case sensitive, default is true	bool
path	match on exact path	string
pathSeparatedPrefix	match on all prefix's. Not exact	string
prefix	match on all prefix's. Not exact	string

HttpRouteRule

Name	Description	Value
description	Description of rule. Optional.	string
routes	Routing configuration that will allow matches on specific paths/headers.	HttpRoute[]
targets	Targets- container apps, revisions, labels	HttpRouteTarget[]

HttpRouteTarget

Name	Description	Value
containerApp	Container App Name to route requests to	string (required)
label	Label/Revision to route requests to	string
revision	Revision to route requests to	string
weight	Weighted routing	int Constraints: Min value = 0 Max value = 100

Microsoft.App/managedEnvironments/httpRouteConfigs

Name	Description	Value
name	The resource name	string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z][a-z0-9]*$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: managedEnvironments
properties	Http Route Config properties	HttpRouteConfigProperties
type	The resource type	"Microsoft.App/managedEnvironments/httpRouteConfigs@2024-10-02-preview"