Klávesy

Následující syntaxe představuje klíčový prostředek:

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

Operace

Klíčové prostředky podporují následující operaci:

• List

Pro všechny operace name je volitelný parametr filtru. Pokud tento parametr vynecháte, znamená to jakýkoli klíč.

Požadavky

• Všechny požadavky HTTP musí být ověřeny. Viz část ověřování.
• Všechny požadavky HTTP musí poskytovat explicitní api-version. Viz část správa verzí.

Výpis klíčů

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

Odpovědi:

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

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

Stránkování

Výsledek se stránkuje, pokud počet vrácených položek překročí limit odpovědi. Postupujte podle volitelných Link hlaviček odpovědí a použijte rel="next" k navigaci. Případně obsah poskytuje další odkaz ve formě @nextLink vlastnosti. Další odkaz obsahuje api-version parametr.

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

Odpověď:

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

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

Filtrování

Filtrování podle name je podporováno.

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

Podporují se následující filtry:

Filtr klíčů	Účinnost
name je vynechán nebo name=*	Odpovídá libovolnému klíči.
name=abc	Odpovídá klíči s názvem abc.
name=abc*	Odpovídá názvům klíčů, které začínají řetězcem abc.
name=abc,xyz	Odpovídá názvům klíčů abc nebo xyz (omezeno na 5 CSV)

Následující znaky jsou vyhrazeny: *, \, ,

Pokud je vyhrazený znak součástí hodnoty, musí být řídicí znak použit .\{Reserved Character} Neplacené znaky mohou být také řídicí znaky.

Ověření filtru

V případě chyby ověření filtru je odpověď HTTP 400 s podrobnostmi o chybě:

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
}

Příklady

• Všechny

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

• Název klíče začíná řetězcem abc

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

• Název klíče je abc nebo xyz

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

Zadání konkrétních polí

Použijte volitelný $select parametr řetězce dotazu a zadejte čárkami oddělený seznam požadovaných polí. $select Pokud parametr vynecháte, odpověď obsahuje výchozí sadu.

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

Přístup založený na čase

Získá reprezentaci výsledku, protože byl v minulosti. Viz oddíl 2.1.1

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

Odpověď:

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