Partager via


Communication Services - List Keys

Afficher la liste des clés
Obtenez les clés d’accès de la ressource CommunicationService.

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

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.

Réponses

Nom Type Description
200 OK

CommunicationServiceKeys

Réussite. La réponse décrit les clés d’accès CommunicationService.

Other Status Codes

ErrorResponse

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

Exemples

List keys

Exemple de requête

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

Exemple de réponse

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

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

CommunicationServiceKeys

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

Nom Type Description
primaryConnectionString

string

CommunicationService chaîne de connexion construit par le biais de primaryKey

primaryKey

string

Clé d’accès primaire.

secondaryConnectionString

string

CommunicationService chaîne de connexion construit via secondaryKey

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.