static_site_custom_domains

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

Overview

Name	static_site_custom_domains
Type	Resource
Id	azure.app_service.static_site_custom_domains

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	StaticSiteCustomDomainOverviewARMResource resource specific properties
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	StaticSiteCustomDomainOverviewARMResource resource specific properties
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, domainName, subscriptionId		Description for Gets an existing custom domain for a particular static site.
list	select	resourceGroupName, name, subscriptionId		Description for Gets all static site custom domains for a particular static site.
create_or_update	insert	resourceGroupName, name, domainName, subscriptionId		Description for Creates a new static site custom domain in an existing resource group and static site.
delete	delete	resourceGroupName, name, domainName, subscriptionId		Description for Deletes a 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
domainName	string	The custom domain to delete.
name	string	Name of the static site.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

get

Description for Gets an existing custom domain for a particular static site.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.static_site_custom_domains
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND domainName = '{{ domainName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Description for Gets all static site custom domains for a particular static site.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.static_site_custom_domains
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Creates a new static site custom domain in an existing resource group and static site.

INSERT INTO azure.app_service.static_site_custom_domains (
data__kind,
data__properties,
resourceGroupName,
name,
domainName,
subscriptionId
)
SELECT 
'{{ kind }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ domainName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: static_site_custom_domains
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the static_site_custom_domains resource.
    - name: name
      value: string
      description: Required parameter for the static_site_custom_domains resource.
    - name: domainName
      value: string
      description: Required parameter for the static_site_custom_domains resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the static_site_custom_domains resource.
    - name: kind
      value: string
      description: |
        Kind of resource.
    - name: properties
      value: object
      description: |
        StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties

DELETE examples

delete

Description for Deletes a custom domain.

DELETE FROM azure.app_service.static_site_custom_domains
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND domainName = '{{ domainName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;