BlockBlobClient | @azure/storage-blob

Hierarchy

BlobClient
- BlockBlobClient

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

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

Overrides BlobClient.constructor
- Defined in Clients.ts:2921
Parameters
- connectionString: string
- containerName: string
- blobName: string
- Optional options: StoragePipelineOptions
Returns BlockBlobClient
Overrides BlobClient.constructor
- Defined in Clients.ts:2943
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns BlockBlobClient
Overrides BlobClient.constructor
- Defined in Clients.ts:2966
Parameters
- url: string
- pipeline: Pipeline
Returns BlockBlobClient

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>>

commitBlockList

commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

- Defined in Clients.ts:3258
Parameters
- blocks: string[]
- Default value options: BlockBlobCommitBlockListOptions = {}
Returns Promise<BlockBlobCommitBlockListResponse>

Response data for the Block Blob Commit Block List 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

getBlockList

getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

- Defined in Clients.ts:3304
Parameters
- listType: BlockListType
- Default value options: BlockBlobGetBlockListOptions = {}
Returns Promise<BlockBlobGetBlockListResponse>

Response data for the Block Blob Get Block List operation.

getPageBlobClient

getPageBlobClient(): PageBlobClient

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

getProperties

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

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

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>

stageBlock

stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

- Defined in Clients.ts:3161
Parameters
- blockId: string
- body: HttpRequestBody
- contentLength: number
- Default value options: BlockBlobStageBlockOptions = {}
Returns Promise<BlockBlobStageBlockResponse>

Response data for the Block Blob Stage Block operation.

stageBlockFromURL

stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count: undefined | number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

- Defined in Clients.ts:3212
Parameters
- blockId: string
- sourceURL: string
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: BlockBlobStageBlockFromURLOptions = {}
Returns Promise<BlockBlobStageBlockFromURLResponse>

Response data for the Block Blob Stage Block From URL 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>

upload

upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

- Defined in Clients.ts:3118
Parameters
- body: HttpRequestBody
- contentLength: number
- Default value options: BlockBlobUploadOptions = {}
Returns Promise<BlockBlobUploadResponse>

Response data for the Block Blob Upload operation.

uploadBrowserData

uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

- Defined in Clients.ts:3356
Parameters
- browserData: Blob | ArrayBuffer | ArrayBufferView
- Default value options: BlockBlobParallelUploadOptions = {}
Returns Promise<BlobUploadCommonResponse>

Response data for the Blob Upload operation.

uploadFile

uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

- Defined in Clients.ts:3525
Parameters
- filePath: string
- Default value options: BlockBlobParallelUploadOptions = {}
Returns Promise<BlobUploadCommonResponse>

Response data for the Blob Upload operation.

uploadStream

uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

- Defined in Clients.ts:3570
Parameters
- stream: Readable
- Default value bufferSize: number = DEFAULT_BLOCK_BUFFER_SIZE_BYTES
- Default value maxConcurrency: number = 5
- Default value options: BlockBlobUploadStreamOptions = {}
Returns Promise<BlobUploadCommonResponse>

Response data for the Blob Upload operation.

withSnapshot

withSnapshot(snapshot: string): BlockBlobClient

Overrides BlobClient.withSnapshot
- Defined in Clients.ts:3079
Parameters
- snapshot: string
Returns BlockBlobClient

A new BlockBlobClient 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 BlockBlobClient

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns BlockBlobClient

Parameters

url: string

pipeline: Pipeline

Returns BlockBlobClient

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>>

commitBlockList

Parameters

blocks: string[]

Default value options: BlockBlobCommitBlockListOptions = {}

Returns Promise<BlockBlobCommitBlockListResponse>

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>

downloadToFile

Parameters

filePath: string

Default value offset: number = 0

Optional count: undefined | number

Default value options: BlobDownloadOptions = {}