Event Hubs - Authorization Rules - Regenerate Keys

Znovu vygeneruje připojovací řetězce služby ACS a SAS pro centrum událostí.

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

Parametry identifikátoru URI

Name In Required Type Description
authorizationRuleName
path True
  • string

Název autorizačního pravidla.

eventHubName
path True
  • string

Název centra událostí

namespaceName
path True
  • string

Název oboru názvů

resourceGroupName
path True
  • string

Název skupiny prostředků v rámci předplatného Azure

subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují Microsoft Azure předplatné. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API klienta.

Text požadavku

Name Required Type Description
keyType True

Přístupový klíč, který se má znovu vygenerovat.

key
  • string

Volitelné, pokud je zadaná hodnota klíče nastavená pro klíč KeyType nebo automaticky vygenerovaná hodnota klíče nastavená pro keyType.

Odpovědi

Name Type Description
200 OK

Připojovací řetězce se úspěšně znovu vygenerovaly.

Other Status Codes

Odpověď na chybu EventHubu popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

EventHubAuthorizationRuleRegenerateKey

Sample Request

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=2021-06-01-preview

{
  "keyType": "PrimaryKey"
}

Sample Response

{
  "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"
}

Definice

AccessKeys

Obor názvů nebo připojovací řetězec EventHubu

ErrorResponse

Odpověď na chybu značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

KeyType

Přístupový klíč, který se má znovu vygenerovat.

RegenerateAccessKeyParameters

Parametry zadané pro operaci znovu vygenerovat autorizační pravidlo určuje, který klíč je potřeba resetovat.

AccessKeys

Obor názvů nebo připojovací řetězec EventHubu

Name Type Description
aliasPrimaryConnectionString
  • string

Primární připojovací řetězec aliasu, pokud je povolená geografická zotavení po havárii

aliasSecondaryConnectionString
  • string

Sekundární připojovací řetězec aliasu, pokud je povolená geografická zotavení po havárii

keyName
  • string

Řetězec, který popisuje autorizační pravidla.

primaryConnectionString
  • string

Primární připojovací řetězec vytvořeného oboru názvů AuthorizationRule.

primaryKey
  • string

256bitový primární klíč zakódovaný base64 pro podepisování a ověřování tokenu SAS.

secondaryConnectionString
  • string

Sekundární připojovací řetězec vytvořeného oboru názvů AuthorizationRule.

secondaryKey
  • string

256bitový primární klíč zakódovaný base64 pro podepisování a ověřování tokenu SAS.

ErrorResponse

Odpověď na chybu značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Name Type Description
code
  • string

Kód chyby

message
  • string

Chybová zpráva označující, proč operace selhala.

KeyType

Přístupový klíč, který se má znovu vygenerovat.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Parametry zadané pro operaci znovu vygenerovat autorizační pravidlo určuje, který klíč je potřeba resetovat.

Name Type Description
key
  • string

Volitelné, pokud je zadaná hodnota klíče nastavená pro klíč KeyType nebo automaticky vygenerovaná hodnota klíče nastavená pro keyType.

keyType

Přístupový klíč, který se má znovu vygenerovat.