Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageBlobGetPageRangesDiffOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • PageBlobGetPageRangesDiffOptionalParams

Index

Properties

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Parameter group

Optional marker

marker: undefined | string

A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.

Optional maxPageSize

maxPageSize: undefined | number

Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000.

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Parameter group

Optional prevSnapshotUrl

prevSnapshotUrl: undefined | string

Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot.

Optional prevsnapshot

prevsnapshot: undefined | string

Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016.

Optional range

range: undefined | string

Return only the bytes of the blob in the specified range.

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional snapshot

snapshot: undefined | string

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Generated using TypeDoc