Event Hubs - List Keys

Gets the ACS and SAS connection strings for the Event Hub.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/ListKeys?api-version=2017-04-01

URI Parameters

Name In Required Type Description
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

authorizationRuleName
path True
  • string

The authorization rule name.

api-version
query True
  • string

Client API Version.

Responses

Name Type Description
200 OK

Connection strings successfully returned.

Other Status Codes

Eventhub error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

EventHubAuthorizationRuleListKey

Sample Request

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513/ListKeys?api-version=2017-04-01

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-2513"
}

Definitions

AccessKeys

Namespace/EventHub Connection String

ErrorResponse

Error response indicates EventHub service is not able to process the incoming request. The reason is provided in the error message.

AccessKeys

Namespace/EventHub Connection String

Name Type Description
aliasPrimaryConnectionString
  • string

Primary connection string of the alias if GEO DR is enabled

aliasSecondaryConnectionString
  • string

Secondary connection string of the alias if GEO DR is enabled

keyName
  • string

A string that describes the AuthorizationRule.

primaryConnectionString
  • string

Primary connection string of the created namespace AuthorizationRule.

primaryKey
  • string

A base64-encoded 256-bit primary key for signing and validating the SAS token.

secondaryConnectionString
  • string

Secondary connection string of the created namespace AuthorizationRule.

secondaryKey
  • string

A base64-encoded 256-bit primary key for signing and validating the SAS token.

ErrorResponse

Error response indicates EventHub service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.