Namespaces - Authorization Rules - List Keys

Serviço:

Service Bus

Versão da API:

2024-01-01

Obtém as cadeias de conexão primária e secundária para o namespace.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys?api-version=2024-01-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
authorizationRuleName	path	True	string minLength: 1 maxLength: 50	O nome da regra de autorização.
namespaceName	path	True	string minLength: 6 maxLength: 50	O nome do namespace
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	AccessKeys	Cadeias de conexão retornadas com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

NameSpaceAuthorizationRuleListKey

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-namespace-6914/AuthorizationRules/sdk-AuthRules-1788/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/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json
// this example is just showing the usage of "NamespaceAuthorizationRules_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 ServiceBusNamespaceAuthorizationRuleResource created on azure
// for more information of creating ServiceBusNamespaceAuthorizationRuleResource, please refer to the document of ServiceBusNamespaceAuthorizationRuleResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-namespace-6914";
string authorizationRuleName = "sdk-AuthRules-1788";
ResourceIdentifier serviceBusNamespaceAuthorizationRuleResourceId = ServiceBusNamespaceAuthorizationRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, authorizationRuleName);
ServiceBusNamespaceAuthorizationRuleResource serviceBusNamespaceAuthorizationRule = client.GetServiceBusNamespaceAuthorizationRuleResource(serviceBusNamespaceAuthorizationRuleResourceId);

// invoke the operation
ServiceBusAccessKeys result = await serviceBusNamespaceAuthorizationRule.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

Resposta da amostra

Código de estado:

200

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-AuthRules-1788"
}

Definições

Name	Description
AccessKeys	Cadeia de conexão Namespace/ServiceBus
Error	O objeto de erro.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorResponse	A resposta de erro de gerenciamento de recursos.

AccessKeys

Object

Cadeia de conexão Namespace/ServiceBus

Name	Tipo	Description
aliasPrimaryConnectionString	string	Cadeia de conexão primária do alias se o GEO DR estiver habilitado
aliasSecondaryConnectionString	string	Cadeia de conexão secundária do alias se o GEO DR estiver habilitado
keyName	string	Uma cadeia de caracteres que descreve a regra de autorização.
primaryConnectionString	string	Cadeia de conexão primária da regra de autorização de namespace criada.
primaryKey	string	Uma chave primária de 256 bits codificada em base64 para assinar e validar o token SAS.
secondaryConnectionString	string	Cadeia de conexão secundária da regra de autorização de namespace criada.
secondaryKey	string	Uma chave primária de 256 bits codificada em base64 para assinar e validar o token SAS.

Error

Object

O objeto de erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Object

A resposta de erro de gerenciamento de recursos.

Name	Tipo	Description
error	Error	O objeto de erro.