Skip to main content

domains

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

Overview​

Namedomains
TypeResource
Idazure.app_service.domains

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (arm-id)Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
namestringThe name of the resource
propertiesobjectDomain resource specific properties
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresourceGroupName, domainName, subscriptionIdDescription for Get a domain.
list_by_resource_groupselectresourceGroupName, subscriptionIdDescription for Get all domains in a resource group.
listselectsubscriptionIdDescription for Get all domains in a subscription.
create_or_updateinsertresourceGroupName, domainName, subscriptionIdDescription for Creates or updates a domain.
updateupdateresourceGroupName, domainName, subscriptionIdDescription for Creates or updates a domain.
deletedeleteresourceGroupName, domainName, subscriptionIdforceHardDeleteDomainDescription for Delete a domain.
check_availabilityexecsubscriptionIdDescription for Check if a domain is available for registration.
renewexecresourceGroupName, domainName, subscriptionIdDescription for Renew a domain.
transfer_outexecresourceGroupName, domainName, subscriptionId

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.

NameDatatypeDescription
domainNamestringName of domain.
resourceGroupNamestringName of the resource group to which the resource belongs.
subscriptionIdstringYour Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
forceHardDeleteDomainbooleanSpecify true to delete the domain immediately. The default is false which deletes the domain after 24 hours.

SELECT examples​

Description for Get a domain.

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

INSERT examples​

Description for Creates or updates a domain.

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

UPDATE examples​

Description for Creates or updates a domain.

UPDATE azure.app_service.domains
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND domainName = '{{ domainName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples​

Description for Delete a domain.

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

Lifecycle Methods​

Description for Check if a domain is available for registration.

EXEC azure.app_service.domains.check_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;