GoatFam.AzureBlobStorage 1.0.0

AzureBlobStorage

A .NET Standard 2.1 library that provides a simplified interface for working with Azure Blob Storage.

Features

• Upload files with block-based uploading - Efficiently upload large files using block-based uploads with automatic retry logic
• Download blob content and files - Download blobs as streams or directly to files with support for progress tracking
• Delete blobs - Remove blobs from containers with validation and error handling
• Update blob content - Modify existing blob content with overwrite or conditional update options
• Copy blobs across storage accounts - Copy blobs within the same storage account or across different storage accounts
• Generate SAS tokens - Create both service SAS and user delegation SAS tokens for secure, time-limited blob access

Getting Started

Prerequisites

• .NET Standard 2.1 compatible runtime (.NET Core 3.1+, .NET 5+, .NET 6+, .NET 8+)
• Azure subscription with a Storage Account
• Azure.Identity library for managed identity support (optional)

Installation

Install the NuGet package in your project:

dotnet add package AzureBlobStorage

Or add it via Package Manager:

Install-Package AzureBlobStorage

For local development, reference the project directly:

<ProjectReference Include="..\..\src\AzureBlobStorage\AzureBlobStorage.csproj" />

Configuration

Add Azure Blob Storage configuration to your appsettings.json:

{
  "AzureBlobStorage": {
    "ConnectionString": "your-connection-string",
    "StorageUri": "https://yourstorageaccount.blob.core.windows.net/",
    "ClientId": "your-managed-identity-client-id",
    "Container": "your-default-container"
  }
}

Registration

Register the service in your Program.cs or Startup.cs:

using AzureBlobStorage.Extensions;

// Register with default configuration
builder.Services.AddAzureBlobStorage();

Basic Usage

using AzureBlobStorage.Services;

public class MyService
{
    private readonly IBlobStorageService _blobService;
    
    public MyService(IBlobStorageService blobService)
    {
        _blobService = blobService;
    }
    
    // Upload a file
    public async Task UploadFileAsync(Stream fileStream, string fileName)
    {
        await _blobService.UploadAsync("my-container", fileName, fileStream);
    }
    
    // Generate SAS token with 60 minutes expiry
    public async Task<Uri> GenerateSasTokenAsync(string container, string fileName)
    {
        return await _blobService.CreateUserDelegationSasAsync(container, fileName, 60);
    }
    
    // Download a blob
    public async Task<Stream> DownloadFileAsync(string fileName)
    {
        return await _blobService.DownloadAsync("my-container", fileName);
    }
    
    // Copy blob across storage accounts
    public async Task CopyBlobAsync(string sourceContainer, string sourceBlob, 
                                     string destContainer, string destBlob)
    {
        await _blobService.CopyBlobToAnotherStorageAccountAsync(
            sourceContainer, sourceBlob, destContainer, destBlob);
    }
}

Documentation

For detailed patterns and examples:

• docs/coding-patterns.md - Options pattern and extension methods
• docs/sample-applications.md - Integration examples
• examples/ArticleManagementAPI - Working implementation
• examples/BlobSasTokenGenerationAf - Azure Functions example

License

This project is licensed under the MIT License.