Class BlobClient

Package version

Hierarchy

StorageClient
- BlobClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides StorageClient.constructor
- Defined in Clients.ts:855
Parameters
- connectionString: string
- containerName: string
- blobName: string
- Optional options: StoragePipelineOptions
Returns BlobClient
Overrides StorageClient.constructor
- Defined in Clients.ts:877
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns BlobClient
Overrides StorageClient.constructor
- Defined in Clients.ts:895
Parameters
- url: string
- pipeline: Pipeline
Returns BlobClient

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>

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

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

createSnapshot

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

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

delete

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

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

download

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

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

- Defined in Clients.ts:1720
Parameters
- Optional offset: undefined | number
- Optional count: undefined | number
- Optional options: BlobDownloadToBufferOptions
Returns Promise<Buffer>
- 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>

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

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

getAppendBlobClient

getAppendBlobClient(): AppendBlobClient

- Defined in Clients.ts:1039
Returns AppendBlobClient

getBlobLeaseClient

getBlobLeaseClient(proposeLeaseId: undefined | string): BlobLeaseClient

- 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

- Defined in Clients.ts:1049
Returns BlockBlobClient

getPageBlobClient

getPageBlobClient(): PageBlobClient

- Defined in Clients.ts:1059
Returns PageBlobClient

getProperties

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

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

setAccessTier

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

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

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

setMetadata

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

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

syncCopyFromURL

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

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

undelete

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

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

withSnapshot

withSnapshot(snapshot: string): BlobClient

- Defined in Clients.ts:1022
Parameters
- snapshot: string
Returns BlobClient

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

Generated using TypeDoc