Partager via


Communication Services - Regenerate Key

Régénérer la clé
Régénérer la clé d’accès CommunicationService. PrimaryKey et SecondaryKey ne peuvent pas être régénérés en même temps.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey?api-version=2023-04-01

Paramètres URI

Nom Dans Obligatoire Type Description
communicationServiceName
path True

string

Nom de la ressource CommunicationService.

Modèle d’expression régulière: ^[-\w]+$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
keyType

KeyType

KeyType à régénérer. Doit être « primary » ou « secondary » (non respect de la casse).

Réponses

Nom Type Description
200 OK

CommunicationServiceKeys

Régénérer la demande de clé a été effectuée avec succès. La réponse contient la nouvelle clé.

Other Status Codes

ErrorResponse

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

Exemples

Regenerate key

Exemple de requête

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/regenerateKey?api-version=2023-04-01

{
  "keyType": "Primary"
}

Exemple de réponse

{
  "primaryKey": "1234",
  "primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}

Définitions

Nom Description
CommunicationServiceKeys

Classe représentant les clés d’accès d’un CommunicationService.

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

KeyType

KeyType à régénérer. Doit être « primary » ou « secondary » (non respect de la casse).

RegenerateKeyParameters

Les paramètres décrivent la demande de régénérer les clés d’accès

CommunicationServiceKeys

Classe représentant les clés d’accès d’un CommunicationService.

Nom Type Description
primaryConnectionString

string

Chaîne de connexion CommunicationService construite via primaryKey

primaryKey

string

Clé d’accès primaire.

secondaryConnectionString

string

Chaîne de connexion CommunicationService construite via la clé secondaire

secondaryKey

string

Clé d’accès secondaire.

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émentaire.

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

KeyType

KeyType à régénérer. Doit être « primary » ou « secondary » (non respect de la casse).

Nom Type Description
Primary

string

Secondary

string

RegenerateKeyParameters

Les paramètres décrivent la demande de régénérer les clés d’accès

Nom Type Description
keyType

KeyType

KeyType à régénérer. Doit être « primary » ou « secondary » (non respect de la casse).