BlobServiceClient | @azure/storage-blob

A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you to manipulate blob containers.

export
class: BlobServiceClient

Hierarchy

StorageClient
- BlobServiceClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides StorageClient.constructor
- Defined in storage/storage-blob/src/BlobServiceClient.ts:326
Creates an instance of BlobServiceClient.
memberof

BlobServiceClient

example
```
const account = "<storage account name>";

// Use a TokenCredential implementation from the @azure/identity package.
// In this case, a DefaultAzureCredential (recommended for most users)
const defaultAzureCredential = new DefaultAzureCredential();

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  defaultAzureCredential
);
```
example
```
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential
);
```
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
Returns BlobServiceClient
Overrides StorageClient.constructor
- Defined in storage/storage-blob/src/BlobServiceClient.ts:367
Creates an instance of BlobServiceClient.

memberof

BlobServiceClient

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: Pipeline
  
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Returns BlobServiceClient

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.

type: {StorageSharedKeyCredential | AnonymousCredential | TokenCredential}
memberof: StorageClient

Protected isHttps

isHttps: boolean

type: {boolean}
memberof: StorageClient

Protected storageClientContext

storageClientContext: StorageClientContext

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

type: {StorageClientContext}
memberof: StorageClient

url

url: string

Encoded URL string value.

type: {string}
memberof: StorageClient

Methods

createContainer

createContainer(containerName: string, options?: ContainerCreateOptions): Promise<object>

- Defined in storage/storage-blob/src/BlobServiceClient.ts:432
Create a Blob container.

memberof

BlobServiceClient

Parameters
- containerName: string
  
  Name of the container to create.
- Default value options: ContainerCreateOptions = {}
Returns Promise<object>

} Container creation response and the corresponding container client.

deleteContainer

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:472
Deletes a Blob container.

memberof

BlobServiceClient

Parameters
- containerName: string
  
  Name of the container to delete.
- Default value options: ContainerDeleteMethodOptions = {}
Returns Promise<ContainerDeleteResponse>

Container deletion response.

getAccountInfo

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:607
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.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

memberof

BlobServiceClient

Parameters
- Default value options: ServiceGetAccountInfoOptions = {}
Returns Promise<ServiceGetAccountInfoResponse>

Response data for the Service Get Account Info operation.

getBlobBatchClient

getBlobBatchClient(): BlobBatchClient

- Defined in storage/storage-blob/src/BlobServiceClient.ts:899
Creates a BlobBatchClient object to conduct batch operations.

see

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

memberof

BlobServiceClient

Returns BlobBatchClient

A new BlobBatchClient object for this service.

getContainerClient

getContainerClient(containerName: string): ContainerClient

- Defined in storage/storage-blob/src/BlobServiceClient.ts:417
Creates a ContainerClient object
memberof

BlobServiceClient

example
```
const containerClient = blobServiceClient.getContainerClient("<container name>");
```
Parameters
- containerName: string
  
  A container name
Returns ContainerClient

A new ContainerClient object for the given container name.

getProperties

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:506
Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

see

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

memberof

BlobServiceClient

Parameters
- Default value options: ServiceGetPropertiesOptions = {}
Returns Promise<ServiceGetPropertiesResponse>

Response data for the Service Get Properties operation.

getStatistics

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:573
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.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats}

memberof

BlobServiceClient

Parameters
- Default value options: ServiceGetStatisticsOptions = {}
Returns Promise<ServiceGetStatisticsResponse>

Response data for the Service Get Statistics operation.

getUserDelegationKey

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:838
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.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

memberof

BlobServiceClient

Parameters
- startsOn: Date
  
  The start time for the user delegation SAS. Must be within 7 days of the current time
- expiresOn: Date
  
  The end time for the user delegation SAS. Must be within 7 days of the current time
- Default value options: ServiceGetUserDelegationKeyOptions = {}
Returns Promise<ServiceGetUserDelegationKeyResponse>

listContainers

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

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.

example

  let i = 1;
  for await (const container of blobServiceClient.listContainers()) {
    console.log(`Container ${i++}: ${container.name}`);
  }

example

  // Generator syntax .next()
  let i = 1;
  const iter = blobServiceClient.listContainers();
  let containerItem = await iter.next();
  while (!containerItem.done) {
    console.log(`Container ${i++}: ${containerItem.value.name}`);
    containerItem = await iter.next();
  }

example

  // Example for .byPage()
  // passing optional maxPageSize in the page settings
  let i = 1;
  for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
    if (response.containerItems) {
      for (const container of response.containerItems) {
        console.log(`Container ${i++}: ${container.name}`);
      }
    }
  }

example

  // Passing marker as an argument (similar to the previous example)
  let 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}`);
    }
  }

memberof

BlobServiceClient

Parameters

Default value options: ServiceListContainersOptions = {}

Returns PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

An asyncIterableIterator that supports paging.

setProperties

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:539
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.

see

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

memberof

BlobServiceClient

Parameters
- properties: BlobServiceProperties
- Default value options: ServiceSetPropertiesOptions = {}
Returns Promise<ServiceSetPropertiesResponse>

Response data for the Service Set Properties operation.

Static fromConnectionString

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

- Defined in storage/storage-blob/src/BlobServiceClient.ts:303
Creates an instance of BlobServiceClient from connection string.

memberof

BlobServiceClient

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
- Optional options: StoragePipelineOptions
Returns BlobServiceClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns BlobServiceClient

Parameters

url: string

pipeline: Pipeline

Returns BlobServiceClient

Properties

accountName

credential

Protected isHttps

Protected storageClientContext

url

Methods

createContainer

Parameters

containerName: string

Default value options: ContainerCreateOptions = {}

Returns Promise<object>

deleteContainer

Parameters

containerName: string

Default value options: ContainerDeleteMethodOptions = {}

Returns Promise<ContainerDeleteResponse>

getAccountInfo

Parameters

Default value options: ServiceGetAccountInfoOptions = {}

Returns Promise<ServiceGetAccountInfoResponse>

getBlobBatchClient

Returns BlobBatchClient

getContainerClient

Parameters

containerName: string

Returns ContainerClient

getProperties

Parameters

Default value options: ServiceGetPropertiesOptions = {}

Returns Promise<ServiceGetPropertiesResponse>

getStatistics

Parameters

Default value options: ServiceGetStatisticsOptions = {}

Returns Promise<ServiceGetStatisticsResponse>

getUserDelegationKey

Parameters

startsOn: Date

expiresOn: Date

Default value options: ServiceGetUserDelegationKeyOptions = {}

Returns Promise<ServiceGetUserDelegationKeyResponse>

listContainers

Parameters

Default value options: ServiceListContainersOptions = {}

Returns PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

setProperties

Parameters

properties: BlobServiceProperties

Default value options: ServiceSetPropertiesOptions = {}

Returns Promise<ServiceSetPropertiesResponse>

Static fromConnectionString

Parameters

connectionString: string

Optional options: StoragePipelineOptions

Returns BlobServiceClient