BlobClient | @azure/storage-blob

A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob, append blob, or page blob.

Hierarchy

StorageClient
- BlobClient

Index

Constructors

constructor

Properties

Accessors

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: PipelineLike): BlobClient

Overrides StorageClient.constructor
- Defined in storage-blob/src/Clients.ts:869
Creates an instance of BlobClient from connection string.

Parameters
- connectionString: string
  
  Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- containerName: string
  
  Container name.
- blobName: string
  
  Blob name.
- Optional options: StoragePipelineOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns BlobClient
Overrides StorageClient.constructor
- Defined in storage-blob/src/Clients.ts:892
Creates an instance of BlobClient. This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.

Parameters
- url: string
  
  A Client string pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  
  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- Optional options: StoragePipelineOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns BlobClient
Overrides StorageClient.constructor
- Defined in storage-blob/src/Clients.ts:911
Creates an instance of BlobClient. This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.

Parameters
- url: string
  
  A Client string pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
- pipeline: PipelineLike
  
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Returns BlobClient

Properties

accountName

accountName: string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.

Protected isHttps

isHttps: boolean

Protected pipeline

pipeline: PipelineLike

Request policy pipeline.

internal

Protected storageClientContext

storageClientContext: StorageClientContext

StorageClient is a reference to protocol layer operations entry, which is generated by AutoRest generator.

url

url: string

Encoded URL string value.

Accessors

containerName

get containerName(): string

- Defined in storage-blob/src/Clients.ts:867
The name of the storage container the blob is associated with.

Returns string

name

get name(): string

- Defined in storage-blob/src/Clients.ts:860
The name of the blob.

Returns string

Methods

abortCopyFromURL

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

- Defined in storage-blob/src/Clients.ts:1749
Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero length and full metadata. Version 2012-02-12 and newer.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

Parameters
- copyId: string
  
  Id of the Copy From URL operation.
- Default value options: BlobAbortCopyFromURLOptions = {}
  
  Optional options to the Blob Abort Copy From URL operation.
Returns Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL

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

- Defined in storage-blob/src/Clients.ts:1714
Asynchronously copies a blob to a destination within the storage account. This method returns a long running operation poller that allows you to wait indefinitely until the copy is completed. You can also cancel a copy before it is completed by calling cancelOperation on the poller. Note that the onProgress callback will not be invoked if the operation completes in the first request, and attempting to cancel a completed copy will result in an error being thrown.

In version 2012-02-12 and later, the source for a Copy Blob operation can be a committed blob in any Azure storage account. Beginning with version 2015-02-21, the source for a Copy Blob operation can be an Azure file in any Azure storage account. Only storage accounts created on or after June 7th, 2012 allow the Copy Blob operation to copy from another storage account.
see
https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Example using automatic polling:
```
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
```
Example using manual polling:
```
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();
```
Example using progress updates:
```
const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();
```
Example using a changing polling interval (default 15 seconds):
```
const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
```
Example using copy cancellation:
```
const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}
```
Parameters
- copySource: string
  
  url to the source Azure Blob/File.
- Default value options: BlobBeginCopyFromURLOptions = {}
  
  Optional options to the Blob Start Copy From URL operation.
Returns Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot

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

- Defined in storage-blob/src/Clients.ts:1612
Creates a read-only snapshot of a blob.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

Parameters
- Default value options: BlobCreateSnapshotOptions = {}
  
  Optional options to the Blob Create Snapshot operation.
Returns Promise<BlobCreateSnapshotResponse>

delete

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

- Defined in storage-blob/src/Clients.ts:1349
Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

Parameters
- Default value options: BlobDeleteOptions = {}
  
  Optional options to Blob Delete operation.
Returns Promise<BlobDeleteResponse>

deleteIfExists

deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

- Defined in storage-blob/src/Clients.ts:1383
Marks the specified blob or snapshot for deletion if it exists. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

Parameters
- Default value options: BlobDeleteOptions = {}
  
  Optional options to Blob Delete operation.
Returns Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy

deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

- Defined in storage-blob/src/Clients.ts:2223
Delete the immutablility policy on the blob.

Parameters
- Optional options: BlobDeleteImmutabilityPolicyOptions
  
  Optional options to delete immutability policy on the blob.
Returns Promise<BlobDeleteImmutabilityPolicyResponse>

download

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

Reads or downloads a blob from the system, including its metadata and properties. You can also call Get Blob to read a snapshot.

In Node.js, data returns in a Readable stream readableStreamBody
In browsers, data returns in a promise blobBody

see: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

Parameters

Default value offset: number = 0

From which position of the blob to download, greater than or equal to 0
Optional count: undefined | number

How much data to be downloaded, greater than 0. Will download to the end when undefined

Default value options: BlobDownloadOptions = {}

Optional options to Blob Download operation.

Example usage (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

Example usage (browser):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Returns Promise<BlobDownloadResponseParsed>

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 storage-blob/src/Clients.ts:1876
ONLY AVAILABLE IN NODE.JS RUNTIME.

Downloads an Azure Blob in parallel to a buffer. Offset and count are optional, downloads the entire blob if they are not provided.

Warning: Buffers can only support files up to about one gigabyte on 32-bit systems or about two gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs larger than this size, consider downloadToFile.

Parameters
- Optional offset: undefined | number
  
  From which position of the block blob to download(in bytes)
- Optional count: undefined | number
  
  How much data(in bytes) to be downloaded. Will download to the end when passing undefined
- Optional options: BlobDownloadToBufferOptions
  
  BlobDownloadToBufferOptions
Returns Promise<Buffer>
- Defined in storage-blob/src/Clients.ts:1897
ONLY AVAILABLE IN NODE.JS RUNTIME.

Downloads an Azure Blob in parallel to a buffer. Offset and count are optional, downloads the entire blob if they are not provided.

Warning: Buffers can only support files up to about one gigabyte on 32-bit systems or about two gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs larger than this size, consider downloadToFile.

Parameters
- buffer: Buffer
  
  Buffer to be fill, must have length larger than count
- Optional offset: undefined | number
  
  From which position of the block blob to download(in bytes)
- Optional count: undefined | number
  
  How much data(in bytes) to be downloaded. Will download to the end when passing undefined
- Optional options: BlobDownloadToBufferOptions
  
  BlobDownloadToBufferOptions
Returns Promise<Buffer>

downloadToFile

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

- Defined in storage-blob/src/Clients.ts:2041
ONLY AVAILABLE IN NODE.JS RUNTIME.

Downloads an Azure Blob to a local file. Fails if the the given file path already exits. Offset and count are optional, pass 0 and undefined respectively to download the entire blob.

Parameters
- filePath: string
  
  -
- Default value offset: number = 0
  
  From which position of the block blob to download.
- Optional count: undefined | number
  
  How much data to be downloaded. Will download to the end when passing undefined.
- Default value options: BlobDownloadOptions = {}
  
  Options to Blob download options.
Returns Promise<BlobDownloadResponseParsed>

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 storage-blob/src/Clients.ts:1264
Returns true if the Azure blob resource represented by this client exists; false otherwise.

NOTE: use this function with care since an existing blob might be deleted by other clients or applications. Vice versa new blobs might be added by other clients or applications after this function completes.

Parameters
- Default value options: BlobExistsOptions = {}
  
  options to Exists operation.
Returns Promise<boolean>

generateSasUrl

generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

- Defined in storage-blob/src/Clients.ts:2195
Only available for BlobClient constructed with a shared key credential.

Generates a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

Parameters
- options: BlobGenerateSasUrlOptions
  
  Optional parameters.
Returns Promise<string>

The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

getAppendBlobClient

getAppendBlobClient(): AppendBlobClient

- Defined in storage-blob/src/Clients.ts:1063
Creates a AppendBlobClient object.

Returns AppendBlobClient

getBlobLeaseClient

getBlobLeaseClient(proposeLeaseId?: undefined | string): BlobLeaseClient

- Defined in storage-blob/src/Clients.ts:1602
Get a BlobLeaseClient that manages leases on the blob.

Parameters
- Optional proposeLeaseId: undefined | string
  
  Initial proposed lease Id.
Returns BlobLeaseClient

A new BlobLeaseClient object for managing leases on the blob.

getBlockBlobClient

getBlockBlobClient(): BlockBlobClient

- Defined in storage-blob/src/Clients.ts:1071
Creates a BlockBlobClient object.

Returns BlockBlobClient

getPageBlobClient

getPageBlobClient(): PageBlobClient

- Defined in storage-blob/src/Clients.ts:1079
Creates a PageBlobClient object.

Returns PageBlobClient

getProperties

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

- Defined in storage-blob/src/Clients.ts:1305
Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

WARNING: The metadata object returned in the response will have its keys in lowercase, even if they originally contained uppercase characters. This differs from the metadata keys returned by the methods of ContainerClient that list blobs using the includeMetadata option, which will retain their original casing.

Parameters
- Default value options: BlobGetPropertiesOptions = {}
  
  Optional options to Get Properties operation.
Returns Promise<BlobGetPropertiesResponse>

getTags

getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

- Defined in storage-blob/src/Clients.ts:1567
Gets the tags associated with the underlying blob.

Parameters
- Default value options: BlobGetTagsOptions = {}
  
  -
Returns Promise<BlobGetTagsResponse>

setAccessTier

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

- Defined in storage-blob/src/Clients.ts:1833
Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

Parameters
- tier: BlockBlobTier | PremiumPageBlobTier | string
  
  The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
- Default value options: BlobSetTierOptions = {}
  
  Optional options to the Blob Set Tier operation.
Returns Promise<BlobSetTierResponse>

setHTTPHeaders

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

- Defined in storage-blob/src/Clients.ts:1457
Sets system properties on the blob.

If no value provided, or no value provided for the specified blob HTTP headers, these blob HTTP headers without a value will be cleared.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

Parameters
- Optional blobHTTPHeaders: BlobHTTPHeaders
  
  If no value provided, or no value provided for the specified blob HTTP headers, these blob HTTP headers without a value will be cleared. A common header to set is blobContentType enabling the browser to provide functionality based on file type.
- Default value options: BlobSetHTTPHeadersOptions = {}
  
  Optional options to Blob Set HTTP Headers operation.
Returns Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy

setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

- Defined in storage-blob/src/Clients.ts:2248
Set immutablility policy on the blob.

Parameters
- immutabilityPolicy: BlobImmutabilityPolicy
- Optional options: BlobSetImmutabilityPolicyOptions
  
  Optional options to set immutability policy on the blob.
Returns Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold

setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

- Defined in storage-blob/src/Clients.ts:2277
Set legal hold on the blob.

Parameters
- legalHoldEnabled: boolean
- Optional options: BlobSetLegalHoldOptions
  
  Optional options to set legal hold on the blob.
Returns Promise<BlobSetLegalHoldResponse>

setMetadata

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

- Defined in storage-blob/src/Clients.ts:1498
Sets user-defined metadata for the specified blob as one or more name-value pairs.

If no option provided, or no metadata defined in the parameter, the blob metadata will be removed.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

Parameters
- Optional metadata: Metadata
  
  Replace existing metadata with this value. If no value provided the existing metadata will be removed.
- Default value options: BlobSetMetadataOptions = {}
  
  Optional options to Set Metadata operation.
Returns Promise<BlobSetMetadataResponse>

setTags

setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

- Defined in storage-blob/src/Clients.ts:1538
Sets tags on the underlying blob. A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. Valid tag key and value characters include lower and upper case letters, digits (0-9), space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_').

Parameters
- tags: Tags
  
  -
- Default value options: BlobSetTagsOptions = {}
  
  -
Returns Promise<BlobSetTagsResponse>

syncCopyFromURL

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

- Defined in storage-blob/src/Clients.ts:1779
The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

Parameters
- copySource: string
  
  The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
- Default value options: BlobSyncCopyFromURLOptions = {}
  
  -
Returns Promise<BlobCopyFromURLResponse>

undelete

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

- Defined in storage-blob/src/Clients.ts:1424
Restores the contents and metadata of soft deleted blob and any associated soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29 or later.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

Parameters
- Default value options: BlobUndeleteOptions = {}
  
  Optional options to Blob Undelete operation.
Returns Promise<BlobUndeleteResponse>

withSnapshot

withSnapshot(snapshot: string): BlobClient

- Defined in storage-blob/src/Clients.ts:1030
Creates a new BlobClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a Client to the base blob.

Parameters
- snapshot: string
  
  The snapshot timestamp.
Returns BlobClient

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

withVersion

withVersion(versionId: string): BlobClient

- Defined in storage-blob/src/Clients.ts:1048
Creates a new BlobClient object pointing to a version of this blob. Provide "" will remove the versionId and return a Client to the base blob.

Parameters
- versionId: string
  
  The versionId.
Returns BlobClient

A new BlobClient object pointing to the version of this blob.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

connectionString: string

containerName: string

blobName: string

Optional options: StoragePipelineOptions

Returns BlobClient

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns BlobClient

Parameters

url: string

pipeline: PipelineLike

Returns BlobClient

Properties

accountName

credential

Protected isHttps

Protected pipeline

Protected storageClientContext

url

Accessors

containerName

Returns string

name

Returns string

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

createSnapshot

Parameters

Default value options: BlobCreateSnapshotOptions = {}

Returns Promise<BlobCreateSnapshotResponse>

delete

Parameters

Default value options: BlobDeleteOptions = {}

Returns Promise<BlobDeleteResponse>

deleteIfExists

Parameters

Default value options: BlobDeleteOptions = {}

Returns Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy

Parameters

Optional options: BlobDeleteImmutabilityPolicyOptions

Returns Promise<BlobDeleteImmutabilityPolicyResponse>

download

Parameters

Default value offset: number = 0

Optional count: undefined | number

Default value options: BlobDownloadOptions = {}

Returns Promise<BlobDownloadResponseParsed>

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>