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

Authorization Rules - Event Hubs - Regenerate Keys

重新生成事件中心的 ACS 和 SAS 连接字符串。

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

URI 参数

名称 必需 类型 说明
authorizationRuleName
path True

string

授权规则名称。

eventHubName
path True

string

事件中心名称

namespaceName
path True

string

命名空间名称

正则表达式模式: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Azure 订阅中资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
keyType True

KeyType

要重新生成的访问密钥。

key

string

可选,如果提供的键值,则为 KeyType 设置或为 keyType 设置自动生成的键值

响应

名称 类型 说明
200 OK

AccessKeys

已成功重新生成连接字符串。

Other Status Codes

ErrorResponse

描述操作失败原因的 Eventhub 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

EventHubAuthorizationRuleRegenerateKey

示例请求

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-1534/regenerateKeys?api-version=2024-01-01

{
  "keyType": "PrimaryKey"
}

示例响应

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-9027.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1534;SharedAccessKey=#############################################;EntityPath=sdk-EventHub-1647",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-9027.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1534;SharedAccessKey=#############################################;EntityPath=sdk-EventHub-1647",
  "primaryKey": "#############################################",
  "secondaryKey": "#############################################",
  "keyName": "sdk-Authrules-1534"
}

定义

名称 说明
AccessKeys

命名空间/EventHub 连接字符串

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

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

KeyType

要重新生成的访问密钥。

RegenerateAccessKeyParameters

提供给“重新生成授权规则”操作的参数指定需要重置的密钥。

AccessKeys

命名空间/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

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

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

名称 类型 说明
error

ErrorDetail

错误对象。

KeyType

要重新生成的访问密钥。

名称 类型 说明
PrimaryKey

string

SecondaryKey

string

RegenerateAccessKeyParameters

提供给“重新生成授权规则”操作的参数指定需要重置的密钥。

名称 类型 说明
key

string

可选,如果提供的键值,则为 KeyType 设置或为 keyType 设置自动生成的键值

keyType

KeyType

要重新生成的访问密钥。