Быстрый старт: клиентская библиотека хранилища BLOB-объектов Azure для C++

Начало работы с клиентской библиотекой хранилища BLOB-объектов Azure для C++. Хранилище BLOB-объектов Azure — это решение корпорации Майкрософт для хранения объектов в облаке. Выполните приведенные здесь действия, чтобы установить пакет и протестировать пример кода для выполнения базовых задач.

| Справочная документация по | APIИсходный код | библиотекиОбразцы |

Предпосылки

• Подписка Azure — создайте бесплатную учетную запись.
• Учетная запись хранения Azure — создайте такую учетную запись.
• Компилятор C++
• CMake
• vcpkg — диспетчер пакетов C и C++

Настройка

В этом разделе описывается подготовка проекта для работы с клиентской библиотекой хранилища BLOB-объектов Azure для C++. Самый простой способ получить пакет SDK Azure для C++ — использовать vcpkg диспетчер пакетов.

Установка пакетов

Используйте команду vcpkg install для установки библиотеки Azure Blob Storage для C++ и необходимых зависимостей.

vcpkg.exe install azure-storage-blobs-cpp

Библиотека удостоверений Azure необходима для безпарольных подключений к службам Azure.

vcpkg.exe install azure-identity-cpp

Дополнительные сведения о настройке проекта и работе с пакетом Azure SDK для C++ см. в файле README для Azure SDK для C++.

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

В Visual Studio создайте консольное приложение C++ для Windows под названием BlobQuickstart.

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

Хранилище BLOB-объектов Azure оптимизировано для хранения больших объемов неструктурированных данных. Неструктурированные данные — это данные, которые не соответствуют определенной модели данных или определению, например текстовым или двоичным данным. Хранилище BLOB обеспечивает три типа ресурсов:

• учетная запись хранения;
• контейнер в аккаунте хранилища
• BLOB в контейнере.

На следующей схеме показана связь между этими ресурсами.

Используйте эти классы C++ для взаимодействия с этими ресурсами:

• BlobServiceClient: класс BlobServiceClient позволяет управлять ресурсами службы хранилища Azure и контейнерами BLOB-объектов.
• BlobContainerClient: класс BlobContainerClient позволяет управлять контейнерами Azure Storage и их блобами.
• BlobClient: класс BlobClient позволяет управлять BLOB-объектами службы хранилища Azure. Это базовый класс для всех специализированных BLOB-классов.
• BlockBlobClient: BlockBlobClient класс позволяет управлять блочными объектами BLOB хранилища Azure.

Примеры кода

В этих примерах фрагментов кода показано, как выполнять следующие задачи с клиентской библиотекой хранилища BLOB-объектов Azure для C++:

• Добавление файлов включения
• Аутентификация в Azure и авторизация доступа к данным Blob-объектов
• Создание контейнера
• Загрузка объектов в контейнер
• Список BLOBов в контейнере
• скачивание больших двоичных объектов;
• Удаление контейнера

Добавление файлов включения

Из каталога проекта:

1. Откройте файл решения BlobQuickstart.sln в Visual Studio
2. В Visual Studio откройте исходный файл BlobQuickstart.cpp
3. Удалите любой код внутри main , который был создан автоматически
4. Добавьте #include и using namespace оператор

#include <iostream>
#include <azure/core.hpp>
#include <azure/identity/default_azure_credential.hpp>
#include <azure/storage/blobs.hpp>

using namespace Azure::Identity;
using namespace Azure::Storage::Blobs;

Аутентификация в Azure и авторизация доступа к объектам BLOB

Запросы приложений к Хранилищу BLOB-объектов Azure должны быть авторизованы. Использование класса DefaultAzureCredential, предоставленного клиентской библиотекой Azure Identity, является рекомендуемым подходом для реализации подключений без пароля к службам Azure в вашем коде, включая хранилище BLOB-объектов.

Вы также можете авторизовать запросы к Хранилищу BLOB-объектов Azure с помощью ключа доступа к учетной записи. Однако этот подход следует использовать с осторожностью. Разработчики должны тщательно следить за тем, чтобы не раскрыть ключи доступа в незащищенном расположении. Любой пользователь, имеющий ключ доступа, может авторизовать запросы к учетной записи хранения и эффективно иметь доступ ко всем данным. DefaultAzureCredential предлагает улучшенные преимущества управления и безопасности по сравнению с ключом учетной записи, чтобы разрешить проверку подлинности без пароля. Оба варианта показаны в следующем примере.

az storage account show --resource-group '<your-resource-group-name>' --name '<your-storage-account-name>' --query id

az role assignment create --assignee "<user@domain>" \
    --role "Storage Blob Data Contributor" \
    --scope "<your-resource-id>"

Get-AzResource -ResourceGroupName "<yourResourceGroupname>" -Name "<yourStorageAccountName>"

New-AzRoleAssignment -SignInName <user@domain> `
    -RoleDefinitionName "Storage Blob Data Contributor" `
    -Scope <yourStorageAccountId>

az storage account show-connection-string --name "<your-storage-account-name>"

$saName = "yourStorageAccountName"
$rgName = "yourResourceGroupName"
$sa = Get-AzStorageAccount -StorageAccountName $saName -ResourceGroupName $rgName

$saKey = (Get-AzStorageAccountKey -ResourceGroupName $rgName -Name $saName)[0].Value

'DefaultEndpointsProtocol=https;AccountName=' + $saName + ';AccountKey=' + $saKey + ';EndpointSuffix=core.windows.net'

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

    // 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.
    // Note that _MSC_VER is set when using MSVC compiler.
    static const char* AZURE_STORAGE_CONNECTION_STRING = "AZURE_STORAGE_CONNECTION_STRING";

#if !defined(_MSC_VER)
    const char* connectionString = std::getenv(AZURE_STORAGE_CONNECTION_STRING);
#else
	// Use getenv_s for MSVC
	size_t requiredSize;
	getenv_s(&requiredSize, NULL, NULL, AZURE_STORAGE_CONNECTION_STRING);
	if (requiredSize == 0) {
		throw std::runtime_error("missing connection string from env.");
	}
	std::vector<char> value(requiredSize);
	getenv_s(&requiredSize, value.data(), value.size(), AZURE_STORAGE_CONNECTION_STRING);
	std::string connectionStringStr = std::string(value.begin(), value.end());
	const char* connectionString = connectionStringStr.c_str();
#endif

	auto blobServiceClient = BlobServiceClient::CreateFromConnectionString(connectionString);

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

Определите имя нового контейнера. Затем создайте экземпляр BlobContainerClient и создайте контейнер.

Добавьте этот код в конец main():

std::string containerName = "myblobcontainer";
auto containerClient = blobServiceClient.GetBlobContainerClient("myblobcontainer");

// Create the container if it does not exist
std::cout << "Creating container: " << containerName << std::endl;
containerClient.CreateIfNotExists();

Загрузить блобы в контейнер

Следующий фрагмент кода:

1. Объявляет строку, содержащую "Привет Azure!"
2. Возвращает ссылку на объект BlockBlobClient путем вызова GetBlockBlobClient в контейнере из раздела "Создание контейнера".
3. Загружает строку в BLOB, вызвав функцию UploadFrom. Эта функция создает большой двоичный объект, если он еще не существует, или обновляет его, если он существует.

Добавьте этот код в конец main():

std::string blobName = "blob.txt";
uint8_t blobContent[] = "Hello Azure!";
// Create the block blob client
BlockBlobClient blobClient = containerClient.GetBlockBlobClient(blobName);

// Upload the blob
std::cout << "Uploading blob: " << blobName << std::endl;
blobClient.UploadFrom(blobContent, sizeof(blobContent));

Перечислите объекты BLOB в контейнере

Перечислите объекты blob в контейнере, вызвав функцию ListBlobs. В контейнер был добавлен только один объект, поэтому операция возвращает только его.

Добавьте этот код в конец main():

std::cout << "Listing blobs..." << std::endl;
auto listBlobsResponse = containerClient.ListBlobs();
for (auto blobItem : listBlobsResponse.Blobs)
{
    std::cout << "Blob name: " << blobItem.Name << std::endl;
}

Загрузка больших двоичных объектов

Получите свойства загруженного BLOB. Затем объявите и измените размер нового std::vector<uint8_t> объекта, используя свойства загруженного файла BLOB. Загрузите ранее созданный BLOB в новый объект std::vector<uint8_t>, вызвав функцию DownloadTo в базовом классе BlobClient. Наконец, отобразите скачанные данные объекта BLOB.

Добавьте этот код в конец main():

auto properties = blobClient.GetProperties().Value;
std::vector<uint8_t> downloadedBlob(properties.BlobSize);

blobClient.DownloadTo(downloadedBlob.data(), downloadedBlob.size());
std::cout << "Downloaded blob contents: " << std::string(downloadedBlob.begin(), downloadedBlob.end()) << std::endl;

Удаление BLOB

Следующий код удаляет BLOB-объект из контейнера хранилища BLOB-объектов Azure, используя функцию BlobClient.Delete.

std::cout << "Deleting blob: " << blobName << std::endl;
blobClient.Delete();

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

Следующий код очищает ресурсы, созданные приложением, удалив весь контейнер с помощью BlobContainerClient.Удаление.

Добавьте этот код в конец main():

std::cout << "Deleting container: " << containerName << std::endl;
containerClient.Delete();

Выполнение кода

Это приложение создает контейнер и отправляет текстовый файл в хранилище BLOB-объектов Azure. Затем в примере перечисляются объекты данных в контейнере, загружается файл и отображается его содержимое. Наконец, приложение удаляет blob и контейнер.

Результат работы приложения будет похож на следующий пример.

Azure Blob Storage - C++ quickstart sample
Creating container: myblobcontainer
Uploading blob: blob.txt
Listing blobs...
Blob name: blob.txt
Downloaded blob contents: Hello Azure!
Deleting blob: blob.txt
Deleting container: myblobcontainer

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

Из этого краткого руководства вы узнали, как отправлять, скачивать и перечислять большие двоичные объекты с помощью C++. Вы также узнали, как создать и удалить контейнер хранилища BLOB-объектов Azure.

Чтобы просмотреть пример хранилища BLOB-объектов C++, перейдите к следующему: