Versionskontrolle

Jede Clientanforderung muss eine explizite API-Version als Abfragezeichenfolgenparameter angeben. Beispiel: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version wird im SemVer-Format (Hauptversion.Nebenversion) ausgedrückt. Eine Bereichs- oder Versionsaushandlung wird nicht unterstützt.

Dieser Artikel bezieht sich auf die API-Version 1.0.

Im Folgenden finden Sie eine Übersicht der möglichen Fehlerantworten, die vom Server zurückgegeben werden, wenn keine Übereinstimmung mit der angeforderten API-Version gefunden wird.

API-Version nicht spezifiziert

Dieser Fehler tritt auf, wenn ein Client eine Anforderung ohne Angabe einer API-Version sendet.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "API version is not specified",
  "name": "api-version",
  "detail": "An API version is required, but was not specified.",
  "status": 400
}

Nicht unterstützte API-Version

Dieser Fehler tritt auf, wenn eine vom Client angeforderte API-Version mit keiner der vom Server unterstützten API-Versionen übereinstimmt.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Unsupported API version",
  "name": "api-version",
  "detail": "The HTTP resource that matches the request URI '{request uri}' does not support the API version '{api-version}'.",
  "status": 400
}

Ungültige API-Version

Dieser Fehler tritt auf, wenn ein Client eine Anforderung mit einer API-Version sendet, aber der Wert nicht wohlgeformt ist oder vom Server nicht analysiert werden kann.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8  
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Invalid API version",
  "name": "api-version",
  "detail": "The HTTP resource that matches the request URI '{request uri}' does not support the API version '{api-version}'.",
  "status": 400
}

Mehrdeutige API-Version

Dieser Fehler tritt auf, wenn ein Client eine API-Version anfordert, die auf dem Server nicht eindeutig ist (z. B. mehrere verschiedene Werte).

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Ambiguous API version",
  "name": "api-version",
  "detail": "The following API versions were requested: {comma separated api versions}. At most, only a single API version may be specified. Please update the intended API version and retry the request.",
  "status": 400
}