Bezeichnungen

Die Ressource Bezeichnung ist folgendermaßen definiert:

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

Unterstützt die folgenden Vorgänge:

• List

name ist ein optionaler Filterparameter für alle Vorgänge. Ohne Angabe dieses Parameters wird eine beliebige Bezeichnung impliziert.

Verwenden Sie den optionalen resourceType Parameter, um Labels nach ihrem zugehörigen Ressourcentyp zu filtern. Setzen resourceType Sie auf für kv Key-Value-Labels oder ff für erweiterte Feature-Flag-Labels.

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.

Auflisten von Bezeichnungen

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

Antworten:

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

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

Listen Sie Labels nach Ressourcentyp auf

Die folgende Anfrage listet Labels auf, die mit erweiterten Feature-Flags verbunden sind:

GET /labels?resourceType=ff&api-version={api-version} HTTP/1.1

Um Bezeichnungen aufzulisten, die mit Schlüsselwerten verknüpft sind, setzen resourceType Sie auf kv.

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 /labels?api-version={api-version} HTTP/1.1

Antwort:

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

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

Filtern

Die Filterung nach name wird unterstützt.

GET /labels?name={label-name}&api-version={api-version}

Unterstützte Filter

Ressourcentyp-Filter

Reservierte Zeichen

*, \, ,

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

Wenn bei der Filterüberprüfung ein Fehler auftritt, 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 /labels?api-version={api-version}
  

• Bezeichnungsname beginnt mit abc

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

• Bezeichnungsname lautet abc oder xyz

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

• Der Name des erweiterten Feature-Flag-Labels beginnt mit abc

  GET /labels?resourceType=ff&name=abc*&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 /labels?$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 /labels&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.labelset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <{relative uri}>; rel="original"

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