Topics - Get
Get a topic.
Get properties of a topic.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-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. |
topic
|
path | True |
string |
Name of the topic. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Topics_Get
Sample request
Sample response
{
"properties": {
"endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
"location": "westcentralus",
"name": "exampletopic2",
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
Definitions
Name | Description |
---|---|
Connection |
ConnectionState information. |
created |
The type of identity that created the resource. |
Data |
Data Residency Boundary of 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. |
Inbound |
|
Input |
This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. |
Ip |
Action to perform based on the match or no match of the IpMask. |
Json |
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema. |
Json |
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided. |
Json |
This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema. |
Persisted |
Status of the connection. |
Private |
PrivateEndpoint information. |
Private |
|
Public |
This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
Resource |
Provisioning state of the Private Endpoint Connection. |
system |
Metadata pertaining to creation and last modification of the resource. |
Topic |
EventGrid Topic |
Topic |
Provisioning state of the topic. |
User |
The information about the user identity. |
ConnectionState
ConnectionState information.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
Actions required (if any). |
description |
string |
Description of the connection state. |
status |
Status of the connection. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency Boundary of the resource.
Name | Type | Description |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
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.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Name | Type | Description |
---|---|---|
action |
Action to perform based on the match or no match of the IpMask. |
|
ipMask |
string |
IP Address in CIDR notation e.g., 10.0.0.0/8. |
InputSchema
This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
Name | Type | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Action to perform based on the match or no match of the IpMask.
Name | Type | Description |
---|---|---|
Allow |
string |
JsonField
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.
Name | Type | Description |
---|---|---|
sourceField |
string |
Name of a field in the input event schema that's to be used as the source of a mapping. |
JsonFieldWithDefault
This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.
Name | Type | Description |
---|---|---|
defaultValue |
string |
The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload. |
sourceField |
string |
Name of a field in the input event schema that's to be used as the source of a mapping. |
JsonInputSchemaMapping
This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.
Name | Type | Description |
---|---|---|
inputSchemaMappingType |
string:
Json |
Type of the custom mapping |
properties.dataVersion |
The mapping information for the DataVersion property of the Event Grid Event. |
|
properties.eventTime |
The mapping information for the EventTime property of the Event Grid Event. |
|
properties.eventType |
The mapping information for the EventType property of the Event Grid Event. |
|
properties.id |
The mapping information for the Id property of the Event Grid Event. |
|
properties.subject |
The mapping information for the Subject property of the Event Grid Event. |
|
properties.topic |
The mapping information for the Topic property of the Event Grid Event. |
PersistedConnectionStatus
Status of the connection.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
PrivateEndpoint information.
Name | Type | Description |
---|---|---|
id |
string |
The ARM identifier for Private Endpoint. |
PrivateEndpointConnection
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified identifier of the resource. |
name |
string |
Name of the resource. |
properties.groupIds |
string[] |
GroupIds from the private link service resource. |
properties.privateEndpoint |
The Private Endpoint resource for this Connection. |
|
properties.privateLinkServiceConnectionState |
Details about the state of the connection. |
|
properties.provisioningState |
Provisioning state of the Private Endpoint Connection. |
|
type |
string |
Type of the resource. |
PublicNetworkAccess
This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
Provisioning state of the Private Endpoint Connection.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
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 |
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 |
The type of identity that last modified the resource. |
Topic
EventGrid Topic
Name | Type | Default value | 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.dataResidencyBoundary |
Data Residency Boundary of the resource. |
||
properties.disableLocalAuth |
boolean |
False |
This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. |
properties.endpoint |
string |
Endpoint for the topic. |
|
properties.inboundIpRules |
This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
||
properties.inputSchema | EventGridSchema |
This determines the format that Event Grid should expect for incoming events published to the topic. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema. |
|
properties.metricResourceId |
string |
Metric resource id for the topic. |
|
properties.privateEndpointConnections | |||
properties.provisioningState |
Provisioning state of the topic. |
||
properties.publicNetworkAccess | Enabled |
This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring |
|
systemData |
The system metadata relating to Topic resource. |
||
tags |
object |
Tags of the resource. |
|
type |
string |
Type of the resource. |
TopicProvisioningState
Provisioning state of the topic.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
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. |