Краткое руководство. Использование библиотеки хранилища BLOB-объектов Azure версии 12 для .NETQuickstart: Azure Blob storage client library v12 for .NET

Приступите к работе с клиентской библиотекой хранилища BLOB-объектов Azure версии 12 для .NET.Get started with the Azure Blob storage client library v12 for .NET. Хранилище BLOB-объектов Azure — это решение корпорации Майкрософт для хранения объектов в облаке.Azure Blob storage is Microsoft's object storage solution for the cloud. Чтобы установить пакет и испробовать пример кода для выполнения базовых задач, выполните приведенные здесь действия.Follow steps to install the package and try out example code for basic tasks. Хранилище BLOB-объектов оптимизировано для хранения больших объемов неструктурированных данных.Blob storage is optimized for storing massive amounts of unstructured data.

Клиентскую библиотеку хранилища BLOB-объектов Azure версии 12 для .NET можно использовать для выполнения таких задач:Use the Azure Blob storage client library v12 for .NET to:

  • Создание контейнераCreate a container
  • передача большого двоичного объекта в хранилище Azure;Upload a blob to Azure Storage
  • перечисление всех больших двоичных объектов в контейнере;List all of the blobs in a container
  • скачивание большого двоичного объекта на локальный компьютер;Download the blob to your local computer
  • Удаление контейнераDelete a container

Дополнительные ресурсы:Additional resources:

Примечание

Функции, описанные в этой статье, теперь доступны для учетных записей с иерархическим пространством имен.The features described in this article are now available to accounts that have a hierarchical namespace. Сведения об ограничениях см. в статье Функции Хранилища BLOB-объектов, доступные в Azure Data Lake Storage 2-го поколения.To review limitations, see the Blob storage features available in Azure Data Lake Storage Gen2 article.

Предварительные требованияPrerequisites

НастройкаSetting up

В этом разделе рассматривается подготовка проекта для работы с клиентской библиотекой хранилища BLOB-объектов Azure версии 12 для .NET.This section walks you through preparing a project to work with the Azure Blob storage client library v12 for .NET.

Создание проектаCreate the project

Создайте приложение .NET Core с именем BlobQuickstartV12.Create a .NET Core application named BlobQuickstartV12.

  1. В окне консоли (командная строка, PowerShell или Bash) выполните команду dotnet new, чтобы создать консольное приложение BlobQuickstartV12.In a console window (such as cmd, PowerShell, or Bash), use the dotnet new command to create a new console app with the name BlobQuickstartV12. Эта команда создает простой проект Hello World на языке C# с одним файлом исходного кода: Program.cs.This command creates a simple "Hello World" C# project with a single source file: Program.cs.

    dotnet new console -n BlobQuickstartV12
    
  2. Переключитесь на только что созданный каталог BlobQuickstartV12.Switch to the newly created BlobQuickstartV12 directory.

    cd BlobQuickstartV12
    
  3. В каталоге BlobQuickstartV12 создайте каталог data.In side the BlobQuickstartV12 directory, create another directory called data. Это каталог для создания и хранения файлов данных больших двоичных объектов.This is where the blob data files will be created and stored.

    mkdir data
    

Установка пакетаInstall the package

Оставаясь в каталоге приложения, установите клиентскую библиотеку хранилища BLOB-объектов Azure для пакета .NET с помощью команды dotnet add package.While still in the application directory, install the Azure Blob storage client library for .NET package by using the dotnet add package command.

dotnet add package Azure.Storage.Blobs

Настройка платформы приложенияSet up the app framework

Из каталога проекта:From the project directory:

  1. Откройте файл Program.cs в редакторе.Open the Program.cs file in your editor
  2. Удалите инструкцию Console.WriteLine("Hello World!");.Remove the Console.WriteLine("Hello World!"); statement
  3. Добавьте директивы using.Add using directives
  4. Обновите объявление метода Main для поддержки асинхронного кода.Update the Main method declaration to support async code

Вот этот код:Here's the code:

using Azure.Storage.Blobs;
using Azure.Storage.Blobs.Models;
using System;
using System.IO;
using System.Threading.Tasks;

namespace BlobQuickstartV12
{
    class Program
    {
        static async Task Main()
        {
        }
    }
}

Копирование учетных данных с портала AzureCopy your credentials from the Azure portal

Когда пример приложения выполняет запрос к службе хранилища Azure, он должен быть авторизован.When the sample application makes a request to Azure Storage, it must be authorized. Для авторизации запроса добавьте в приложение учетные данные учетной записи хранения в виде строки подключения.To authorize a request, add your storage account credentials to the application as a connection string. Чтобы просмотреть учетные данные учетной записи хранения, выполните следующие действия:View your storage account credentials by following these steps:

  1. Войдите на портал Azure.Sign in to the Azure portal.

  2. Перейдите к учетной записи хранения.Locate your storage account.

  3. В разделе Параметры учетной записи хранения выберите параметр Ключи доступа.In the Settings section of the storage account overview, select Access keys. На этой странице вы увидите ключи доступа к учетной записи и полную строку подключения для каждого ключа.Here, you can view your account access keys and the complete connection string for each key.

  4. Найдите значение для параметра Строка подключения в разделе Key1 и нажмите кнопку Скопировать, чтобы скопировать строку подключения.Find the Connection string value under key1, and select the Copy button to copy the connection string. На следующем этапе вы добавите значение строки подключения в переменную среды.You will add the connection string value to an environment variable in the next step.

    Снимок экрана, на котором показано, как скопировать строку подключения с портала Azure

Настройка строки подключения хранилищаConfigure your storage connection string

После копирования строки подключения запишите ее в переменной среды на локальном компьютере, где выполняется приложение.After you have copied your connection string, write it to a new environment variable on the local machine running the application. Чтобы задать переменную среды, откройте окно консоли и следуйте инструкциям для используемой операционной системы.To set the environment variable, open a console window, and follow the instructions for your operating system. Замените <yourconnectionstring> фактической строкой подключения.Replace <yourconnectionstring> with your actual connection string.

WindowsWindows

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

После добавления переменной среды в Windows вам необходимо запустить новый экземпляр командного окна.After you add the environment variable in Windows, you must start a new instance of the command window.

LinuxLinux

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

macOSmacOS

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

Перезапуск программRestart programs

После добавления переменной среды перезапустите все запущенные программы, которым может понадобиться считать переменную среды.After you add the environment variable, restart any running programs that will need to read the environment variable. Например, перезапустите среду разработки или редактор, прежде чем продолжить.For example, restart your development environment or editor before continuing.

Объектная модельObject model

Хранилище BLOB-объектов Azure оптимизировано для хранения больших объемов неструктурированных данных.Azure 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. В хранилище BLOB-объектов предлагается три типа ресурсов:Blob storage offers three types of resources:

  • учетная запись хранения;The storage account
  • контейнер в учетной записи хранения;A container in the storage account
  • большой двоичный объект в контейнере.A blob in the container

На следующей схеме показана связь между этими ресурсами.The following diagram shows the relationship between these resources.

Схема архитектуры службы хранилища BLOB-объектов

Используйте следующие классы .NET для взаимодействия с этими ресурсами:Use the following .NET classes to interact with these resources:

  • BlobServiceClient. Класс BlobServiceClient позволяет управлять ресурсами службы хранилища Azure и контейнерами больших двоичных объектов.BlobServiceClient: The BlobServiceClient class allows you to manipulate Azure Storage resources and blob containers.
  • BlobContainerClient. Класс BlobContainerClient позволяет управлять контейнерами службы хранилища Azure и содержащимися в них большими двоичными объектами.BlobContainerClient: The BlobContainerClient class allows you to manipulate Azure Storage containers and their blobs.
  • BlobClient. Класс BlobClient позволяет управлять большими двоичными объектами службы хранилища Azure.BlobClient: The BlobClient class allows you to manipulate Azure Storage blobs.
  • BlobDownloadInfo. Класс BlobDownloadInfo представляет свойства и содержимое, возвращаемое при скачивании большого двоичного объекта.BlobDownloadInfo: The BlobDownloadInfo class represents the properties and content returned from downloading a blob.

Примеры кодаCode examples

В этих примерах фрагментов кода показано, как выполнять следующие действия с помощью клиентской библиотеки хранилища BLOB-объектов Azure для .NET:These example code snippets show you how to perform the following with the Azure Blob storage client library for .NET:

Получение строки подключенияGet the connection string

Приведенный ниже код извлекает строку подключения для учетной записи хранения из переменной среды, созданной в разделе Настройка строки подключения хранилища.The code below retrieves the connection string for the storage account from the environment variable created in the Configure your storage connection string section.

Добавьте этот код в метод Main.Add this code inside the Main method:

Console.WriteLine("Azure Blob storage v12 - .NET quickstart sample\n");

// Retrieve the connection string for use with the application. The storage
// connection string is stored in an environment variable on the machine
// running the application called AZURE_STORAGE_CONNECTION_STRING. If the
// environment variable is created after the application is launched in a
// console or with Visual Studio, the shell or application needs to be closed
// and reloaded to take the environment variable into account.
string connectionString = Environment.GetEnvironmentVariable("AZURE_STORAGE_CONNECTION_STRING");

Создание контейнераCreate a container

Выберите имя нового контейнера.Decide on a name for the new container. Приведенный ниже код добавляет к имени контейнера значение GUID, чтобы сделать это имя уникальным.The code below appends a GUID value to the container name to ensure that it is unique.

Важно!

Имена контейнеров должны состоять из знаков нижнего регистра.Container names must be lowercase. Дополнительные сведения об именовании контейнеров и больших двоичных объектов см. в статье Naming and Referencing Containers, Blobs, and Metadata (Именование контейнеров, больших двоичных объектов и метаданных и ссылка на них).For more information about naming containers and blobs, see Naming and Referencing Containers, Blobs, and Metadata.

Создайте экземпляр класса BlobServiceClient.Create an instance of the BlobServiceClient class. Затем вызовите метод CreateBlobContainerAsync, чтобы создать контейнер в своей учетной записи хранения.Then, call the CreateBlobContainerAsync method to create the container in your storage account.

Добавьте следующий код в конец метода Main.Add this code to the end of the Main method:

// Create a BlobServiceClient object which will be used to create a container client
BlobServiceClient blobServiceClient = new BlobServiceClient(connectionString);

//Create a unique name for the container
string containerName = "quickstartblobs" + Guid.NewGuid().ToString();

// Create the container and return a container client object
BlobContainerClient containerClient = await blobServiceClient.CreateBlobContainerAsync(containerName);

Отправка больших двоичных объектов в контейнерUpload blobs to a container

Приведенный ниже фрагмент кода:The following code snippet:

  1. Создает текстовый файл в локальном каталоге data.Creates a text file in the local data directory.
  2. Возвращает ссылку на объект BlobClient, вызывая метод GetBlobClient для контейнера из раздела Создание контейнера.Gets a reference to a BlobClient object by calling the GetBlobClient method on the container from the Create a container section.
  3. Передает локальный текстовый файл в большой двоичный объект, вызывая метод UploadAsync.Uploads the local text file to the blob by calling the UploadAsync method. С помощью этого метода создается большой двоичный объект, если он не был создан ранее, или же, если он имеется, происходит его замещение.This method creates the blob if it doesn't already exist, and overwrites it if it does.

Добавьте следующий код в конец метода Main.Add this code to the end of the Main method:

// Create a local file in the ./data/ directory for uploading and downloading
string localPath = "./data/";
string fileName = "quickstart" + Guid.NewGuid().ToString() + ".txt";
string localFilePath = Path.Combine(localPath, fileName);

// Write text to the file
await File.WriteAllTextAsync(localFilePath, "Hello, World!");

// Get a reference to a blob
BlobClient blobClient = containerClient.GetBlobClient(fileName);

Console.WriteLine("Uploading to Blob storage as blob:\n\t {0}\n", blobClient.Uri);

// Open the file and upload its data
using FileStream uploadFileStream = File.OpenRead(localFilePath);
await blobClient.UploadAsync(uploadFileStream, true);
uploadFileStream.Close();

Перечисление BLOB-объектов в контейнереList the blobs in a container

Выведите список больших двоичных объектов в контейнере, вызвав метод GetBlobsAsync.List the blobs in the container by calling the GetBlobsAsync method. В этом случае в контейнер был добавлен лишь один большой двоичный объект, поэтому операция перечисления возвращает только его.In this case, only one blob has been added to the container, so the listing operation returns just that one blob.

Добавьте следующий код в конец метода Main.Add this code to the end of the Main method:

Console.WriteLine("Listing blobs...");

// List all blobs in the container
await foreach (BlobItem blobItem in containerClient.GetBlobsAsync())
{
    Console.WriteLine("\t" + blobItem.Name);
}

Скачивание больших двоичных объектовDownload blobs

Скачайте созданный ранее большой двоичный объект, вызвав метод DownloadAsync.Download the previously created blob by calling the DownloadAsync method. Пример кода добавляет суффикс "DOWNLOADED" к имени файла, чтобы в локальной файловой системе можно было просмотреть оба файла.The example code adds a suffix of "DOWNLOADED" to the file name so that you can see both files in local file system.

Добавьте следующий код в конец метода Main.Add this code to the end of the Main method:

// Download the blob to a local file
// Append the string "DOWNLOADED" before the .txt extension 
// so you can compare the files in the data directory
string downloadFilePath = localFilePath.Replace(".txt", "DOWNLOADED.txt");

Console.WriteLine("\nDownloading blob to\n\t{0}\n", downloadFilePath);

// Download the blob's contents and save it to a file
BlobDownloadInfo download = await blobClient.DownloadAsync();

using (FileStream downloadFileStream = File.OpenWrite(downloadFilePath))
{
    await download.Content.CopyToAsync(downloadFileStream);
    downloadFileStream.Close();
}

Удаление контейнераDelete a container

Следующий код очищает созданные приложением ресурсы, полностью удаляя контейнер с помощью метода DeleteAsync.The following code cleans up the resources the app created by deleting the entire container by using DeleteAsync. Он также удаляет локальные файлы, созданные приложением.It also deletes the local files created by the app.

Приложение приостанавливается для ввода пользователя, вызывая Console.ReadLine, перед удалением большого двоичного объекта, контейнера и локальных файлов.The app pauses for user input by calling Console.ReadLine before it deletes the blob, container, and local files. Это хорошая возможность проверить правильность создания ресурсов перед их удалением.This is a good chance to verify that the resources were actually created correctly, before they are deleted.

Добавьте следующий код в конец метода Main.Add this code to the end of the Main method:

// Clean up
Console.Write("Press any key to begin clean up");
Console.ReadLine();

Console.WriteLine("Deleting blob container...");
await containerClient.DeleteAsync();

Console.WriteLine("Deleting the local source and downloaded files...");
File.Delete(localFilePath);
File.Delete(downloadFilePath);

Console.WriteLine("Done");

Выполнение кодаRun the code

В этом приложении тестовый файл создается в локальной папке data, а затем передается в хранилище BLOB-объектов.This app creates a test file in your local data folder and uploads it to Blob storage. После этого выводится список больших двоичных объектов в контейнере, а затем файл загружается с новым именем, чтобы можно было сравнить старый и новый файлы.The example then lists the blobs in the container and downloads the file with a new name so that you can compare the old and new files.

Перейдите к каталогу приложения, выполните его сборку и запустите его.Navigate to your application directory, then build and run the application.

dotnet build
dotnet run

Вы должны увидеть выходные данные приложения, как показано ниже.The output of the app is similar to the following example:

Azure Blob storage v12 - .NET quickstart sample

Uploading to Blob storage as blob:
         https://mystorageacct.blob.core.windows.net/quickstartblobs60c70d78-8d93-43ae-954d-8322058cfd64/quickstart2fe6c5b4-7918-46cb-96f4-8c4c5cb2fd31.txt

Listing blobs...
        quickstart2fe6c5b4-7918-46cb-96f4-8c4c5cb2fd31.txt

Downloading blob to
        ./data/quickstart2fe6c5b4-7918-46cb-96f4-8c4c5cb2fd31DOWNLOADED.txt

Press any key to begin clean up
Deleting blob container...
Deleting the local source and downloaded files...
Done

Прежде чем начать удаление, проверьте наличие двух файлов в папке data.Before you begin the clean up process, check your data folder for the two files. Вы можете открыть их и убедиться, что они идентичны.You can open them and observe that they are identical.

После проверки файлов нажмите клавишу ВВОД, чтобы завершить работу с демонстрационной версией и удалить тестовые файлы.After you've verified the files, press the Enter key to delete the test files and finish the demo.

Дальнейшие действияNext steps

В этом кратком руководстве вы узнали, как передавать, загружать и перечислять файлы в большие двоичные объекты с помощью .NET.In this quickstart, you learned how to upload, download, and list blobs using .NET.

Чтобы просмотреть примеры приложений для хранилища BLOB-объектов, перейдите к следующему разделу:To see Blob storage sample apps, continue to: