MinIO Client SDK provides higher level APIs for MinIO and Amazon S3 compatible cloud storage services.For a complete list of APIs and examples, please take a look at the Dotnet Client API Reference.This document assumes that you have a working VisualStudio development environment.
To install MinIO .NET package, run the following command in Nuget Package Manager Console.
PM> Install-Package MinioWhen using AddMinio to add Minio to your ServiceCollection, Minio will also use any custom Logging providers you've added, like Serilog to output traces when enabled.
using Minio;
using Minio.DataModel.Args;
public static class Program
{
var endpoint = "play.min.io";
var accessKey = "minioadmin";
var secretKey = "minioadmin";
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder();
// Add Minio using the default endpoint
builder.Services.AddMinio(accessKey, secretKey);
// Add Minio using the custom endpoint and configure additional settings for default MinioClient initialization
builder.Services.AddMinio(configureClient => configureClient
.WithEndpoint(endpoint)
.WithCredentials(accessKey, secretKey)
.Build());
// NOTE: SSL and Build are called by the build-in services already.
var app = builder.Build();
app.Run();
}
}
[ApiController]
public class ExampleController : ControllerBase
{
private readonly IMinioClient minioClient;
public ExampleController(IMinioClient minioClient)
{
this.minioClient = minioClient;
}
[HttpGet]
[ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
public async Task<IActionResult> GetUrl(string bucketID)
{
return Ok(await minioClient.PresignedGetObjectAsync(new PresignedGetObjectArgs()
.WithBucket(bucketID))
.ConfigureAwait(false));
}
}
[ApiController]
public class ExampleFactoryController : ControllerBase
{
private readonly IMinioClientFactory minioClientFactory;
public ExampleFactoryController(IMinioClientFactory minioClientFactory)
{
this.minioClientFactory = minioClientFactory;
}
[HttpGet]
[ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
public async Task<IActionResult> GetUrl(string bucketID)
{
var minioClient = minioClientFactory.CreateClient(); //Has optional argument to configure specifics
return Ok(await minioClient.PresignedGetObjectAsync(new PresignedGetObjectArgs()
.WithBucket(bucketID))
.ConfigureAwait(false));
}
}To connect to an Amazon S3 compatible cloud storage service, you need the following information
| Variable name | Description |
|---|---|
| endpoint | <Domain-name> or <ip:port> of your object storage |
| accessKey | User ID that uniquely identifies your account |
| secretKey | Password to your account |
| secure | boolean value to enable/disable HTTPS support (default=true) |
The following examples uses a freely hosted public MinIO service "play.min.io" for development purposes.
using Minio;
var endpoint = "play.min.io";
var accessKey = "minioadmin";
var secretKey = "minioadmin";
var secure = true;
// Initialize the client with access credentials.
private static IMinioClient minio = new MinioClient()
.WithEndpoint(endpoint)
.WithCredentials(accessKey, secretKey)
.WithSSL(secure)
.Build();
// Create an async task for listing buckets.
var getListBucketsTask = await minio.ListBucketsAsync().ConfigureAwait(false);
// Iterate over the list of buckets.
foreach (var bucket in getListBucketsTask.Result.Buckets)
{
Console.WriteLine(bucket.Name + " " + bucket.CreationDateDateTime);
}This example program connects to an object storage server, creates a bucket and uploads a file to the bucket. To run the following example, click on [Link] and start the project
using System;
using Minio;
using Minio.Exceptions;
using Minio.DataModel;
using Minio.Credentials;
using Minio.DataModel.Args;
using System.Threading.Tasks;
namespace FileUploader
{
class FileUpload
{
static void Main(string[] args)
{
var endpoint = "play.min.io";
var accessKey = "minioadmin";
var secretKey = "minioadmin";
try
{
var minio = new MinioClient()
.WithEndpoint(endpoint)
.WithCredentials(accessKey, secretKey)
.WithSSL()
.Build();
FileUpload.Run(minio).Wait();
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
Console.ReadLine();
}
// File uploader task.
private async static Task Run(IMinioClient minio)
{
var bucketName = "mymusic";
var location = "us-east-1";
var objectName = "golden-oldies.zip";
var filePath = "C:\\Users\\username\\Downloads\\golden_oldies.mp3";
var contentType = "application/zip";
try
{
// Make a bucket on the server, if not already present.
var beArgs = new BucketExistsArgs()
.WithBucket(bucketName);
bool found = await minio.BucketExistsAsync(beArgs).ConfigureAwait(false);
if (!found)
{
var mbArgs = new MakeBucketArgs()
.WithBucket(bucketName);
await minio.MakeBucketAsync(mbArgs).ConfigureAwait(false);
}
// Upload a file to bucket.
var putObjectArgs = new PutObjectArgs()
.WithBucket(bucketName)
.WithObject(objectName)
.WithFileName(filePath)
.WithContentType(contentType);
await minio.PutObjectAsync(putObjectArgs).ConfigureAwait(false);
Console.WriteLine("Successfully uploaded " + objectName );
}
catch (MinioException e)
{
Console.WriteLine("File Upload Error: {0}", e.Message);
}
}
}
}-
Clone this repository and open the Minio.Sln in Visual Studio 2017.
-
Enter your credentials and bucket name, object name etc. in Minio.Examples/Program.cs
-
Uncomment the example test cases such as below in Program.cs to run an example.
//Cases.MakeBucket.Run(minioClient, bucketName).Wait();- Run the Minio.Client.Examples project from Visual Studio
NOTE: minio-dotnet requires .NET 6.x SDK to build on Linux.
- Install .Net SDK
wget https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
sudo apt-get update; \
sudo apt-get install -y apt-transport-https && \
sudo apt-get update && \
sudo apt-get install -y dotnet-sdk-6.0
- Clone this project.
$ git clone https://github.com/minio/minio-dotnet && cd minio-dotnet
- Enter your credentials and bucket name, object name etc. in Minio.Examples/Program.cs Uncomment the example test cases such as below in Program.cs to run an example.
//Cases.MakeBucket.Run(minioClient, bucketName).Wait();dotnet build --configuration Release --no-restore
dotnet pack ./Minio/Minio.csproj --no-build --configuration Release --output ./artifacts
dotnet test ./Minio.Tests/Minio.Tests.csproj
- MakeBucket.cs
- ListBuckets.cs
- BucketExists.cs
- RemoveBucket.cs
- ListObjects.cs
- ListIncompleteUploads.cs
- ListenBucketNotifications.cs