Sleutels

api-versie: 1.0

De volgende syntaxis vertegenwoordigt een sleutelresource:

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

Operations

Belangrijke resources ondersteunen de volgende bewerking:

• Lijst

Voor alle bewerkingen name is een optionele filterparameter. Als u dit weglaat, impliceert dit elke sleutel.

Vereisten

• Alle HTTP-aanvragen moeten worden geverifieerd. Zie de sectie verificatie .
• Alle HTTP-aanvragen moeten expliciet api-versionbevatten. Zie de sectie versiebeheer .

Lijstsleutels

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

Reacties:

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

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

Paginering

Het resultaat wordt gepagineerd als het aantal geretourneerde items de antwoordlimiet overschrijdt. Volg de optionele Link antwoordheaders en gebruik rel="next" voor navigatie. De inhoud biedt ook een volgende koppeling in de vorm van de @nextLink eigenschap. De volgende koppeling bevat api-version de parameter .

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

Reactie:

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

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

Filteren

Filteren op name wordt ondersteund.

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

De volgende filters worden ondersteund:

Sleutelfilter	Effect
name wordt weggelaten of name=*	Komt overeen met elke willekeurige sleutel
name=abc	Komt overeen met een sleutel met de naam abc
name=abc*	Komt overeen met sleutelnamen die beginnen met abc
name=abc,xyz	Komt overeen met sleutelnamen abc of xyz (beperkt tot 5 CSV)

De volgende tekens zijn gereserveerd: *, \, ,

Als een gereserveerd teken deel uitmaakt van de waarde, moet het worden escaped met behulp van \{Reserved Character}. Niet-gereserveerde tekens kunnen ook worden ge escaped.

Filtervalidatie

In het geval van een filtervalidatiefout is het antwoord HTTP 400 met foutdetails:

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
}

Voorbeelden

• Alles

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

• Sleutelnaam begint met abc

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

• Sleutelnaam is abc of xyz

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

Specifieke velden aanvragen

Gebruik de optionele $select querytekenreeksparameter en geef een door komma's gescheiden lijst met aangevraagde velden op. Als u de $select parameter weglaat, bevat het antwoord de standaardset.

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

Time-Based Access

Verkrijg een weergave van het resultaat zoals het zich in het verleden bevond. Zie sectie 2.1.1

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

Reactie:

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": [
        ....
    ]
}