Soenneker.Blob.Suite 11.0.7886

Soenneker.Blob.Suite

Installs and registers the Soenneker utilities for copying, deleting, downloading, uploading, and accessing Azure Blob Storage.

Installation

dotnet add package Soenneker.Blob.Suite

Install the individual packages instead when an application needs only part of the suite.

Configuration

{
  "Environment": "Production",
  "Azure": {
    "Storage": {
      "Blob": {
        "ConnectionString": "<connection string>",
        "AccountName": "<storage account name>",
        "AccountKey": "<storage account key>"
      }
    }
  }
}

The connection string is used for normal Blob operations. The account name, account key, and environment are required by the SAS utility registered through the upload package.

Registration

using Microsoft.Extensions.DependencyInjection;
using Soenneker.Blob.Suite.Registrars;

services.AddBlobSuiteAsSingleton();

Use AddBlobSuiteAsScoped() when the utilities should follow the consuming dependency-injection scope.

Registered utilities

Soenneker.Blob.Fetch is not included. Add that package separately when blob metadata listing is needed.

Usage

Inject only the utility needed by each consumer:

using Soenneker.Blob.Download.Abstract;
using Soenneker.Blob.Upload.Abstract;

public sealed class AssetStore
{
    private readonly IBlobUploadUtil _uploads;
    private readonly IBlobDownloadUtil _downloads;

    public AssetStore(IBlobUploadUtil uploads, IBlobDownloadUtil downloads)
    {
        _uploads = uploads;
        _downloads = downloads;
    }

    public async ValueTask UploadManifest(
        string json,
        CancellationToken cancellationToken)
    {
        _ = await _uploads.Upload(
            "assets",
            "manifest.json",
            json,
            contentType: "application/json",
            cancellationToken: cancellationToken);
    }

    public ValueTask<string> DownloadManifest(CancellationToken cancellationToken)
    {
        return _downloads.DownloadToString(
            "assets",
            "manifest.json",
            cancellationToken: cancellationToken);
    }
}

The upload method returns Azure's Response<BlobContentInfo> when the caller needs the service response. See each component package for operation-specific ownership, buffering, and error behavior.