Queues - Authorization Rules - List Keys

Tjänst:

Service Bus

API-version:

2024-01-01

Primära och sekundära anslutningssträngar till kön.

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

Name	I	Obligatorisk	Typ	Description
authorizationRuleName	path	True	string minLength: 1 maxLength: 50	Namnet på auktoriseringsregeln.
namespaceName	path	True	string minLength: 6 maxLength: 50	Namnområdesnamnet
queueName	path	True	string minLength: 1	Könamnet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	AccessKeys	Anslutningssträngarna har returnerats.
Other Status Codes	ErrorResponse	ServiceBus-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

QueueAuthorizationRuleListKey

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AccessKeys	Namnområde/ServiceBus-anslutningssträng
Error	Felobjektet.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Svar på resurshanteringsfel.

AccessKeys

Objekt

Namnområde/ServiceBus-anslutningssträng

Name	Typ	Description
aliasPrimaryConnectionString	string	Primär anslutningssträng för aliaset om GEO DR är aktiverat
aliasSecondaryConnectionString	string	Sekundär anslutningssträng för aliaset om GEO DR är aktiverat
keyName	string	En sträng som beskriver auktoriseringsregeln.
primaryConnectionString	string	Primär anslutningssträng för den skapade auktoriseringsregeln för namnrymd.
primaryKey	string	En base64-kodad 256-bitars primärnyckel för signering och validering av SAS-token.
secondaryConnectionString	string	Sekundär anslutningssträng för den skapade auktoriseringsregeln för namnområde.
secondaryKey	string	En base64-kodad 256-bitars primärnyckel för signering och validering av SAS-token.

Error

Objekt

Felobjektet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Objekt

Svar på resurshanteringsfel.

Name	Typ	Description
error	Error	Felobjektet.