gateway_route_configs

Creates, updates, deletes, gets or lists a gateway_route_configs resource.

Overview

Name	gateway_route_configs
Type	Resource
Id	azure_extras.app_platform.gateway_route_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
appResourceId	string	The resource Id of the Azure Spring Apps app, required unless route defines uri.
filters	array	To modify the request before sending it to the target endpoint, or the received response in app level.
openApi	object	OpenAPI properties of Spring Cloud Gateway route config.
predicates	array	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	string	Protocol of routed Azure Spring Apps applications. Known values are: "HTTP" and "HTTPS".
provisioningState	string	State of the Spring Cloud Gateway route config. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
routes	array	Array of API routes, each route contains properties such as title\ , uri\ , ssoEnabled\ , predicates\ , filters.
ssoEnabled	boolean	Enable Single Sign-On in app level.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
appResourceId	string	The resource Id of the Azure Spring Apps app, required unless route defines uri.
filters	array	To modify the request before sending it to the target endpoint, or the received response in app level.
openApi	object	OpenAPI properties of Spring Cloud Gateway route config.
predicates	array	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	string	Protocol of routed Azure Spring Apps applications. Known values are: "HTTP" and "HTTPS".
provisioningState	string	State of the Spring Cloud Gateway route config. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
routes	array	Array of API routes, each route contains properties such as title\ , uri\ , ssoEnabled\ , predicates\ , filters.
ssoEnabled	boolean	Enable Single Sign-On in app level.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, gateway_name, route_config_name, subscription_id		Get the Spring Cloud Gateway route configs.
list	select	resource_group_name, service_name, gateway_name, subscription_id		Handle requests to list all Spring Cloud Gateway route configs.
create_or_update	insert	resource_group_name, service_name, gateway_name, route_config_name, subscription_id		Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.
create_or_update	replace	resource_group_name, service_name, gateway_name, route_config_name, subscription_id		Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.
delete	delete	resource_group_name, service_name, gateway_name, route_config_name, subscription_id		Delete the Spring Cloud Gateway route config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
gateway_name	string	The name of Spring Cloud Gateway. Required.
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
route_config_name	string	The name of the Spring Cloud Gateway route config. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the Spring Cloud Gateway route configs.

SELECT
id,
name,
appResourceId,
filters,
openApi,
predicates,
protocol,
provisioningState,
routes,
ssoEnabled,
systemData,
type
FROM azure_extras.app_platform.gateway_route_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_name = '{{ gateway_name }}' -- required
AND route_config_name = '{{ route_config_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handle requests to list all Spring Cloud Gateway route configs.

SELECT
id,
name,
appResourceId,
filters,
openApi,
predicates,
protocol,
provisioningState,
routes,
ssoEnabled,
systemData,
type
FROM azure_extras.app_platform.gateway_route_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_name = '{{ gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.

INSERT INTO azure_extras.app_platform.gateway_route_configs (
properties,
resource_group_name,
service_name,
gateway_name,
route_config_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ gateway_name }}',
'{{ route_config_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: gateway_route_configs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gateway_route_configs resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the gateway_route_configs resource.
  - name: gateway_name
    value: "{{ gateway_name }}"
    description: Required parameter for the gateway_route_configs resource.
  - name: route_config_name
    value: "{{ route_config_name }}"
    description: Required parameter for the gateway_route_configs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gateway_route_configs resource.
  - name: properties
    description: |
      API route config of the Spring Cloud Gateway.
    value:
      provisioningState: "{{ provisioningState }}"
      appResourceId: "{{ appResourceId }}"
      openApi:
        uri: "{{ uri }}"
      protocol: "{{ protocol }}"
      routes:
        - title: "{{ title }}"
          description: "{{ description }}"
          uri: "{{ uri }}"
          ssoEnabled: {{ ssoEnabled }}
          tokenRelay: {{ tokenRelay }}
          predicates: "{{ predicates }}"
          filters: "{{ filters }}"
          order: {{ order }}
          tags: "{{ tags }}"
      ssoEnabled: {{ ssoEnabled }}
      predicates:
        - "{{ predicates }}"
      filters:
        - "{{ filters }}"

REPLACE examples

create_or_update

Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.

REPLACE azure_extras.app_platform.gateway_route_configs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND route_config_name = '{{ route_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the Spring Cloud Gateway route config.

DELETE FROM azure_extras.app_platform.gateway_route_configs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND route_config_name = '{{ route_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;