custom_domains

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

Overview

Name	custom_domains
Type	Resource
Id	azure.web_pubsub.custom_domains

Fields

The following fields are returned by SELECT queries:

get

Success. The response describe the corresponding custom domain.

Name	Datatype	Description
properties	object	Properties of a custom domain.

list

Success. The response describes custom domains of the resource.

Name	Datatype	Description
properties	object	Properties of a custom domain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, name		Get a custom domain.
list	select	subscriptionId, resourceGroupName, resourceName		List all custom domains.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, name, data__properties		Create or update a custom domain.
delete	delete	subscriptionId, resourceGroupName, resourceName, name		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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a custom domain.

SELECT
properties
FROM azure.web_pubsub.custom_domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND name = '{{ name }}' -- required
;

list

List all custom domains.

SELECT
properties
FROM azure.web_pubsub.custom_domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

Create or update a custom domain.

INSERT INTO azure.web_pubsub.custom_domains (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
name
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ name }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: custom_domains
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the custom_domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_domains resource.
    - name: resourceName
      value: string
      description: Required parameter for the custom_domains resource.
    - name: name
      value: string
      description: Required parameter for the custom_domains resource.
    - name: properties
      value: object
      description: |
        Properties of a custom domain.

DELETE examples

delete

Delete a custom domain.

DELETE FROM azure.web_pubsub.custom_domains
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND name = '{{ name }}' --required
;