Queues - Authorization Rules - List Keys

Dienst:

Service Bus

API-Version:

2024-01-01

Primäre und sekundäre Verbindungszeichenfolgen zur Warteschlange.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationRuleName	path	True	string minLength: 1 maxLength: 50	Der Name der Autorisierungsregel.
namespaceName	path	True	string minLength: 6 maxLength: 50	Der Namespacename
queueName	path	True	string minLength: 1	Der Warteschlangenname.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AccessKeys	Verbindungszeichenfolgen wurden erfolgreich zurückgegeben.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

QueueAuthorizationRuleListKey

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AccessKeys	Namespace/ServiceBus-Verbindungszeichenfolge
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.

AccessKeys

Objekt

Namespace/ServiceBus-Verbindungszeichenfolge

Name	Typ	Beschreibung
aliasPrimaryConnectionString	string	Primäre Verbindungszeichenfolge des Alias, wenn GEO DR aktiviert ist
aliasSecondaryConnectionString	string	Sekundäre Verbindungszeichenfolge des Alias, wenn GEO DR aktiviert ist
keyName	string	Eine Zeichenfolge, die die Autorisierungsregel beschreibt.
primaryConnectionString	string	Primäre Verbindungszeichenfolge der erstellten Namespaceautorisierungsregel.
primaryKey	string	Ein base64-codierter 256-Bit-Primärschlüssel zum Signieren und Validieren des SAS-Tokens.
secondaryConnectionString	string	Sekundäre Verbindungszeichenfolge der erstellten Namespaceautorisierungsregel.
secondaryKey	string	Ein base64-codierter 256-Bit-Primärschlüssel zum Signieren und Validieren des SAS-Tokens.

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.