[索引鍵]

下列語法代表索引鍵資源：

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

Operations

金鑰資源支援下列作業：

• 清單​​

所有作業 name 都是選擇性篩選參數。 如果省略，則表示 任何 索引鍵。

必要條件

• 所有 HTTP 要求都必須經過驗證。 請參閱驗證一節。
• 所有 HTTP 要求都必須提供明確的 api-version。 請參閱版本設定一節。

列出索引鍵

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

回應：

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

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

分頁

如果傳回的項目數目超過回應限制，則會分頁結果。 請遵循選擇性 Link 的回應標頭，並用於 rel="next" 流覽。 或者，內容會以 屬性的形式 @nextLink 提供下一個連結。 下一個連結包含 api-version 參數。

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

回應：

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

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

篩選

支援篩選依據 name 。

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

支援下列篩選條件：

索引鍵篩選	效果
省略 name 或使用 name=*	比對任何索引鍵
name=abc	比對名為 abc 的 金鑰
name=abc*	比對開頭為 abc 的 索引鍵名稱
name=abc,xyz	比對金鑰名稱 abc 或 xyz （限制為 5 CSV）

保留下列字元：*、、 \,

如果保留字元是值的一部分，則必須使用 \{Reserved Character}逸出它。 您也可以逸出非保留字元。

篩選驗證

在篩選驗證錯誤的情況下，回應為 HTTP 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
}

範例

• 全部

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

• 機碼名稱開頭為 abc

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

• 機碼名稱為 abc 或 xyz

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

要求特定欄位

使用選擇性 $select 的查詢字串參數，並提供要求的欄位逗號分隔清單。 $select如果省略 參數，回應會包含預設集合。

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

以時間為基礎的存取

取得過去一段時間的結果表示法。 請參閱 2.1.1 節

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

回應：

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