gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.spring_apps.gateways

Fields

vw_gateways

Name	Datatype	Description
addon_configs	text	field from the properties object
api_metadata_properties	text	field from the properties object
apm_types	text	field from the properties object
apms	text	field from the properties object
client_auth	text	field from the properties object
cors_properties	text	field from the properties object
environment_variables	text	field from the properties object
gatewayName	text	field from the properties object
https_only	text	field from the properties object
instances	text	field from the properties object
operator_properties	text	field from the properties object
provisioning_state	text	field from the properties object
public	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_requests	text	field from the properties object
response_cache_properties	text	field from the properties object
serviceName	text	field from the properties object
sku	text	Sku of Azure Spring Apps
sso_properties	text	field from the properties object
subscriptionId	text	field from the properties object
url	text	field from the properties object

gateways

Name	Datatype	Description
properties	object	Spring Cloud Gateway properties payload
sku	object	Sku of Azure Spring Apps

Methods

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

SELECT examples

Handles requests to list all resources in a Service.

vw_gateways

SELECT
addon_configs,
api_metadata_properties,
apm_types,
apms,
client_auth,
cors_properties,
environment_variables,
gatewayName,
https_only,
instances,
operator_properties,
provisioning_state,
public,
resourceGroupName,
resource_requests,
response_cache_properties,
serviceName,
sku,
sso_properties,
subscriptionId,
url
FROM azure.spring_apps.vw_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

gateways

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

INSERT example

Use the following StackQL query and manifest file to create a new gateways resource.

All Properties

/*+ create */
INSERT INTO azure.spring_apps.gateways (
gatewayName,
resourceGroupName,
serviceName,
subscriptionId,
properties,
sku
)
SELECT 
'{{ gatewayName }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: public
          value: boolean
        - name: url
          value: string
        - name: httpsOnly
          value: boolean
        - name: ssoProperties
          value:
            - name: scope
              value:
                - string
            - name: clientId
              value: string
            - name: clientSecret
              value: string
            - name: issuerUri
              value: string
        - name: apiMetadataProperties
          value:
            - name: title
              value: string
            - name: description
              value: string
            - name: documentation
              value: string
            - name: version
              value: string
            - name: serverUrl
              value: string
        - name: corsProperties
          value:
            - name: allowedOrigins
              value:
                - string
            - name: allowedOriginPatterns
              value:
                - string
            - name: allowedMethods
              value:
                - string
            - name: allowedHeaders
              value:
                - string
            - name: maxAge
              value: integer
            - name: allowCredentials
              value: boolean
            - name: exposedHeaders
              value:
                - string
        - name: clientAuth
          value:
            - name: certificates
              value:
                - string
            - name: certificateVerification
              value: string
        - name: apmTypes
          value:
            - string
        - name: apms
          value: []
        - name: environmentVariables
          value:
            - name: properties
              value: object
            - name: secrets
              value: object
        - name: resourceRequests
          value:
            - name: cpu
              value: string
            - name: memory
              value: string
        - name: addonConfigs
          value: object
        - name: instances
          value:
            - - name: name
                value: string
              - name: status
                value: string
        - name: operatorProperties
          value:
            - name: resourceRequests
              value:
                - name: cpu
                  value: string
                - name: memory
                  value: string
                - name: instanceCount
                  value: integer
            - name: instances
              value:
                - - name: name
                    value: string
                  - name: status
                    value: string
        - name: responseCacheProperties
          value:
            - name: responseCacheType
              value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer

DELETE example

Deletes the specified gateways resource.

/*+ delete */
DELETE FROM azure.spring_apps.gateways
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';