domain_topics

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

Overview

Name	domain_topics
Type	Resource
Id	azure.event_grid.domain_topics

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the Domain Topic.
systemData	object	The system metadata relating to Domain Topic resource.
type	string	Type of the resource.

list_by_domain

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the Domain Topic.
systemData	object	The system metadata relating to Domain Topic resource.
type	string	Type 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, domainTopicName		Get properties of a domain topic.
list_by_domain	select	subscriptionId, resourceGroupName, domainName	$filter, $top	List all the topics in a domain.
create_or_update	insert	subscriptionId, resourceGroupName, domainName, domainTopicName		Asynchronously creates or updates a new domain topic with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, domainName, domainTopicName		Delete existing domain topic.

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.
domainTopicName	string	Name of the domain topic.
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 topic.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.domain_topics
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND domainName = '{{ domainName }}' -- required
AND domainTopicName = '{{ domainTopicName }}' -- required
;

list_by_domain

List all the topics in a domain.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.domain_topics
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND domainName = '{{ domainName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.event_grid.domain_topics (
subscriptionId,
resourceGroupName,
domainName,
domainTopicName
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ domainName }}',
'{{ domainTopicName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: domain_topics
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the domain_topics resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the domain_topics resource.
    - name: domainName
      value: string
      description: Required parameter for the domain_topics resource.
    - name: domainTopicName
      value: string
      description: Required parameter for the domain_topics resource.

DELETE examples

delete

Delete existing domain topic.

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