Tasten

Die folgende Syntax stellt eine Schlüsselressource dar:

{
    "name": [string]             // Name of the key
}

Operations

Schlüsselressourcen unterstützen den folgenden Vorgang:

• List

name ist ein optionaler Filterparameter für alle Vorgänge. Ohne Angabe dieses Parameters wird ein beliebiger Schlüssel impliziert.

Voraussetzungen

• Alle HTTP-Anforderungen müssen authentifiziert werden. Informationen dazu erhalten Sie im Abschnitt Authentifizierung.
• Alle HTTP-Anforderungen müssen explizit die api-version angeben. Informationen dazu erhalten Sie im Abschnitt Versionsverwaltung.

Dient zum Auflisten von Schlüsseln.

GET /keys?api-version={api-version} HTTP/1.1

Antworten:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json; charset=utf-8"

{
    "items": [
        {
          "name": "{key-name}"
        },
        ...
    ],
    "@nextLink": "{relative uri}"
}

Paginierung

Das Ergebnis ist paginiert, wenn die Anzahl der zurückgegebenen Elemente das Antwortlimit überschreitet. Folgen Sie den optionalen Link-Headern, und verwenden Sie rel="next" zur Navigation. Alternativ dazu stellt der Inhalt in Form der Eigenschaft @nextLink einen Link zu weiteren Elementen bereit. Der Link zu weiteren Elementen enthält den Parameter api-version.

GET /keys?api-version={api-version} HTTP/1.1

Antwort:

HTTP/1.1 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json; charset=utf-8
Link: <{relative uri}>; rel="next"

{
    "items": [
        ...
    ],
    "@nextLink": "{relative uri}"
}

Filtern

Die Filterung nach name wird unterstützt.

GET /keys?name={key-name}&api-version={api-version}

Folgende Filter werden unterstützt:

Schlüsselfilter	Wirkung
name wird weggelassen oder lautet name=*	Übereinstimmung mit einem beliebigen Schlüssel
name=abc	Übereinstimmung mit einem Schlüssel namens abc
name=abc*	Übereinstimmung mit Schlüsselnamen, die mit abc beginnen
name=abc,xyz	Übereinstimmung mit den Schlüsselnamen abc oder xyz (auf fünf CSVs begrenzt)

Die folgenden Zeichen sind reserviert: *, \, ,

Wenn ein Wert ein reserviertes Zeichen enthält, muss dieses mit einem Escapezeichen versehen werden: \{Reserved Character}. Nicht reservierten Zeichen können ebenfalls mit Escapezeichen versehen werden.

Filterüberprüfung

Im Fall eines Fehlers bei der Filterüberprüfung ist die Antwort ein HTTP-Fehler 400 mit Details:

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8

{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Invalid request parameter 'name'",
  "name": "name",
  "detail": "name(2): Invalid character",
  "status": 400
}

Beispiele

• All

  GET /keys?api-version={api-version}
  

• Der Schlüsselname beginnt mit abc

  GET  /keys?name=abc*&api-version={api-version}
  

• Der Schlüsselname lautet abc oder xyz

  GET /keys?name=abc,xyz&api-version={api-version}
  

Anfordern bestimmter Felder

Verwenden Sie den optionalen Abfragezeichenfolgenparameter $select, und geben Sie eine durch Trennzeichen getrennte Liste der angeforderten Felder an. Wenn der Parameter $select ausgelassen wird, enthält die Antwort die Standardgruppe von Feldern.

GET /keys?$select=name&api-version={api-version} HTTP/1.1

Zeitbasierter Zugriff

Rufen Sie eine Darstellung des Ergebnisses ab, so wie es zu einem bestimmten Zeitpunkt in der Vergangenheit war. Siehe Abschnitt 2.1.1.

GET /keys&api-version={api-version} HTTP/1.1
Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT

Antwort:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <relative uri>; rel="original"

{
    "items": [
        ....
    ]
}