Skip to content

Commit 15edb15

Browse files
v-shilsv-shils
authored
Merge pull request #281596 from avanigupta/avanigupta/restApiUpdates
Update AppConfiguration Data Plane REST API docs
2 parents 01c39c4 + ae45403 commit 15edb15

File tree

7 files changed

+305
-39
lines changed

7 files changed

+305
-39
lines changed

‎articles/azure-app-configuration/rest-api-key-value.md

Lines changed: 113 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ author: maud-lv
55
ms.author: malev
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 08/17/2020
8+
ms.date: 08/02/2024
9+
zone_pivot_groups: appconfig-data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v1,v23-10,v23-11"
1013

1114
# Key-values
1215

1316
A key-value is a resource identified by unique combination of `key` + `label`. `label` is optional. To explicitly reference a key-value without a label, use "\0" (URL encoded as ``%00``). See details for each operation.
1417

15-
This article applies to API version 1.0.
16-
1718
## Operations
1819

1920
- Get
@@ -107,8 +108,12 @@ HTTP/1.1 200 OK
107108
## List key-values
108109

109110
Optional: ``key`` (If not specified, it implies any key.)
111+
110112
Optional: ``label`` (If not specified, it implies any label.)
111113

114+
:::zone-end
115+
:::zone target="docs" pivot="v1,v23-10"
116+
112117
```http
113118
GET /kv?label=*&api-version={api-version} HTTP/1.1
114119
```
@@ -120,7 +125,74 @@ HTTP/1.1 200 OK
120125
Content-Type: application/vnd.microsoft.appconfig.kvset+json; charset=utf-8
121126
```
122127

123-
For additional options, see the "Filtering" section later in this article.
128+
:::zone-end
129+
:::zone target="docs" pivot="v23-11"
130+
131+
Optional: ``tags`` (If not specified, it implies any tags.)
132+
133+
```http
134+
GET /kv?key=Test*&label=*&tags=tag1=value1&tags=tag2=value2&api-version={api-version} HTTP/1.1
135+
```
136+
137+
**Response:**
138+
139+
```http
140+
HTTP/1.1 200 OK
141+
Content-Type: application/vnd.microsoft.appconfig.kvset+json; charset=utf-8
142+
```
143+
:::zone-end
144+
:::zone target="docs" pivot="v1,v23-10,v23-11"
145+
146+
For more options, see the "Filtering" section later in this article.
147+
148+
:::zone-end
149+
:::zone target="docs" pivot="v23-10,v23-11"
150+
151+
## List key-values (conditionally)
152+
153+
To improve client caching, use `If-Match` or `If-None-Match` request headers. The `etag` argument is part of the list key-values response body and header.
154+
If `If-Match` or `If-None-Match` are omitted, the operation is unconditional.
155+
156+
The following response gets the key-value only if the current representation matches the specified `etag`:
157+
158+
```http
159+
GET /kv?key={key}label={label}&api-version={api-version} HTTP/1.1
160+
If-Match: "4f6dd610dd5e4deebc7fbaef685fb903"
161+
```
162+
163+
**Responses:**
164+
165+
```http
166+
HTTP/1.1 412 PreconditionFailed
167+
```
168+
169+
or
170+
171+
```http
172+
HTTP/1.1 200 OK
173+
```
174+
175+
The following response gets the key-values only if the current representation doesn't match the specified `etag`:
176+
177+
```http
178+
GET /kv?key={key}label={label}&api-version={api-version} HTTP/1.1
179+
If-None-Match: "4f6dd610dd5e4deebc7fbaef685fb903"
180+
```
181+
182+
**Responses:**
183+
184+
```http
185+
HTTP/1.1 304 NotModified
186+
```
187+
188+
or
189+
190+
```http
191+
HTTP/1.1 200 OK
192+
```
193+
194+
:::zone-end
195+
:::zone target="docs" pivot="v1,v23-10,v23-11"
124196

125197
## Pagination
126198

@@ -150,13 +222,31 @@ Link: <{relative uri}>; rel="next"
150222

151223
## Filtering
152224

225+
:::zone-end
226+
:::zone target="docs" pivot="v1,v23-10"
227+
153228
A combination of `key` and `label` filtering is supported.
154229
Use the optional `key` and `label` query string parameters.
155230

156231
```http
157232
GET /kv?key={key}&label={label}&api-version={api-version}
158233
```
159234

235+
:::zone-end
236+
:::zone target="docs" pivot="v23-11"
237+
238+
A combination of `key`, `label`, and `tags` filtering is supported.
239+
Use the optional `key`, `label`, and `tags` query string parameters.
240+
Multiple tag filters can be provided as query string parameters in the `tagName=tagValue` format. Tag filters must be an exact match.
241+
242+
```http
243+
GET /kv?key={key}&label={label}&tags={tagFilter1}&tags={tagFilter2}&api-version={api-version}
244+
```
245+
246+
:::zone-end
247+
:::zone target="docs" pivot="v1,v23-10,v23-11"
248+
249+
160250
### Supported filters
161251

162252
|Key filter|Effect|
@@ -169,11 +259,25 @@ GET /kv?key={key}&label={label}&api-version={api-version}
169259
|Label filter|Effect|
170260
|--|--|
171261
|`label` is omitted or `label=*`|Matches **any** label|
172-
|`label=%00`|Matches KV without label|
262+
|`label=%00`|Matches key-values with no label|
173263
|`label=prod`|Matches the label **prod**|
174264
|`label=prod*`|Matches labels that start with **prod**|
175265
|`label=prod,test`|Matches labels **prod** or **test** (limited to 5 CSV)|
176266

267+
:::zone-end
268+
:::zone target="docs" pivot="v23-11"
269+
270+
|Tags filter|Effect|
271+
|--|--|
272+
|`tags` is omitted or `tags=` |Matches **any** tag|
273+
|`tags=group=app1`|Matches key-values that have a tag named `group` with value `app1`|
274+
|`tags=group=app1&tags=env=prod`|Matches key-values that have a tag named `group` with value `app1` and a tag named `env` with value `prod`(limited to 5 tag filters)|
275+
|`tags=tag1=%00`|Matches key-values that have a tag named `tag1` with value `null`|
276+
|`tags=tag1=`|Matches key-values that have a tag named `tag1` with empty value|
277+
278+
:::zone-end
279+
:::zone target="docs" pivot="v1,v23-10,v23-11"
280+
177281
***Reserved characters***
178282

179283
`*`, `\`, `,`
@@ -182,7 +286,7 @@ If a reserved character is part of the value, then it must be escaped by using `
182286

183287
***Filter validation***
184288

185-
In the case of a filter validation error, the response is HTTP `400` with error details:
289+
If filter validation fails, the response is HTTP `400` with error details:
186290

187291
```http
188292
HTTP/1.1 400 Bad Request
@@ -298,7 +402,7 @@ ETag: "4f6dd610dd5e4deebc7fbaef685fb903"
298402
}
299403
```
300404

301-
If the item is locked, you'll receive the following response:
405+
If the item is locked, the following response is returned:
302406

303407
```http
304408
HTTP/1.1 409 Conflict
@@ -393,3 +497,5 @@ HTTP/1.1 204 No Content
393497
## Delete key (conditionally)
394498

395499
This is similar to the "Set key (conditionally)" section earlier in this article.
500+
501+
:::zone-end

‎articles/azure-app-configuration/rest-api-keys.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ author: maud-lv
55
ms.author: malev
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 08/17/2020
8+
ms.date: 08/02/2024
9+
zone_pivot_groups: appconfig-data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v1,v23-10,v23-11"
1013

1114
# Keys
1215

13-
api-version: 1.0
14-
1516
The following syntax represents a key resource:
1617

1718
```http
@@ -175,3 +176,5 @@ Link: <relative uri>; rel="original"
175176
]
176177
}
177178
```
179+
180+
:::zone-end

‎articles/azure-app-configuration/rest-api-labels.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ author: maud-lv
55
ms.author: malev
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 08/17/2020
8+
ms.date: 08/02/2024
9+
zone_pivot_groups: appconfig-data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v1,v23-10,v23-11"
1013

1114
# Labels
1215

13-
api-version: 1.0
14-
1516
The **Label** resource is defined as follows:
1617

1718
```json
@@ -93,7 +94,7 @@ GET /labels?name={label-name}&api-version={api-version}
9394

9495
### Supported filters
9596

96-
|Key Filter|Effect|
97+
|Label Filter|Effect|
9798
|--|--|
9899
|`name` is omitted or `name=*`|Matches **any** label|
99100
|`name=abc`|Matches a label named **abc**|
@@ -178,3 +179,5 @@ Link: <{relative uri}>; rel="original"
178179
]
179180
}
180181
```
182+
183+
:::zone-end

‎articles/azure-app-configuration/rest-api-locks.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ author: maud-lv
55
ms.author: malev
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 08/17/2020
8+
ms.date: 08/02/2024
9+
zone_pivot_groups: appconfig-data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v1,v23-10,v23-11"
1013

1114
# Locks
1215

13-
This API (version 1.0) provides lock and unlock semantics for the key-value resource. It supports the following operations:
16+
This API provides lock and unlock semantics for the key-value resource. It supports the following operations:
1417

1518
- Place lock
1619
- Remove lock
@@ -108,3 +111,5 @@ The following request applies the operation only if the current key-value repres
108111
PUT|DELETE /kv/{key}?label={label}&api-version={api-version} HTTP/1.1
109112
If-None-Match: "4f6dd610dd5e4deebc7fbaef685fb903"
110113
```
114+
115+
:::zone-end

‎articles/azure-app-configuration/rest-api-revisions.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ author: maud-lv
55
ms.author: malev
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 08/17/2020
8+
ms.date: 08/02/2024
9+
zone_pivot_groups: appconfig-data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v1,v23-10,v23-11"
1013

1114
# Key-value revisions
1215

@@ -16,8 +19,6 @@ For all operations, ``key`` is an optional parameter. If omitted, it implies any
1619

1720
For all operations, ``label`` is an optional parameter. If omitted, it implies any label.
1821

19-
This article applies to API version 1.0.
20-
2122
## Prerequisites
2223

2324
[!INCLUDE [azure-app-configuration-create](../../includes/azure-app-configuration-rest-api-prereqs.md)]
@@ -99,13 +100,30 @@ Content-Range: items 0-2/80
99100

100101
## Filtering
101102

103+
:::zone-end
104+
:::zone target="docs" pivot="v1,v23-10"
105+
102106
A combination of `key` and `label` filtering is supported.
103107
Use the optional `key` and `label` query string parameters.
104108

105109
```http
106110
GET /revisions?key={key}&label={label}&api-version={api-version}
107111
```
108112

113+
:::zone-end
114+
:::zone target="docs" pivot="v23-11"
115+
116+
A combination of `key`, `label` and `tags` filtering is supported.
117+
Use the optional `key`, `label` and `tags` query string parameters.
118+
Multiple tag filters can be provided as query string parameters in the `tagName=tagValue` format. Tag filters must be an exact match.
119+
120+
```http
121+
GET /revisions?key={key}&label={label}&tags={tagFilter1}&tags={tagFilter2}&api-version={api-version}
122+
```
123+
124+
:::zone-end
125+
:::zone target="docs" pivot="v1,v23-10,v23-11"
126+
109127
### Supported filters
110128

111129
|Key filter|Effect|
@@ -119,14 +137,28 @@ GET /revisions?key={key}&label={label}&api-version={api-version}
119137

120138
|Label filter|Effect|
121139
|--|--|
122-
|`label` is omitted or `label=`|Matches entry without label|
140+
|`label` is omitted or `label=`|Matches key-values with no label|
123141
|`label=*`|Matches **any** label|
124142
|`label=prod`|Matches the label **prod**|
125143
|`label=prod*`|Matches labels that start with **prod**|
126144
|`label=*prod`|Matches labels that end with **prod**|
127145
|`label=*prod*`|Matches labels that contain **prod**|
128146
|`label=prod,test`|Matches labels **prod** or **test** (limited to 5 CSV)|
129147

148+
:::zone-end
149+
:::zone target="docs" pivot="v23-11"
150+
151+
|Tags filter|Effect|
152+
|--|--|
153+
|`tags` is omitted or `tags=` |Matches **any** tag|
154+
|`tags=group=app1`|Matches key-values that have a tag named `group` with value `app1`|
155+
|`tags=group=app1&tags=env=prod`|Matches key-values that have a tag named `group` with value `app1` and a tag named `env` with value `prod`(limited to 5 tag filters)|
156+
|`tags=tag1=%00`|Matches key-values that have a tag named `tag1` with value `null`|
157+
|`tags=tag1=`|Matches key-values that have a tag named `tag1` with empty value|
158+
159+
:::zone-end
160+
:::zone target="docs" pivot="v1,v23-10,v23-11"
161+
130162
### Reserved characters
131163

132164
The reserved characters are:
@@ -207,3 +239,5 @@ Link: <{relative uri}>; rel="original"
207239
]
208240
}
209241
```
242+
243+
:::zone-end

0 commit comments

Comments
 (0)