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
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.
encryption	object	Key encryption configuration properties of the system topic resource. This is an optional property. When not specified, no key encryption is used.
identity	object	Identity information for the resource.
location	string	The geo-location where the resource lives. Required.
metricResourceId	string	Metric resource id for the system topic.
platformCapabilities	object	Represents the platform capabilities of the resource, including Azure Confidential Compute related properties.
provisioningState	string	Provisioning state of the system topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
source	string	Source for the system topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicType	string	TopicType for the system topic.
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.
encryption	object	Key encryption configuration properties of the system topic resource. This is an optional property. When not specified, no key encryption is used.
identity	object	Identity information for the resource.
location	string	The geo-location where the resource lives. Required.
metricResourceId	string	Metric resource id for the system topic.
platformCapabilities	object	Represents the platform capabilities of the resource, including Azure Confidential Compute related properties.
provisioningState	string	Provisioning state of the system topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
source	string	Source for the system topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicType	string	TopicType for the system topic.
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.
encryption	object	Key encryption configuration properties of the system topic resource. This is an optional property. When not specified, no key encryption is used.
identity	object	Identity information for the resource.
location	string	The geo-location where the resource lives. Required.
metricResourceId	string	Metric resource id for the system topic.
platformCapabilities	object	Represents the platform capabilities of the resource, including Azure Confidential Compute related properties.
provisioningState	string	Provisioning state of the system topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
source	string	Source for the system topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicType	string	TopicType for the system topic.
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, system_topic_name, subscription_id		Get a system topic. Get properties of a system topic.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top	List system topics under a resource group. List all the system topics under a resource group.
list_by_subscription	select	subscription_id	$filter, $top	List system topics under an Azure subscription. List all the system topics under an Azure subscription.
create_or_update	insert	resource_group_name, system_topic_name, subscription_id, location		Create a system topic. Asynchronously creates a new system topic with the specified parameters.
update	update	resource_group_name, system_topic_name, subscription_id		Update a system topic. Asynchronously updates a system topic with the specified parameters.
create_or_update	replace	resource_group_name, system_topic_name, subscription_id, location		Create a system topic. Asynchronously creates a new system topic with the specified parameters.
delete	delete	resource_group_name, system_topic_name, subscription_id		Delete a system topic. 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
system_topic_name	string	Name of the system topic. Required.
$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 system topic. Get properties of a system topic.

SELECT
id,
name,
encryption,
identity,
location,
metricResourceId,
platformCapabilities,
provisioningState,
source,
systemData,
tags,
topicType,
type
FROM azure.event_grid.system_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND system_topic_name = '{{ system_topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List system topics under a resource group. List all the system topics under a resource group.

SELECT
id,
name,
encryption,
identity,
location,
metricResourceId,
platformCapabilities,
provisioningState,
source,
systemData,
tags,
topicType,
type
FROM azure.event_grid.system_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List system topics under an Azure subscription. List all the system topics under an Azure subscription.

SELECT
id,
name,
encryption,
identity,
location,
metricResourceId,
platformCapabilities,
provisioningState,
source,
systemData,
tags,
topicType,
type
FROM azure.event_grid.system_topics
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create a system topic. Asynchronously creates a new system topic with the specified parameters.

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

Manifest

# Description fields are for documentation purposes
- name: system_topics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the system_topics resource.
  - name: system_topic_name
    value: "{{ system_topic_name }}"
    description: Required parameter for the system_topics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the system_topics 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 system topic.
    value:
      provisioningState: "{{ provisioningState }}"
      source: "{{ source }}"
      topicType: "{{ topicType }}"
      metricResourceId: "{{ metricResourceId }}"
      encryption:
        customerManagedKeyEncryption:
          - keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
            keyEncryptionKeyIdentity:
              type: "{{ type }}"
              userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
            keyEncryptionKeyStatus: "{{ keyEncryptionKeyStatus }}"
            keyEncryptionKeyStatusFriendlyDescription: "{{ keyEncryptionKeyStatusFriendlyDescription }}"
      platformCapabilities:
        confidentialCompute:
          mode: "{{ mode }}"
  - name: identity
    description: |
      Identity information for the resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a system topic. Asynchronously updates a system topic with the specified parameters.

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

REPLACE examples

create_or_update

Create a system topic. Asynchronously creates a new system topic with the specified parameters.

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

DELETE examples

delete

Delete a system topic. Delete existing system topic.

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