Démarrage rapide : Bibliothèque cliente de stockage Blob Azure pour C++

Commencez avec la bibliothèque cliente Azure Blob Storage pour C++. Azure Blob Storage est la solution de stockage d’objets de Microsoft pour le cloud. Suivez ces étapes pour installer le package et essayer un exemple de code pour les tâches de base.

| Documentation de référence sur l’API | Code source de la bibliothèque | Exemples |

Prerequisites

• Abonnement Azure : créez-en un gratuitement
• Compte de stockage Azure : créez un compte de stockage
• Compilateur C++
• CMake
• vcpkg - Gestionnaire de package C et C++

Configuration

Cette section vous guide tout au long de la préparation d’un projet pour travailler avec la bibliothèque cliente Stockage Blob Azure pour C++. Le moyen le plus simple d’acquérir le Kit de développement logiciel (SDK) Azure pour C++ consiste à utiliser le gestionnaire de vcpkg package.

Installer les packages

Utilisez la vcpkg install commande pour installer la bibliothèque Stockage Blob Azure pour C++ et les dépendances nécessaires :

vcpkg.exe install azure-storage-blobs-cpp

La bibliothèque Azure Identity est nécessaire pour les connexions sans mot de passe aux services Azure :

vcpkg.exe install azure-identity-cpp

Pour plus d’informations sur la configuration du projet et l’utilisation du Kit de développement logiciel (SDK) Azure pour C++, consultez le fichier lisez-moi du Kit de développement logiciel (SDK) Azure pour C++.

Créer le projet

Dans Visual Studio, créez une application console C++ pour Windows appelée BlobQuickstart.

Modèle d'objet

Stockage Blob Azure est optimisé pour stocker des quantités massives de données non structurées. Les données non structurées sont des données qui ne respectent pas un modèle ou une définition de données particulier, telles que des données texte ou binaires. Le Stockage Blob offre trois types de ressources :

• Le compte de stockage
• Conteneur dans le compte de stockage
• Blob dans le conteneur

Le diagramme suivant montre la relation entre ces ressources.

Utilisez ces classes C++ pour interagir avec ces ressources :

• BlobServiceClient : La classe BlobServiceClient permet la manipulation des ressources Azure Storage et des conteneurs d’objets blob.
• BlobContainerClient : la BlobContainerClient classe vous permet de manipuler des conteneurs stockage Azure et leurs objets blob.
• BlobClient : La BlobClient classe vous permet de manipuler des objets blob stockage Azure. Il s’agit de la classe de base pour toutes les classes spécialisées de blob.
• BlockBlobClient : La BlockBlobClient classe vous permet de manipuler des objets blob de blocs stockage Azure.

Exemples de code

Ces exemples d’extraits de code vous montrent comment effectuer les tâches suivantes avec la bibliothèque cliente Stockage Blob Azure pour C++ :

• Ajouter des fichiers include
• S’authentifier auprès d’Azure et autoriser l’accès aux données blob
• Créer un conteneur
• Télécharger des blobs dans un conteneur
• Lister les blobs dans un conteneur
• Télécharger des blobs
• Supprimer un conteneur

Ajouter des fichiers include

À partir du répertoire de projet :

1. Ouvrir le fichier de solution BlobQuickstart.sln dans Visual Studio
2. Dans Visual Studio, ouvrez le fichier source BlobQuickstart.cpp
3. Supprimer tout code à l’intérieur main qui a été généré automatiquement
4. Ajouter les déclarations #include et 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;

S’authentifier auprès d’Azure et autoriser l’accès aux données blob

Les demandes d’application adressées au Stockage Blob Azure doivent être autorisées. L’utilisation de la DefaultAzureCredential classe fournie par la bibliothèque de client Azure Identity est l’approche recommandée pour implémenter des connexions sans mot de passe aux services Azure dans votre code, notamment le Stockage Blob.

Vous pouvez également autoriser les demandes adressées au Stockage Blob Azure à l’aide de la clé d’accès au compte. Toutefois, cette approche doit être utilisée avec précaution. Les développeurs doivent être attentifs à ne jamais exposer la clé d’accès dans un emplacement non sécurisé. Toute personne disposant de la clé d’accès est en mesure d’autoriser les demandes sur le compte de stockage et a accès efficacement à toutes les données. DefaultAzureCredential offre des avantages de gestion et de sécurité améliorés sur la clé de compte pour autoriser l’authentification sans mot de passe. Les deux options sont illustrées dans l’exemple suivant.

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

Créer un conteneur

Choisissez un nom pour le nouveau conteneur. Créez ensuite une instance du BlobContainerClient conteneur et créez-le.

Ajoutez ce code à la fin de 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();

Charger des objets blob sur un conteneur

L’extrait de code suivant :

1. Déclare une chaîne contenant « Hello Azure! ».
2. Obtient une référence à un objet BlockBlobClient en appelant GetBlockBlobClient sur le conteneur à partir de la section Créer un conteneur .
3. Transfère la chaîne vers le blob en utilisant la fonction UploadFrom. Cette fonction crée l’objet blob s’il n’existe pas déjà ou le met à jour s’il le fait.

Ajoutez ce code à la fin de 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));

Créer la liste des objets blob d’un conteneur

Répertoriez les objets blob dans le conteneur en appelant la fonction ListBlobs . Un seul objet blob a été ajouté au conteneur. L’opération retourne donc uniquement cet objet blob.

Ajoutez ce code à la fin de main():

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

Télécharger des objets blob

Obtenez les propriétés de l'objet blob téléchargé. Ensuite, déclarez et redimensionnez un nouvel std::vector<uint8_t> objet à l’aide des propriétés de l’objet blob chargé. Téléchargez l’objet blob créé précédemment dans le nouvel std::vector<uint8_t> objet en appelant la fonction DownloadTo dans la classe de base BlobClient . Enfin, affichez les données de l’objet blob téléchargé.

Ajoutez ce code à la fin de 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;

Supprimer un Blob

Le code suivant supprime l’objet blob du conteneur Stockage Blob Azure en appelant la fonction BlobClient.Delete .

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

Supprimer un conteneur

Le code suivant nettoie les ressources créées par l’application en supprimant l’intégralité du conteneur à l’aide de BlobContainerClient.Supprimez.

Ajoutez ce code à la fin de main():

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

Exécuter le code

Cette application crée un conteneur et charge un fichier texte dans stockage Blob Azure. L’exemple répertorie ensuite les objets blob dans le conteneur, télécharge le fichier et affiche le contenu du fichier. Enfin, l’application supprime l’objet blob et le conteneur.

La sortie de l’application est similaire à l’exemple suivant :

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

Étapes suivantes

Dans ce guide de démarrage rapide, vous avez appris à charger, télécharger et répertorier des objets blob à l’aide de C++. Vous avez également appris à créer et supprimer un conteneur Stockage Blob Azure.

Pour afficher un exemple de stockage Blob C++, passez à :