Event Hubs - Authorization Rules - Regenerate Keys

Ponownie generuje parametry połączenia ACS i SAS dla centrum zdarzeń.

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 identyfikatora URI

Name In Required Type Description
authorizationRuleName
path True
  • string

Nazwa reguły autoryzacji.

eventHubName
path True
  • string

Nazwa centrum zdarzeń

namespaceName
path True
  • string

Nazwa przestrzeni nazw

resourceGroupName
path True
  • string

Nazwa grupy zasobów w ramach subskrypcji platformy Azure.

subscriptionId
path True
  • string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API klienta.

Treść żądania

Name Required Type Description
keyType True

Klucz dostępu do ponownego generowania.

key
  • string

Opcjonalnie, jeśli podana wartość klucza jest ustawiona dla parametru KeyType lub automatycznie wygenerowanej wartości klucza dla parametru keyType

Odpowiedzi

Name Type Description
200 OK

Parametry połączenia zostały pomyślnie wygenerowane ponownie.

Other Status Codes

Odpowiedź o błędzie usługi EventHub opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

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 personifikacja konta użytkownika

Przykłady

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

Definicje

AccessKeys

Przestrzeń nazw/parametry połączenia usługi EventHub

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

KeyType

Klucz dostępu do ponownego generowania.

RegenerateAccessKeyParameters

Parametry podane do operacji Reguły autoryzacji ponownej generowania określa, który klucz musi zostać zresetowany.

AccessKeys

Przestrzeń nazw/parametry połączenia usługi EventHub

Name Type Description
aliasPrimaryConnectionString
  • string

Podstawowy parametry połączenia aliasu, jeśli włączono odzyskiwanie po awarii geograficznej

aliasSecondaryConnectionString
  • string

Pomocnicza parametry połączenia aliasu, jeśli włączono odzyskiwanie po awarii geograficznej

keyName
  • string

Ciąg opisujący regułę AuthorizationRule.

primaryConnectionString
  • string

Podstawowa parametry połączenia utworzonej przestrzeni nazw AuthorizationRule.

primaryKey
  • string

Zakodowany w formacie base64 klucz podstawowy 256-bitowy do podpisywania i weryfikowania tokenu SAS.

secondaryConnectionString
  • string

Pomocnicza parametry połączenia utworzonej przestrzeni nazw AuthorizationRule.

secondaryKey
  • string

Zakodowany w formacie base64 klucz podstawowy 256-bitowy do podpisywania i weryfikowania tokenu SAS.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

KeyType

Klucz dostępu do ponownego generowania.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Parametry podane do operacji Reguły autoryzacji ponownej generowania określa, który klucz musi zostać zresetowany.

Name Type Description
key
  • string

Opcjonalnie, jeśli podana wartość klucza jest ustawiona dla parametru KeyType lub automatycznie wygenerowanej wartości klucza dla parametru keyType

keyType

Klucz dostępu do ponownego generowania.