PageBlobClient | @azure/storage-blob

Hierarchy

BlobClient
- PageBlobClient

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new PageBlobClient(connectionString: string, containerName: string, blobName: string, options: StoragePipelineOptions): PageBlobClient
new PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options: StoragePipelineOptions): PageBlobClient
new PageBlobClient(url: string, pipeline: Pipeline): PageBlobClient

Overrides BlobClient.constructor
- Defined in Clients.ts:4122
Parameters
- connectionString: string
- containerName: string
- blobName: string
- Optional options: StoragePipelineOptions
Returns PageBlobClient
Overrides BlobClient.constructor
- Defined in Clients.ts:4144
Parameters
- url: string
- credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns PageBlobClient
Overrides BlobClient.constructor
- Defined in Clients.ts:4162
Parameters
- url: string
- pipeline: Pipeline
Returns PageBlobClient

Properties

accountName

accountName: string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Protected isHttps

isHttps: boolean

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

containerName

containerName:

name

name:

Methods

abortCopyFromURL

abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Inherited from BlobClient.abortCopyFromURL
- Defined in Clients.ts:1601
Parameters
- copyId: string
- Default value options: BlobAbortCopyFromURLOptions = {}
Returns Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL

beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Inherited from BlobClient.beginCopyFromURL
- Defined in Clients.ts:1564
Parameters
- copySource: string
- Default value options: BlobBeginCopyFromURLOptions = {}
Returns Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages

clearPages(offset?: number, count: undefined | number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

- Defined in Clients.ts:4438
Parameters
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: PageBlobClearPagesOptions = {}
Returns Promise<PageBlobClearPagesResponse>

Response data for the Page Blob Clear Pages operation.

create

create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

- Defined in Clients.ts:4293
Parameters
- size: number
- Default value options: PageBlobCreateOptions = {}
Returns Promise<PageBlobCreateResponse>

Response data for the Page Blob Create operation.

createSnapshot

createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Inherited from BlobClient.createSnapshot
- Defined in Clients.ts:1467
Parameters
- Default value options: BlobCreateSnapshotOptions = {}
Returns Promise<BlobCreateSnapshotResponse>

delete

delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Inherited from BlobClient.delete
- Defined in Clients.ts:1317
Parameters
- Default value options: BlobDeleteOptions = {}
Returns Promise<BlobDeleteResponse>

download

download(offset?: number, count: undefined | number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseModel>

Inherited from BlobClient.download
- Defined in Clients.ts:1123
Parameters
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: BlobDownloadOptions = {}
Returns Promise<BlobDownloadResponseModel>

downloadToBuffer

downloadToBuffer(offset: undefined | number, count: undefined | number, options: BlobDownloadToBufferOptions): Promise<Buffer>
downloadToBuffer(buffer: Buffer, offset: undefined | number, count: undefined | number, options: BlobDownloadToBufferOptions): Promise<Buffer>

Inherited from BlobClient.downloadToBuffer
- Defined in Clients.ts:1720
Parameters
- Optional offset: undefined | number
- Optional count: undefined | number
- Optional options: BlobDownloadToBufferOptions
Returns Promise<Buffer>
Inherited from BlobClient.downloadToBuffer
- Defined in Clients.ts:1743
Parameters
- buffer: Buffer
- Optional offset: undefined | number
- Optional count: undefined | number
- Optional options: BlobDownloadToBufferOptions
Returns Promise<Buffer>

downloadToFile

downloadToFile(filePath: string, offset?: number, count: undefined | number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseModel>

Inherited from BlobClient.downloadToFile
- Defined in Clients.ts:1887
Parameters
- filePath: string
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: BlobDownloadOptions = {}
Returns Promise<BlobDownloadResponseModel>

The response data for blob download operation, but with readableStreamBody set to undefined since its content is already read and written into a local file at the specified path.

exists

exists(options?: BlobExistsOptions): Promise<boolean>

Inherited from BlobClient.exists
- Defined in Clients.ts:1236
Parameters
- Default value options: BlobExistsOptions = {}
Returns Promise<boolean>

getAppendBlobClient

getAppendBlobClient(): AppendBlobClient

Inherited from BlobClient.getAppendBlobClient
- Defined in Clients.ts:1039
Returns AppendBlobClient

getBlobLeaseClient

getBlobLeaseClient(proposeLeaseId: undefined | string): BlobLeaseClient

Inherited from BlobClient.getBlobLeaseClient
- Defined in Clients.ts:1455
Parameters
- Optional proposeLeaseId: undefined | string
Returns BlobLeaseClient

A new BlobLeaseClient object for managing leases on the blob.

getBlockBlobClient

getBlockBlobClient(): BlockBlobClient

Inherited from BlobClient.getBlockBlobClient
- Defined in Clients.ts:1049
Returns BlockBlobClient

getPageBlobClient

getPageBlobClient(): PageBlobClient

Inherited from BlobClient.getPageBlobClient
- Defined in Clients.ts:1059
Returns PageBlobClient

getPageRanges

getPageRanges(offset?: number, count: undefined | number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

- Defined in Clients.ts:4476
Parameters
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: PageBlobGetPageRangesOptions = {}
Returns Promise<PageBlobGetPageRangesResponse>

Response data for the Page Blob Get Ranges operation.

getPageRangesDiff

getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

- Defined in Clients.ts:4518
Parameters
- offset: number
- count: number
- prevSnapshot: string
- Default value options: PageBlobGetPageRangesDiffOptions = {}
Returns Promise<PageBlobGetPageRangesDiffResponse>

Response data for the Page Blob Get Page Range Diff operation.

getProperties

getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Inherited from BlobClient.getProperties
- Defined in Clients.ts:1281
Parameters
- Default value options: BlobGetPropertiesOptions = {}
Returns Promise<BlobGetPropertiesResponse>

resize

resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

- Defined in Clients.ts:4560
Parameters
- size: number
- Default value options: PageBlobResizeOptions = {}
Returns Promise<PageBlobResizeResponse>

Response data for the Page Blob Resize operation.

setAccessTier

setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Inherited from BlobClient.setAccessTier
- Defined in Clients.ts:1679
Parameters
- tier: BlockBlobTier | PremiumPageBlobTier | string
- Default value options: BlobSetTierOptions = {}
Returns Promise<BlobSetTierResponse>

setHTTPHeaders

setHTTPHeaders(blobHTTPHeaders: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Inherited from BlobClient.setHTTPHeaders
- Defined in Clients.ts:1381
Parameters
- Optional blobHTTPHeaders: BlobHTTPHeaders
- Default value options: BlobSetHTTPHeadersOptions = {}
Returns Promise<BlobSetHTTPHeadersResponse>

setMetadata

setMetadata(metadata: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Inherited from BlobClient.setMetadata
- Defined in Clients.ts:1421
Parameters
- Optional metadata: Metadata
- Default value options: BlobSetMetadataOptions = {}
Returns Promise<BlobSetMetadataResponse>

startCopyIncremental

startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

- Defined in Clients.ts:4637
Parameters
- copySource: string
- Default value options: PageBlobStartCopyIncrementalOptions = {}
Returns Promise<PageBlobCopyIncrementalResponse>

Response data for the Page Blob Copy Incremental operation.

syncCopyFromURL

syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Inherited from BlobClient.syncCopyFromURL
- Defined in Clients.ts:1633
Parameters
- copySource: string
- Default value options: BlobSyncCopyFromURLOptions = {}
Returns Promise<BlobCopyFromURLResponse>

undelete

undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Inherited from BlobClient.undelete
- Defined in Clients.ts:1349
Parameters
- Default value options: BlobUndeleteOptions = {}
Returns Promise<BlobUndeleteResponse>

updateSequenceNumber

updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber: undefined | number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

- Defined in Clients.ts:4594
Parameters
- sequenceNumberAction: SequenceNumberActionType
- Optional sequenceNumber: undefined | number
- Default value options: PageBlobUpdateSequenceNumberOptions = {}
Returns Promise<PageBlobUpdateSequenceNumberResponse>

Response data for the Page Blob Update Sequence Number operation.

uploadPages

uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

- Defined in Clients.ts:4334
Parameters
- body: HttpRequestBody
- offset: number
- count: number
- Default value options: PageBlobUploadPagesOptions = {}
Returns Promise<PageBlobUploadPagesResponse>

Response data for the Page Blob Upload Pages operation.

uploadPagesFromURL

uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

- Defined in Clients.ts:4380
Parameters
- sourceURL: string
- sourceOffset: number
- destOffset: number
- count: number
- Default value options: PageBlobUploadPagesFromURLOptions = {}
Returns Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot

withSnapshot(snapshot: string): PageBlobClient

Overrides BlobClient.withSnapshot
- Defined in Clients.ts:4272
Parameters
- snapshot: string
Returns PageBlobClient

A new PageBlobClient object identical to the source but with the specified snapshot timestamp.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

connectionString: string

containerName: string

blobName: string

Optional options: StoragePipelineOptions

Returns PageBlobClient

Parameters

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns PageBlobClient

Parameters

url: string

pipeline: Pipeline

Returns PageBlobClient

Properties

accountName

credential

Protected isHttps

Protected storageClientContext

url

Accessors

containerName

name

Methods

abortCopyFromURL

Parameters

copyId: string

Default value options: BlobAbortCopyFromURLOptions = {}

Returns Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL

Parameters

copySource: string

Default value options: BlobBeginCopyFromURLOptions = {}

Returns Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages

Parameters

Default value offset: number = 0

Optional count: undefined | number

Default value options: PageBlobClearPagesOptions = {}

Returns Promise<PageBlobClearPagesResponse>

create

Parameters

size: number

Default value options: PageBlobCreateOptions = {}

Returns Promise<PageBlobCreateResponse>

createSnapshot

Parameters

Default value options: BlobCreateSnapshotOptions = {}

Returns Promise<BlobCreateSnapshotResponse>

delete

Parameters

Default value options: BlobDeleteOptions = {}

Returns Promise<BlobDeleteResponse>

download

Parameters

Default value offset: number = 0

Optional count: undefined | number

Default value options: BlobDownloadOptions = {}

Returns Promise<BlobDownloadResponseModel>

downloadToBuffer

Parameters

Optional offset: undefined | number

Optional count: undefined | number

Optional options: BlobDownloadToBufferOptions

Returns Promise<Buffer>

Parameters

buffer: Buffer

Optional offset: undefined | number

Optional count: undefined | number

Optional options: BlobDownloadToBufferOptions

Returns Promise<Buffer>