System Topics - Create Or Update
Create a system topic.
Asynchronously creates a new system topic with the specified parameters.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}?api-version=2025-02-15
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
The name of the resource group within the user's subscription. |
|
subscription
|
path | True |
string |
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
|
system
|
path | True |
string |
Name of the system topic. |
|
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| location | True |
string |
Location of the resource. |
| identity |
Identity information for the resource. |
||
| properties.source |
string |
Source for the system topic. |
|
| properties.topicType |
string |
TopicType for the system topic. |
|
| tags |
object |
Tags of the resource. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| 201 Created |
Created |
|
| Other Status Codes |
*** Error Responses: ***
|
Examples
SystemTopics_CreateOrUpdate
Sample request
PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1?api-version=2025-02-15
{
"properties": {
"source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
"topicType": "microsoft.storage.storageaccounts"
},
"location": "westus2",
"tags": {
"tag1": "value1",
"tag2": "value2"
}
}
Sample response
{
"properties": {
"provisioningState": "Succeeded",
"source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
"topicType": "microsoft.storage.storageaccounts",
"metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e"
},
"location": "centraluseuap",
"tags": null,
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2",
"name": "exampleSystemTopic2",
"type": "Microsoft.EventGrid/systemTopics"
}
{
"properties": {
"provisioningState": "Succeeded",
"source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
"topicType": "microsoft.storage.storageaccounts",
"metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e"
},
"location": "centraluseuap",
"tags": null,
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2",
"name": "exampleSystemTopic2",
"type": "Microsoft.EventGrid/systemTopics"
}
Definitions
| Name | Description |
|---|---|
|
created |
The type of identity that created the resource. |
|
Identity |
The identity information for the resource. |
|
Identity |
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. |
|
Resource |
Provisioning state of the Private Endpoint Connection. |
|
system |
Metadata pertaining to creation and last modification of the resource. |
|
System |
EventGrid System Topic. |
|
User |
The information about the user identity. |
createdByType
The type of identity that created the resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
IdentityInfo
The identity information for the resource.
| Name | Type | Description |
|---|---|---|
| principalId |
string |
The principal ID of resource identity. |
| tenantId |
string |
The tenant ID of resource. |
| 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. |
|
| userAssignedIdentities |
<string,
User |
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. |
IdentityType
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.
| Value | Description |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned |
ResourceProvisioningState
Provisioning state of the Private Endpoint Connection.
| Value | Description |
|---|---|
| Creating | |
| Updating | |
| Deleting | |
| Succeeded | |
| Canceled | |
| Failed |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |
SystemTopic
EventGrid System Topic.
| Name | Type | Description |
|---|---|---|
| id |
string |
Fully qualified identifier of the resource. |
| identity |
Identity information for the resource. |
|
| location |
string |
Location of the resource. |
| name |
string |
Name of the resource. |
| properties.metricResourceId |
string |
Metric resource id for the system topic. |
| properties.provisioningState |
Provisioning state of the system topic. |
|
| properties.source |
string |
Source for the system topic. |
| properties.topicType |
string |
TopicType for the system topic. |
| systemData |
The system metadata relating to the Event Grid resource. |
|
| tags |
object |
Tags of the resource. |
| type |
string |
Type of the resource. |
UserIdentityProperties
The information about the user identity.
| Name | Type | Description |
|---|---|---|
| clientId |
string |
The client id of user assigned identity. |
| principalId |
string |
The principal id of user assigned identity. |