Skip to content

Commit 74d71bf

Browse files
committed
Update all docs with API versions
1 parent 1edd350 commit 74d71bf

File tree

6 files changed

+144
-16
lines changed

6 files changed

+144
-16
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: maud-lv
55
ms.author: malev
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 07/23/2024
8+
ms.date: 08/02/2024
99
zone_pivot_groups: data-plane-api-version
1010

1111
---
@@ -108,6 +108,7 @@ HTTP/1.1 200 OK
108108
## List key-values
109109

110110
Optional: ``key`` (If not specified, it implies any key.)
111+
111112
Optional: ``label`` (If not specified, it implies any label.)
112113

113114
:::zone-end
@@ -224,7 +225,7 @@ Use the optional `key` and `label` query string parameters.
224225
:::zone-end
225226
:::zone target="docs" pivot="v23-11"
226227

227-
For API Versions greater than `2023-11-01`, filtering by`tags` is also supported. Multiple tag filters can be provided as query string parameters in the `tagName=tagValue` format. Tag filters must be an exact match.
228+
For API Versions greater than `2023-11-01`, filtering by `tags` is also supported. Multiple tag filters can be provided as query string parameters in the `tagName=tagValue` format. Tag filters must be an exact match.
228229

229230
```http
230231
GET /kv?key={key}&label={label}&tags={tagFilter1}&tags={tagFilter2}&api-version={api-version}

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: 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: 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: 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: 32 additions & 1 deletion
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: data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v1,v23-10,v23-11"
1013

1114
# Key-value revisions
1215

@@ -100,6 +103,18 @@ Content-Range: items 0-2/80
100103
A combination of `key` and `label` filtering is supported.
101104
Use the optional `key` and `label` query string parameters.
102105

106+
:::zone-end
107+
:::zone target="docs" pivot="v23-11"
108+
109+
For API Versions greater than `2023-11-01`, filtering by`tags` is also supported. Multiple tag filters can be provided as query string parameters in the `tagName=tagValue` format. Tag filters must be an exact match.
110+
111+
```http
112+
GET /revisions?key={key}&label={label}&tags={tagFilter1}&tags={tagFilter2}&api-version={api-version}
113+
```
114+
115+
:::zone-end
116+
:::zone target="docs" pivot="v1,v23-10,v23-11"
117+
103118
```http
104119
GET /revisions?key={key}&label={label}&api-version={api-version}
105120
```
@@ -125,6 +140,20 @@ GET /revisions?key={key}&label={label}&api-version={api-version}
125140
|`label=*prod*`|Matches labels that contain **prod**|
126141
|`label=prod,test`|Matches labels **prod** or **test** (limited to 5 CSV)|
127142

143+
:::zone-end
144+
:::zone target="docs" pivot="v23-11"
145+
146+
|Tags filter|Effect|
147+
|--|--|
148+
|`tags` is omitted or `tags=` |Matches **any** tag|
149+
|`tags=group=app1`|Matches KV where the tag name is `group` and tag value is `app1`|
150+
|`tags=group=app1&tags=env=prod`|Matches KV which contain at least 2 tags, where the tag names are `group` and `env` and tag values are `app1` and `prod` respectively (limited to 5 tag filters)|
151+
|`tags=tag1=%00`|Matches KV where the tag name is `tag1` and tag value is `null`|
152+
|`tags=tag1=`|Matches KV where the tag name is `tag1` and tag value is empty|
153+
154+
:::zone-end
155+
:::zone target="docs" pivot="v1,v23-10,v23-11"
156+
128157
### Reserved characters
129158

130159
The reserved characters are:
@@ -205,3 +234,5 @@ Link: <{relative uri}>; rel="original"
205234
]
206235
}
207236
```
237+
238+
:::zone-end

articles/azure-app-configuration/rest-api-snapshot.md

Lines changed: 89 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ author: jimmyca15
55
ms.author: jimmyca
66
ms.service: azure-app-configuration
77
ms.topic: reference
8-
ms.date: 03/21/2023
8+
ms.date: 08/02/2024
9+
zone_pivot_groups: data-plane-api-version
10+
911
---
12+
:::zone target="docs" pivot="v23-10,v23-11"
1013

1114
# Snapshot
1215

1316
A snapshot is a resource identified uniquely by its name. See details for each operation.
1417

15-
This article applies to API version 2022-11-01-preview.
16-
1718
## Operations
1819

1920
- Get
@@ -48,13 +49,30 @@ This article applies to API version 2022-11-01-preview.
4849

4950
`SnapshotFilter`
5051

52+
:::zone-end
53+
:::zone target="docs" pivot="v23-10"
54+
5155
```json
5256
{
5357
"key": [string],
5458
"label": [string]
5559
}
5660
```
5761

62+
:::zone-end
63+
:::zone target="docs" pivot="v23-11"
64+
65+
```json
66+
{
67+
"key": [string],
68+
"label": [string],
69+
"tags": [array<string>]
70+
}
71+
```
72+
73+
:::zone-end
74+
:::zone target="docs" pivot="v23-10,v23-11"
75+
5876
## Get snapshot
5977

6078
Required: ``{name}``, ``{api-version}``
@@ -256,15 +274,22 @@ GET /snapshot?$select=name,status&api-version={api-version} HTTP/1.1
256274
| name | yes | n/a | Length <br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 256 |
257275
| filters | yes | n/a | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 1<br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 3 |
258276
| filters[\<index\>].key | yes | n/a | |
259-
| tags | no | {} | |
260277
| filters[\<index\>].label | no | null | Multi-match label filters (E.g.: "*", "comma,separated") aren't supported with 'key' composition type. |
278+
:::zone-end
279+
:::zone target="docs" pivot="v23-11"
280+
| filters[\<index\>].tags | no | null | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 0<br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 5 |
281+
:::zone-end
282+
:::zone target="docs" pivot="v23-10,v23-11"
283+
| tags | no | {} | |
261284
| composition_type | no | key | |
262285
| retention_period | no | Standard tier <br/>&nbsp;&nbsp;&nbsp;&nbsp; 2592000 (30 days) <br/> Free tier <br/> &nbsp;&nbsp;&nbsp;&nbsp; 604800 (7 days) | Standard tier <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 3600 (1 hour) <br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 7776000 (90 days) <br/> Free tier <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 3600 (1 hour) <br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 604800 (7 days) |
263286

264287
```http
265288
PUT /snapshot/{name}?api-version={api-version} HTTP/1.1
266289
Content-Type: application/vnd.microsoft.appconfig.snapshot+json
267290
```
291+
:::zone-end
292+
:::zone target="docs" pivot="v23-10"
268293

269294
```json
270295
{
@@ -316,6 +341,64 @@ Operation-Location: {appConfigurationEndpoint}/operations?snapshot={name}&api-ve
316341
}
317342
```
318343

344+
:::zone-end
345+
:::zone target="docs" pivot="v23-11"
346+
347+
```json
348+
{
349+
"filters": [ // required
350+
{
351+
"key": "app1/*", // required
352+
"label": "prod", // optional
353+
"tags": ["group=g1", "default=true"] // optional
354+
}
355+
],
356+
"tags": { // optional
357+
"tag1": "value1",
358+
"tag2": "value2",
359+
},
360+
"composition_type": "key", // optional
361+
"retention_period": 2592000 // optional
362+
}
363+
```
364+
365+
**Responses:**
366+
367+
```http
368+
HTTP/1.1 201 Created
369+
Content-Type: application/vnd.microsoft.appconfig.snapshot+json; charset=utf-8
370+
Last-Modified: Tue, 05 Dec 2017 02:41:26 GMT
371+
ETag: "4f6dd610dd5e4deebc7fbaef685fb903"
372+
Operation-Location: {appConfigurationEndpoint}/operations?snapshot={name}&api-version={api-version}
373+
```
374+
375+
```json
376+
{
377+
"etag": "4f6dd610dd5e4deebc7fbaef685fb903",
378+
"name": "{name}",
379+
"status": "provisioning",
380+
"filters": [
381+
{
382+
"key": "app1/*",
383+
"label": "prod",
384+
"tags": ["group=g1", "default=true"]
385+
}
386+
],
387+
"composition_type": "key",
388+
"created": "2023-03-20T21:00:03+00:00",
389+
"size": 2000,
390+
"items_count": 4,
391+
"tags": {
392+
"t1": "value1",
393+
"t2": "value2"
394+
},
395+
"retention_period": 2592000
396+
}
397+
```
398+
399+
:::zone-end
400+
:::zone target="docs" pivot="v23-10,v23-11"
401+
319402
The status of the newly created snapshot will be "provisioning".
320403
Once the snapshot is fully provisioned, the status will update to "ready".
321404
Clients can poll the snapshot to wait for the snapshot to be ready before listing its associated key-values.
@@ -552,3 +635,5 @@ Use the optional `$select` query string parameter and provide a comma-separated
552635
```http
553636
GET /kv?snapshot={name}&$select=key,value&api-version={api-version} HTTP/1.1
554637
```
638+
639+
:::zone-end

0 commit comments

Comments
 (0)