Namespaces - Authorization Rules - List Keys

参考

服务:: Service Bus

API 版本:: 2024-01-01

获取命名空间的主连接字符串和辅助连接字符串。

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

URI 参数

名称	在	必需	类型	说明
authorizationRuleName	path	True	string minLength: 1 maxLength: 50	授权规则名称。
namespaceName	path	True	string minLength: 6 maxLength: 50	命名空间名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	AccessKeys	已成功返回连接字符串。
Other Status Codes	ErrorResponse	描述作失败的原因的 ServiceBus 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

NameSpaceAuthorizationRuleListKey

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

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

示例响应

状态代码:: 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"
}

定义

名称	说明
AccessKeys	Namespace/ServiceBus 连接字符串
Error	错误对象。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	资源管理错误响应。

AccessKeys

Object

Namespace/ServiceBus 连接字符串

名称	类型	说明
aliasPrimaryConnectionString	string	如果启用了 GEO DR，则别名的主要连接字符串
aliasSecondaryConnectionString	string	如果启用了 GEO DR，则别名的辅助连接字符串
keyName	string	描述授权规则的字符串。
primaryConnectionString	string	创建的命名空间授权规则的主连接字符串。
primaryKey	string	用于签名和验证 SAS 令牌的 base64 编码的 256 位主密钥。
secondaryConnectionString	string	创建的命名空间授权规则的辅助连接字符串。
secondaryKey	string	用于签名和验证 SAS 令牌的 base64 编码的 256 位主密钥。

Error

Object

错误对象。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

Object

资源管理错误响应。

名称	类型	说明
error	Error	错误对象。

通过

Namespaces - Authorization Rules - List Keys

URI 参数

响应

安全性

azure_auth

作用域

示例

NameSpaceAuthorizationRuleListKey

示例请求

示例响应

定义

AccessKeys

Error

ErrorAdditionalInfo

ErrorResponse