Event Hubs - Authorization Rules - Regenerate Keys

Régénère les chaînes de connexion ACS et SAS pour Event Hub.

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

Paramètres URI

Name In Required Type Description
authorizationRuleName
path True
  • string

Nom de la règle d’autorisation.

eventHubName
path True
  • string

Nom du hub d’événements

namespaceName
path True
  • string

Nom de l’espace de noms

resourceGroupName
path True
  • string

Nom du groupe de ressources dans l’abonnement Azure.

subscriptionId
path True
  • string

Informations d’identification de l’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API cliente.

Corps de la demande

Name Required Type Description
keyType True

Clé d’accès à régénérer.

key
  • string

Facultatif, si la valeur de clé fournie est définie pour KeyType ou la valeur clé générée automatiquement pour keyType

Réponses

Name Type Description
200 OK

Chaînes de connexion régénérées avec succès.

Other Status Codes

Réponse d’erreur Eventhub décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation emprunt d’identité de votre compte d’utilisateur

Exemples

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

Définitions

AccessKeys

Chaîne de connexion De l’espace de noms/EventHub

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

KeyType

Clé d’accès à régénérer.

RegenerateAccessKeyParameters

Les paramètres fournis à l’opération régénérer une règle d’autorisation spécifient la clé à réinitialiser.

AccessKeys

Chaîne de connexion De l’espace de noms/EventHub

Name Type Description
aliasPrimaryConnectionString
  • string

Chaîne de connexion principal de l’alias si la récupération d’urgence géographique est activée

aliasSecondaryConnectionString
  • string

Chaîne de connexion secondaire de l’alias si GEO DR est activé

keyName
  • string

Chaîne qui décrit l’autorisationRule.

primaryConnectionString
  • string

Chaîne de connexion principal de l’espace de noms créé AuthorizationRule.

primaryKey
  • string

Clé principale cryptée en Base64 sur 256 bits pour signer et valider le jeton SAS.

secondaryConnectionString
  • string

Chaîne de connexion secondaire de l’espace de noms créé AuthorizationRule.

secondaryKey
  • string

Clé principale cryptée en Base64 sur 256 bits pour signer et valider le jeton SAS.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Name Type Description
code
  • string

Code d’erreur.

message
  • string

Message d’erreur indiquant la raison de l’échec de l’opération.

KeyType

Clé d’accès à régénérer.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Les paramètres fournis à l’opération régénérer une règle d’autorisation spécifient la clé à réinitialiser.

Name Type Description
key
  • string

Facultatif, si la valeur de clé fournie est définie pour KeyType ou la valeur clé générée automatiquement pour keyType

keyType

Clé d’accès à régénérer.