gateway_custom_domains

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

Overview

Name	gateway_custom_domains
Type	Resource
Id	azure.spring_apps.gateway_custom_domains

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Spring Cloud Gateway custom domain.

Name	Datatype	Description
properties	object	The properties of custom domain for Spring Cloud Gateway

list

Success. The response describes the list of Spring Cloud Gateway custom domains.

Name	Datatype	Description
properties	object	The properties of custom domain for 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, domainName		Get the Spring Cloud Gateway custom domain.
list	select	subscriptionId, resourceGroupName, serviceName, gatewayName		Handle requests to list all Spring Cloud Gateway custom domains.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, gatewayName, domainName		Create or update the Spring Cloud Gateway custom domain.
delete	delete	subscriptionId, resourceGroupName, serviceName, gatewayName, domainName		Delete the Spring Cloud Gateway custom domain.

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
domainName	string	The name of the Spring Cloud Gateway custom domain.
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 custom domain.

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

list

Handle requests to list all Spring Cloud Gateway custom domains.

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

INSERT examples

create_or_update

Create or update the Spring Cloud Gateway custom domain.

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

Manifest

# Description fields are for documentation purposes
- name: gateway_custom_domains
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the gateway_custom_domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateway_custom_domains resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateway_custom_domains resource.
    - name: gatewayName
      value: string
      description: Required parameter for the gateway_custom_domains resource.
    - name: domainName
      value: string
      description: Required parameter for the gateway_custom_domains resource.
    - name: properties
      value: object
      description: |
        The properties of custom domain for Spring Cloud Gateway

DELETE examples

delete

Delete the Spring Cloud Gateway custom domain.

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