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 resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	Provisioning state of the domain topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_domain

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.
provisioningState	string	Provisioning state of the domain topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, domain_topic_name, subscription_id		Get a domain topic. Get properties of a domain topic.
list_by_domain	select	resource_group_name, domain_name, subscription_id	$filter, $top	List domain topics. List all the topics in a domain.
create_or_update	insert	resource_group_name, domain_name, domain_topic_name, subscription_id		Create or update a domain topic. Asynchronously creates or updates a new domain topic with the specified parameters.
create_or_update	replace	resource_group_name, domain_name, domain_topic_name, subscription_id		Create or update a domain topic. Asynchronously creates or updates a new domain topic with the specified parameters.
delete	delete	resource_group_name, domain_name, domain_topic_name, subscription_id		Delete a domain topic. 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
domain_name	string	Name of the domain. Required.
domain_topic_name	string	Name of the topic. 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 topic. Get properties of a domain topic.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.event_grid.domain_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND domain_topic_name = '{{ domain_topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_domain

List domain topics. List all the topics in a domain.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.event_grid.domain_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.event_grid.domain_topics (
resource_group_name,
domain_name,
domain_topic_name,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ domain_name }}',
'{{ domain_topic_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: domain_topics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the domain_topics resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the domain_topics resource.
  - name: domain_topic_name
    value: "{{ domain_topic_name }}"
    description: Required parameter for the domain_topics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the domain_topics resource.

REPLACE examples

create_or_update

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

REPLACE azure.event_grid.domain_topics
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND domain_topic_name = '{{ domain_topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a domain topic. Delete existing domain topic.

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