Microsoft.EventGrid systemTopics
Bicep resource definition
The systemTopics resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2024-12-15-preview' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
source: 'string'
topicType: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
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 |
|---|
Microsoft.EventGrid/systemTopics
| Name | Description | Value |
|---|---|---|
| identity | Identity information for the resource. | IdentityInfo |
| location | Location of the resource. | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the system topic. | SystemTopicProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
SystemTopicProperties
| Name | Description | Value |
|---|---|---|
| source | Source for the system topic. | string |
| topicType | TopicType for the system topic. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
UserIdentityProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client id of user assigned identity. | string |
| principalId | The principal id of user assigned identity. | string |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Create Blob Storage and Event Grid subscription to the Blob | 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 Azure Data Explorer db with Event Grid connection. |
ARM template resource definition
The systemTopics resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2024-12-15-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"source": "string",
"topicType": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
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 |
|---|
Microsoft.EventGrid/systemTopics
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-15-preview' |
| identity | Identity information for the resource. | IdentityInfo |
| location | Location of the resource. | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the system topic. | SystemTopicProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.EventGrid/systemTopics' |
SystemTopicProperties
| Name | Description | Value |
|---|---|---|
| source | Source for the system topic. | string |
| topicType | TopicType for the system topic. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
UserIdentityProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client id of user assigned identity. | string |
| principalId | The principal id of user assigned identity. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create Blob Storage and Event Grid subscription to the Blob |
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 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@2024-12-15-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
source = "string"
topicType = "string"
}
})
}
Property values
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 |
|---|
Microsoft.EventGrid/systemTopics
| Name | Description | Value |
|---|---|---|
| identity | Identity information for the resource. | IdentityInfo |
| location | Location of the resource. | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the system topic. | SystemTopicProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.EventGrid/systemTopics@2024-12-15-preview" |
SystemTopicProperties
| Name | Description | Value |
|---|---|---|
| source | Source for the system topic. | string |
| topicType | TopicType for the system topic. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
UserIdentityProperties
| Name | Description | Value |
|---|---|---|
| clientId | The client id of user assigned identity. | string |
| principalId | The principal id of user assigned identity. | string |