Microsoft.EventGrid systemTopics

  • Article

Bicep resource definition

The systemTopics resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/systemTopics resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventGrid/systemTopics@2023-12-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    source: 'string'
    topicType: 'string'
  }
}

Property values

systemTopics

Name Description Value
name The resource name string (required)
location Location of the resource. string (required)
tags Tags of the resource. Dictionary of tag names and values. See Tags in templates
identity Identity information for the resource. IdentityInfo
properties Properties of the system topic. SystemTopicProperties

IdentityInfo

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Name Description Value
{customized property} UserIdentityProperties

UserIdentityProperties

Name Description Value
clientId The client id of user assigned identity. string
principalId The principal id of user assigned identity. string

SystemTopicProperties

Name Description Value
source Source for the system topic. string
topicType TopicType for the system topic. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Blob Storage and Event Grid subscription to the Blob

Deploy to Azure		 Creates Azure Blob Storage account and then creates an Event Grid subscription to that Blob.
Deploy Azure Data Explorer db with Event Grid connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Grid connection.

ARM template resource definition

The systemTopics resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/systemTopics resource, add the following JSON to your template.

{
  "type": "Microsoft.EventGrid/systemTopics",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "source": "string",
    "topicType": "string"
  }
}

Property values

systemTopics

Name Description Value
type The resource type 'Microsoft.EventGrid/systemTopics'
apiVersion The resource api version '2023-12-15-preview'
name The resource name string (required)
location Location of the resource. string (required)
tags Tags of the resource. Dictionary of tag names and values. See Tags in templates
identity Identity information for the resource. IdentityInfo
properties Properties of the system topic. SystemTopicProperties

IdentityInfo

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Name Description Value
{customized property} UserIdentityProperties

UserIdentityProperties

Name Description Value
clientId The client id of user assigned identity. string
principalId The principal id of user assigned identity. string

SystemTopicProperties

Name Description Value
source Source for the system topic. string
topicType TopicType for the system topic. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Blob Storage and Event Grid subscription to the Blob

Deploy to Azure		 Creates Azure Blob Storage account and then creates an Event Grid subscription to that Blob.
Deploy Azure Data Explorer db with Event Grid connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Grid connection.

Terraform (AzAPI provider) resource definition

The systemTopics resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/systemTopics resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/systemTopics@2023-12-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      source = "string"
      topicType = "string"
    }
  })
}

Property values

systemTopics

Name Description Value
type The resource type "Microsoft.EventGrid/systemTopics@2023-12-15-preview"
name The resource name string (required)
location Location of the resource. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Tags of the resource. Dictionary of tag names and values.
identity Identity information for the resource. IdentityInfo
properties Properties of the system topic. SystemTopicProperties

IdentityInfo

Name Description Value
type The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
This property is currently not used and reserved for future usage.
 Array of user identity IDs.

IdentityInfoUserAssignedIdentities

Name Description Value
{customized property} UserIdentityProperties

UserIdentityProperties

Name Description Value
clientId The client id of user assigned identity. string
principalId The principal id of user assigned identity. string

SystemTopicProperties

Name Description Value
source Source for the system topic. string
topicType TopicType for the system topic. string