Queues - Authorization Rules - List Keys

Service:

Service Bus

API Version:

2024-01-01

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=2024-01-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	The name of the resource group. The name is case insensitive.
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	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AccessKeys	Connection strings successfully returned.
Other Status Codes	ErrorResponse	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

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Queues/SBQueueAuthorizationRuleListKey.json
// this example is just showing the usage of "QueueAuthorizationRules_ListKeys" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusQueueAuthorizationRuleResource created on azure
// for more information of creating ServiceBusQueueAuthorizationRuleResource, please refer to the document of ServiceBusQueueAuthorizationRuleResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-namespace-7982";
string queueName = "sdk-Queues-2317";
string authorizationRuleName = "sdk-AuthRules-5800";
ResourceIdentifier serviceBusQueueAuthorizationRuleResourceId = ServiceBusQueueAuthorizationRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, queueName, authorizationRuleName);
ServiceBusQueueAuthorizationRuleResource serviceBusQueueAuthorizationRule = client.GetServiceBusQueueAuthorizationRuleResource(serviceBusQueueAuthorizationRuleResourceId);

// invoke the operation
ServiceBusAccessKeys result = await serviceBusQueueAuthorizationRule.GetKeysAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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

Name	Description
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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	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	Error	The error object.