Package version:
Creates an instance of BlobServiceClient.
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: anySuch 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: StoragePipelineOptionsOptional. Options to configure the HTTP pipeline.
Example using DefaultAzureCredential from @azure/identity:
import { DefaultAzureCredential } from "@azure/identity";
import { BlobServiceClient } from "@azure/storage-blob";
// Enter your storage account name
const account = "<account>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential,
);
Example using an account name/key:
import { StorageSharedKeyCredential, BlobServiceClient } from "@azure/storage-blob";
const account = "<account>";
const accountKey = "<accountkey>";
// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential,
);
Creates an instance of BlobServiceClient.
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".
Call newPipeline() to create a default pipeline, or provide a customized pipeline.
ReadonlyaccountReadonlycredentialSuch 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 ReadonlyisProtected ReadonlystorageStorageClient is a reference to protocol layer operations entry, which is generated by AutoRest generator.
ReadonlyurlEncoded URL string value.
Create a Blob container.
Name of the container to create.
Options to configure Container Create operation.
Container creation response and the corresponding container client.
Deletes a Blob container.
Name of the container to delete.
Options to configure Container Delete operation.
Container deletion response.
Returns an async iterable iterator to find all blobs with specified tag under the specified account.
.byPage() returns an async iterable iterator to list the blobs in pages.
The where parameter enables the caller to query blobs whose tags match a given expression. The given expression must evaluate to true for a blob to be returned in the results. The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter; however, only a subset of the OData filter syntax is supported in the Blob service.
Options to find blobs by tags.
https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
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(),
);
// Use for await to iterate the blobs
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${blob.name}`);
}
// Use iter.next() to iterate the blobs
i = 1;
const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
let { value, done } = await iter.next();
while (!done) {
console.log(`Blob ${i++}: ${value.name}`);
({ value, done } = await iter.next());
}
// Use byPage() to iterate the blobs
i = 1;
for await (const page of blobServiceClient
.findBlobsByTags("tagkey='tagvalue'")
.byPage({ maxPageSize: 20 })) {
for (const blob of page.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
// Use paging with a marker
i = 1;
let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 blob names
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
.findBlobsByTags("tagkey='tagvalue'")
.byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints blob names
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
Only available for BlobServiceClient constructed with a shared key credential.
Generates a Blob account 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.
OptionalexpiresOn: anyOptional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
Specifies the list of permissions to be associated with the SAS.
Specifies the resource types associated with the shared access signature.
Optional parameters.
An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
Only available for BlobServiceClient constructed with a shared key credential.
Generates string to sign for a Blob account 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.
OptionalexpiresOn: anyOptional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
Specifies the list of permissions to be associated with the SAS.
Specifies the resource types associated with the shared access signature.
Optional parameters.
An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
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.
Options to the Service Get Account Info operation.
Response data for the Service Get Account Info operation.
Creates a BlobBatchClient object to conduct batch operations.
A new BlobBatchClient object for this service.
Creates a ContainerClient object
A container name
A new ContainerClient object for the given container name.
Example usage:
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 containerClient = blobServiceClient.getContainerClient("<container name>");
Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Options to the Service Get Properties operation.
Response data for the Service Get Properties operation.
Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
Options to the Service Get Statistics operation.
Response data for the Service Get Statistics operation.
ONLY AVAILABLE WHEN USING BEARER TOKEN AUTHENTICATION (TokenCredential).
Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.
The start time for the user delegation SAS. Must be within 7 days of the current time
The end time for the user delegation SAS. Must be within 7 days of the current time
Returns an async iterable iterator to list all the containers under the specified account.
.byPage() returns an async iterable iterator to list the containers in pages.
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(),
);
// Use for await to iterate the containers
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
// Use iter.next() to iterate the containers
i = 1;
const iter = blobServiceClient.listContainers();
let { value, done } = await iter.next();
while (!done) {
console.log(`Container ${i++}: ${value.name}`);
({ value, done } = await iter.next());
}
// Use byPage() to iterate the containers
i = 1;
for await (const page of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
for (const container of page.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
// Use paging with a marker
i = 1;
let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 container names
if (response.containerItems) {
for (const container of response.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
.listContainers()
.byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 container names
if (response.containerItems) {
for (const container of response.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
Options to list containers.
An asyncIterableIterator that supports paging.
Sets properties for a storage account’s Blob service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
Options to the Service Set Properties operation.
Response data for the Service Set Properties operation.
Restore a previously deleted Blob container. This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.
Name of the previously deleted container.
Version of the previously deleted container, used to uniquely identify the deleted container.
Options to configure Container Restore operation.
Container deletion response.
StaticfromCreates an instance of BlobServiceClient from connection 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
Optionaloptions: StoragePipelineOptionsOptional. Options to configure the HTTP pipeline.
A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you to manipulate blob containers.