PageBlob | @azure/storage-blob

Class representing a PageBlob.

Hierarchy

PageBlob

Index

Constructors

constructor

Methods

Constructors

constructor

new PageBlob(client: StorageClientContext): PageBlob

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:37
Initialize a new instance of the class PageBlob class.

Parameters
- client: StorageClientContext
  
  Reference to the service client
Returns PageBlob

Methods

clearPages

clearPages(contentLength: number, options?: PageBlobClearPagesOptionalParams): Promise<PageBlobClearPagesResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:97
The Clear Pages operation clears a set of pages from a page blob

Parameters
- contentLength: number
  
  The length of the request.
- Optional options: PageBlobClearPagesOptionalParams
  
  The options parameters.
Returns Promise<PageBlobClearPagesResponse>

copyIncremental

copyIncremental(copySource: string, options?: PageBlobCopyIncrementalOptionalParams): Promise<PageBlobCopyIncrementalResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:229
The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31.

Parameters
- copySource: string
  
  Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature.
- Optional options: PageBlobCopyIncrementalOptionalParams
  
  The options parameters.
Returns Promise<PageBlobCopyIncrementalResponse>

create

create(contentLength: number, blobContentLength: number, options?: PageBlobCreateOptionalParams): Promise<PageBlobCreateResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:54
The Create operation creates a new page blob.

Parameters
- contentLength: number
  
  The length of the request.
- blobContentLength: number
  
  This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary.
- Optional options: PageBlobCreateOptionalParams
  
  The options parameters.
Returns Promise<PageBlobCreateResponse>

getPageRanges

getPageRanges(options?: PageBlobGetPageRangesOptionalParams): Promise<PageBlobGetPageRangesResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:147
The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob

Parameters
- Optional options: PageBlobGetPageRangesOptionalParams
  
  The options parameters.
Returns Promise<PageBlobGetPageRangesResponse>

getPageRangesDiff

getPageRangesDiff(options?: PageBlobGetPageRangesDiffOptionalParams): Promise<PageBlobGetPageRangesDiffResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:164
The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob and previous snapshot.

Parameters
- Optional options: PageBlobGetPageRangesDiffOptionalParams
  
  The options parameters.
Returns Promise<PageBlobGetPageRangesDiffResponse>

resize

resize(blobContentLength: number, options?: PageBlobResizeOptionalParams): Promise<PageBlobResizeResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:182
Resize the Blob

Parameters
- blobContentLength: number
  
  This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary.
- Optional options: PageBlobResizeOptionalParams
  
  The options parameters.
Returns Promise<PageBlobResizeResponse>

updateSequenceNumber

updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, options?: PageBlobUpdateSequenceNumberOptionalParams): Promise<PageBlobUpdateSequenceNumberResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:203
Update the sequence number of the blob

Parameters
- sequenceNumberAction: SequenceNumberActionType
  
  Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number
- Optional options: PageBlobUpdateSequenceNumberOptionalParams
  
  The options parameters.
Returns Promise<PageBlobUpdateSequenceNumberResponse>

uploadPages

uploadPages(contentLength: number, body: coreHttp.HttpRequestBody, options?: PageBlobUploadPagesOptionalParams): Promise<PageBlobUploadPagesResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:76
The Upload Pages operation writes a range of pages to a page blob

Parameters
- contentLength: number
  
  The length of the request.
- body: coreHttp.HttpRequestBody
  
  Initial data
- Optional options: PageBlobUploadPagesOptionalParams
  
  The options parameters.
Returns Promise<PageBlobUploadPagesResponse>

uploadPagesFromURL

uploadPagesFromURL(sourceUrl: string, sourceRange: string, contentLength: number, range: string, options?: PageBlobUploadPagesFromURLOptionalParams): Promise<PageBlobUploadPagesFromURLResponse>

- Defined in storage-blob/src/generated/src/operations/pageBlob.ts:122
The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL

Parameters
- sourceUrl: string
  
  Specify a URL to the copy source.
- sourceRange: string
  
  Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header.
- contentLength: number
  
  The length of the request.
- range: string
  
  The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required.
- Optional options: PageBlobUploadPagesFromURLOptionalParams
  
  The options parameters.
Returns Promise<PageBlobUploadPagesFromURLResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: StorageClientContext

Returns PageBlob

Methods

clearPages

Parameters

contentLength: number

Optional options: PageBlobClearPagesOptionalParams

Returns Promise<PageBlobClearPagesResponse>

copyIncremental

Parameters

copySource: string

Optional options: PageBlobCopyIncrementalOptionalParams

Returns Promise<PageBlobCopyIncrementalResponse>

create

Parameters

contentLength: number

blobContentLength: number

Optional options: PageBlobCreateOptionalParams

Returns Promise<PageBlobCreateResponse>

getPageRanges

Parameters

Optional options: PageBlobGetPageRangesOptionalParams

Returns Promise<PageBlobGetPageRangesResponse>

getPageRangesDiff

Parameters

Optional options: PageBlobGetPageRangesDiffOptionalParams

Returns Promise<PageBlobGetPageRangesDiffResponse>

resize

Parameters

blobContentLength: number

Optional options: PageBlobResizeOptionalParams

Returns Promise<PageBlobResizeResponse>

updateSequenceNumber

Parameters

sequenceNumberAction: SequenceNumberActionType

Optional options: PageBlobUpdateSequenceNumberOptionalParams

Returns Promise<PageBlobUpdateSequenceNumberResponse>

uploadPages

Parameters

contentLength: number

body: coreHttp.HttpRequestBody

Optional options: PageBlobUploadPagesOptionalParams

Returns Promise<PageBlobUploadPagesResponse>

uploadPagesFromURL

Parameters

sourceUrl: string

sourceRange: string

contentLength: number

range: string

Optional options: PageBlobUploadPagesFromURLOptionalParams

Returns Promise<PageBlobUploadPagesFromURLResponse>