通过

Queues - Authorization Rules - List Keys

  • 参考
服务:
Service Bus
API 版本:
2024-01-01

队列的主连接字符串和辅助连接字符串。

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 参数

名称 在 必需 类型 说明
authorizationRuleName
 path True

string

minLength: 1
maxLength: 50

授权规则名称。
namespaceName
 path True

string

minLength: 6
maxLength: 50

命名空间名称
queueName
 path True

string

minLength: 1

队列名称。
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 模拟用户帐户

示例

QueueAuthorizationRuleListKey

示例请求

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

示例响应

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

定义

名称 说明
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

错误对象。