Bien démarrer avec le service Stockage Blob Azure et Python

Article
10/02/2024

Cet article vous montre comment vous connecter au service Stockage Blob Azure à l’aide de la bibliothèque de client Stockage Blob Azure pour Python. Une fois la connexion établie, votre code peut opérer sur les conteneurs, les blobs et les fonctionnalités du service Stockage Blob Azure.

Référence API | Package (PyPi) | Code source de la bibliothèque | Échantillons | Envoyer des commentaires

Prérequis

Abonnement Azure : créez-en un gratuitement
Compte de stockage Azure : créez un compte de stockage
Python 3.8+

Configuration de votre projet

Cette section vous guide tout au long de la préparation d’un projet à utiliser avec la bibliothèque de client Stockage Blob Azure pour Python.

À partir du répertoire du projet, installez les packages des bibliothèques de client Stockage Blob Azure et Azure Identity à l’aide de la commande pip install. Le package azure-identity est nécessaire pour les connexions sans mot de passe aux services Azure.

pip install azure-storage-blob azure-identity

Ouvrez ensuite votre fichier de code, et ajoutez les instructions import nécessaires. Dans cet exemple, nous ajoutons ce qui suit à notre fichier .py :

from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient, BlobClient, ContainerClient

Informations sur la bibliothèque de client de blob :

azure.storage.blob : contient les classes primaires (objets clients) qui vous permettent d’effectuer des opérations sur le service, les conteneurs et les objets blob.

Programmation asynchrone

La bibliothèque cliente Stockage Blob Azure pour Python prend en charge les APIs synchrones et asynchrones. Les API asynchrones sont basées sur la bibliothèque asyncio python.

Procédez comme suit pour utiliser les API asynchrones dans votre projet :

Installez un transport asynchrone, tel que aiohttp. Vous pouvez installer aiohttp avec azure-storage-blob à l’aide d’une commande d’installation de dépendance facultative. Dans cet exemple, nous utilisons la commande pip install suivante :
```
pip install azure-storage-blob[aio]
```
Ouvrez votre fichier de code, et ajoutez les instructions import nécessaires. Dans cet exemple, nous ajoutons ce qui suit à notre fichier .py :
```
import asyncio

from azure.identity.aio import DefaultAzureCredential
from azure.storage.blob.aio import BlobServiceClient, BlobClient, ContainerClient
```
L’instruction import asyncio n’est requise que si vous utilisez la bibliothèque dans votre code. Il est ajouté ici pour plus de clarté, car les exemples des articles du guide des développeurs utiliser la bibliothèque de asyncio.
Créez un objet client à l’aide de async with pour commencer à utiliser des ressources de données. Seul le client de niveau supérieur doit utiliser async with, car d’autres clients créés à partir de celui-ci partagent le même pool de connexions. Dans cet exemple, nous créons un objet BlobServiceClient à l’aide de async with, puis créons un objet ContainerClient :
```
async with BlobServiceClient(account_url, credential=credential) as blob_service_client:
    container_client = blob_service_client.get_container_client(container="sample-container")
```
Pour plus d’informations, consultez les exemples asynchrones de Autoriser l’accès et vous connecter au stockage Blob.

Informations sur la bibliothèque asynchrone du client de blob :

azure.storage.blob : contient les classes primaires qui vous permettent d’effectuer des opérations sur le service, les conteneurs et les objets blob de façon asynchrone.

Autoriser l’accès et la connexion au Stockage Blob

Pour connecter une application au stockage Blob, créez une instance de la classe BlobServiceClient. Cet objet est votre point de départ pour interagir avec les ressources de données au niveau du compte de stockage. Vous pouvez l’utiliser pour opérer sur le compte de stockage et ses conteneurs. Vous pouvez également utiliser le client de service pour créer des clients de conteneurs ou des clients d’objets blob, en fonction de la ressource que vous devez utiliser.

Pour en savoir plus sur la création et la gestion d’objets clients, incluant les meilleures pratiques, consultez Créer et gérer des objets clients qui interagissent avec les ressources de données.

Vous pouvez autoriser un objet BlobServiceClient en utilisant un jeton d’autorisation Microsoft Entra, une clé d’accès au compte ou une signature d’accès partagé (SAP). Pour une sécurité optimale, Microsoft recommande d’utiliser Microsoft Entra ID avec des identités managées pour autoriser les requêtes sur les données d’objet blob. Pour plus d’informations, consultez Autoriser l’accès aux objets blob avec Microsoft Entra ID.

Pour autoriser avec Microsoft Entra ID, vous devez utiliser un principal de sécurité. Le type de principal de sécurité dont vous avez besoin dépend de l’emplacement d’exécution de votre application. Utilisez le tableau suivant comme guide :

Où l’application s’exécute	Principal de sécurité	Assistance
Ordinateur local (développement et test)	Principal du service	Pour découvrir comment inscrire l’application, configurer un groupe Microsoft Entra, attribuer des rôles et configurer des variables d’environnement, consultez Autoriser l’accès à l’aide de principaux de service de développeur
Ordinateur local (développement et test)	Identité de l’utilisateur	Pour découvrir comment configurer un groupe Microsoft Entra, attribuer des rôles et se connecter à Azure, consultez Autoriser l’accès à l’aide des informations d’identification du développeur
Hébergé dans Azure	Identité managée	Pour savoir comment activer une identité managée et attribuer des rôles, consultez Autoriser l’accès à partir d’applications hébergées sur Azure en utilisant une identité managée.
Hébergé en dehors d’Azure (par exemple, des applications locales)	Principal du service	Pour savoir comment inscrire l’application, attribuer des rôles et configurer des variables d’environnement, consultez Autoriser l’accès à partir d’applications locales en utilisant un principal de service d’application.

Autoriser l’accès en utilisant DefaultAzureCredential

Un moyen simple et facile d’autoriser l’accès et de se connecter au Stockage Blob consiste à obtenir un jeton OAuth en créant une instance DefaultAzureCredential. Vous pouvez ensuite utiliser ces informations d’identification pour créer un objet BlobServiceClient.

L’exemple suivant crée un objet BlobServiceClient à l’aide de DefaultAzureCredential :

def get_blob_service_client_token_credential(self):
    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    credential = DefaultAzureCredential()

    # Create the BlobServiceClient object
    blob_service_client = BlobServiceClient(account_url, credential=credential)

    return blob_service_client

Si votre projet utilise des API asynchrones, instanciez BlobServiceClient à l’aide de async with :

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"
credential = DefaultAzureCredential()

async with BlobServiceClient(account_url, credential=credential) as blob_service_client:
    # Work with data resources in the storage account

Pour utiliser un jeton SAS (signature d’accès partagé), fournissez celui-ci sous forme de chaîne, puis initialisez un objet BlobServiceClient. Si l’URL de votre compte inclut le jeton SAS, omettez le paramètre des informations d’identification.

def get_blob_service_client_sas(self, sas_token: str):
    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    # The SAS token string can be assigned to credential here or appended to the account URL
    credential = sas_token

    # Create the BlobServiceClient object
    blob_service_client = BlobServiceClient(account_url, credential=credential)

    return blob_service_client

Si votre projet utilise des API asynchrones, instanciez BlobServiceClient à l’aide de async with :

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"

# Replace <sas_token_str> with your actual SAS token
sas_token: str = "<sas_token_str>"

async with BlobServiceClient(account_url, credential=sas_token) as blob_service_client:
    # Work with data resources in the storage account

Pour en savoir plus sur la génération et la gestion des jetons SAP, consultez les articles suivants :

Remarque

Pour les scénarios où les signatures d’accès partagé (SAP) sont utilisées, Microsoft recommande d’utiliser une SAP de délégation d’utilisateur. Une SAP de délégation d’utilisateur est sécurisée avec des informations d’identification Microsoft Entra au lieu de la clé de compte.

Pour utiliser une clé partagée de compte de stockage, fournissez la clé sous forme de chaîne, puis initialisez un objet BlobServiceClient.

def get_blob_service_client_account_key(self):
    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    shared_access_key = os.getenv("AZURE_STORAGE_ACCESS_KEY")
    credential = shared_access_key

    # Create the BlobServiceClient object
    blob_service_client = BlobServiceClient(account_url, credential=credential)

    return blob_service_client

Vous pouvez également créer un objet BlobServiceClient avec une chaîne de connexion.

def get_blob_service_client_connection_string(self):
    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    connection_string = os.getenv("AZURE_STORAGE_CONNECTION_STRING")

    # Create the BlobServiceClient object
    blob_service_client = BlobServiceClient.from_connection_string(connection_string)

    return blob_service_client

Si votre projet utilise des API asynchrones, instanciez BlobServiceClient à l’aide de async with :

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"

shared_access_key = os.getenv("AZURE_STORAGE_ACCESS_KEY")

async with BlobServiceClient(account_url, credential=shared_access_key) as blob_service_client:
    # Work with data resources in the storage account

Pour plus d’informations sur la façon d’obtenir des clés de compte et découvrir les meilleures pratiques pour gérer et protéger correctement vos clés, consultez Gérer les clés d’accès au compte de stockage.

Important

La clé d’accès au compte doit être utilisée avec précaution. Si votre clé d’accès de compte est perdue ou accidentellement placée dans un emplacement non sécurisé, votre service peut devenir vulnérable. 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 et des fonctionnalités de sécurité améliorées, et est l’approche recommandée pour la gestion de l’autorisation auprès des services Azure.

Générer votre application

Lorsque vous créez des applications pour travailler avec des ressources de données dans stockage Blob Azure, votre code interagit principalement avec trois types de ressources : comptes de stockage, conteneurs et objets blob. Si vous souhaitez en savoir plus sur ces types de ressources, sur leurs liens entre eux et sur l’interaction des applications avec les ressources, veuillez consulter la rubrique Comprendre comment les applications interagissent avec les ressources de données du Stockage Blob.

Les guides suivants vous montrent comment accéder aux données et effectuer des actions spécifiques à l’aide de la bibliothèque cliente Stockage Azure pour Python :

Guide	Description
Configurer une stratégie de nouvelle tentative	Implémentez des stratégies de nouvelle tentative pour les opérations du client.
Copier des objets blob	Copiez un blob d’un emplacement à un autre.
Créer un conteneur	Créer des conteneurs d’objets blob.
Créer une SAP de délégation d’utilisateur	Créez une SAP de délégation d’utilisateur pour un conteneur ou un blob.
Créer et gérer des baux de blob	Établissez et gérez un verrou sur un blob.
Créer et gérer des baux de conteneur	Établissez et gérez un verrou sur un conteneur.
Supprimer et restaurer des blobs	Supprimez des objets blob et restaurez des objets blob supprimés de manière réversible.
Supprimer et restaurer des conteneurs	Supprimez des conteneurs et restaurez des conteneurs supprimés de manière réversible.
Télécharger des objets blob	Téléchargez des blobs à l’aide de chaînes, de flux et de chemins d’accès de fichiers.
Rechercher des blobs à l’aide d’étiquettes	Définissez et récupérez des étiquettes, puis utilisez-les pour rechercher des objets blob.
Lister des objets blob	Répertoriez les blobs de différentes façons.
Lister des conteneurs	Répertoriez les conteneurs dans un compte et les différentes options disponibles pour personnaliser une liste.
Gérer les propriétés et les métadonnées (blobs)	Obtenez et définissez des propriétés et des métadonnées pour des blobs.
Gérer les propriétés et les métadonnées (conteneurs)	Obtenez et définissez les propriétés et les métadonnées pour des conteneurs.
Réglage des performances pour les transferts de données	Optimiser les performances des opérations de transfert de données.
Définissez le niveau d’accès d’un blob	Définissez ou modifiez le niveau d’accès d’un objet blob de blocs.
Charger des objets blob	Découvrez comment charger des blobs à l’aide de chaînes, de flux, de chemins d’accès de fichiers et d’autres méthodes.

Partager via

Bien démarrer avec le service Stockage Blob Azure et Python

Prérequis

Configuration de votre projet

Programmation asynchrone

Autoriser l’accès et la connexion au Stockage Blob

Autoriser l’accès en utilisant DefaultAzureCredential

Générer votre application

Commentaires

Ressources supplémentaires