Skip to content

Commit ae45403

Browse files
committed
Snapshot Acrolinx Updates
1 parent d89a8cb commit ae45403

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ zone_pivot_groups: appconfig-data-plane-api-version
1515

1616
:::zone target="docs" pivot="v1"
1717

18-
Snapshot resource is not available in API version 1.0.
18+
Snapshot resource isn't available in API version 1.0.
1919

2020
:::zone-end
2121
:::zone target="docs" pivot="v23-10,v23-11"
@@ -145,7 +145,7 @@ If-None-Match: "{etag}"
145145
HTTP/1.1 304 NotModified
146146
```
147147

148-
or
148+
Or
149149

150150
```http
151151
HTTP/1.1 200 OK
@@ -167,7 +167,7 @@ HTTP/1.1 200 OK
167167
Content-Type: application/vnd.microsoft.appconfig.snapshotset+json; charset=utf-8
168168
```
169169

170-
For additional options, see the "Filtering" section later in this article.
170+
For more options, see the "Filtering" section later in this article.
171171

172172
## Pagination
173173

@@ -223,11 +223,11 @@ GET /snapshots?name={name}&status={status}&api-version={api-version}
223223

224224
`*`, `\`, `,`
225225

226-
If a reserved character is part of the value, then it must be escaped by using `\{Reserved Character}`. Non-reserved characters can also be escaped.
226+
If a reserved character is part of the value, then it must be escaped by using `\{Reserved Character}`. Nonreserved characters can also be escaped.
227227

228228
***Filter validation***
229229

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

232232
```http
233233
HTTP/1.1 400 Bad Request
@@ -281,13 +281,13 @@ GET /snapshot?$select=name,status&api-version={api-version} HTTP/1.1
281281

282282
| Property Name | Required | Default value | Validation |
283283
|-|-|-|-|
284-
| name | yes | n/a | Length <br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 256 |
285-
| filters | yes | n/a | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 1<br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 3 |
284+
| name | yes | n/a | Length <br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 256 |
285+
| filters | yes | n/a | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; Minimum: 1<br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 3 |
286286
| filters[\<index\>].key | yes | n/a | |
287-
| filters[\<index\>].label | no | null | Multi-match label filters (E.g.: "*", "comma,separated") aren't supported with 'key' composition type. |
287+
| filters[\<index\>].label | no | null | Multi-match label filters (for example: "*", "comma,separated") aren't supported with 'key' composition type. |
288288
| tags | no | {} | |
289289
| composition_type | no | key | |
290-
| 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) |
290+
| retention_period | no | Standard tier <br/>&nbsp;&nbsp;&nbsp;&nbsp; 2592000 (30 days) <br/> Free tier <br/> &nbsp;&nbsp;&nbsp;&nbsp; 604800 (seven days) | Standard tier <br/> &nbsp;&nbsp;&nbsp;&nbsp; Minimum: 3600 (one hour) <br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 7776000 (90 days) <br/> Free tier <br/> &nbsp;&nbsp;&nbsp;&nbsp; Minimum: 3600 (one hour) <br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 604800 (seven days) |
291291

292292
```http
293293
PUT /snapshot/{name}?api-version={api-version} HTTP/1.1
@@ -349,14 +349,14 @@ Operation-Location: {appConfigurationEndpoint}/operations?snapshot={name}&api-ve
349349

350350
| Property Name | Required | Default value | Validation |
351351
|-|-|-|-|
352-
| name | yes | n/a | Length <br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 256 |
353-
| filters | yes | n/a | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 1<br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 3 |
352+
| name | yes | n/a | Length <br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 256 |
353+
| filters | yes | n/a | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; Minimum: 1<br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 3 |
354354
| filters[\<index\>].key | yes | n/a | |
355-
| filters[\<index\>].label | no | null | Multi-match label filters (E.g.: "*", "comma,separated") aren't supported with 'key' composition type. |
356-
| filters[\<index\>].tags | no | null | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; minimum: 0<br/> &nbsp;&nbsp;&nbsp;&nbsp; maximum: 5 |
355+
| filters[\<index\>].label | no | null | Multi-match label filters (for example: "*", "comma,separated") aren't supported with 'key' composition type. |
356+
| filters[\<index\>].tags | no | null | Count <br/> &nbsp;&nbsp;&nbsp;&nbsp; Minimum: 0<br/> &nbsp;&nbsp;&nbsp;&nbsp; Maximum: 5 |
357357
| tags | no | {} | |
358358
| composition_type | no | key | |
359-
| 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) |
359+
| 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) |
360360

361361
```http
362362
PUT /snapshot/{name}?api-version={api-version} HTTP/1.1
@@ -418,12 +418,12 @@ Operation-Location: {appConfigurationEndpoint}/operations?snapshot={name}&api-ve
418418
:::zone-end
419419
:::zone target="docs" pivot="v23-10,v23-11"
420420

421-
The status of the newly created snapshot will be "provisioning".
422-
Once the snapshot is fully provisioned, the status will update to "ready".
421+
The status of the newly created snapshot is `provisioning`.
422+
Once the snapshot is fully provisioned, the status updates to `ready`.
423423
Clients can poll the snapshot to wait for the snapshot to be ready before listing its associated key-values.
424424
To query additional information about the operation, reference the [polling snapshot creation](#polling-snapshot-creation) section.
425425

426-
If the snapshot already exists, you'll receive the following response:
426+
If the snapshot already exists, the following response is returned:
427427

428428
```http
429429
HTTP/1.1 409 Conflict
@@ -473,7 +473,7 @@ Content-Type: application/json; charset=utf-8
473473
}
474474
```
475475

476-
If any error occurs during the provisioning of the snapshot, the `error` property will contain details describing the error.
476+
If any error occurs during the provisioning of the snapshot, the `error` property contains details describing the error.
477477

478478
```json
479479
{
@@ -489,7 +489,7 @@ If any error occurs during the provisioning of the snapshot, the `error` propert
489489
## Archive (Patch)
490490

491491
A snapshot in the `ready` state can be archived.
492-
An archived snapshot will be assigned an expiration date, based off the retention period established at the time of its creation.
492+
An archived snapshot is assigned an expiration date, based off the retention period established at the time of its creation.
493493
After the expiration date passes, the snapshot will be permanently deleted.
494494
At any time before the expiration date, the snapshot's items can still be listed.
495495

@@ -548,7 +548,7 @@ Content-Type: application/problem+json; charset="utf-8"
548548
## Recover (Patch)
549549

550550
A snapshot in the `archived` state can be recovered.
551-
Once the snapshot is recovered the snapshot's expiration date is removed.
551+
After the snapshot is recovered, the snapshot's expiration date is removed.
552552

553553
Recovering a snapshot that is already `ready` doesn't affect the snapshot.
554554

@@ -630,7 +630,7 @@ Content-Type: application/vnd.microsoft.appconfig.snapshot+json; charset=utf-8
630630
...
631631
```
632632

633-
or
633+
Or
634634

635635
```http
636636
HTTP/1.1 412 PreconditionFailed

0 commit comments

Comments
 (0)