Freigeben über


Accounts - List Keys

Listet die Kontoschlüssel für das angegebene Cognitive Services-Konto auf.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

Der Name des Cognitive Services-Kontos.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

minLength: 1

Die ID des Zielabonnements.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

ApiKeys

Gibt mit einem Antworttext zurück, der die Abonnementschlüssel für die Ressource enthält: key1 Der erste API-Schlüssel für die Authentifizierung, wenn der Client den API-Endpunkt aufruft.

key2 Der zweite API-Schlüssel für die Authentifizierung, wenn der Client den API-Endpunkt aufruft.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist

Beispiele

List Keys

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ApiKeys

Die Zugriffstasten für das Konto der kognitiven Dienste.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

ApiKeys

Die Zugriffstasten für das Konto der kognitiven Dienste.

Name Typ Beschreibung
key1

string

Ruft den Wert von Schlüssel 1 ab.

key2

string

Ruft den Wert von Schlüssel 2 ab.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.