How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Topics API

The Topics API from Microsoft Azure — 15 operation(s) for topics.

Microsoft Azure Topics API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Topics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 20 operations across 15 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

20 operations 15 paths 44 schemas 2 DELETE7 GET1 PATCH8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 2 DELETE, 7 GET, 1 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Topics 20
POST
/topics/{topicName}:publish
Microsoft Azure Post Topics Topicname:publish
microsoftAzurePublishcloudevent 2 params body → 200default
POST
/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:receive
Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:receive
microsoftAzureReceivecloudevents 5 params → 200default
POST
/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:acknowledge
Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:acknowledge
microsoftAzureAcknowledgecloudevents 3 params body → 200default
POST
/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:release
Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:release
microsoftAzureReleasecloudevents 4 params body → 200default
POST
/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:reject
Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:reject
microsoftAzureRejectcloudevents 3 params body → 200default
POST
/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:renewLock
Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:renewlock
microsoftAzureRenewcloudeventlocks 3 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
Microsoft Azure Get A Topic
microsoftAzureTopicsGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
Microsoft Azure Create A Topic
microsoftAzureTopicsCreateorupdate 4 params body → 201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
Microsoft Azure Delete A Topic
microsoftAzureTopicsDelete 4 params → 202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}
Microsoft Azure Update A Topic
microsoftAzureTopicsUpdate 4 params body → 200201default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics
Microsoft Azure List Topics Under An Azure Subscription
microsoftAzureTopicsListbysubscription 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics
Microsoft Azure List Topics Under A Resource Group
microsoftAzureTopicsListbyresourcegroup 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys
Microsoft Azure List Keys For A Topic
microsoftAzureTopicsListsharedaccesskeys 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey
Microsoft Azure Regenerate Key For A Topic
microsoftAzureTopicsRegeneratekey 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes
Microsoft Azure List Topic Event Types
microsoftAzureTopicsListeventtypes 6 params → 200default
GET
/{scope}/providers/Microsoft.EventGrid/extensionTopics/default
Microsoft Azure Get Properties Of An Extension Topic
microsoftAzureExtensiontopicsGet 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics
microsoftAzureTopicsListbynamespace 6 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname
microsoftAzureTopicsCreateorupdate 5 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname
microsoftAzureTopicsDelete 5 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname
microsoftAzureTopicsGet 5 params → 200default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are SBTopicProperties (17 properties), TopicProperties (10 properties), CloudEvent (10 properties), Topic (6 properties). Each schema is shown below with its type and property counts.

Topic
object
EventGrid Topic
6 properties
PrivateEndpointConnectionProperties
object
Properties of the private endpoint connection resource.
4 properties
PrivateEndpoint
object
PrivateEndpoint information.
1 property
EventTypesListResult
object
Result of the List Event Types operation
1 property
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
IdentityInfo
object
The identity information for the resource.
4 properties
ReleaseResult
object
The result of the Release operation.
2 properties 2 required
TopicRegenerateKeyRequest
object
Topic regenerate share access key request
1 property 1 required
TopicUpdateParameterProperties
object
Information of topic update parameter properties.
4 properties
SBTopicListResult
object
The response to the List Topics operation.
2 properties
CloudEvent
object
Properties of an event published to an Azure Messaging EventGrid Namespace topic using the CloudEvent 1.0 Schema.
10 properties 4 required
RejectOptions
object
Array of lock tokens for the corresponding received Cloud Events to be rejected.
1 property 1 required
AcknowledgeOptions
object
Array of lock tokens for the corresponding received Cloud Events to be acknowledged.
1 property 1 required
ReceiveResult
object
Details of the Receive operation response.
1 property 1 required
RejectResult
object
The result of the Reject operation.
2 properties 2 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
SBTopicProperties
object
The Topic Properties definition.
17 properties
Resource
object
Definition of a Resource
3 properties
PublishResult
object
The result of the Publish operation.
PrivateEndpointConnection
object
1 property
AcknowledgeResult
object
The result of the Acknowledge operation.
2 properties 2 required
ExtendedLocation
object
Definition of an Extended Location
2 properties
TopicSharedAccessKeys
object
Shared access keys of the Topic
2 properties
TopicUpdateParameters
object
Properties of the Topic update
4 properties
InboundIpRule
object
2 properties
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
InputSchemaMapping
object
By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom…
1 property 1 required
UserIdentityProperties
object
The information about the user identity.
2 properties
BrokerProperties
object
Properties of the Event Broker operation.
2 properties 2 required
TopicsListResult
object
Result of the List Topics operation
2 properties
RenewLockOptions
object
Array of lock tokens for the corresponding received Cloud Events to be renewed.
1 property 1 required
TrackedResource
object
Definition of a Tracked Resource.
2 properties 1 required
FailedLockToken
object
Failed LockToken information.
2 properties 2 required
ConnectionState
object
ConnectionState information.
3 properties
EventType
object
Event Type for a subject under a topic
1 property
ResourceSku
object
Describes an EventGrid Resource Sku.
1 property
ReleaseOptions
object
Array of lock tokens for the corresponding received Cloud Events to be released.
1 property 1 required
ExtensionTopicProperties
object
Properties of the Extension Topic
2 properties
ReceiveDetails
object
Receive operation details per Cloud Event.
2 properties 2 required
ExtensionTopic
object
Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.
2 properties
SBTopic
object
Description of topic resource.
2 properties
EventTypeProperties
object
Properties of the event type
4 properties
TopicProperties
object
Properties of the Topic.
10 properties
RenewCloudEventLocksResult
object
The result of the RenewLock operation.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-topics-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Topics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.