Partager via


Authorization Rules - Namespaces - Regenerate Keys

Régénère les chaînes de connexion primaires ou secondaires pour l’espace de noms spécifié.

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

Paramètres URI

Nom Dans Obligatoire Type Description
authorizationRuleName
path True

string

Nom de la règle d’autorisation.

namespaceName
path True

string

Nom de l’espace de noms

Modèle d’expression régulière: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Nom du groupe de ressources au sein de l’abonnement Azure.

subscriptionId
path True

string

Informations d’identification d’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

Nom Obligatoire Type Description
keyType True

KeyType

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

key

string

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

Réponses

Nom Type Description
200 OK

AccessKeys

Les chaînes de connexion ont été correctement régénérées.

Other Status Codes

ErrorResponse

Réponse d’erreur Eventhub décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

NameSpaceAuthorizationRuleRegenerateKey

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
AccessKeys

Chaîne de connexion d’espace de noms/EventHub

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande 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 la règle d’autorisation spécifient quelle clé doit être réinitialisée.

AccessKeys

Chaîne de connexion d’espace de noms/EventHub

Nom Type Description
aliasPrimaryConnectionString

string

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

aliasSecondaryConnectionString

string

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

keyName

string

Chaîne qui décrit l’objet AuthorizationRule.

primaryConnectionString

string

Principal chaîne de connexion 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.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

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

Nom Type Description
error

ErrorDetail

Objet d’erreur.

KeyType

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

Nom Type Description
PrimaryKey

string

SecondaryKey

string

RegenerateAccessKeyParameters

Les paramètres fournis à l’opération Régénérer la règle d’autorisation spécifient quelle clé doit être réinitialisée.

Nom Type Description
key

string

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

keyType

KeyType

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