BlobsStorage class

Package:

@microsoft/agents-hosting-storage-blob

A legacy Azure Blob storage provider.

Extends

BlobsStorageInternals

Constructors

BlobsStorage(string, string, BlobsStorageOptions, string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential)

Methods

delete(string[])	Deletes legacy items from Azure Blob Storage.
read(string[])	Reads legacy items from Azure Blob Storage.
write(StoreItems)	Writes legacy items to Azure Blob Storage.

Inherited Methods

getVersion(string)

Constructor Details

BlobsStorage(string, string, BlobsStorageOptions, string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential)

new BlobsStorage(containerName: string, connectionString?: string, options?: BlobsStorageOptions, url?: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential)

Parameters

containerName

string

connectionString

string

options

BlobsStorageOptions

url

string

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Method Details

delete(string[])

Deletes legacy items from Azure Blob Storage.

function delete(keys: string[]): Promise<void>

Parameters

keys

string[]

The keys to delete. Missing blobs are ignored.

Returns

Promise<void>

read(string[])

Reads legacy items from Azure Blob Storage.

function read(keys: string[]): Promise<StoreItems>

Parameters

keys

string[]

The keys to read.

Returns

Promise<StoreItems>

Existing items keyed by storage key. Missing blobs are omitted and returned items include the Blob ETag as their legacy eTag.

write(StoreItems)

Writes legacy items to Azure Blob Storage.

function write(changes: StoreItems): Promise<void>

Parameters

changes

StoreItems

The items to write, keyed by storage key.

Returns

Promise<void>

Inherited Method Details

getVersion(string)

function getVersion(key: string): Promise<string | undefined>

Parameters

key

string

Returns

Promise<string | undefined>

Inherited From BlobsStorageInternals.getVersion