api_portal_custom_domains

Creates, updates, deletes, gets or lists an api_portal_custom_domains resource.

Overview

Name	api_portal_custom_domains
Type	Resource
Id	azure.spring_apps.api_portal_custom_domains

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding API portal custom domain.

Name	Datatype	Description
properties	object	The properties of custom domain for API portal

list

Success. The response describes the list of API portal custom domains.

Name	Datatype	Description
properties	object	The properties of custom domain for API portal

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, apiPortalName, domainName		Get the API portal custom domain.
list	select	subscriptionId, resourceGroupName, serviceName, apiPortalName		Handle requests to list all API portal custom domains.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, apiPortalName, domainName		Create or update the API portal custom domain.
delete	delete	subscriptionId, resourceGroupName, serviceName, apiPortalName, domainName		Delete the API portal 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
apiPortalName	string	The name of API portal.
domainName	string	The name of the API portal custom domain.
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 API portal custom domain.

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

list

Handle requests to list all API portal custom domains.

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

INSERT examples

create_or_update

Create or update the API portal custom domain.

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

Manifest

# Description fields are for documentation purposes
- name: api_portal_custom_domains
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the api_portal_custom_domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_portal_custom_domains resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_portal_custom_domains resource.
    - name: apiPortalName
      value: string
      description: Required parameter for the api_portal_custom_domains resource.
    - name: domainName
      value: string
      description: Required parameter for the api_portal_custom_domains resource.
    - name: properties
      value: object
      description: |
        The properties of custom domain for API portal

DELETE examples

delete

Delete the API portal custom domain.

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