Microsoft Azure

Azure Event Hubs: Openapi

Azure Event Hubs client

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Event Hubs client

Endpoints 68

Operations

  • GETOperations_List/providers/Microsoft.EventHub/operationsLists all of the available Event Hub REST API operations.

Clusters

  • GETClusters_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.EventHub/clustersLists the available Event Hubs Clusters within an ARM resource group
  • GETClusters_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clustersLists the available Event Hubs Clusters within an ARM resource group
  • GETClusters_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterNameGets the resource description of the specified Event Hubs Cluster.
  • PUTClusters_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterNameCreates or updates an instance of an Event Hubs Cluster.
  • DELETEClusters_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterNameDeletes an existing Event Hubs Cluster. This operation is idempotent.
  • PATCHClusters_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterNameModifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
  • GETClusters_ListNamespaces/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName/namespacesList all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
  • GETConfiguration_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName/quotaConfiguration/defaultGet all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
  • PATCHConfiguration_Patch/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/clusters/:clusterName/quotaConfiguration/defaultReplace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.

DisasterRecoveryConfigs

  • GETDisasterRecoveryConfigs_ListAuthorizationRules/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:alias/authorizationRulesGets a list of authorization rules for a Namespace.
  • GETDisasterRecoveryConfigs_GetAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:alias/authorizationRules/:authorizationRuleNameGets an AuthorizationRule for a Namespace by rule name.
  • POSTDisasterRecoveryConfigs_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:alias/authorizationRules/:authorizationRuleName/listKeysGets the primary and secondary connection strings for the Namespace.

EHNamespaces

  • GETNamespaces_List/subscriptions/:subscriptionId/providers/Microsoft.EventHub/namespacesLists all the available Namespaces within a subscription, irrespective of the resource groups.
  • GETNamespaces_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespacesLists the available Namespaces within a resource group.
  • GETNamespaces_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceNameGets the description of the specified namespace.
  • PUTNamespaces_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceNameCreates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
  • DELETENamespaces_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceNameDeletes an existing namespace. This operation also removes all associated resources under the namespace.
  • PATCHNamespaces_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceNameCreates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
  • POSTDisasterRecoveryConfigs_CheckNameAvailability/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/checkNameAvailabilityCheck the give Namespace name availability.
  • POSTNamespaces_Failover/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/failoverGeoDR Failover
  • GETPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/privateLinkResourcesGets lists of resources that supports Privatelinks.

NetworkRuleSets

  • GETNamespaces_ListNetworkRuleSet/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkRuleSetsGets NetworkRuleSet for a Namespace.
  • GETNamespaces_GetNetworkRuleSet/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkRuleSets/defaultGets NetworkRuleSet for a Namespace.
  • PUTNamespaces_CreateOrUpdateNetworkRuleSet/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkRuleSets/defaultCreate or update NetworkRuleSet for a Namespace.

AuthorizationRules

  • GETNamespaces_ListAuthorizationRules/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/authorizationRulesGets a list of authorization rules for a Namespace.
  • GETNamespaces_GetAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/authorizationRules/:authorizationRuleNameGets an AuthorizationRule for a Namespace by rule name.
  • PUTNamespaces_CreateOrUpdateAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/authorizationRules/:authorizationRuleNameCreates or updates an AuthorizationRule for a Namespace.
  • DELETENamespaces_DeleteAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/authorizationRules/:authorizationRuleNameDeletes an AuthorizationRule for a Namespace.
  • POSTNamespaces_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/listKeysGets the primary and secondary connection strings for the Namespace.
  • POSTNamespaces_RegenerateKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/regenerateKeysRegenerates the primary or secondary connection strings for the specified Namespace.

EventHubs

  • GETEventHubs_ListAuthorizationRules/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/authorizationRulesGets the authorization rules for an Event Hub.
  • GETEventHubs_GetAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/authorizationRules/:authorizationRuleNameGets an AuthorizationRule for an Event Hub by rule name.
  • PUTEventHubs_CreateOrUpdateAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/authorizationRules/:authorizationRuleNameCreates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
  • DELETEEventHubs_DeleteAuthorizationRule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/authorizationRules/:authorizationRuleNameDeletes an Event Hub AuthorizationRule.
  • POSTEventHubs_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/authorizationRules/:authorizationRuleName/listKeysGets the ACS and SAS connection strings for the Event Hub.
  • POSTEventHubs_RegenerateKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/authorizationRules/:authorizationRuleName/regenerateKeysRegenerates the ACS and SAS connection strings for the Event Hub.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/privateEndpointConnectionsGets the available PrivateEndpointConnections within a namespace.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionNameGets a description for the specified Private Endpoint Connection name.
  • PUTPrivateEndpointConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionNameCreates or updates PrivateEndpointConnections of service namespace.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionNameDeletes an existing namespace. This operation also removes all associated resources under the namespace.

NetworkSecurityPerimeterConfigurations

  • GETNetworkSecurityPerimeterConfiguration_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkSecurityPerimeterConfigurationsGets list of current NetworkSecurityPerimeterConfiguration for Namespace
  • GETNetworkSecurityPerimeterConfigurations_GetResourceAssociationName/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkSecurityPerimeterConfigurations/:resourceAssociationNameReturn a NetworkSecurityPerimeterConfigurations resourceAssociationName
  • POSTNetworkSecurityPerimeterConfigurations_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/networkSecurityPerimeterConfigurations/:resourceAssociationName/reconcileRefreshes any information about the association.

ArmDisasterRecoveries

  • GETDisasterRecoveryConfigs_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigsGets all Alias(Disaster Recovery configurations)
  • GETDisasterRecoveryConfigs_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:aliasRetrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
  • PUTDisasterRecoveryConfigs_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:aliasCreates or updates a new Alias(Disaster Recovery configuration)
  • DELETEDisasterRecoveryConfigs_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:aliasDeletes an Alias(Disaster Recovery configuration)
  • POSTDisasterRecoveryConfigs_BreakPairing/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:alias/breakPairingThis operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
  • POSTDisasterRecoveryConfigs_FailOver/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/disasterRecoveryConfigs/:alias/failoverInvokes GEO DR failover and reconfigure the alias to point to the secondary namespace

Eventhubs

  • GETEventHubs_ListByNamespace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs?$skip=0&$top=1Gets all the Event Hubs in a Namespace.
  • GETEventHubs_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubNameGets an Event Hubs description for the specified Event Hub.
  • PUTEventHubs_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubNameCreates or updates a new Event Hub as a nested resource within a Namespace.
  • DELETEEventHubs_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubNameDeletes an Event Hub from the specified Namespace and resource group.

ConsumerGroups

  • GETConsumerGroups_ListByEventHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/consumergroups?$skip=0&$top=1Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
  • GETConsumerGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/consumergroups/:consumerGroupNameGets a description for the specified consumer group.
  • PUTConsumerGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/consumergroups/:consumerGroupNameCreates or updates an Event Hubs consumer group as a nested resource within a Namespace.
  • DELETEConsumerGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/eventhubs/:eventHubName/consumergroups/:consumerGroupNameDeletes a consumer group from the specified Event Hub and resource group.

SchemaGroups

  • GETSchemaRegistry_ListByNamespace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/schemagroups?$skip=0&$top=1Gets all the Schema Groups in a Namespace.
  • GETSchemaRegistry_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/schemagroups/:schemaGroupNameGets the details of an EventHub schema group.
  • PUTSchemaRegistry_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/schemagroups/:schemaGroupNameCreates or Updates an EventHub schema group.
  • DELETESchemaRegistry_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/schemagroups/:schemaGroupNameDeletes an EventHub schema group.

ApplicationGroups

  • GETApplicationGroup_ListByNamespace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/applicationGroupsGets a list of application groups for a Namespace.
  • GETApplicationGroup_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/applicationGroups/:applicationGroupNameGets an ApplicationGroup for a Namespace.
  • PUTApplicationGroup_CreateOrUpdateApplicationGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/applicationGroups/:applicationGroupNameCreates or updates an ApplicationGroup for a Namespace.
  • DELETEApplicationGroup_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventHub/namespaces/:namespaceName/applicationGroups/:applicationGroupNameDeletes an ApplicationGroup for a Namespace.
  • GETClusters_ListAvailableClusterRegion/subscriptions/:subscriptionId/providers/Microsoft.EventHub/availableClusterRegionsList the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
  • POSTNamespaces_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.EventHub/checkNameAvailabilityCheck the give Namespace name availability.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
68 operations on 44 pathsGET 33PUT 11POST 11DELETE 10PATCH 3
Main resources
Clusters 9EHNamespaces 9ArmDisasterRecoveries 6AuthorizationRules 6EventHubs 6ApplicationGroups 4ConsumerGroups 4Eventhubs 4PrivateEndpointConnections 4SchemaGroups 4
Response formats
application/json
Description format
Swagger 2.0, API version 2026-01-01

How to test the Azure Event Hubs: Openapi in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Event Hubs: Openapi collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.EventHub/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Event Hubs: Openapi?

Azure Event Hubs client It is listed under Developer tools and has 68 endpoints.

Who publishes the Azure Event Hubs: Openapi?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Event Hubs: Openapi?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Event Hubs: Openapi?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Event Hubs: Openapi have?

68 operations on 44 paths (33 GET, 11 PUT, 11 POST, 10 DELETE, 3 PATCH). The largest groups are Clusters, EHNamespaces, ArmDisasterRecoveries, AuthorizationRules.

Is forking the Azure Event Hubs: Openapi free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.