Sign in

Updates the state of a key-value snapshot.

Updates the state of a key-value snapshot.

patch/snapshots/{name}

Path parameters

namestring required

The name of the key-value snapshot to update.

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

Sync-Tokenstring

Used to guarantee real-time consistency between requests.

If-Matchstring

Used to perform an operation only if the targeted resource's etag matches the value provided.

If-None-Matchstring

Used to perform an operation only if the targeted resource's etag does not match the value provided.

x-ms-client-request-idstring uuid

An opaque, globally-unique, client-generated string identifier for the request.

Request body

status'provisioning' | 'ready' | 'archived' | 'failed'

Snapshot status.

Response

The request has succeeded.

namestring required

The name of the snapshot.

status'provisioning' | 'ready' | 'archived' | 'failed'

Snapshot status.

composition_type'key' | 'key_label'

Composition types.

createdstring date-time

The time that the snapshot was created.

expiresstring date-time

The time that the snapshot will expire.

retention_periodinteger

The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.

sizeinteger

The size in bytes of the snapshot.

items_countinteger

The amount of key-values in the snapshot.

tagsobject

The tags of the snapshot.

descriptionstring

The description of the snapshot.

etagstring

A value representing the current state of the snapshot.

Changes

Changed in 2 of the 4 revisions of this API.11