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_extras.app_platform.api_portal_custom_domains

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.
systemData	object	Metadata pertaining to creation and last modification of the resource.
thumbprint	string	The thumbprint of bound certificate.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
thumbprint	string	The thumbprint of bound certificate.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, api_portal_name, domain_name, subscription_id		Get the API portal custom domain.
list	select	resource_group_name, service_name, api_portal_name, subscription_id		Handle requests to list all API portal custom domains.
create_or_update	insert	resource_group_name, service_name, api_portal_name, domain_name, subscription_id		Create or update the API portal custom domain.
create_or_update	replace	resource_group_name, service_name, api_portal_name, domain_name, subscription_id		Create or update the API portal custom domain.
delete	delete	resource_group_name, service_name, api_portal_name, domain_name, subscription_id		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
api_portal_name	string	The name of API portal. Required.
domain_name	string	The name of the API portal custom domain. 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 API portal custom domain.

SELECT
id,
name,
systemData,
thumbprint,
type
FROM azure_extras.app_platform.api_portal_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_portal_name = '{{ api_portal_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handle requests to list all API portal custom domains.

SELECT
id,
name,
systemData,
thumbprint,
type
FROM azure_extras.app_platform.api_portal_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_portal_name = '{{ api_portal_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the API portal custom domain.

INSERT INTO azure_extras.app_platform.api_portal_custom_domains (
properties,
resource_group_name,
service_name,
api_portal_name,
domain_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_portal_name }}',
'{{ domain_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_portal_custom_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_portal_custom_domains resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_portal_custom_domains resource.
  - name: api_portal_name
    value: "{{ api_portal_name }}"
    description: Required parameter for the api_portal_custom_domains resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the api_portal_custom_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_portal_custom_domains resource.
  - name: properties
    description: |
      The properties of custom domain for API portal.
    value:
      thumbprint: "{{ thumbprint }}"

REPLACE examples

create_or_update

Create or update the API portal custom domain.

REPLACE azure_extras.app_platform.api_portal_custom_domains
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_portal_name = '{{ api_portal_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the API portal custom domain.

DELETE FROM azure_extras.app_platform.api_portal_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_portal_name = '{{ api_portal_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;