Event Hubs - Authorization Rules - Regenerate Keys

Återskapar ACS- och SAS-anslutningssträngarna för händelsehubben.

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

URI-parametrar

Name In Required Type Description
authorizationRuleName
path True
  • string

Namnet på auktoriseringsregeln.

eventHubName
path True
  • string

Händelsehubbens namn

namespaceName
path True
  • string

Namnområdesnamnet

resourceGroupName
path True
  • string

Namnet på resursgruppen i Azure-prenumerationen.

subscriptionId
path True
  • string

Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True
  • string

Klient-API-version.

Begärandetext

Name Required Type Description
keyType True

Åtkomstnyckeln som ska återskapas.

key
  • string

Valfritt, om nyckelvärdet anges, anges för KeyType eller autogenererad nyckel som angetts för keyType

Svar

Name Type Description
200 OK

Anslutningssträngarna har återskapats.

Other Status Codes

Eventhub-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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 personifiera ditt användarkonto

Exempel

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

Definitioner

AccessKeys

Namnområde/EventHub-anslutningssträng

ErrorResponse

Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

KeyType

Åtkomstnyckeln som ska återskapas.

RegenerateAccessKeyParameters

Parametrar som anges för åtgärden Återskapa auktoriseringsregel anger vilken nyckel som måste återställas.

AccessKeys

Namnområde/EventHub-anslutningssträng

Name Type Description
aliasPrimaryConnectionString
  • string

Primär anslutningssträng för aliaset om GEO DR är aktiverat

aliasSecondaryConnectionString
  • string

Sekundär anslutningssträng för aliaset om GEO DR är aktiverat

keyName
  • string

En sträng som beskriver AuthorizationRule.

primaryConnectionString
  • string

Primär anslutningssträng för det skapade namnområdet AuthorizationRule.

primaryKey
  • string

En base64-kodad 256-bitars primärnyckel för signering och validering av SAS-token.

secondaryConnectionString
  • string

Sekundär anslutningssträng för det skapade namnområdet AuthorizationRule.

secondaryKey
  • string

En base64-kodad 256-bitars primärnyckel för signering och validering av SAS-token.

ErrorResponse

Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name Type Description
code
  • string

Felkod.

message
  • string

Felmeddelande som anger varför åtgärden misslyckades.

KeyType

Åtkomstnyckeln som ska återskapas.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Parametrar som anges för åtgärden Återskapa auktoriseringsregel anger vilken nyckel som måste återställas.

Name Type Description
key
  • string

Valfritt, om nyckelvärdet anges, anges för KeyType eller autogenererad nyckel som angetts för keyType

keyType

Åtkomstnyckeln som ska återskapas.