domains

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

Overview

Name	domains
Type	Resource
Id	azure.event_grid.domains

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoCreateTopicWithFirstSubscription	boolean	This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
autoDeleteTopicWithLastSubscription	boolean	This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
dataResidencyBoundary	string	Data Residency Boundary of the resource. Known values are: "WithinGeopair" and "WithinRegion". (WithinGeopair, WithinRegion)
disableLocalAuth	boolean	This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the domain.
endpoint	string	Endpoint for the Event Grid Domain Resource which is used for publishing the events.
eventTypeInfo	object	Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
identity	object	Identity information for the Event Grid Domain resource.
inboundIpRules	array	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
inputSchema	string	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: "EventGridSchema", "CustomEventSchema", and "CloudEventSchemaV1_0". (EventGridSchema, CustomEventSchema, CloudEventSchemaV1_0)
inputSchemaMapping	object	Information about the InputSchemaMapping which specified the info about mapping event payload.
location	string	The geo-location where the resource lives. Required.
metricResourceId	string	Metric resource id for the Event Grid Domain Resource.
minimumTlsVersionAllowed	string	Minimum TLS version of the publisher allowed to publish to this domain. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	Provisioning state of the Event Grid Domain Resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	The Sku pricing tier for the Event Grid Domain resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoCreateTopicWithFirstSubscription	boolean	This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
autoDeleteTopicWithLastSubscription	boolean	This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
dataResidencyBoundary	string	Data Residency Boundary of the resource. Known values are: "WithinGeopair" and "WithinRegion". (WithinGeopair, WithinRegion)
disableLocalAuth	boolean	This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the domain.
endpoint	string	Endpoint for the Event Grid Domain Resource which is used for publishing the events.
eventTypeInfo	object	Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
identity	object	Identity information for the Event Grid Domain resource.
inboundIpRules	array	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
inputSchema	string	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: "EventGridSchema", "CustomEventSchema", and "CloudEventSchemaV1_0". (EventGridSchema, CustomEventSchema, CloudEventSchemaV1_0)
inputSchemaMapping	object	Information about the InputSchemaMapping which specified the info about mapping event payload.
location	string	The geo-location where the resource lives. Required.
metricResourceId	string	Metric resource id for the Event Grid Domain Resource.
minimumTlsVersionAllowed	string	Minimum TLS version of the publisher allowed to publish to this domain. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	Provisioning state of the Event Grid Domain Resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	The Sku pricing tier for the Event Grid Domain resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoCreateTopicWithFirstSubscription	boolean	This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
autoDeleteTopicWithLastSubscription	boolean	This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
dataResidencyBoundary	string	Data Residency Boundary of the resource. Known values are: "WithinGeopair" and "WithinRegion". (WithinGeopair, WithinRegion)
disableLocalAuth	boolean	This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the domain.
endpoint	string	Endpoint for the Event Grid Domain Resource which is used for publishing the events.
eventTypeInfo	object	Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
identity	object	Identity information for the Event Grid Domain resource.
inboundIpRules	array	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
inputSchema	string	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: "EventGridSchema", "CustomEventSchema", and "CloudEventSchemaV1_0". (EventGridSchema, CustomEventSchema, CloudEventSchemaV1_0)
inputSchemaMapping	object	Information about the InputSchemaMapping which specified the info about mapping event payload.
location	string	The geo-location where the resource lives. Required.
metricResourceId	string	Metric resource id for the Event Grid Domain Resource.
minimumTlsVersionAllowed	string	Minimum TLS version of the publisher allowed to publish to this domain. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	Provisioning state of the Event Grid Domain Resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	The Sku pricing tier for the Event Grid Domain resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, domain_name, subscription_id		Get a domain. Get properties of a domain.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top	List domains under a resource group. List all the domains under a resource group.
list_by_subscription	select	subscription_id	$filter, $top	List domains under an Azure subscription. List all the domains under an Azure subscription.
create_or_update	insert	resource_group_name, domain_name, subscription_id, location		Create or update a domain. Asynchronously creates or updates a new domain with the specified parameters.
update	update	resource_group_name, domain_name, subscription_id		Update a domain. Asynchronously updates a domain with the specified parameters.
create_or_update	replace	resource_group_name, domain_name, subscription_id, location		Create or update a domain. Asynchronously creates or updates a new domain with the specified parameters.
delete	delete	resource_group_name, domain_name, subscription_id		Delete a domain. Delete existing domain.
list_shared_access_keys	exec	resource_group_name, domain_name, subscription_id		List keys for a domain. List the two keys used to publish to a domain.
regenerate_key	exec	resource_group_name, domain_name, subscription_id, keyName		Regenerate key for a domain. Regenerate a shared access key for a 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
domain_name	string	Name of the domain. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
$top	integer	The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

SELECT examples

get

Get a domain. Get properties of a domain.

SELECT
id,
name,
autoCreateTopicWithFirstSubscription,
autoDeleteTopicWithLastSubscription,
dataResidencyBoundary,
disableLocalAuth,
endpoint,
eventTypeInfo,
identity,
inboundIpRules,
inputSchema,
inputSchemaMapping,
location,
metricResourceId,
minimumTlsVersionAllowed,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.event_grid.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List domains under a resource group. List all the domains under a resource group.

SELECT
id,
name,
autoCreateTopicWithFirstSubscription,
autoDeleteTopicWithLastSubscription,
dataResidencyBoundary,
disableLocalAuth,
endpoint,
eventTypeInfo,
identity,
inboundIpRules,
inputSchema,
inputSchemaMapping,
location,
metricResourceId,
minimumTlsVersionAllowed,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.event_grid.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List domains under an Azure subscription. List all the domains under an Azure subscription.

SELECT
id,
name,
autoCreateTopicWithFirstSubscription,
autoDeleteTopicWithLastSubscription,
dataResidencyBoundary,
disableLocalAuth,
endpoint,
eventTypeInfo,
identity,
inboundIpRules,
inputSchema,
inputSchemaMapping,
location,
metricResourceId,
minimumTlsVersionAllowed,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.event_grid.domains
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update a domain. Asynchronously creates or updates a new domain with the specified parameters.

INSERT INTO azure.event_grid.domains (
tags,
location,
properties,
sku,
identity,
resource_group_name,
domain_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ domain_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the domains resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the domains resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the Event Grid Domain resource.
    value:
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            groupIds:
              - "{{ groupIds }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      provisioningState: "{{ provisioningState }}"
      minimumTlsVersionAllowed: "{{ minimumTlsVersionAllowed }}"
      endpoint: "{{ endpoint }}"
      inputSchema: "{{ inputSchema }}"
      eventTypeInfo:
        kind: "{{ kind }}"
        inlineEventTypes: "{{ inlineEventTypes }}"
      inputSchemaMapping:
        inputSchemaMappingType: "{{ inputSchemaMappingType }}"
      metricResourceId: "{{ metricResourceId }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      inboundIpRules:
        - ipMask: "{{ ipMask }}"
          action: "{{ action }}"
      disableLocalAuth: {{ disableLocalAuth }}
      autoCreateTopicWithFirstSubscription: {{ autoCreateTopicWithFirstSubscription }}
      autoDeleteTopicWithLastSubscription: {{ autoDeleteTopicWithLastSubscription }}
      dataResidencyBoundary: "{{ dataResidencyBoundary }}"
  - name: sku
    description: |
      The Sku pricing tier for the Event Grid Domain resource.
    value:
      name: "{{ name }}"
  - name: identity
    description: |
      Identity information for the Event Grid Domain resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a domain. Asynchronously updates a domain with the specified parameters.

UPDATE azure.event_grid.domains
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a domain. Asynchronously creates or updates a new domain with the specified parameters.

REPLACE azure.event_grid.domains
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a domain. Delete existing domain.

DELETE FROM azure.event_grid.domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_shared_access_keys

List keys for a domain. List the two keys used to publish to a domain.

EXEC azure.event_grid.domains.list_shared_access_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_key

Regenerate key for a domain. Regenerate a shared access key for a domain.

EXEC azure.event_grid.domains.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;