Note

Access to this page requires authorization. You can trysigning in orchanging directories.

Access to this page requires authorization. You can trychanging directories.

Creates an instance of BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

Parameters

Creates an instance of BlobServiceClient.

new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parameters

import { DefaultAzureCredential } from "@azure/identity";import { BlobServiceClient } from "@azure/storage-blob";// Enter your storage account nameconst account = "<account>";const defaultAzureCredential = new DefaultAzureCredential();const blobServiceClient = new BlobServiceClient(  `https://${account}.blob.core.windows.net`,  defaultAzureCredential,);

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 browsersconst sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);const blobServiceClient = new BlobServiceClient(  `https://${account}.blob.core.windows.net`,  sharedKeyCredential,);

accountName: string

Property Value

Inherited From StorageClient.accountName

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Property Value

Inherited From StorageClient.credential

Encoded URL string value.

url: string

Property Value

Inherited From StorageClient.url

Create a Blob container.

Seehttps://learn.microsoft.com/rest/api/storageservices/create-container

function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

Parameters

Returns

Container creation response and the corresponding container client.

Deletes a Blob container.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Parameters

Returns

Container deletion response.

Returns an async iterable iterator to find all blobs with specified tagunder the specified account.

.byPage() returns an async iterable iterator to list the blobs in pages.

Seehttps://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 blobslet i = 1;for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {  console.log(`Blob ${i++}: ${blob.name}`);}// Use iter.next() to iterate the blobsi = 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 blobsi = 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 markeri = 1;let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });let response = (await iterator.next()).value;// Prints 2 blob namesif (response.blobs) {  for (const blob of response.blobs) {    console.log(`Blob ${i++}: ${blob.name}`);  }}// Gets next markerlet marker = response.continuationToken;// Passing next marker as continuationTokeniterator = blobServiceClient  .findBlobsByTags("tagkey='tagvalue'")  .byPage({ continuationToken: marker, maxPageSize: 10 });response = (await iterator.next()).value;// Prints blob namesif (response.blobs) {  for (const blob of response.blobs) {    console.log(`Blob ${i++}: ${blob.name}`);  }}

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse, PageSettings>

Parameters

Returns

Creates an instance of BlobServiceClient from connection string.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient

Parameters

Returns

Only available for BlobServiceClient constructed with a shared key credential.

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

Seehttps://learn.microsoft.com/rest/api/storageservices/create-account-sas

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parameters

Returns

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 onthe client properties and parameters passed in. The SAS is signed by the shared key credential of the client.

Seehttps://learn.microsoft.com/rest/api/storageservices/create-account-sas

function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parameters

Returns

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 kindfor the specified account.The Get Account Information operation is available on service versions beginningwith version 2018-03-28.

Seehttps://learn.microsoft.com/rest/api/storageservices/get-account-information

function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>

Parameters

Returns

Response data for the Service Get Account Info operation.

Creates a BlobBatchClient object to conduct batch operations.

Seehttps://learn.microsoft.com/rest/api/storageservices/blob-batch

function getBlobBatchClient(): BlobBatchClient

Returns

A new BlobBatchClient object for this service.

Creates aContainerClient object

function getContainerClient(containerName: string): ContainerClient

Parameters

Returns

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 propertiesfor Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Seehttps://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parameters

Returns

Response data for the Service Get Properties operation.

Retrieves statistics related to replication for the Blob service. It is onlyavailable on the secondary location endpoint when read-access geo-redundantreplication is enabled for the storage account.

Seehttps://learn.microsoft.com/rest/api/storageservices/get-blob-service-stats

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

Parameters

Returns

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 usingbearer token authentication.

Seehttps://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parameters

Returns

Returns an async iterable iterator to list all the containersunder 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 containerslet i = 1;for await (const container of blobServiceClient.listContainers()) {  console.log(`Container ${i++}: ${container.name}`);}// Use iter.next() to iterate the containersi = 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 containersi = 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 markeri = 1;let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });let response = (await iterator.next()).value;// Prints 2 container namesif (response.containerItems) {  for (const container of response.containerItems) {    console.log(`Container ${i++}: ${container.name}`);  }}// Gets next markerlet marker = response.continuationToken;// Passing next marker as continuationTokeniterator = blobServiceClient  .listContainers()  .byPage({ continuationToken: marker, maxPageSize: 10 });response = (await iterator.next()).value;// Prints 10 container namesif (response.containerItems) {  for (const container of response.containerItems) {    console.log(`Container ${i++}: ${container.name}`);  }}

function listContainers(options?: ServiceListContainersOptions): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>

Parameters

Returns

An asyncIterableIterator that supports paging.

Sets properties for a storage account’s Blob service endpoint, including propertiesfor Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.

Seehttps://learn.microsoft.com/rest/api/storageservices/set-blob-service-properties

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parameters

Returns

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.

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

Parameters

Returns

Container deletion response.