api_portal_custom_domains
Creates, updates, deletes, gets or lists a api_portal_custom_domains
resource.
Overview
Name | api_portal_custom_domains |
Type | Resource |
Id | azure.spring_apps.api_portal_custom_domains |
Fields
- vw_api_portal_custom_domains
- api_portal_custom_domains
Name | Datatype | Description |
---|---|---|
apiPortalName | text | field from the properties object |
domainName | text | field from the properties object |
resourceGroupName | text | field from the properties object |
serviceName | text | field from the properties object |
subscriptionId | text | field from the properties object |
thumbprint | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
properties | object | The properties of custom domain for API portal |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | apiPortalName, domainName, resourceGroupName, serviceName, subscriptionId | Get the API portal custom domain. |
list | SELECT | apiPortalName, resourceGroupName, serviceName, subscriptionId | Handle requests to list all API portal custom domains. |
create_or_update | INSERT | apiPortalName, domainName, resourceGroupName, serviceName, subscriptionId | Create or update the API portal custom domain. |
delete | DELETE | apiPortalName, domainName, resourceGroupName, serviceName, subscriptionId | Delete the API portal custom domain. |
SELECT
examples
Handle requests to list all API portal custom domains.
- vw_api_portal_custom_domains
- api_portal_custom_domains
SELECT
apiPortalName,
domainName,
resourceGroupName,
serviceName,
subscriptionId,
thumbprint
FROM azure.spring_apps.vw_api_portal_custom_domains
WHERE apiPortalName = '{{ apiPortalName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
properties
FROM azure.spring_apps.api_portal_custom_domains
WHERE apiPortalName = '{{ apiPortalName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new api_portal_custom_domains
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.spring_apps.api_portal_custom_domains (
apiPortalName,
domainName,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT
'{{ apiPortalName }}',
'{{ domainName }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: thumbprint
value: string
DELETE
example
Deletes the specified api_portal_custom_domains
resource.
/*+ delete */
DELETE FROM azure.spring_apps.api_portal_custom_domains
WHERE apiPortalName = '{{ apiPortalName }}'
AND domainName = '{{ domainName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';