Kunci

Sintaks berikut mewakili sumber daya kunci:

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

Operasional

Sumber daya utama mendukung operasi berikut ini:

• List

Untuk semua name operasi adalah parameter filter opsional. Jika dihilangkan, itu menyiratkan setiap kunci.

Prasyarat

• Semua permintaan HTTP harus diautentikasi. Lihat bagian autentikasi.
• Semua permintaan HTTP harus menyediakan eksplisit api-version. Lihat bagian penerapan versi.

Daftar Kunci

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

Respons:

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

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

Penentuan halaman

hasilnya akan ditentukan halaman jika jumlah item yang dikembalikan melebihi batas respons. Ikuti Link header respons opsional dan gunakan untuk rel="next" navigasi. Atau konten menyediakan tautan berikutnya dalam bentuk properti @nextLink. Tautan berikutnya berisi parameter api-version.

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

Respons:

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

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

Filter

Pemfilteran menurut name didukung.

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

Filter berikut ini didukung:

Karakter berikut dipesan: *, \, ,

Jika karakter yang dipesan adalah bagian dari nilai, maka karakter harus lolos menggunakan \{Reserved Character}. Karakter tidak khusus juga dapat hilang.

Validasi filter

Dalam kasus kesalahan validasi filter, responsnya adalah HTTP 400 dengan detail kesalahan:

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
}

Contoh

• Semua

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

• Nama kunci dimulai dengan abc

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

• Nama kuncinya adalah abc atau xyz

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

Bidang khusus permintaan

Gunakan $select parameter untai (karakter) kueri opsional dan berikan daftar bidang yang diminta yang dipisahkan koma. Jika parameter $select dihilangkan, respons berisi set default.

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

Akses Berbasis Waktu

Dapatkan representasi hasil seperti pada waktu yang lalu. Lihat bagian 2.1.1

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

Respons:

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