Creates an instance of BlockBlobClient.
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
Container name.
Blob name.
Optional. Options to configure the HTTP pipeline.
Creates an instance of BlockBlobClient. This method accepts an encoded URL or non-encoded URL pointing to a block 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.
A URL string pointing to Azure Storage block blob, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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".
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 to configure the HTTP pipeline.
Creates an instance of BlockBlobClient. This method accepts an encoded URL or non-encoded URL pointing to a block 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.
A URL string pointing to Azure Storage block blob, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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".
Call newPipeline() to create a default pipeline, or provide a customized pipeline.
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.
Request policy pipeline.
StorageClient is a reference to protocol layer operations entry, which is generated by AutoRest generator.
Encoded URL string value.
The name of the storage container the blob is associated with.
The name of the blob.
Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero length and full metadata. Version 2012-02-12 and newer.
Id of the Copy From URL operation.
Optional options to the Blob Abort Copy From URL operation.
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.
url to the source Azure Blob/File.
Optional options to the Blob Start Copy From URL operation.
Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior stageBlock operation. You can call commitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted.
Array of 64-byte value that is base64-encoded
Options to the Block Blob Commit Block List operation.
Response data for the Block Blob Commit Block List operation.
Creates a read-only snapshot of a blob.
Optional options to the Blob Create Snapshot operation.
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.
Optional options to Blob Delete operation.
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.
Optional options to Blob Delete operation.
Delete the immutablility policy on the blob.
Optional options to delete immutability policy on the blob.
Reads or downloads a blob from the system, including its metadata and properties. You can also call Get Blob to read a snapshot.
From which position of the blob to download, greater than or equal to 0
How much data to be downloaded, greater than 0. Will download to the end when undefined
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);
});
}
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.
From which position of the block blob to download(in bytes)
How much data(in bytes) to be downloaded. Will download to the end when passing undefined
BlobDownloadToBufferOptions
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.
Buffer to be fill, must have length larger than count
From which position of the block blob to download(in bytes)
How much data(in bytes) to be downloaded. Will download to the end when passing undefined
BlobDownloadToBufferOptions
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.
-
From which position of the block blob to download.
How much data to be downloaded. Will download to the end when passing undefined.
Options to Blob download options.
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.
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.
options to Exists operation.
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.
Optional parameters.
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
Creates a AppendBlobClient object.
Get a BlobLeaseClient that manages leases on the blob.
Initial proposed lease Id.
A new BlobLeaseClient object for managing leases on the blob.
Creates a BlockBlobClient object.
Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter.
Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.
Options to the Block Blob Get Block List operation.
Response data for the Block Blob Get Block List operation.
Creates a PageBlobClient object.
Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.
Optional options to Get Properties operation.
Gets the tags associated with the underlying blob.
-
ONLY AVAILABLE IN NODE.JS RUNTIME.
Quick query for a JSON or CSV formatted blob.
Example usage (Node.js):
// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);
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);
});
}
-
-
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.
The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
Optional options to the Blob Set Tier operation.
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.
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.
Optional options to Blob Set HTTP Headers operation.
Set immutablility policy on the blob.
Optional options to set immutability policy on the blob.
Set legal hold on the blob.
Optional options to set legal hold on the blob.
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.
Replace existing metadata with this value. If no value provided the existing metadata will be removed.
Optional options to Set Metadata operation.
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 ('_').
-
-
Uploads the specified block to the block blob's "staging area" to be later committed by a call to commitBlockList.
A 64-byte value that is base64-encoded
Data to upload to the staging area.
Number of bytes to upload.
Options to the Block Blob Stage Block operation.
Response data for the Block Blob Stage Block operation.
The Stage Block From URL operation creates a new block to be committed as part of a blob where the contents are read from a URL. This API is available starting in version 2018-03-28.
A 64-byte value that is base64-encoded
Specifies the URL of the blob. The value
may be a URL of up to 2 KB in length that specifies a blob.
The value should be URL-encoded as it would appear
in a request URI. The source blob must either be public
or must be authenticated via a shared access signature.
If the source blob is public, no authentication is required
to perform the operation. Here are some examples of source object URLs:
- https://myaccount.blob.core.windows.net/mycontainer/myblob
- https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
From which position of the blob to download, greater than or equal to 0
How much data to be downloaded, greater than 0. Will download to the end when undefined
Options to the Block Blob Stage Block From URL operation.
Response data for the Block Blob Stage Block From URL operation.
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.
The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
-
Creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use stageBlockFromURL and commitBlockList.
Specifies the URL of the blob. The value
may be a URL of up to 2 KB in length that specifies a blob.
The value should be URL-encoded as it would appear
in a request URI. The source blob must either be public
or must be authenticated via a shared access signature.
If the source blob is public, no authentication is required
to perform the operation. Here are some examples of source object URLs:
- https://myaccount.blob.core.windows.net/mycontainer/myblob
- https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Optional parameters.
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.
Optional options to Blob Undelete operation.
Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use stageBlock and commitBlockList.
This is a non-parallel uploading method, please use uploadFile, uploadStream or uploadBrowserData for better performance with concurrency uploading.
Blob, string, ArrayBuffer, ArrayBufferView or a function which returns a new Readable stream whose offset is from data source beginning.
Length of body in bytes. Use Buffer.byteLength() to calculate body length for a string including non non-Base64/Hex-encoded characters.
Options to the Block Blob Upload operation.
Response data for the Block Blob Upload operation.
Example usage:
const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
ONLY AVAILABLE IN BROWSERS.
Uploads a browser Blob/File/ArrayBuffer/ArrayBufferView object to block blob.
When buffer length lesser than or equal to 256MB, this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.
A common BlockBlobParallelUploadOptions.blobHTTPHeaders option to set is
blobContentType
, enabling the browser to provide
functionality based on file type.
Blob, File, ArrayBuffer or ArrayBufferView
Options to upload browser data.
Response data for the Blob Upload operation.
Uploads a Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView object to a BlockBlob.
When data length is no more than the specifiled BlockBlobParallelUploadOptions.maxSingleShotSize (default is BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES), this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.
A common BlockBlobParallelUploadOptions.blobHTTPHeaders option to set is
blobContentType
, enabling the browser to provide
functionality based on file type.
Buffer(Node.js), Blob, ArrayBuffer or ArrayBufferView
-
ONLY AVAILABLE IN NODE.JS RUNTIME.
Uploads a local file in blocks to a block blob.
When file size lesser than or equal to 256MB, this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.
Full path of local file
Options to Upload to Block Blob operation.
Response data for the Blob Upload operation.
ONLY AVAILABLE IN NODE.JS RUNTIME.
Uploads a Node.js Readable stream into block blob.
PERFORMANCE IMPROVEMENT TIPS:
Node.js Readable stream
Size of every buffer allocated, also the block size in the uploaded block blob. Default value is 8MB
Max concurrency indicates the max number of buffers that can be allocated, positive correlation with max uploading concurrency. Default value is 5
Options to Upload Stream to Block Blob operation.
Response data for the Blob Upload operation.
Creates a new BlockBlobClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a URL to the base blob.
The snapshot timestamp.
A new BlockBlobClient object identical to the source but with the specified snapshot timestamp.
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.
The versionId.
A new BlobClient object pointing to the version of this blob.
Generated using TypeDoc
BlockBlobClient defines a set of operations applicable to block blobs.