Topics – Authorization Rules - Regenerate Keys

Régénère les chaînes de connexion principales ou secondaires pour la rubrique.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys?api-version=2017-04-01

Paramètres URI

Name In Required Type Description
authorizationRuleName
path True
  • string

Nom de la règle d’autorisation.

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 d’abonnement qui identifient de façon unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

topicName
path True
  • string

Nom de la rubrique.

api-version
query True
  • string

Version d’API client.

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 réinitialisée pour la valeur de KeyType ou la valeur de clé de génération automatiquement définie 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 ServiceBus décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

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

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

TopicAuthorizationRuleRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace8408/topics/sdk-Topics2075/authorizationRules/sdk-Authrules5067/regenerateKeys?api-version=2017-04-01
{
  "keyType": "PrimaryKey"
}

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984",
  "primaryKey": "#############################################",
  "secondaryKey": "#############################################",
  "keyName": "sdk-AuthRules-4310"
}

Définitions

AccessKeys

Chaîne de connexion de l’espace de noms/ServiceBus

Error

Objet d’erreur.

ErrorAdditionalInfo

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

ErrorResponse

Réponse d’erreur de gestion des ressources.

KeyType

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

RegenerateAccessKeyParameters

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

AccessKeys

Chaîne de connexion de l’espace de noms/ServiceBus

Name Type Description
aliasPrimaryConnectionString
  • string

Chaîne de connexion principale de l’alias si géo-DR est activé

aliasSecondaryConnectionString
  • string

Chaîne de connexion secondaire de l’alias si géo-DR est activé

keyName
  • string

Chaîne qui décrit la règle d’autorisation.

primaryConnectionString
  • string

Chaîne de connexion principale de la règle d’autorisation de l’espace de noms créée.

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 la règle d’autorisation de l’espace de noms créée.

secondaryKey
  • string

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

Error

Objet d’erreur.

Name Type Description
additionalInfo

Informations supplémentaires sur l’erreur.

code
  • string

Code d'erreur.

details

Détails de l’erreur.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur.

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Informations supplémentaires.

type
  • string

Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur de gestion des ressources.

Name Type Description
error

Objet d’erreur.

KeyType

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

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

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

Name Type Description
key
  • string

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

keyType

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