devdeer.Libraries.Azure.BlobStorage 0.1.4-beta

devdeer.Libraries.Azure.BlobStorage

Disclaimer

If you want to use this package you should be aware of some principles and practices we at DEVDEER use. So be aware that this is not backed by a public repository. The purpose here is to give out customers easy access to our logic. Nevertheless, you are welcome to use this lib if it provides any advantages.

Summary

devdeer.Libraries.Azure.BlobStorage is a .NET library designed to simplify interactions with Azure Blob Storage. It provides an abstraction layer over the Azure SDK, making it easier to perform common blob operations such as uploading, downloading, and managing containers. This library is primarily intended for internal DEVDEER projects, but it can be useful for any .NET-based application that integrates with Azure Storage.

Key Features:

• Simplified API for working with Azure Blob Storage.
• Asynchronous support using Task-based methods.
• Configurable authentication via account key.
• Helper methods for common blob operations.
• Logging integration with .NET's built-in logging framework.

Usage

To use this library, follow these steps:

1. Install the Package

Add the library to your .NET project using NuGet:

dotnet add package devdeer.Libraries.Azure.BlobStorage

2. Authentication Methods

This module supports multiple ways to authenticate and interact with Azure Blob Storage. You can choose the method that best suits your deployment environment and security requirements. The supported methods are:

1. Connection String

• Description: Uses an explicit connection string which encapsulates all the required authentication details.
• Usage: Supply a complete connection string directly in your configuration. This method is straightforward and encapsulates all authentication details.
• Example:

  {
    "BlobStorageOptions": {
      "ConnectionString": "storage-connection-string"
    }
  }
  

2. Account Name + Account Key

• Description:
  Uses the storage account's name and key to create an authenticated client.
• Usage:
  Provide both AccountName and AccountKey in your configuration. The client will construct the connection string dynamically if an explicit connection string is not provided.
• Example:

  {
    "BlobStorageOptions": {
      "AccountName": "storage-account-name",
      "AccountKey": "storage-account-key"
    }
  }
  

3. Default Azure Credential + Account Name

• Description: Leverages the DefaultAzureCredential class from the Azure Identity library for authentication. This method is ideal for environments where managed identities or developer credentials (e.g., Visual Studio, Azure CLI) are available.
• Usage: Provide the AccountName in your configuration. The module will use the DefaultAzureCredential to automatically select the best available credential (e.g., environment variables, managed identity, Azure CLI credentials, etc.).
• Example:

  {
    "BlobStorageOptions": {
      "AccountName": "storage-account-name"
    }
  }
  

• Remarks:
  • Ensure that your environment is configured with the necessary credentials (e.g., through environment variables or managed identity).
  • Consider enabling Managed Identity on your Azure resources.

3. Configure Azure Blob Storage Container Connection

You can configure default container using appsettings.json:

{
  "BlobStorage": {
    "ContainerName": "your-container"
  }
}

4. Injecting and Using the Blob Storage Service

This library provides a service for managing blobs. To register it in Program.cs, add the following dependency injection (DI) configuration:

var builder = Host.CreateDefaultBuilder(args)
    .ConfigureServices((context, services) =>
    {
        // Register options from configuration
        services.RegisterOption<BlobStorageOptions>(BlobStorageOptions.ConfigurationKey);

        // Register blob storage logic
        services.AddTransient<IBlobStorageLogic, BlobStorageLogic>();
    });

After registering the service, you can inject it into your classes and use it as needed. The example below demonstrates injecting IBlobStorageLogic into a service and using it to upload a file:

public class MyService
{
    // Field for the blob storage logic instance.
    private readonly IBlobStorageLogic _blobStorageLogic;

    // Constructor with dependency injection.
    public MyService(IBlobStorageLogic blobStorageLogic)
    {
        _blobStorageLogic = blobStorageLogic;
    }

    // Method to upload a file.
    public async Task UploadFileAsync(Stream fileStream, string fileName, string? containerName)
    {
        await _blobStorageLogic.UploadAsync(fileStream, fileName, containerName);
    }
}

5. Example Operations

• Uploading a File:

var myService = new MyService();
// Upload file as stream.
using var stream = File.OpenRead("localfile.txt");
await myService.UploadAsync(stream, "remote-file.txt");
// Download blob to a path.
var directoryPath = "/path";
var fileName = "file.txt";
await myService.DownloadToPathAsync(fileName, directoryPath);

About DEVDEER

DEVDEER is a company from Magdeburg, Germany which is specialized in consulting, project management and development. We are very focussed on Microsoft Azure as a platform to run our products and solutions in the cloud. So all of our backend components usually runs in this environment and is developed using .NET. In the frontend area we are using react and a huge bunch of packages to build our UIs.

You can find us online:

• Website
• GitHub
• Twitter
• Youtube