Put Key Value - Put Key Value

服務:

App Configuration

API 版本:

2024-09-01

建立索引鍵/值。

PUT {endpoint}/kv/{key}?api-version=2024-09-01

含選擇性參數:

PUT {endpoint}/kv/{key}?api-version=2024-09-01&label={label}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)
key	path	True	string	要建立之索引鍵/值的索引鍵。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
label	query		string	要建立之索引鍵/值的標籤。

要求標頭

Media Types: "application/vnd.microsoft.appconfig.kv+json", "application/vnd.microsoft.appconfig.kvset+json", "application/json", "text/json", "application/*+json", "application/json-patch+json"

名稱	必要	類型	Description
Sync-Token		string	用來保證要求之間的即時一致性。
If-Match		string	只有在目標資源的 etag 符合所提供的值時，才會用來執行作業。
If-None-Match		string	只有在目標資源的 etag 不符合所提供的值時，才會用來執行作業。
x-ms-client-request-id		string (uuid)	要求不透明、全域唯一、用戶端產生的字串標識碼。

要求本文

Media Types: "application/vnd.microsoft.appconfig.kv+json", "application/vnd.microsoft.appconfig.kvset+json", "application/json", "text/json", "application/*+json", "application/json-patch+json"

名稱	類型	Description
content_type	string	儲存在機碼值內之值的內容類型。
etag	string	值，表示資源的目前狀態。
label	string	索引鍵/值所屬的標籤。
last_modified	string (date-time)	表示上次修改索引鍵/值的日期。
locked	boolean	指出索引鍵/值是否已鎖定。
tags	object	索引鍵/值的標記
value	string	索引鍵/值的值。

回應

名稱	類型	Description
200 OK	KeyValue	要求已成功。 Media Types: "application/vnd.microsoft.appconfig.kv+json", "application/problem+json", "application/json" 標題 ETag: string Sync-Token: string
Other Status Codes	Error	未預期的錯誤回應。 Media Types: "application/vnd.microsoft.appconfig.kv+json", "application/problem+json", "application/json"

安全性

Connection String

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://azconfig.io/.default

範例

Creates a key-value with the If-Match header.

Creates a key-value.

Creates a key-value with the If-Match header.

範例要求

HTTP

PUT https://{exampleAppConfigurationName}.azconfig.io/kv/Message?api-version=2024-09-01

範例回覆

狀態碼:

200

Content-Type: application/vnd.microsoft.appconfig.kv+json
ETag: W/"L10qpBghN693OaxydgTkLmrBbV5"
Last-Modified: Tue, 27 Aug 2019 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763

{
  "etag": "L10qpBghN693OaxydgTkLmrBbV5",
  "key": "Message",
  "label": null,
  "content_type": null,
  "value": "Hello World!",
  "tags": {},
  "locked": false,
  "last_modified": "2019-08-27T16:52:32+00:00"
}

Creates a key-value.

範例要求

HTTP

PUT https://{exampleAppConfigurationName}.azconfig.io/kv/Message?api-version=2024-09-01

範例回覆

狀態碼:

200

Content-Type: application/vnd.microsoft.appconfig.kv+json
ETag: W/"tnIHBkDYQwtdNMLoWtr5aybkKwL"
Last-Modified: Tue, 27 Aug 2019 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763

{
  "etag": "tnIHBkDYQwtdNMLoWtr5aybkKwL",
  "key": "Message",
  "label": null,
  "content_type": null,
  "value": "Hello World!",
  "tags": {},
  "locked": false,
  "last_modified": "2019-08-27T16:52:32+00:00"
}

定義

名稱	Description
Error	Azure 應用程式組態錯誤物件。
KeyValue	代表應用程式設定的索引鍵/值組。

Error

Object

Azure 應用程式組態錯誤物件。

名稱	類型	Description
detail	string	錯誤的詳細描述。
name	string	導致錯誤的參數名稱。
status	integer (int32)	錯誤所對應的 HTTP 狀態代碼。
title	string	錯誤的簡短摘要。
type	string	錯誤的型別。

KeyValue

Object

代表應用程式設定的索引鍵/值組。

名稱	類型	Description
content_type	string	儲存在機碼值內之值的內容類型。
etag	string	值，表示資源的目前狀態。
key	string	索引鍵/值的索引鍵。
label	string	索引鍵/值所屬的標籤。
last_modified	string (date-time)	表示上次修改索引鍵/值的日期。
locked	boolean	指出索引鍵/值是否已鎖定。
tags	object	索引鍵/值的標記
value	string	索引鍵/值的值。