Anahtarlar

Aşağıdaki söz dizimi bir anahtar kaynağını temsil eder:

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

Operations

Önemli kaynaklar aşağıdaki işlemi destekler:

• Liste

Tüm işlemler name için isteğe bağlı bir filtre parametresidir. Atlanırsa herhangi bir anahtar anlamına gelir.

Önkoşullar

• Tüm HTTP isteklerinin kimliği doğrulanmalıdır. Kimlik doğrulama bölümüne bakın.
• Tüm HTTP istekleri açık api-versionsağlamalıdır. Sürüm oluşturma bölümüne bakın.

Liste Anahtarları

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

Yanıt:

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

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

Sayfalandırma

Döndürülen öğe sayısı yanıt sınırını aşarsa sonuç sayfalanır. İsteğe bağlı Link yanıt üst bilgilerini izleyin ve gezinti için kullanın rel="next" . Alternatif olarak, içerik özelliği biçiminde @nextLink bir sonraki bağlantı sağlar. Sonraki bağlantı parametresini içerir api-version .

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

Yanıt:

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

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

Filtreleme

Filtreleme ölçütü name desteklenir.

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

Aşağıdaki filtreler desteklenir:

Şu karakterler ayrılmıştır: *, \, ,

Ayrılmış karakter değerin bir parçasıysa, kullanılarak \{Reserved Character}kaçış karakteri kullanılmalıdır. Ayrılmış olmayan karakterler de kaçılabilir.

Filtre doğrulama

Bir filtre doğrulama hatası söz konusu olduğunda yanıt, hata ayrıntılarını içeren HTTP'dir 400 :

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
}

Örnekler

• Tümü

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

• Anahtar adı abc ile başlar

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

• Anahtar adı abc veya xyz

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

Belirli alanlar isteme

İsteğe bağlı $select sorgu dizesi parametresini kullanın ve istenen alanların virgülle ayrılmış listesini sağlayın. $select Parametresi atlanırsa, yanıt varsayılan kümeyi içerir.

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

Zamana Dayalı Erişim

Sonucun geçmiş bir zamanda olduğu gibi bir gösterimini elde edin. Bkz. bölüm 2.1.1

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

Yanıt:

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