custom_domains

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

Overview

Name	custom_domains
Type	Resource
Id	azure_extras.app_platform.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.
appName	string	The app name of domain.
certName	string	The bound certificate name of domain.
provisioningState	string	Provisioning state of the Domain. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
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.
appName	string	The app name of domain.
certName	string	The bound certificate name of domain.
provisioningState	string	Provisioning state of the Domain. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
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, app_name, domain_name, subscription_id		Get the custom domain of one lifecycle application.
list	select	resource_group_name, service_name, app_name, subscription_id		List the custom domains of one lifecycle application.
create_or_update	insert	resource_group_name, service_name, app_name, domain_name, subscription_id		Create or update custom domain of one lifecycle application.
update	update	resource_group_name, service_name, app_name, domain_name, subscription_id		Update custom domain of one lifecycle application.
create_or_update	replace	resource_group_name, service_name, app_name, domain_name, subscription_id		Create or update custom domain of one lifecycle application.
delete	delete	resource_group_name, service_name, app_name, domain_name, subscription_id		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
app_name	string	The name of the App resource. Required.
domain_name	string	The name of the custom domain resource. 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 custom domain of one lifecycle application.

SELECT
id,
name,
appName,
certName,
provisioningState,
systemData,
thumbprint,
type
FROM azure_extras.app_platform.custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List the custom domains of one lifecycle application.

SELECT
id,
name,
appName,
certName,
provisioningState,
systemData,
thumbprint,
type
FROM azure_extras.app_platform.custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update custom domain of one lifecycle application.

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

Manifest

# Description fields are for documentation purposes
- name: custom_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the custom_domains resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the custom_domains resource.
  - name: app_name
    value: "{{ app_name }}"
    description: Required parameter for the custom_domains resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the custom_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the custom_domains resource.
  - name: properties
    description: |
      Properties of the custom domain resource.
    value:
      thumbprint: "{{ thumbprint }}"
      appName: "{{ appName }}"
      certName: "{{ certName }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update custom domain of one lifecycle application.

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

REPLACE examples

create_or_update

Create or update custom domain of one lifecycle application.

REPLACE azure_extras.app_platform.custom_domains
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_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 custom domain of one lifecycle application.

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