Queues - Authorization Rules - List Keys

Primary and secondary connection strings to the queue.

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

URI Parameters

Name In Required Type Description
authorizationRuleName
path True
  • string

The authorization rule name.

namespaceName
path True
  • string

The namespace name

queueName
path True
  • string

The queue name.

resourceGroupName
path True
  • string

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

Connection strings successfully returned.

Other Status Codes

ServiceBus 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

QueueAuthorizationRuleListKey

Sample Request

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800/ListKeys?api-version=2017-04-01

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-AuthRules-5800"
}

Definitions

AccessKeys

Namespace/ServiceBus Connection String

Error

The error object.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

The resource management error response.

AccessKeys

Namespace/ServiceBus 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 authorization rule.

primaryConnectionString
  • string

Primary connection string of the created namespace authorization rule.

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 authorization rule.

secondaryKey
  • string

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

Error

The error object.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorResponse

The resource management error response.

Name Type Description
error

The error object.