custom_domains

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

Overview

Name	custom_domains
Type	Resource
Id	azure.spring_apps.custom_domains

Fields

The following fields are returned by SELECT queries:

get

Success. The response describe the custom domain.

Name	Datatype	Description
properties	object	Properties of the custom domain resource.

list

Success. The response describe the custom domain resource list of one application.

Name	Datatype	Description
properties	object	Properties of the custom domain resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, appName, domainName		Get the custom domain of one lifecycle application.
list	select	subscriptionId, resourceGroupName, serviceName, appName		List the custom domains of one lifecycle application.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, appName, domainName		Create or update custom domain of one lifecycle application.
update	update	subscriptionId, resourceGroupName, serviceName, appName, domainName		Update custom domain of one lifecycle application.
delete	delete	subscriptionId, resourceGroupName, serviceName, appName, domainName		Delete the custom domain of one lifecycle application.

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
appName	string	The name of the App resource.
domainName	string	The name of the custom domain resource.
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 custom domain of one lifecycle application.

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

list

List the custom domains of one lifecycle application.

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

INSERT examples

create_or_update

Create or update custom domain of one lifecycle application.

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

Manifest

# Description fields are for documentation purposes
- name: custom_domains
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the custom_domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_domains resource.
    - name: serviceName
      value: string
      description: Required parameter for the custom_domains resource.
    - name: appName
      value: string
      description: Required parameter for the custom_domains resource.
    - name: domainName
      value: string
      description: Required parameter for the custom_domains resource.
    - name: properties
      value: object
      description: |
        Properties of the custom domain resource.

UPDATE examples

update

Update custom domain of one lifecycle application.

UPDATE azure.spring_apps.custom_domains
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND appName = '{{ appName }}' --required
AND domainName = '{{ domainName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the custom domain of one lifecycle application.

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