system_topics

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

Overview

Name	system_topics
Type	Resource
Id	azure.event_grid.system_topics

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Identity information for the resource.
location	string	Location of the resource.
properties	object	Properties of the system topic.
systemData	object	The system metadata relating to System Topic resource.
tags	object	Tags of the resource.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity information for the resource.
location	string	Location of the resource.
properties	object	Properties of the system topic.
systemData	object	The system metadata relating to System Topic resource.
tags	object	Tags of the resource.

list_by_subscription

Name	Datatype	Description
identity	object	Identity information for the resource.
location	string	Location of the resource.
properties	object	Properties of the system topic.
systemData	object	The system metadata relating to System Topic 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, systemTopicName		Get properties of a system topic.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $top	List all the system topics under a resource group.
list_by_subscription	select	subscriptionId	$filter, $top	List all the system topics under an Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName, systemTopicName		Asynchronously creates a new system topic with the specified parameters.
update	update	subscriptionId, resourceGroupName, systemTopicName		Asynchronously updates a system topic with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, systemTopicName		Delete existing system 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
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.
systemTopicName	string	Name of the system topic.
$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 system topic.

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

list_by_resource_group

List all the system topics under a resource group.

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

list_by_subscription

List all the system topics under an Azure subscription.

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

INSERT examples

create_or_update

Asynchronously creates a new system topic with the specified parameters.

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

Manifest

# Description fields are for documentation purposes
- name: system_topics
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the system_topics resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the system_topics resource.
    - name: systemTopicName
      value: string
      description: Required parameter for the system_topics 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 system topic.
    - name: identity
      value: object
      description: |
        Identity information for the resource.

UPDATE examples

update

Asynchronously updates a system topic with the specified parameters.

UPDATE azure.event_grid.system_topics
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND systemTopicName = '{{ systemTopicName }}' --required
RETURNING
identity,
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete existing system topic.

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