System Topics - Create Or Update

Reference

Service:: Event Grid

API Version:: 2025-02-15

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
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
systemTopicName	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		IdentityInfo	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	SystemTopic	OK
201 Created	SystemTopic	Created
Other Status Codes		* Error Responses: * 400 Bad Request. 500 Internal Server Error.

Name

Type

Description

200 OK

SystemTopic

201 Created

SystemTopic

Created

Other Status Codes

*** Error Responses: ***

400 Bad Request.
500 Internal Server Error.

Examples

SystemTopics_CreateOrUpdate

Sample request

HTTP

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

Status code:: 200

{
  "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"
}

Status code:: 201

{
  "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
createdByType	The type of identity that created the resource.
IdentityInfo	The identity information for the resource.
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.
ResourceProvisioningState	Provisioning state of the Private Endpoint Connection.
systemData	Metadata pertaining to creation and last modification of the resource.
SystemTopic	EventGrid System Topic.
UserIdentityProperties	The information about the user identity.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

IdentityInfo

Object

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	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.
userAssignedIdentities	<string, UserIdentityProperties>	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

Enumeration

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
SystemAssigned, UserAssigned
UserAssigned

ResourceProvisioningState

Enumeration

Provisioning state of the Private Endpoint Connection.

Value	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

SystemTopic

Object

EventGrid System Topic.

Name	Type	Description
id	string	Fully qualified identifier of the resource.
identity	IdentityInfo	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	ResourceProvisioningState	Provisioning state of the system topic.
properties.source	string	Source for the system topic.
properties.topicType	string	TopicType for the system topic.
systemData	systemData	The system metadata relating to the Event Grid resource.
tags	object	Tags of the resource.
type	string	Type of the resource.

UserIdentityProperties

Object

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.

Share via

System Topics - Create Or Update

URI Parameters

Request Body

Responses

Examples

SystemTopics_CreateOrUpdate

Sample request

Sample response

Definitions

createdByType

IdentityInfo

IdentityType

ResourceProvisioningState

systemData

SystemTopic

UserIdentityProperties

Additional resources