Freigeben über

Configuration Stores - List Keys

Dienst:
App Configuration
API-Version:
2024-06-01

Listet den Zugriffsschlüssel für den angegebenen Konfigurationsspeicher auf.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01
Mit optionalen Parametern: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01&$skipToken={$skipToken}

URI-Parameter

Name In Erforderlich Typ Beschreibung
configStoreName
 path True

string

minLength: 5
maxLength: 50
pattern: ^[a-zA-Z0-9_-]*$

Der Name des Konfigurationsspeichers.
resourceGroupName
 path True

string

Der Name der Ressourcengruppe, zu der die Containerregistrierung gehört.
subscriptionId
 path True

string

Die Microsoft Azure-Abonnement-ID.
api-version
 query True

string

Die Client-API-Version.
$skipToken
 query

string

Ein Skip-Token wird verwendet, um das Abrufen von Elementen fortzusetzen, nachdem ein Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen skipToken-Parameter, der einen Ausgangspunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

ApiKeyListResult

Die Anforderung war erfolgreich; die Anforderung war wohlgeformt und richtig empfangen.
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

ConfigurationStores_ListKeys

Beispielanforderung

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2024-06-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "id": "439AD01B4BE67DB1",
      "name": "Primary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "CB45E100456857B9",
      "name": "Secondary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "B3AC55B7E71431A9",
      "name": "Primary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    },
    {
      "id": "E2AF6A9A89DCC177",
      "name": "Secondary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    }
  ]
}

Definitionen

Name Beschreibung
ApiKey

Ein API-Schlüssel, der für die Authentifizierung mit einem Konfigurationsspeicherendpunkt verwendet wird.
ApiKeyListResult

Das Ergebnis einer Anforderung zum Auflisten von API-Schlüsseln.
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetails

Die Details des Fehlers.
ErrorResponse

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

ApiKey

Objekt

Ein API-Schlüssel, der für die Authentifizierung mit einem Konfigurationsspeicherendpunkt verwendet wird.

Name Typ Beschreibung
connectionString

string

Eine Verbindungszeichenfolge, die von unterstützungsbasierten Clients für die Authentifizierung verwendet werden kann.
id

string

Die Schlüssel-ID.
lastModified

string (date-time)

Das letzte Mal, wenn eine der Eigenschaften des Schlüssels geändert wurde.
name

string

Ein Name für den Schlüssel, der seine Verwendung beschreibt.
readOnly

boolean

Gibt an, ob dieser Schlüssel nur für Lesevorgänge verwendet werden kann.
value

string

Der Wert des Schlüssels, der für Authentifizierungszwecke verwendet wird.

ApiKeyListResult

Objekt

Das Ergebnis einer Anforderung zum Auflisten von API-Schlüsseln.

Name Typ Beschreibung
nextLink

string

Der URI, der zum Anfordern des nächsten Satzes von seitenseitigen Ergebnissen verwendet werden kann.
value

ApiKey[]

Der Sammlungswert.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetails

Objekt

Die Details des Fehlers.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Fehlercode.
message

string

Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name Typ Beschreibung
error

ErrorDetails

Die Details des Fehlers.