Accounts - List Keys

Listes les clés de compte pour le compte Cognitive Services spécifié.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys?api-version=2023-05-01

Paramètres URI

Nom Dans Obligatoire Type Description
accountName
path True

string

Nom du compte Cognitive Services.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

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

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

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

Réponses

Nom Type Description
200 OK

ApiKeys

Retourne avec un corps de réponse contenant les clés d’abonnement pour la ressource : key1 La première clé API pour l’authentification lorsque le client appelle le point de terminaison de l’API.

key2 Deuxième clé API pour l’authentification lorsque le client appelle le point de terminaison d’API.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant le motif de l’échec de l’opération

Exemples

List Keys

Sample Request

POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/listKeys?api-version=2023-05-01

Sample Response

{
  "key1": "KEY1",
  "key2": "KEY2"
}

Définitions

Nom Description
ApiKeys

Clés d’accès pour le compte Cognitive Services.

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ApiKeys

Clés d’accès pour le compte Cognitive Services.

Nom Type Description
key1

string

Obtient la valeur de la clé 1.

key2

string

Obtient la valeur de la clé 2.

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 d’erreur.