gateway_route_configs

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

Overview

Name	gateway_route_configs
Type	Resource
Id	azure.spring_apps.gateway_route_configs

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Spring Cloud Gateway route configs.

Name	Datatype	Description
properties	object	API route config of the Spring Cloud Gateway

list

Success. The response describes the list of Spring Cloud Gateway route configs.

Name	Datatype	Description
properties	object	API route config of the Spring Cloud Gateway

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, gatewayName, routeConfigName		Get the Spring Cloud Gateway route configs.
list	select	subscriptionId, resourceGroupName, serviceName, gatewayName		Handle requests to list all Spring Cloud Gateway route configs.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, gatewayName, routeConfigName		Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.
delete	delete	subscriptionId, resourceGroupName, serviceName, gatewayName, routeConfigName		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
gatewayName	string	The name of Spring Cloud Gateway.
resourceGroupName	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.
routeConfigName	string	The name of the Spring Cloud Gateway route config.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the Spring Cloud Gateway route configs.

SELECT
properties
FROM azure.spring_apps.gateway_route_configs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayName = '{{ gatewayName }}' -- required
AND routeConfigName = '{{ routeConfigName }}' -- required
;

list

Handle requests to list all Spring Cloud Gateway route configs.

SELECT
properties
FROM azure.spring_apps.gateway_route_configs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayName = '{{ gatewayName }}' -- 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.spring_apps.gateway_route_configs (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
gatewayName,
routeConfigName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ gatewayName }}',
'{{ routeConfigName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: gateway_route_configs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the gateway_route_configs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateway_route_configs resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateway_route_configs resource.
    - name: gatewayName
      value: string
      description: Required parameter for the gateway_route_configs resource.
    - name: routeConfigName
      value: string
      description: Required parameter for the gateway_route_configs resource.
    - name: properties
      value: object
      description: |
        API route config of the Spring Cloud Gateway

DELETE examples

delete

Delete the Spring Cloud Gateway route config.

DELETE FROM azure.spring_apps.gateway_route_configs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
AND routeConfigName = '{{ routeConfigName }}' --required
;