gateways

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

Overview

Name	gateways
Type	Resource
Id	azure_extras.app_platform.gateways

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.
apiMetadataProperties	object	API metadata property for Spring Cloud Gateway.
apms	array	Collection of ApmReferences in service level.
clientAuth	object	Client-Certification Authentication.
corsProperties	object	Cross-Origin Resource Sharing property.
environmentVariables	object	Environment variables of Spring Cloud Gateway.
httpsOnly	boolean	Indicate if only https is allowed.
instances	array	Collection of instances belong to Spring Cloud Gateway.
operatorProperties	object	Properties of the Spring Cloud Gateway Operator.
provisioningState	string	State of the Spring Cloud Gateway. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
public	boolean	Indicates whether the Spring Cloud Gateway exposes endpoint.
resourceRequests	object	The requested resource quantity for required CPU and Memory.
sku	object	Sku of the Spring Cloud Gateway resource.
ssoProperties	object	Single sign-on related configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
url	string	URL of the Spring Cloud Gateway, exposed when 'public' is true.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
apiMetadataProperties	object	API metadata property for Spring Cloud Gateway.
apms	array	Collection of ApmReferences in service level.
clientAuth	object	Client-Certification Authentication.
corsProperties	object	Cross-Origin Resource Sharing property.
environmentVariables	object	Environment variables of Spring Cloud Gateway.
httpsOnly	boolean	Indicate if only https is allowed.
instances	array	Collection of instances belong to Spring Cloud Gateway.
operatorProperties	object	Properties of the Spring Cloud Gateway Operator.
provisioningState	string	State of the Spring Cloud Gateway. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
public	boolean	Indicates whether the Spring Cloud Gateway exposes endpoint.
resourceRequests	object	The requested resource quantity for required CPU and Memory.
sku	object	Sku of the Spring Cloud Gateway resource.
ssoProperties	object	Single sign-on related configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.
url	string	URL of the Spring Cloud Gateway, exposed when 'public' is true.

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, subscription_id		Get the Spring Cloud Gateway and its properties.
list	select	resource_group_name, service_name, subscription_id		Handles requests to list all resources in a Service.
create_or_update	insert	resource_group_name, service_name, gateway_name, subscription_id		Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
create_or_update	replace	resource_group_name, service_name, gateway_name, subscription_id		Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
delete	delete	resource_group_name, service_name, gateway_name, subscription_id		Disable the default Spring Cloud Gateway.
list_env_secrets	exec	resource_group_name, service_name, gateway_name, subscription_id		List sensitive environment variables of Spring Cloud Gateway.
restart	exec	resource_group_name, service_name, gateway_name, subscription_id		Restart the Spring Cloud Gateway.
validate_domain	exec	resource_group_name, service_name, gateway_name, subscription_id, 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
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.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the Spring Cloud Gateway and its properties.

SELECT
id,
name,
apiMetadataProperties,
apms,
clientAuth,
corsProperties,
environmentVariables,
httpsOnly,
instances,
operatorProperties,
provisioningState,
public,
resourceRequests,
sku,
ssoProperties,
systemData,
type,
url
FROM azure_extras.app_platform.gateways
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
;

list

Handles requests to list all resources in a Service.

SELECT
id,
name,
apiMetadataProperties,
apms,
clientAuth,
corsProperties,
environmentVariables,
httpsOnly,
instances,
operatorProperties,
provisioningState,
public,
resourceRequests,
sku,
ssoProperties,
systemData,
type,
url
FROM azure_extras.app_platform.gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gateways resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the gateways resource.
  - name: gateway_name
    value: "{{ gateway_name }}"
    description: Required parameter for the gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gateways resource.
  - name: properties
    description: |
      Spring Cloud Gateway properties payload.
    value:
      provisioningState: "{{ provisioningState }}"
      public: {{ public }}
      url: "{{ url }}"
      httpsOnly: {{ httpsOnly }}
      ssoProperties:
        scope:
          - "{{ scope }}"
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        issuerUri: "{{ issuerUri }}"
      apiMetadataProperties:
        title: "{{ title }}"
        description: "{{ description }}"
        documentation: "{{ documentation }}"
        version: "{{ version }}"
        serverUrl: "{{ serverUrl }}"
      corsProperties:
        allowedOrigins:
          - "{{ allowedOrigins }}"
        allowedOriginPatterns:
          - "{{ allowedOriginPatterns }}"
        allowedMethods:
          - "{{ allowedMethods }}"
        allowedHeaders:
          - "{{ allowedHeaders }}"
        maxAge: {{ maxAge }}
        allowCredentials: {{ allowCredentials }}
        exposedHeaders:
          - "{{ exposedHeaders }}"
      clientAuth:
        certificates:
          - "{{ certificates }}"
        certificateVerification: "{{ certificateVerification }}"
      apms:
        - resourceId: "{{ resourceId }}"
      environmentVariables:
        properties: "{{ properties }}"
        secrets: "{{ secrets }}"
      resourceRequests:
        cpu: "{{ cpu }}"
        memory: "{{ memory }}"
      instances:
        - name: "{{ name }}"
          status: "{{ status }}"
      operatorProperties:
        resourceRequests:
          cpu: "{{ cpu }}"
          memory: "{{ memory }}"
          instanceCount: {{ instanceCount }}
        instances:
          - name: "{{ name }}"
            status: "{{ status }}"
  - name: sku
    description: |
      Sku of the Spring Cloud Gateway resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      capacity: {{ capacity }}

REPLACE examples

create_or_update

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

REPLACE azure_extras.app_platform.gateways
SET 
properties = '{{ properties }}',
sku = '{{ sku }}'
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
RETURNING
id,
name,
properties,
sku,
systemData,
type;

DELETE examples

delete

Disable the default Spring Cloud Gateway.

DELETE FROM azure_extras.app_platform.gateways
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
;

Lifecycle Methods

list_env_secrets

List sensitive environment variables of Spring Cloud Gateway.

EXEC azure_extras.app_platform.gateways.list_env_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restart

Restart the Spring Cloud Gateway.

EXEC azure_extras.app_platform.gateways.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

validate_domain

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

EXEC azure_extras.app_platform.gateways.validate_domain 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;