domains

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

Overview

Name	domains
Type	Resource
Id	azure.event_grid.domains

Fields

vw_domains

Name	Datatype	Description
auto_create_topic_with_first_subscription	text	field from the properties object
auto_delete_topic_with_last_subscription	text	field from the properties object
data_residency_boundary	text	field from the properties object
disable_local_auth	text	field from the properties object
domainName	text	field from the properties object
endpoint	text	field from the properties object
event_type_info	text	field from the properties object
identity	text	The identity information for the resource.
inbound_ip_rules	text	field from the properties object
input_schema	text	field from the properties object
input_schema_mapping	text	field from the properties object
location	text	The geo-location where the resource lives
metric_resource_id	text	field from the properties object
minimum_tls_version_allowed	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	Describes an EventGrid Resource Sku.
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.

domains

Name	Datatype	Description
identity	object	The identity information for the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the Event Grid Domain Resource.
sku	object	Describes an EventGrid Resource Sku.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	domainName, resourceGroupName, subscriptionId	Get properties of a domain.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all the domains under a resource group.
list_by_subscription	SELECT	subscriptionId	List all the domains under an Azure subscription.
create_or_update	INSERT	domainName, resourceGroupName, subscriptionId	Asynchronously creates or updates a new domain with the specified parameters.
delete	DELETE	domainName, resourceGroupName, subscriptionId	Delete existing domain.
update	UPDATE	domainName, resourceGroupName, subscriptionId	Asynchronously updates a domain with the specified parameters.
regenerate_key	EXEC	domainName, resourceGroupName, subscriptionId, data__keyName	Regenerate a shared access key for a domain.

SELECT examples

List all the domains under an Azure subscription.

vw_domains

SELECT
auto_create_topic_with_first_subscription,
auto_delete_topic_with_last_subscription,
data_residency_boundary,
disable_local_auth,
domainName,
endpoint,
event_type_info,
identity,
inbound_ip_rules,
input_schema,
input_schema_mapping,
location,
metric_resource_id,
minimum_tls_version_allowed,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
sku,
subscriptionId,
system_data,
tags
FROM azure.event_grid.vw_domains
WHERE subscriptionId = '{{ subscriptionId }}';

domains

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.event_grid.domains
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new domains resource.

All Properties

/*+ create */
INSERT INTO azure.event_grid.domains (
domainName,
resourceGroupName,
subscriptionId,
tags,
location,
properties,
sku,
identity
)
SELECT 
'{{ domainName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: groupIds
                    value:
                      - string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: string
        - name: provisioningState
          value: string
        - name: minimumTlsVersionAllowed
          value: string
        - name: endpoint
          value: string
        - name: inputSchema
          value: string
        - name: eventTypeInfo
          value:
            - name: kind
              value: string
            - name: inlineEventTypes
              value: object
        - name: inputSchemaMapping
          value:
            - name: inputSchemaMappingType
              value: string
        - name: metricResourceId
          value: string
        - name: publicNetworkAccess
          value: string
        - name: inboundIpRules
          value:
            - - name: ipMask
                value: string
              - name: action
                value: string
        - name: disableLocalAuth
          value: boolean
        - name: autoCreateTopicWithFirstSubscription
          value: boolean
        - name: autoDeleteTopicWithLastSubscription
          value: boolean
        - name: dataResidencyBoundary
          value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: userAssignedIdentities
          value: object

UPDATE example

Updates a domains resource.

/*+ update */
UPDATE azure.event_grid.domains
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
domainName = '{{ domainName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified domains resource.

/*+ delete */
DELETE FROM azure.event_grid.domains
WHERE domainName = '{{ domainName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';