PageBlob class
Class representing a PageBlob.
Constructors
| Page |
Create a PageBlob. |
Methods
Constructor Details
PageBlob(StorageClientContext)
Create a PageBlob.
new PageBlob(client: StorageClientContext)Parameters
- client
- StorageClientContext
Reference to the service client.
Method Details
clearPages(number, Models.PageBlobClearPagesOptionalParams)
The Clear Pages operation clears a set of pages from a page blob
function clearPages(contentLength: number, options?: Models.PageBlobClearPagesOptionalParams)Parameters
- contentLength
-
number
The length of the request.
- options
- Models.PageBlobClearPagesOptionalParams
Returns
Promise<Models.PageBlobClearPagesResponse>
Promise<Models.PageBlobClearPagesResponse>
clearPages(number, PageBlobClearPagesOptionalParams, ServiceCallback<void>)
function clearPages(contentLength: number, options: PageBlobClearPagesOptionalParams, callback: ServiceCallback<void>)Parameters
- contentLength
-
number
The length of the request.
- options
- PageBlobClearPagesOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
clearPages(number, ServiceCallback<void>)
function clearPages(contentLength: number, callback: ServiceCallback<void>)Parameters
- contentLength
-
number
The length of the request.
- callback
-
ServiceCallback<void>
The callback
copyIncremental(string, Models.PageBlobCopyIncrementalOptionalParams)
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.
function copyIncremental(copySource: string, options?: Models.PageBlobCopyIncrementalOptionalParams)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.
- options
- Models.PageBlobCopyIncrementalOptionalParams
Returns
Promise<Models.PageBlobCopyIncrementalResponse>
Promise<Models.PageBlobCopyIncrementalResponse>
copyIncremental(string, PageBlobCopyIncrementalOptionalParams, ServiceCallback<void>)
function copyIncremental(copySource: string, options: PageBlobCopyIncrementalOptionalParams, callback: ServiceCallback<void>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
copyIncremental(string, ServiceCallback<void>)
function copyIncremental(copySource: string, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
create(number, number, Models.PageBlobCreateOptionalParams)
The Create operation creates a new page blob.
function create(contentLength: number, blobContentLength: number, options?: Models.PageBlobCreateOptionalParams)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.
- options
- Models.PageBlobCreateOptionalParams
Returns
Promise<Models.PageBlobCreateResponse>
Promise<Models.PageBlobCreateResponse>
create(number, number, PageBlobCreateOptionalParams, ServiceCallback<void>)
function create(contentLength: number, blobContentLength: number, options: PageBlobCreateOptionalParams, callback: ServiceCallback<void>)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.
- options
- PageBlobCreateOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
create(number, number, ServiceCallback<void>)
function create(contentLength: number, blobContentLength: number, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
getPageRanges(Models.PageBlobGetPageRangesOptionalParams)
The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob
function getPageRanges(options?: Models.PageBlobGetPageRangesOptionalParams)Parameters
- options
- Models.PageBlobGetPageRangesOptionalParams
Returns
Promise<Models.PageBlobGetPageRangesResponse>
Promise<Models.PageBlobGetPageRangesResponse>
getPageRanges(PageBlobGetPageRangesOptionalParams, ServiceCallback<PageList>)
function getPageRanges(options: PageBlobGetPageRangesOptionalParams, callback: ServiceCallback<PageList>)Parameters
The optional parameters
- callback
-
ServiceCallback<PageList>
The callback
getPageRanges(ServiceCallback<PageList>)
function getPageRanges(callback: ServiceCallback<PageList>)Parameters
- callback
-
ServiceCallback<PageList>
The callback
getPageRangesDiff(Models.PageBlobGetPageRangesDiffOptionalParams)
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.
function getPageRangesDiff(options?: Models.PageBlobGetPageRangesDiffOptionalParams)Parameters
- options
- Models.PageBlobGetPageRangesDiffOptionalParams
Returns
Promise<Models.PageBlobGetPageRangesDiffResponse>
Promise<Models.PageBlobGetPageRangesDiffResponse>
getPageRangesDiff(PageBlobGetPageRangesDiffOptionalParams, ServiceCallback<PageList>)
function getPageRangesDiff(options: PageBlobGetPageRangesDiffOptionalParams, callback: ServiceCallback<PageList>)Parameters
The optional parameters
- callback
-
ServiceCallback<PageList>
The callback
getPageRangesDiff(ServiceCallback<PageList>)
function getPageRangesDiff(callback: ServiceCallback<PageList>)Parameters
- callback
-
ServiceCallback<PageList>
The callback
resize(number, Models.PageBlobResizeOptionalParams)
Resize the Blob
function resize(blobContentLength: number, options?: Models.PageBlobResizeOptionalParams)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.
- options
- Models.PageBlobResizeOptionalParams
Returns
Promise<Models.PageBlobResizeResponse>
Promise<Models.PageBlobResizeResponse>
resize(number, PageBlobResizeOptionalParams, ServiceCallback<void>)
function resize(blobContentLength: number, options: PageBlobResizeOptionalParams, callback: ServiceCallback<void>)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.
- options
- PageBlobResizeOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
resize(number, ServiceCallback<void>)
function resize(blobContentLength: number, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
updateSequenceNumber(Models.SequenceNumberActionType, Models.PageBlobUpdateSequenceNumberOptionalParams)
Update the sequence number of the blob
function updateSequenceNumber(sequenceNumberAction: Models.SequenceNumberActionType, options?: Models.PageBlobUpdateSequenceNumberOptionalParams)Parameters
- sequenceNumberAction
- Models.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. Possible values include: 'max', 'update', 'increment'
- options
- Models.PageBlobUpdateSequenceNumberOptionalParams
Returns
Promise<Models.PageBlobUpdateSequenceNumberResponse>
Promise<Models.PageBlobUpdateSequenceNumberResponse>
updateSequenceNumber(Models.SequenceNumberActionType, PageBlobUpdateSequenceNumberOptionalParams, ServiceCallback<void>)
function updateSequenceNumber(sequenceNumberAction: Models.SequenceNumberActionType, options: PageBlobUpdateSequenceNumberOptionalParams, callback: ServiceCallback<void>)Parameters
- sequenceNumberAction
- Models.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. Possible values include: 'max', 'update', 'increment'
The optional parameters
- callback
-
ServiceCallback<void>
The callback
updateSequenceNumber(Models.SequenceNumberActionType, ServiceCallback<void>)
function updateSequenceNumber(sequenceNumberAction: Models.SequenceNumberActionType, callback: ServiceCallback<void>)Parameters
- sequenceNumberAction
- Models.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. Possible values include: 'max', 'update', 'increment'
- callback
-
ServiceCallback<void>
The callback
uploadPages(msRest.HttpRequestBody, number, Models.PageBlobUploadPagesOptionalParams)
The Upload Pages operation writes a range of pages to a page blob
function uploadPages(body: msRest.HttpRequestBody, contentLength: number, options?: Models.PageBlobUploadPagesOptionalParams)Parameters
- body
- msRest.HttpRequestBody
Initial data
- contentLength
-
number
The length of the request.
- options
- Models.PageBlobUploadPagesOptionalParams
Returns
Promise<Models.PageBlobUploadPagesResponse>
Promise<Models.PageBlobUploadPagesResponse>
uploadPages(msRest.HttpRequestBody, number, PageBlobUploadPagesOptionalParams, ServiceCallback<void>)
function uploadPages(body: msRest.HttpRequestBody, contentLength: number, options: PageBlobUploadPagesOptionalParams, callback: ServiceCallback<void>)Parameters
- body
- msRest.HttpRequestBody
Initial data
- contentLength
-
number
The length of the request.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
uploadPages(msRest.HttpRequestBody, number, ServiceCallback<void>)
function uploadPages(body: msRest.HttpRequestBody, contentLength: number, callback: ServiceCallback<void>)Parameters
- body
- msRest.HttpRequestBody
Initial data
- contentLength
-
number
The length of the request.
- callback
-
ServiceCallback<void>
The callback
uploadPagesFromURL(string, string, number, string, Models.PageBlobUploadPagesFromURLOptionalParams)
The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL
function uploadPagesFromURL(sourceUrl: string, sourceRange: string, contentLength: number, range: string, options?: Models.PageBlobUploadPagesFromURLOptionalParams)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.
- options
- Models.PageBlobUploadPagesFromURLOptionalParams
Returns
Promise<Models.PageBlobUploadPagesFromURLResponse>
Promise<Models.PageBlobUploadPagesFromURLResponse>
uploadPagesFromURL(string, string, number, string, PageBlobUploadPagesFromURLOptionalParams, ServiceCallback<void>)
function uploadPagesFromURL(sourceUrl: string, sourceRange: string, contentLength: number, range: string, options: PageBlobUploadPagesFromURLOptionalParams, callback: ServiceCallback<void>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
uploadPagesFromURL(string, string, number, string, ServiceCallback<void>)
function uploadPagesFromURL(sourceUrl: string, sourceRange: string, contentLength: number, range: string, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
