標題
本文提供搭配 Azure 應用程式設定 REST API 使用的標頭參考頁面連結。
要求標頭
下表描述 Azure 應用程式設定中使用的常見要求標頭。
| 標頭 | 描述 | 例如 |
|---|---|---|
| 授權 | 用來驗證服務的要求。 請參閱第 14.8 節 | Authorization: HMAC-SHA256 Credential=<Credential>&SignedHeaders=Host;x-ms-date;x-ms-content-sha256&Signature=<Signature> |
| 接受 | 通知伺服器用戶端在 HTTP 回應中接受的媒體類型。 請參閱第 14.1 節 | Accept: application/vnd.microsoft.appconfig.kv+json; |
| Accept-Datetime | 要求伺服器傳回內容作為之前狀態的表示法。 此標頭的值是該狀態的要求日期時間。 請參閱 RFC 7089 | Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT |
| Content-Type | 包含 HTTP 要求本文中內容的媒體類型。 請參閱第 14.17 節 | Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8; |
| 日期 | 發出 HTTP 要求的日期時間。 此標頭用於 HMAC 驗證。 請參閱第 14.18 節 | Date: Fri, 11 May 2018 18:48:36 GMT |
| 主控件 | 指定發出要求的租用戶。 此標頭用於 HMAC 驗證。 請參閱第 14.23 節 | Host: contoso.azconfig.io |
| If-Match | 用來提出 HTTP 要求條件式。 只有目標資源的 ETag 符合此標頭的值時，此要求才會成功。 「*」值符合任何 ETag。 請參閱第 14.24 節 | If-Match: "4f6dd610dd5e4deebc7fbaef685fb903" |
| If-None-Match | 用來提出 HTTP 要求條件式。 只有目標資源的 ETag 不符合此標頭的值時，此要求才會成功。 「*」值符合任何 ETag。 請參閱第 14.26 節 | If-None-Match: "4f6dd610dd5e4deebc7fbaef685fb903" |
| Sync-Token | 用來啟用要求序列期間的即時一致性。 | Sync-Token: jtqGc1I4=MDoyOA==;sn=28 |
| x-ms-client-request-id | 用戶端提供的唯一識別碼，用來追蹤要求的來回行程。 | x-ms-client-request-id: 00000000-0000-0000-0000-000000000000 |
| x-ms-content-sha256 | HTTP 要求本文的 sha256 摘要。 此標頭用於 HMAC 驗證。 | x-ms-content-sha256: 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU= |
| x-ms-date | 如果無法存取日期標頭，您可以設定此標頭並用來取代 Date 標頭。 此標頭用於 HMAC 驗證。 |
x-ms-date: Fri, 11 May 2018 18:48:36 GMT |
| x-ms-return-client-request-id | 搭配 x-ms-client-request-id 標頭使用。 如果此標頭的值是 'true'，即指示伺服器傳回 x-ms-client-request-id 要求標頭的值。 |
x-ms-return-client-request-id: true |
回應標頭
伺服器回應時可能包含下列 HTTP 標頭。
| 標頭 | 描述 | 例如 |
|---|---|---|
| Content-Type | 包含 HTTP 回應本文中內容的媒體類型。 請參閱第 14.17 節 | Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8; |
| ETag | 不透明權杖，表示指定資源的狀態。 可用於條件式作業。 請參閱第 14.19 節 | ETag: "4f6dd610dd5e4deebc7fbaef685fb903" |
| Last-Modified | 描述上次修改要求資源的時間。 格式化為 HTTP-Date。 請參閱第 14.29 節 | Last-Modified: Tue, 05 Dec 2017 02:41:26 GMT |
| 連結 | 提供回應相關資源的連結。 此標頭使用「下一個」連結並用於分頁。 請參閱 RFC 5988 | Link: </kv?after={token}>; rel="next" |
| Memento-Datetime | 表示回應包含的內容會聲明之前的狀態。 此標頭的值是該狀態的日期時間。 請參閱 RFC 7089 | Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT |
| retry-after-ms | 提供用戶端等候重試失敗要求的建議期間 (以毫秒為單位)。 | retry-after-ms: 10 |
| x-ms-request-id | 伺服器產生的唯一識別碼，用來追蹤服務中的要求。 | x-ms-request-id: 00000000-0000-0000-0000-000000000000 |
| WWW-Authenticate | 用來挑戰用戶端驗證，並提供驗證嘗試失敗的原因。 請參閱第 14.47 節 | WWW-Authenticate: HMAC-SHA256 error="invalid_token" error_description="Invalid Signature" |