Accounts - List Keys

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

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

Der Name des Cognitive Services-Kontos.

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

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

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 mit Beschreibung des Grunds für den Fehler

Beispiele

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"
}

Definitionen

Name Beschreibung
ApiKeys

Die Zugriffsschlüssel für das Cognitive Services-Konto.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

ApiKeys

Die Zugriffsschlüssel für das Cognitive Services-Konto.

Name Typ Beschreibung
key1

string

Ruft den Wert von Schlüssel 1 ab.

key2

string

Ruft den Wert von Schlüssel 2 ab.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

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.