Share via

GatewayRouteConfigProperties interface

  • Reference
Package:
@azure/arm-appplatform

API route config of the Spring Cloud Gateway

Properties

appResourceId

The resource Id of the Azure Spring Apps app, required unless route defines uri.
filters

To modify the request before sending it to the target endpoint, or the received response in app level.
openApi

OpenAPI properties of Spring Cloud Gateway route config.
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.
protocol

Protocol of routed Azure Spring Apps applications.
provisioningState

State of the Spring Cloud Gateway route config. NOTE: This property will not be serialized. It can only be populated by the server.
routes

Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
ssoEnabled

Enable Single Sign-On in app level.

Property Details

appResourceId

The resource Id of the Azure Spring Apps app, required unless route defines uri.

appResourceId?: string

Property Value

string

filters

To modify the request before sending it to the target endpoint, or the received response in app level.

filters?: string[]

Property Value

string[]

openApi

OpenAPI properties of Spring Cloud Gateway route config.

openApi?: GatewayRouteConfigOpenApiProperties

Property Value

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.

predicates?: string[]

Property Value

string[]

protocol

Protocol of routed Azure Spring Apps applications.

protocol?: string

Property Value

string

provisioningState

State of the Spring Cloud Gateway route config. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

routes

Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.

routes?: GatewayApiRoute[]

Property Value

GatewayApiRoute[]

ssoEnabled

Enable Single Sign-On in app level.

ssoEnabled?: boolean

Property Value

boolean