Azure.Storage.Blobs 12.21.2

.NET 对 Azure 存储 Blob 的客户端库

服务器版本：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 和 2019-02-02

Azure Blob 存储是微软的云对象存储解决方案。Blob 存储针对存储大量非结构化数据进行了优化。非结构化数据是指不遵循特定数据模型或定义的数据，如文本或二进制数据。

源代码[点击访问] | 包件(NuGet)[点击访问] | API参考文档[点击访问] | REST API文档[点击访问] | 产品文档[点击访问]

入门指南

安装包

使用NuGet[点击访问]安装Azure Storage Blobs客户端库(.NET)

dotnet add package Azure.Storage.Blobs

先决条件

您需要Azure订阅和存储帐户才能使用此包。

要创建新的存储帐户，您可以使用Azure门户、Azure PowerShell或Azure CLI。以下是一个使用Azure CLI的示例

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

认证客户端

为了与Azure Blobs存储服务交互，您需要创建BlobServiceClient类的实例。Azure Identity库[点击访问]使为Azure SDK客户端添加Azure Active Directory认证支持变得简单。

// 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());

有关在Azure存储中启用Azure Active Directory认证的更多信息，请参阅我们的文档和示例。

关键概念

Blob存储适用于：

• 直接向浏览器提供服务或文档。
• 存储用于分布式访问的文件。
• 流式传输视频和音频。
• 写入日志文件。
• 用于备份和恢复、灾难恢复和存档的数据存储。
• 用于由本地或Azure托管服务分析的数据存储。

Blob存储提供三种类型资源：

• 通过BlobServiceClient使用的存储帐户
• 通过BlobContainerClient使用的存储帐户中的容器
• 通过BlobClient使用的容器中的blob

有关认证选项的更多信息（包括连接字符串、共享密钥、共享密钥签名、Active Directory和匿名公开访问），请参阅我们的示例。

线程安全

我们保证所有客户端实例方法都是线程安全的且相互独立 (指导方针)。这确保了重用客户端实例的建议总是安全的，即使在多线程中也是如此。

其他概念

客户端选项 | 访问响应 | 长时间运行的操作 | 处理失败 | 诊断 | 模拟 | 客户端生命周期

示例

上传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);

下载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);

Blob 列表操作

// 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);
}

异步 API

我们完全支持同步和异步 API。

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

// Download the public MacBeth copy at https://www.gutenberg.org/cache/epub/1533/pg1533.txt
await new BlobClient(new Uri("https://www.gutenberg.org/cache/epub/1533/pg1533.txt")).DownloadToAsync(downloadPath);

故障排除

所有 Blob 服务操作在失败时，都会抛出 RequestFailedException 异常，并提供有用的 ErrorCode 错误代码。其中许多错误是可恢复的。

// 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
}

下一步

从我们的 Blob 示例 开始

1. Hello World：上传、下载和列出 blob（或异步）
2. 认证：使用连接字符串、公开访问、共享密钥、共享访问签名和 Azure Active Directory 进行认证。

贡献

有关构建、测试和为该库做出贡献的详细信息，请参阅 Storage CONTRIBUTING.md。

本项目欢迎贡献和建议。大多数贡献都需要您同意 contributor license agreement (cla) 声明，您有权利并且确实授予我们使用您贡献的权利。有关详细信息，请访问cla.microsoft.com。

本项目已采用 Microsoft Open Source Code of Conduct。有关更多信息，请参阅 Code of Conduct FAQ 或通过 [email protected] 联系以获取任何附加问题或评论。