README.md

Ramstack.FileSystem.Azure

Provides an implementation of Ramstack.FileSystem based on Azure Blob Storage.

Getting Started

To install the Ramstack.FileSystem.Azure NuGet package in your project, run the following command:

dotnet add package Ramstack.FileSystem.Azure

Usage

using Ramstack.FileSystem.Azure;

string connectionString = "...";
AzureFileSystem fs = new AzureFileSystem(connectionString, containerName: "storage");

// Create Azure container if it doesn't exist
await fs.CreateContainerAsync(PublicAccessType.None);

await foreach (VirtualFile file in fs.GetFilesAsync("/"))
{
    Console.WriteLine(node.Name);
}

You can also configure the file system to be read-only:

AzureFileSystem fs = new AzureFileSystem(connectionString, containerName: "storage")
{
    IsReadOnly = true
};

Related Projects

• Ramstack.FileSystem.Abstractions - Provides a virtual file system abstraction.
• Ramstack.FileSystem.Physical - Provides an implementation based on the local file system.
• Ramstack.FileSystem.Amazon - Provides an implementation using Amazon S3 storage.
• Ramstack.FileSystem.Google - Provides an implementation using Google Cloud Storage.
• Ramstack.FileSystem.Readonly - Provides a read-only wrapper for the underlying file system.
• Ramstack.FileSystem.Globbing - Wraps the file system, filtering files and directories using glob patterns.
• Ramstack.FileSystem.Prefixed - Adds a prefix to file paths within the underlying file system.
• Ramstack.FileSystem.Sub - Wraps the underlying file system, restricting access to a specific subpath.
• Ramstack.FileSystem.Adapters - Provides integration with Microsoft.Extensions.FileProviders.
• Ramstack.FileSystem.Composite - Provides an implementation that combines multiple file systems into a single composite file system.

Supported Versions

	Version
.NET	6, 7, 8, 9, 10

Contributions

Bug reports and contributions are welcome.

License

This package is released as open source under the MIT License. See the LICENSE file for more details.