Share via

Authorization Rules - Event Hubs - List Keys

Service:
Event Hubs
API Version:
2024-01-01

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=2024-01-01

URI Parameters

Name In Required Type Description
authorizationRuleName
 path True

string

minLength: 1

The authorization rule name.
eventHubName
 path True

string

minLength: 1
maxLength: 256

The Event Hub name
namespaceName
 path True

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

The Namespace name
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Name of the resource group within the azure subscription.
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.
api-version
 query True

string

Client API Version.

Responses

Name Type Description
200 OK

AccessKeys

Connection strings successfully returned.
Other Status Codes

ErrorResponse

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=2024-01-01

Sample response

Status code:
200 
{
  "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

Name Description
AccessKeys

Namespace/EventHub Connection String
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

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

AccessKeys

Object

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.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

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

Name Type Description
error

ErrorDetail

The error object.