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
identity	object	Identity information for the Event Grid Domain resource.
location	string	Location of the resource.
properties	object	Properties of the Event Grid Domain resource.
sku	object	The Sku pricing tier for the Event Grid Domain resource.
systemData	object	The system metadata relating to the Event Grid Domain resource.
tags	object	Tags of the resource.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity information for the Event Grid Domain resource.
location	string	Location of the resource.
properties	object	Properties of the Event Grid Domain resource.
sku	object	The Sku pricing tier for the Event Grid Domain resource.
systemData	object	The system metadata relating to the Event Grid Domain resource.
tags	object	Tags of the resource.

list_by_subscription

Name	Datatype	Description
identity	object	Identity information for the Event Grid Domain resource.
location	string	Location of the resource.
properties	object	Properties of the Event Grid Domain resource.
sku	object	The Sku pricing tier for the Event Grid Domain resource.
systemData	object	The system metadata relating to the Event Grid Domain resource.
tags	object	Tags of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, domainName		Get properties of a domain.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $top	List all the domains under a resource group.
list_by_subscription	select	subscriptionId	$filter, $top	List all the domains under an Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName, domainName		Asynchronously creates or updates a new domain with the specified parameters.
update	update	subscriptionId, resourceGroupName, domainName		Asynchronously updates a domain with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, domainName		Delete existing domain.
regenerate_key	exec	subscriptionId, resourceGroupName, domainName, keyName		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
domainName	string	Name of the domain.
resourceGroupName	string	The name of the resource group within the user's subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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'.
$top	integer (int32)	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.

SELECT examples

get

Get properties of a domain.

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

list_by_resource_group

List all the domains under a resource group.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.event_grid.domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List all the domains under an Azure subscription.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.event_grid.domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.event_grid.domains (
data__location,
data__tags,
data__properties,
data__sku,
data__identity,
subscriptionId,
resourceGroupName,
domainName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ domainName }}'
RETURNING
identity,
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: domains
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the domains resource.
    - name: domainName
      value: string
      description: Required parameter for the domains resource.
    - name: location
      value: string
      description: |
        Location of the resource.
    - name: tags
      value: object
      description: |
        Tags of the resource.
    - name: properties
      value: object
      description: |
        Properties of the Event Grid Domain resource.
    - name: sku
      value: object
      description: |
        The Sku pricing tier for the Event Grid Domain resource.
    - name: identity
      value: object
      description: |
        Identity information for the Event Grid Domain resource.

UPDATE examples

update

Asynchronously updates a domain with the specified parameters.

UPDATE azure.event_grid.domains
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND domainName = '{{ domainName }}' --required;

DELETE examples

delete

Delete existing domain.

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

Lifecycle Methods

regenerate_key

Regenerate a shared access key for a domain.

EXEC azure.event_grid.domains.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@domainName='{{ domainName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;