Event Hubs - List All

Service:: Event Hubs

API Version:: 2015-08-01

Gets all the Event Hubs in a Namespace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version={api-version}

URI Parameters

Name	In	Required	Type	Description
authorizationRuleName	path	True	string	The authorization rule name.
eventHubName	path	True	string	The Event Hub name
consumerGroupName	path	True	string	The consumer group name
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.
resourceGroupName	path	True	string	Name of the resource group within the azure subscription.
namespaceName	path	True	string	The Namespace name
api-version	query	True	string	Client API Version.

Responses

Name	Type	Description
200 OK	EventHubListResult	Successfully retrieved the list of Event Hubs.

Examples

EventHubsListAll

Sample Request

GET https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.EventHub/namespaces/sdk-Namespace4919/eventhubs?api-version=2015-08-01&eventHubName=sdk-eventhub4839

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.EventHub/namespaces/sdk-Namespace4919/eventhubs/sdk-eventhub4839",
      "name": "sdk-eventhub4839",
      "type": "Microsoft.EventHub/EventHubs",
      "properties": {
        "messageRetentionInDays": 7,
        "status": "Active",
        "createdAt": "2017-03-12T07:39:13.310Z",
        "updatedAt": "2017-03-12T07:39:15.410Z",
        "partitionCount": 4,
        "partitionIds": [
          "0",
          "1",
          "2",
          "3"
        ]
      }
    }
  ]
}

Definitions

EventHubListResult
EventHubResource	Single item in List or Get Event Hub operation

EventHubListResult

Name	Type	Description
nextLink	string	Link to the next set of results. Not empty if Value contains incomplete list of EventHubs.
value	EventHubResource[]	Result of the List EventHubs operation.

EventHubResource

Single item in List or Get Event Hub operation

Name	Type	Description
createdAt	string date-time	Exact time the Event Hub was created.
id	string	Resource Id
location	string	Resource location
messageRetentionInDays	integer int64	Number of days to retain the events for this Event Hub.
name	string	Resource name
partitionCount	integer int64	Number of partitions created for the Event Hub.
partitionIds	string[]	Current number of shards on the Event Hub.
status	enum: Active Disabled Restoring SendDisabled ReceiveDisabled Creating Deleting Renaming Unknown	Enumerates the possible values for the status of the Event Hub.
type	string	Resource type
updatedAt	string date-time	The exact time the message was updated.