Event Hubs - List Authorization Rules

Service:
Event Hubs
API Version:
2015-08-01

Gets the authorization rules for an Event Hub.

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

URI Parameters

Name In Required Type Description
authorizationRuleName
 path True
  • string
The authorization rule 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
eventHubName
 path True
  • string

The Event Hub name
api-version
 query True
  • string

Client API Version.

Responses

Name Type Description
200 OK

Event Hub AuthorizationRule returned successfully.

Examples

EventHubAutorizationRuleListAll

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "name": "sdk-Authrules9261",
      "properties": {
        "rights": [
          "Listen",
          "Send"
        ]
      }
    }
  ]
}

Definitions

SharedAccessAuthorizationRuleListResult
SharedAccessAuthorizationRuleResource

Single item in a List or Get AuthorizationRule operation
Name Type Description
nextLink
  • string

Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules
value

Result of the List Authorization Rules operation.

Single item in a List or Get AuthorizationRule operation

Name Type Description
id
  • string

Resource Id
location
  • string

Resource location
name
  • string

Resource name
rights
  • string[]

The rights associated with the rule.
type
  • string

Resource type