Microsoft.AppPlatform Spring/gateways/routeConfigs 2022-09-01-preview
Bicep resource definition
The Spring/gateways/routeConfigs 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.AppPlatform/Spring/gateways/routeConfigs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
appResourceId: 'string'
openApi: {
uri: 'string'
}
protocol: 'string'
routes: [
{
description: 'string'
filters: [
'string'
]
order: int
predicates: [
'string'
]
ssoEnabled: bool
tags: [
'string'
]
title: 'string'
tokenRelay: bool
uri: 'string'
}
]
}
}
Property values
Spring/gateways/routeConfigs
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (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: gateways |
| properties | API route config of the Spring Cloud Gateway | GatewayRouteConfigProperties |
GatewayRouteConfigProperties
| Name | Description | Value |
|---|---|---|
| appResourceId | The resource Id of the Azure Spring Apps app, required unless route defines uri. |
string |
| openApi | OpenAPI properties of Spring Cloud Gateway route config. | GatewayRouteConfigOpenApiProperties |
| protocol | Protocol of routed Azure Spring Apps applications. | 'HTTP' 'HTTPS' |
| routes | Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters. |
GatewayApiRoute[] |
GatewayRouteConfigOpenApiProperties
| Name | Description | Value |
|---|---|---|
| uri | The URI of OpenAPI specification. | string |
GatewayApiRoute
| Name | Description | Value |
|---|---|---|
| description | A description, will be applied to methods in the generated OpenAPI documentation. | string |
| filters | To modify the request before sending it to the target endpoint, or the received response. | string[] |
| order | Route processing order. | int |
| predicates | A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. | string[] |
| ssoEnabled | Enable sso validation. | bool |
| tags | Classification tags, will be applied to methods in the generated OpenAPI documentation. | string[] |
| title | A title, will be applied to methods in the generated OpenAPI documentation. | string |
| tokenRelay | Pass currently-authenticated user's identity token to application service, default is 'false' | bool |
| uri | Full uri, will override appName. |
string |
ARM template resource definition
The Spring/gateways/routeConfigs 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.AppPlatform/Spring/gateways/routeConfigs resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs",
"apiVersion": "2022-09-01-preview",
"name": "string",
"properties": {
"appResourceId": "string",
"openApi": {
"uri": "string"
},
"protocol": "string",
"routes": [
{
"description": "string",
"filters": [ "string" ],
"order": "int",
"predicates": [ "string" ],
"ssoEnabled": "bool",
"tags": [ "string" ],
"title": "string",
"tokenRelay": "bool",
"uri": "string"
}
]
}
}
Property values
Spring/gateways/routeConfigs
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.AppPlatform/Spring/gateways/routeConfigs' |
| apiVersion | The resource api version | '2022-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | API route config of the Spring Cloud Gateway | GatewayRouteConfigProperties |
GatewayRouteConfigProperties
| Name | Description | Value |
|---|---|---|
| appResourceId | The resource Id of the Azure Spring Apps app, required unless route defines uri. |
string |
| openApi | OpenAPI properties of Spring Cloud Gateway route config. | GatewayRouteConfigOpenApiProperties |
| protocol | Protocol of routed Azure Spring Apps applications. | 'HTTP' 'HTTPS' |
| routes | Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters. |
GatewayApiRoute[] |
GatewayRouteConfigOpenApiProperties
| Name | Description | Value |
|---|---|---|
| uri | The URI of OpenAPI specification. | string |
GatewayApiRoute
| Name | Description | Value |
|---|---|---|
| description | A description, will be applied to methods in the generated OpenAPI documentation. | string |
| filters | To modify the request before sending it to the target endpoint, or the received response. | string[] |
| order | Route processing order. | int |
| predicates | A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. | string[] |
| ssoEnabled | Enable sso validation. | bool |
| tags | Classification tags, will be applied to methods in the generated OpenAPI documentation. | string[] |
| title | A title, will be applied to methods in the generated OpenAPI documentation. | string |
| tokenRelay | Pass currently-authenticated user's identity token to application service, default is 'false' | bool |
| uri | Full uri, will override appName. |
string |
Terraform (AzAPI provider) resource definition
The Spring/gateways/routeConfigs 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.AppPlatform/Spring/gateways/routeConfigs resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
appResourceId = "string"
openApi = {
uri = "string"
}
protocol = "string"
routes = [
{
description = "string"
filters = [
"string"
]
order = int
predicates = [
"string"
]
ssoEnabled = bool
tags = [
"string"
]
title = "string"
tokenRelay = bool
uri = "string"
}
]
}
})
}
Property values
Spring/gateways/routeConfigs
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-09-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: gateways |
| properties | API route config of the Spring Cloud Gateway | GatewayRouteConfigProperties |
GatewayRouteConfigProperties
| Name | Description | Value |
|---|---|---|
| appResourceId | The resource Id of the Azure Spring Apps app, required unless route defines uri. |
string |
| openApi | OpenAPI properties of Spring Cloud Gateway route config. | GatewayRouteConfigOpenApiProperties |
| protocol | Protocol of routed Azure Spring Apps applications. | "HTTP" "HTTPS" |
| routes | Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters. |
GatewayApiRoute[] |
GatewayRouteConfigOpenApiProperties
| Name | Description | Value |
|---|---|---|
| uri | The URI of OpenAPI specification. | string |
GatewayApiRoute
| Name | Description | Value |
|---|---|---|
| description | A description, will be applied to methods in the generated OpenAPI documentation. | string |
| filters | To modify the request before sending it to the target endpoint, or the received response. | string[] |
| order | Route processing order. | int |
| predicates | A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. | string[] |
| ssoEnabled | Enable sso validation. | bool |
| tags | Classification tags, will be applied to methods in the generated OpenAPI documentation. | string[] |
| title | A title, will be applied to methods in the generated OpenAPI documentation. | string |
| tokenRelay | Pass currently-authenticated user's identity token to application service, default is 'false' | bool |
| uri | Full uri, will override appName. |
string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for