gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.spring_apps.gateways

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Spring Cloud Gateway.

Name	Datatype	Description
properties	object	Spring Cloud Gateway properties payload
sku	object	Sku of the Spring Cloud Gateway resource

list

Success. The response describes the list of gateways in the Service.

Name	Datatype	Description
properties	object	Spring Cloud Gateway properties payload
sku	object	Sku of the Spring Cloud Gateway resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, gatewayName		Get the Spring Cloud Gateway and its properties.
list	select	subscriptionId, resourceGroupName, serviceName		Handles requests to list all resources in a Service.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, gatewayName		Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
delete	delete	subscriptionId, resourceGroupName, serviceName, gatewayName		Disable the default Spring Cloud Gateway.
restart	exec	subscriptionId, resourceGroupName, serviceName, gatewayName		Restart the Spring Cloud Gateway.
validate_domain	exec	subscriptionId, resourceGroupName, serviceName, gatewayName, name		Check the domains are valid as well as not in use.

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.
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 and its properties.

SELECT
properties,
sku
FROM azure.spring_apps.gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayName = '{{ gatewayName }}' -- required
;

list

Handles requests to list all resources in a Service.

SELECT
properties,
sku
FROM azure.spring_apps.gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.spring_apps.gateways (
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
serviceName,
gatewayName
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ gatewayName }}'
RETURNING
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: gateways
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateways resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateways resource.
    - name: gatewayName
      value: string
      description: Required parameter for the gateways resource.
    - name: properties
      value: object
      description: |
        Spring Cloud Gateway properties payload
    - name: sku
      value: object
      description: |
        Sku of the Spring Cloud Gateway resource

DELETE examples

delete

Disable the default Spring Cloud Gateway.

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

Lifecycle Methods

restart

Restart the Spring Cloud Gateway.

EXEC azure.spring_apps.gateways.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@gatewayName='{{ gatewayName }}' --required
;

validate_domain

Check the domains are valid as well as not in use.

EXEC azure.spring_apps.gateways.validate_domain 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@gatewayName='{{ gatewayName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;