web_pub_sub_custom_domains

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

Overview

Name	web_pub_sub_custom_domains
Type	Resource
Id	azure.web_pubsub.web_pub_sub_custom_domains

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
customCertificate	object	Reference to a resource. Required.
domainName	string	The custom domain name. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
customCertificate	object	Reference to a resource. Required.
domainName	string	The custom domain name. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, name, subscription_id		Get a custom domain.
list	select	resource_group_name, resource_name, subscription_id		List all custom domains.
create_or_update	insert	resource_group_name, resource_name, name, subscription_id, properties		Create or update a custom domain.
create_or_update	replace	resource_group_name, resource_name, name, subscription_id, properties		Create or update a custom domain.
delete	delete	resource_group_name, resource_name, name, subscription_id		Delete 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
name	string	Custom domain name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the resource. Required.
subscription_id	string

SELECT examples

get

Get a custom domain.

SELECT
id,
name,
customCertificate,
domainName,
provisioningState,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all custom domains.

SELECT
id,
name,
customCertificate,
domainName,
provisioningState,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a custom domain.

INSERT INTO azure.web_pubsub.web_pub_sub_custom_domains (
properties,
resource_group_name,
resource_name,
name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_pub_sub_custom_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the web_pub_sub_custom_domains resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the web_pub_sub_custom_domains resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the web_pub_sub_custom_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the web_pub_sub_custom_domains resource.
  - name: properties
    value:
      domainName: "{{ domainName }}"
      customCertificate:
        id: "{{ id }}"

REPLACE examples

create_or_update

Create or update a custom domain.

REPLACE azure.web_pubsub.web_pub_sub_custom_domains
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a custom domain.

DELETE FROM azure.web_pubsub.web_pub_sub_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;