Azure.Storage.Blobs 12.21.0-beta.1

Prefix Reserved
This is a prerelease version of Azure.Storage.Blobs.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Azure.Storage.Blobs --version 12.21.0-beta.1                
NuGet\Install-Package Azure.Storage.Blobs -Version 12.21.0-beta.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Storage.Blobs" Version="12.21.0-beta.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Storage.Blobs --version 12.21.0-beta.1                
#r "nuget: Azure.Storage.Blobs, 12.21.0-beta.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Storage.Blobs as a Cake Addin
#addin nuget:?package=Azure.Storage.Blobs&version=12.21.0-beta.1&prerelease

// Install Azure.Storage.Blobs as a Cake Tool
#tool nuget:?package=Azure.Storage.Blobs&version=12.21.0-beta.1&prerelease                

Azure Storage Blobs client library for .NET

Server Version: 2021-02-12, 2020-12-06, 2020-10-02, 2020-08-04, 2020-06-12, 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2019-02-02

Azure Blob storage is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data. Unstructured data is data that does not adhere to a particular data model or definition, such as text or binary data.

Source code | Package (NuGet) | API reference documentation | REST API documentation | Product documentation

Getting started

Install the package

Install the Azure Storage Blobs client library for .NET with NuGet:

dotnet add package Azure.Storage.Blobs

Prerequisites

You need an Azure subscription and a Storage Account to use this package.

To create a new Storage Account, you can use the Azure Portal, Azure PowerShell, or the Azure CLI. Here's an example using the Azure CLI:

az storage account create --name MyStorageAccount --resource-group MyResourceGroup --location westus --sku Standard_LRS

Authenticate the client

In order to interact with the Azure Blobs Storage service, you'll need to create an instance of the BlobServiceClient class. The Azure Identity library makes it easy to add Azure Active Directory support for authenticating Azure SDK clients with their corresponding Azure services.

// Create a BlobServiceClient that will authenticate through Active Directory
Uri accountUri = new Uri("https://MYSTORAGEACCOUNT.blob.core.windows.net/");
BlobServiceClient client = new BlobServiceClient(accountUri, new DefaultAzureCredential());

Learn more about enabling Azure Active Directory for authentication with Azure Storage in our documentation and our samples.

Key concepts

Blob storage is designed for:

  • Serving images or documents directly to a browser.
  • Storing files for distributed access.
  • Streaming video and audio.
  • Writing to log files.
  • Storing data for backup and restore, disaster recovery, and archiving.
  • Storing data for analysis by an on-premises or Azure-hosted service.

Blob storage offers three types of resources:

  • The storage account used via BlobServiceClient
  • A container in the storage account used via BlobContainerClient
  • A blob in a container used via BlobClient

Learn more about options for authentication (including Connection Strings, Shared Key, Shared Key Signatures, Active Directory, and anonymous public access) in our samples.

Thread safety

We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.

Additional concepts

Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime

Examples

Uploading a blob

// Get a connection string to our Azure Storage account.  You can
// obtain your connection string from the Azure Portal (click
// Access Keys under Settings in the Portal Storage account blade)
// or using the Azure CLI with:
//
//     az storage account show-connection-string --name <account_name> --resource-group <resource_group>
//
// And you can provide the connection string to your application
// using an environment variable.

string connectionString = "<connection_string>";
string containerName = "sample-container";
string blobName = "sample-blob";
string filePath = "sample-file";

// Get a reference to a container named "sample-container" and then create it
BlobContainerClient container = new BlobContainerClient(connectionString, containerName);
container.Create();

// Get a reference to a blob named "sample-file" in a container named "sample-container"
BlobClient blob = container.GetBlobClient(blobName);

// Upload local file
blob.Upload(filePath);

Downloading a blob

// Get a temporary path on disk where we can download the file
string downloadPath = "hello.jpg";

// Download the public blob at https://aka.ms/bloburl
new BlobClient(new Uri("https://aka.ms/bloburl")).DownloadTo(downloadPath);

Enumerating blobs

// Get a connection string to our Azure Storage account.
string connectionString = "<connection_string>";
string containerName = "sample-container";
string filePath = "hello.jpg";

// Get a reference to a container named "sample-container" and then create it
BlobContainerClient container = new BlobContainerClient(connectionString, containerName);
container.Create();

// Upload a few blobs so we have something to list
container.UploadBlob("first", File.OpenRead(filePath));
container.UploadBlob("second", File.OpenRead(filePath));
container.UploadBlob("third", File.OpenRead(filePath));

// Print out all the blob names
foreach (BlobItem blob in container.GetBlobs())
{
    Console.WriteLine(blob.Name);
}

Async APIs

We fully support both synchronous and asynchronous APIs.

// Get a temporary path on disk where we can download the file
string downloadPath = "hello.jpg";

// Download the public blob at https://aka.ms/bloburl
await new BlobClient(new Uri("https://aka.ms/bloburl")).DownloadToAsync(downloadPath);

Troubleshooting

All Blob service operations will throw a RequestFailedException on failure with helpful ErrorCodes. Many of these errors are recoverable.

// Get a connection string to our Azure Storage account.
string connectionString = "<connection_string>";
string containerName = "sample-container";

// Try to delete a container named "sample-container" and avoid any potential race conditions
// that might arise by checking if the container is already deleted or is in the process
// of being deleted.
BlobContainerClient container = new BlobContainerClient(connectionString, containerName);

try
{
    container.Delete();
}
catch (RequestFailedException ex)
    when (ex.ErrorCode == BlobErrorCode.ContainerBeingDeleted ||
          ex.ErrorCode == BlobErrorCode.ContainerNotFound)
{
    // Ignore any errors if the container being deleted or if it has already been deleted
}

Next steps

Get started with our Blob samples:

  1. Hello World: Upload, download, and list blobs (or asynchronously)
  2. Auth: Authenticate with connection strings, public access, shared keys, shared access signatures, and Azure Active Directory.

Contributing

See the Storage CONTRIBUTING.md for details on building, testing, and contributing to this library.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (814)

Showing the top 5 NuGet packages that depend on Azure.Storage.Blobs:

Package Downloads
Microsoft.Azure.WebJobs.Host.Storage

This package contains Azure Storage based implementations of some WebJobs SDK component interfaces. For more information, please visit https://go.microsoft.com/fwlink/?linkid=2279708.

Microsoft.Azure.DurableTask.AzureStorage

Azure Storage provider extension for the Durable Task Framework.

Microsoft.Azure.WebJobs.Extensions.Storage.Blobs

This extension adds bindings for Storage

Azure.Extensions.AspNetCore.DataProtection.Blobs

Microsoft Azure Blob storage support as key store (https://docs.microsoft.com/aspnet/core/security/data-protection/implementation/key-storage-providers).

AspNetCore.HealthChecks.AzureStorage

HealthChecks.AzureStorage is the health check package for Blobs, Tables and Queues.

GitHub repositories (120)

Showing the top 5 popular GitHub repositories that depend on Azure.Storage.Blobs:

Repository Stars
bitwarden/server
Bitwarden infrastructure/backend (API, database, Docker, etc).
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
aspnetboilerplate/aspnetboilerplate
ASP.NET Boilerplate - Web Application Framework
dotnet/orleans
Cloud Native application framework for .NET
Version Downloads Last updated
12.21.0 11,585 7/16/2024
12.21.0-beta.1 6,908 6/11/2024
12.20.0 3,622,867 5/14/2024
12.20.0-beta.2 18,076 4/16/2024
12.20.0-beta.1 162,277 12/5/2023
12.19.1 19,837,831 11/14/2023
12.19.0 900,607 11/6/2023
12.19.0-beta.1 14,793 10/16/2023
12.18.0 7,805,554 9/12/2023
12.18.0-beta.1 35,683 8/8/2023
12.17.0 9,037,260 7/11/2023
12.17.0-beta.1 48,354 5/30/2023
12.16.0 18,768,063 4/11/2023
12.16.0-beta.1 9,200 3/28/2023
12.15.1 3,731,849 3/24/2023
12.15.0 6,242,170 2/22/2023
12.15.0-beta.1 21,779 2/8/2023
12.14.1 23,261,399 10/20/2022
12.14.0 3,064,166 10/12/2022
12.14.0-beta.1 51,498 8/23/2022
12.13.1 18,748,818 8/23/2022
12.13.0 17,843,507 7/8/2022
12.13.0-beta.1 16,748 6/15/2022
12.12.0 14,675,698 5/2/2022
12.12.0-beta.1 15,848 4/12/2022
12.11.0 5,924,045 3/10/2022
12.11.0-beta.3 47,582 2/7/2022
12.11.0-beta.2 136,339 11/30/2021
12.11.0-beta.1 22,391 11/4/2021
12.10.0 32,339,553 9/9/2021
12.10.0-beta.2 23,434 7/23/2021
12.10.0-beta.1 5,540 7/23/2021
12.9.1 8,436,085 6/23/2021
12.9.0 3,100,537 6/9/2021
12.9.0-beta.4 143,230 5/12/2021
12.9.0-beta.3 20,324 4/9/2021
12.9.0-beta.2 71,668 3/10/2021
12.9.0-beta.1 91,589 2/10/2021
12.8.4 2,073,547 5/21/2021
12.8.3 3,147,753 4/27/2021
12.8.2 37,240 4/27/2021
12.8.1 3,608,933 3/29/2021
12.8.0 15,196,034 1/12/2021
12.8.0-beta.1 49,346 12/7/2020
12.7.0 8,697,397 11/10/2020
12.7.0-preview.1 67,811 10/1/2020
12.6.0 11,462,538 8/31/2020
12.5.1 976,779 8/18/2020
12.5.0-preview.6 35,849 7/28/2020
12.5.0-preview.5 35,445 7/3/2020
12.5.0-preview.4 6,861 6/19/2020
12.5.0-preview.1 5,785 6/8/2020
12.4.4 7,038,821 6/5/2020
12.4.3 407,400 6/2/2020
12.4.2 1,884,413 5/6/2020
12.4.1 1,639,479 4/6/2020
12.4.0 1,148,002 3/12/2020
12.3.0 1,287,113 2/11/2020
12.2.0 1,151,406 1/10/2020
12.1.0 728,817 12/4/2019
12.0.0 1,477,838 10/31/2019
12.0.0-preview.4 6,124 10/10/2019
12.0.0-preview.3 6,329 9/10/2019
12.0.0-preview.2 3,277 8/6/2019
12.0.0-preview.1 2,811 7/3/2019
1.0.0-preview.1 5,138 5/7/2019