The Spring/gateways/routeConfigs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AppPlatform/Spring/gateways/routeConfigs resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"appResourceId": "string",
"filters": [ "string" ],
"openApi": {
"uri": "string"
},
"predicates": [ "string" ],
"protocol": "string",
"routes": [
{
"description": "string",
"filters": [ "string" ],
"order": "int",
"predicates": [ "string" ],
"ssoEnabled": "bool",
"tags": [ "string" ],
"title": "string",
"tokenRelay": "bool",
"uri": "string"
}
],
"ssoEnabled": "bool"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.AppPlatform/Spring/gateways/routeConfigs' |
apiVersion | The resource api version | '2023-03-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 |
Name | Description | Value |
---|---|---|
appResourceId | The resource Id of the Azure Spring Apps app, required unless route defines uri . |
string |
filters | To modify the request before sending it to the target endpoint, or the received response in app level. | string[] |
openApi | OpenAPI properties of Spring Cloud Gateway route config. | GatewayRouteConfigOpenApiProperties |
predicates | A number of conditions to evaluate a route for each request in app level. 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[] |
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[] |
ssoEnabled | Enable Single Sign-On in app level. | bool |
Name | Description | Value |
---|---|---|
uri | The URI of OpenAPI specification. | string |
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 |