共用方式為


Authorization Rules - Namespaces - Regenerate Keys

重新產生指定之命名空間的主要或次要連接字串。

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

URI 參數

名稱 位於 必要 類型 Description
authorizationRuleName
path True

string

授權規則名稱。

namespaceName
path True

string

命名空間名稱

Regex 模式: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Azure 訂用帳戶內的資源組名。

subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

要求本文

名稱 必要 類型 Description
keyType True

KeyType

要重新產生的存取金鑰。

key

string

選擇性的,如果提供的索引鍵值是針對 KeyType 設定,或針對 keyType 設定自動產生的 Key 值

回應

名稱 類型 Description
200 OK

AccessKeys

已成功重新產生連接字串。

Other Status Codes

ErrorResponse

Eventhub 錯誤回應,描述作業失敗的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

NameSpaceAuthorizationRuleRegenerateKey

範例要求

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-8980/authorizationRules/sdk-Authrules-8929/regenerateKeys?api-version=2024-01-01

{
  "keyType": "PrimaryKey"
}

範例回覆

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

定義

名稱 Description
AccessKeys

Namespace/EventHub 連接字串

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應表示事件中樞服務無法處理傳入要求。 錯誤訊息中會提供原因。

KeyType

要重新產生的存取金鑰。

RegenerateAccessKeyParameters

提供給重新產生授權規則作業的參數會指定需要重設的金鑰。

AccessKeys

Namespace/EventHub 連接字串

名稱 類型 Description
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

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應表示事件中樞服務無法處理傳入要求。 錯誤訊息中會提供原因。

名稱 類型 Description
error

ErrorDetail

錯誤物件。

KeyType

要重新產生的存取金鑰。

名稱 類型 Description
PrimaryKey

string

SecondaryKey

string

RegenerateAccessKeyParameters

提供給重新產生授權規則作業的參數會指定需要重設的金鑰。

名稱 類型 Description
key

string

選擇性的,如果提供的索引鍵值是針對 KeyType 設定,或針對 keyType 設定自動產生的 Key 值

keyType

KeyType

要重新產生的存取金鑰。