Package version:

Class BlobClient

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

Hierarchy (view full)

StorageClient
- BlobClient

Constructors

constructor

new BlobClient(connectionString, containerName, blobName, options?): BlobClient
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.
- Optionaloptions: StoragePipelineOptions
  Optional. Options to configure the HTTP pipeline.
Returns BlobClient
Overrides StorageClient.constructor
- Defined in Clients.ts:966
new BlobClient(url, credential?, options?): BlobClient
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".
- Optionalcredential: any
  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.
- Optionaloptions: StoragePipelineOptions
  Optional. Options to configure the HTTP pipeline.
Returns BlobClient
Overrides StorageClient.constructor
- Defined in Clients.ts:986
new BlobClient(url, pipeline): BlobClient
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 URL string pointing to Azure Storage blob, such as "https://myaccount.blob.core.windows.net/mycontainer/blob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". 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. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline: PipelineLike
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Returns BlobClient
Overrides StorageClient.constructor
- Defined in Clients.ts:1010

Properties

`Readonly`accountName

accountName: string

`Readonly`credential

credential: any

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` `Readonly`isHttps

isHttps: boolean

`Protected` `Readonly`storageClientContext

storageClientContext: StorageClient

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

`Readonly`url

url: string

Encoded URL string value.

Accessors

containerName

get containerName(): string
The name of the storage container the blob is associated with.

Returns string
- Defined in Clients.ts:948

name

get name(): string
The name of the blob.

Returns string
- Defined in Clients.ts:941

Methods

abortCopyFromURL

abortCopyFromURL(copyId, options?): Promise<BlobAbortCopyFromURLResponse>
Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero length and full metadata. Version 2012-02-12 and newer.
Parameters
- copyId: string
  Id of the Copy From URL operation.
- options: BlobAbortCopyFromURLOptions = {}
  Optional options to the Blob Abort Copy From URL operation.
Returns Promise<BlobAbortCopyFromURLResponse>
See
https://learn.microsoft.com/rest/api/storageservices/abort-copy-blob
- Defined in Clients.ts:1788

beginCopyFromURL

beginCopyFromURL(copySource, options?): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

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.

Parameters

copySource: string
url to the source Azure Blob/File.
options: BlobBeginCopyFromURLOptions = {}
Optional options to the Blob Start Copy From URL operation.

Returns Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

See

https://learn.microsoft.com/rest/api/storageservices/copy-blob

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

// Example using copy cancellation:
const cancelCopyPoller = await blobClient.beginCopyFromURL("url");
// cancel operation after starting it.
try {
  await cancelCopyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  cancelCopyPoller.getResult();
} catch (err: any) {
  if (err.name === "PollerCancelledError") {
    console.log("The copy was cancelled.");
  }
}

createSnapshot

createSnapshot(options?): Promise<BlobCreateSnapshotResponse>
Creates a read-only snapshot of a blob.
Parameters
- options: BlobCreateSnapshotOptions = {}
  Optional options to the Blob Create Snapshot operation.
Returns Promise<BlobCreateSnapshotResponse>
See
https://learn.microsoft.com/rest/api/storageservices/snapshot-blob
- Defined in Clients.ts:1654

delete

delete(options?): Promise<BlobDeleteResponse>
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.
Parameters
- options: BlobDeleteOptions = {}
  Optional options to Blob Delete operation.
Returns Promise<BlobDeleteResponse>
See
https://learn.microsoft.com/rest/api/storageservices/delete-blob
- Defined in Clients.ts:1440

deleteIfExists

deleteIfExists(options?): Promise<BlobDeleteIfExistsResponse>
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.
Parameters
- options: BlobDeleteOptions = {}
  Optional options to Blob Delete operation.
Returns Promise<BlobDeleteIfExistsResponse>
See
https://learn.microsoft.com/rest/api/storageservices/delete-blob
- Defined in Clients.ts:1467

deleteImmutabilityPolicy

deleteImmutabilityPolicy(options?): Promise<BlobDeleteImmutabilityPolicyResponse>
Delete the immutablility policy on the blob.
Parameters
- options: BlobDeleteImmutabilityPolicyOptions = {}
  Optional options to delete immutability policy on the blob.
Returns Promise<BlobDeleteImmutabilityPolicyResponse>
- Defined in Clients.ts:2312

download

download(offset?, count?, options?): 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

Parameters

offset: number = 0
From which position of the blob to download, greater than or equal to 0
Optionalcount: number
How much data to be downloaded, greater than 0. Will download to the end when undefined

options: BlobDownloadOptions = {}

Optional options to Blob Download operation.

Example usage (Node.js):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
const downloadBlockBlobResponse = await blobClient.download();
if (downloadBlockBlobResponse.readableStreamBody) {
  const downloaded = await streamToString(downloadBlockBlobResponse.readableStreamBody);
  console.log(`Downloaded blob content: ${downloaded}`);
}

async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
  const result = await new Promise<Buffer<ArrayBuffer>>((resolve, reject) => {
    const chunks: Buffer[] = [];
    stream.on("data", (data) => {
      chunks.push(Buffer.isBuffer(data) ? data : Buffer.from(data));
    });
    stream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    stream.on("error", reject);
  });
  return result.toString();
}

Example usage (browser):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
const downloadBlockBlobResponse = await blobClient.download();
const blobBody = await downloadBlockBlobResponse.blobBody;
if (blobBody) {
  const downloaded = await blobBody.text();
  console.log(`Downloaded blob content: ${downloaded}`);
}

Returns Promise<BlobDownloadResponseParsed>

See

https://learn.microsoft.com/rest/api/storageservices/get-blob

downloadToBuffer

downloadToBuffer(offset?, count?, options?): Promise<Buffer>
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
- Optionaloffset: number
  From which position of the block blob to download(in bytes)
- Optionalcount: number
  How much data(in bytes) to be downloaded. Will download to the end when passing undefined
- Optionaloptions: BlobDownloadToBufferOptions
  BlobDownloadToBufferOptions
Returns Promise<Buffer>
- Defined in Clients.ts:1900
downloadToBuffer(buffer, offset?, count?, options?): Promise<Buffer>
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
- Optionaloffset: number
  From which position of the block blob to download(in bytes)
- Optionalcount: number
  How much data(in bytes) to be downloaded. Will download to the end when passing undefined
- Optionaloptions: BlobDownloadToBufferOptions
  BlobDownloadToBufferOptions
Returns Promise<Buffer>
- Defined in Clients.ts:1921

downloadToFile

downloadToFile(filePath, offset?, count?, options?): Promise<BlobDownloadResponseParsed>
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
- offset: number = 0
  From which position of the block blob to download.
- Optionalcount: number
  How much data to be downloaded. Will download to the end when passing undefined.
- 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.
- Defined in Clients.ts:2053

exists

exists(options?): Promise<boolean>
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
- options: BlobExistsOptions = {}
  options to Exists operation.
Returns Promise<boolean>
- Defined in Clients.ts:1363

generateSasStringToSign

generateSasStringToSign(options): string
Only available for BlobClient constructed with a shared key credential.

Generates string to sign for 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.
Parameters
- options: BlobGenerateSasUrlOptions
  Optional parameters.
Returns string
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

See
https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
- Defined in Clients.ts:2226

generateSasUrl

generateSasUrl(options): Promise<string>
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.
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.

See
https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
- Defined in Clients.ts:2191

generateUserDelegationSasStringToSign

generateUserDelegationSasStringToSign(options, userDelegationKey): string
Only available for BlobClient constructed with a shared key credential.

Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
Parameters
- options: BlobGenerateSasUrlOptions
  Optional parameters.
- userDelegationKey: UserDelegationKey
  Return value of blobServiceClient.getUserDelegationKey()
Returns string
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

See
https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
- Defined in Clients.ts:2290

generateUserDelegationSasUrl

generateUserDelegationSasUrl(options, userDelegationKey): Promise<string>
Generates a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
Parameters
- options: BlobGenerateSasUrlOptions
  Optional parameters.
- userDelegationKey: UserDelegationKey
  Return value of blobServiceClient.getUserDelegationKey()
Returns Promise<string>
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

See
https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
- Defined in Clients.ts:2256

getAccountInfo

getAccountInfo(options?): Promise<BlobGetAccountInfoResponse>
The Get Account Information operation returns the sku name and account kind for the specified account. The Get Account Information operation is available on service versions beginning with version 2018-03-28.
Parameters
- options: BlobGetAccountInfoOptions = {}
  Options to the Service Get Account Info operation.
Returns Promise<BlobGetAccountInfoResponse>
Response data for the Service Get Account Info operation.

See
https://learn.microsoft.com/rest/api/storageservices/get-account-information
- Defined in Clients.ts:2383

getAppendBlobClient

getAppendBlobClient(): AppendBlobClient
Creates a AppendBlobClient object.

Returns AppendBlobClient
- Defined in Clients.ts:1148

getBlobLeaseClient

getBlobLeaseClient(proposeLeaseId?): BlobLeaseClient
Get a BlobLeaseClient that manages leases on the blob.
Parameters
- OptionalproposeLeaseId: string
  Initial proposed lease Id.
Returns BlobLeaseClient
A new BlobLeaseClient object for managing leases on the blob.
- Defined in Clients.ts:1644

getBlockBlobClient

getBlockBlobClient(): BlockBlobClient
Creates a BlockBlobClient object.

Returns BlockBlobClient
- Defined in Clients.ts:1156

getPageBlobClient

getPageBlobClient(): PageBlobClient
Creates a PageBlobClient object.

Returns PageBlobClient
- Defined in Clients.ts:1164

getProperties

getProperties(options?): Promise<BlobGetPropertiesResponse>
Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.
Parameters
- options: BlobGetPropertiesOptions = {}
  Optional options to Get Properties operation.
Returns Promise<BlobGetPropertiesResponse>
See
https://learn.microsoft.com/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.
- Defined in Clients.ts:1403

getTags

getTags(options?): Promise<BlobGetTagsResponse>
Gets the tags associated with the underlying blob.
Parameters
- options: BlobGetTagsOptions = {}
Returns Promise<BlobGetTagsResponse>
- Defined in Clients.ts:1615

setAccessTier

setAccessTier(tier, options?): Promise<BlobSetTierResponse>
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.
Parameters
- tier: string
  The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
- options: BlobSetTierOptions = {}
  Optional options to the Blob Set Tier operation.
Returns Promise<BlobSetTierResponse>
See
https://learn.microsoft.com/rest/api/storageservices/set-blob-tier
- Defined in Clients.ts:1864

setHTTPHeaders

setHTTPHeaders(blobHTTPHeaders?, options?): Promise<BlobSetHTTPHeadersResponse>
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.
Parameters
- OptionalblobHTTPHeaders: 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.
- options: BlobSetHTTPHeadersOptions = {}
  Optional options to Blob Set HTTP Headers operation.
Returns Promise<BlobSetHTTPHeadersResponse>
See
https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
- Defined in Clients.ts:1525

setImmutabilityPolicy

setImmutabilityPolicy(immutabilityPolicy, options?): Promise<BlobSetImmutabilityPolicyResponse>
Set immutability policy on the blob.
Parameters
- immutabilityPolicy: BlobImmutabilityPolicy
- options: BlobSetImmutabilityPolicyOptions = {}
  Optional options to set immutability policy on the blob.
Returns Promise<BlobSetImmutabilityPolicyResponse>
- Defined in Clients.ts:2336

setLegalHold

setLegalHold(legalHoldEnabled, options?): Promise<BlobSetLegalHoldResponse>
Set legal hold on the blob.
Parameters
- legalHoldEnabled: boolean
- options: BlobSetLegalHoldOptions = {}
  Optional options to set legal hold on the blob.
Returns Promise<BlobSetLegalHoldResponse>
- Defined in Clients.ts:2360

setMetadata

setMetadata(metadata?, options?): Promise<BlobSetMetadataResponse>
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.
Parameters
- Optionalmetadata: Metadata
  Replace existing metadata with this value. If no value provided the existing metadata will be removed.
- options: BlobSetMetadataOptions = {}
  Optional options to Set Metadata operation.
Returns Promise<BlobSetMetadataResponse>
See
https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
- Defined in Clients.ts:1559

setTags

setTags(tags, options?): Promise<BlobSetTagsResponse>
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: Record<string, string>
- options: BlobSetTagsOptions = {}
Returns Promise<BlobSetTagsResponse>
- Defined in Clients.ts:1592

syncCopyFromURL

syncCopyFromURL(copySource, options?): Promise<BlobCopyFromURLResponse>
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.
Parameters
- copySource: string
  The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
- options: BlobSyncCopyFromURLOptions = {}
Returns Promise<BlobCopyFromURLResponse>
See
https://learn.microsoft.com/rest/api/storageservices/copy-blob-from-url
- Defined in Clients.ts:1815

undelete

undelete(options?): Promise<BlobUndeleteResponse>
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.
Parameters
- options: BlobUndeleteOptions = {}
  Optional options to Blob Undelete operation.
Returns Promise<BlobUndeleteResponse>
See
https://learn.microsoft.com/rest/api/storageservices/undelete-blob
- Defined in Clients.ts:1499

withSnapshot

withSnapshot(snapshot): BlobClient
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
- Defined in Clients.ts:1115

withVersion

withVersion(versionId): BlobClient
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.
- Defined in Clients.ts:1133

Class BlobClient

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BlobClient

Parameters

Returns BlobClient

Parameters

Returns BlobClient

Properties

ReadonlyaccountName

Readonlycredential

Protected ReadonlyisHttps

Protected ReadonlystorageClientContext

Readonlyurl

Accessors

containerName

Returns string

name

Returns string

Methods

abortCopyFromURL

Parameters

Returns Promise<BlobAbortCopyFromURLResponse>

See

beginCopyFromURL

Parameters

Returns Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

See

createSnapshot

Parameters

Returns Promise<BlobCreateSnapshotResponse>

See

delete

Parameters

Returns Promise<BlobDeleteResponse>

See

deleteIfExists

Parameters

Returns Promise<BlobDeleteIfExistsResponse>

See

deleteImmutabilityPolicy

Parameters

Returns Promise<BlobDeleteImmutabilityPolicyResponse>

download

Parameters

Returns Promise<BlobDownloadResponseParsed>

See

downloadToBuffer

Parameters

Returns Promise<Buffer>

Parameters

Returns Promise<Buffer>

downloadToFile

Parameters

Returns Promise<BlobDownloadResponseParsed>

exists

Parameters

Returns Promise<boolean>

generateSasStringToSign

Parameters

Returns string

See

generateSasUrl

Parameters

Returns Promise<string>

See

generateUserDelegationSasStringToSign

Parameters

Returns string

See

generateUserDelegationSasUrl

Parameters

Returns Promise<string>

`Readonly`accountName

`Readonly`credential

`Protected` `Readonly`isHttps

`Protected` `Readonly`storageClientContext

`Readonly`url