BlobsStorageV2 class
An Azure Blob Storage provider for the structured BlobsStorageV2 contract.
This is the V2 counterpart to BlobsStorage and accepts the same connection settings.
It returns a result for every requested key and exposes the Azure Blob ETag as the separate
storage version, preserving any eTag property in an application value. Writes support
create-only, replace, and expected-version conditions to detect concurrent updates.
- Extends
Constructors
| Blobs |
Creates a V2 Azure Blob Storage provider. |
Methods
| delete(string[], Storage |
Deletes Blob values with an optional ETag version condition. |
| read<T>(string[]) | Reads Blob values and ETag versions. |
| write<T>(Record<string, T>, Storage |
Writes Blob values with optional concurrency conditions. |
Constructor Details
BlobsStorageV2(string, string, BlobsStorageOptions, string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential)
Creates a V2 Azure Blob Storage provider.
new BlobsStorageV2(containerName: string, connectionString?: string, options?: BlobsStorageOptions, url?: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential)Parameters
- containerName
-
string
The Blob container name when using a connection string.
- connectionString
-
string
The Azure Storage connection string.
- options
- BlobsStorageOptions
Optional Azure Storage pipeline options.
- url
-
string
The Blob service or container URL when using a credential.
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
The credential used with url.
Method Details
delete(string[], StorageDeleteOptions)
Deletes Blob values with an optional ETag version condition.
function delete(keys: string[], options?: StorageDeleteOptions): Promise<StorageDeleteResults>Parameters
- keys
-
string[]
The keys to delete. Empty batches are valid.
- options
- StorageDeleteOptions
An optional expected Blob ETag version.
Returns
Promise<StorageDeleteResults>
A result for every supplied key.
read<T>(string[])
Reads Blob values and ETag versions.
function read<T>(keys: string[]): Promise<StorageReadResults<T>>Parameters
- keys
-
string[]
The keys to read. Empty batches are valid.
Returns
Promise<StorageReadResults<T>>
A result for every key, with notFound for missing blobs and the Blob ETag as the
version for successful reads.
write<T>(Record<string, T>, StorageWriteOptions)
Writes Blob values with optional concurrency conditions.
function write<T>(changes: Record<string, T>, options?: StorageWriteOptions): Promise<StorageWriteResults>Parameters
- changes
-
Record<string, T>
The values to write, keyed by storage key.
- options
- StorageWriteOptions
Create-only, replace, or expected-version conditions.
Returns
Promise<StorageWriteResults>
A result for every supplied key, including Blob concurrency-condition outcomes.