通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Authorization Rules - Event Hubs - List Keys

服务:
Event Hubs
API 版本:
2024-01-01

获取事件中心的 ACS 和 SAS 连接字符串。

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

URI 参数

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

string

minLength: 1

授权规则名称。
eventHubName
 path True

string

minLength: 1
maxLength: 256

事件中心名称
namespaceName
 path True

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

Namespace名称
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Azure 订阅中的资源组的名称。
subscriptionId
 path True

string

唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version
 query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

AccessKeys

已成功返回连接字符串。
Other Status Codes

ErrorResponse

事件中心错误响应，描述作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

EventHubAuthorizationRuleListKey

示例请求

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513/listKeys?api-version=2024-01-01

示例响应

状态代码:
200 
{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-2513"
}

定义

名称 说明
AccessKeys

Namespace/EventHub 连接字符串
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应指示事件中心服务无法处理传入请求。 错误消息中提供了原因。

AccessKeys

Object

Namespace/EventHub 连接字符串

名称 类型 说明
aliasPrimaryConnectionString

string

如果启用了 GEO DR，则别名的主要连接字符串
aliasSecondaryConnectionString

string

如果启用了 GEO DR，则别名的辅助连接字符串
keyName

string

描述 AuthorizationRule 的字符串。
primaryConnectionString

string

创建的命名空间 AuthorizationRule 的主连接字符串。
primaryKey

string

用于签名和验证 SAS 令牌的 base64 编码的 256 位主密钥。
secondaryConnectionString

string

创建的命名空间 AuthorizationRule 的辅助连接字符串。
secondaryKey

string

用于签名和验证 SAS 令牌的 base64 编码的 256 位主密钥。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应指示事件中心服务无法处理传入请求。 错误消息中提供了原因。

名称 类型 说明
error

ErrorDetail

错误对象。