aio Paquet

  • Référence

Classes

BlobClient

Client pour interagir avec un objet blob spécifique, bien que cet objet blob n’existe pas encore.
BlobLeaseClient

Crée un objet BlobLeaseClient.

Ce client fournit des opérations de bail sur un BlobClient ou ContainerClient.
BlobPrefix

Itérable de propriétés d’objet blob.

Retourné par walk_blobs lorsqu’un délimiteur est utilisé. Peut être considéré comme un répertoire d’objets blob virtuel.
BlobServiceClient

Client pour interagir avec le service Blob au niveau du compte.

Ce client fournit des opérations pour récupérer et configurer les propriétés du compte, ainsi que pour répertorier, créer et supprimer des conteneurs dans le compte. Pour les opérations relatives à un conteneur ou à un objet blob spécifique, les clients de ces entités peuvent également être récupérés à l’aide des fonctions get_client .
ContainerClient

Un client pour interagir avec un conteneur spécifique, bien que ce conteneur n’existe pas encore.

Pour les opérations relatives à un objet blob spécifique dans ce conteneur, un client d’objet blob peut être récupéré à l’aide de la get_blob_client fonction .
ExponentialRetry

Nouvelle tentative exponentielle.

Construit un objet de nouvelle tentative exponentielle. Le initial_backoff est utilisé pour la première tentative. Les nouvelles tentatives suivantes sont retentées après initial_backoff + increment_power^retry_count secondes. Par exemple, par défaut, la première tentative se produit après 15 secondes, la seconde après (15+3^1) = 18 secondes et la troisième après (15+3^2) = 24 secondes.
LinearRetry

Nouvelle tentative linéaire.

Construit un objet de nouvelle tentative linéaire.
StorageStreamDownloader

Objet de diffusion en continu à télécharger à partir du Stockage Azure.

Fonctions

download_blob_from_url

Téléchargez le contenu d’un objet blob dans un fichier ou un flux local.

async download_blob_from_url(blob_url: str, output: str, credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> None

Paramètres

blob_url
str
Obligatoire

URI complet de l’objet blob. Cela peut également inclure un jeton SAS.

output
str ou <xref:<xref:writable stream>>
Obligatoire

Où les données doivent être téléchargées. Il peut s’agir d’un chemin de fichier dans lequel écrire ou d’un handle d’E/S ouvert dans lequel écrire.

credential
valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL de l’objet blob a déjà un jeton SAS ou si l’objet blob est public. La valeur peut être une chaîne de jeton SAS, une instance d’azureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials à partir d’azure.identity. Si l’URI de ressource contient déjà un jeton SAS, celui-ci est ignoré au profit d’informations d’identification explicites.

  • sauf dans le cas d’AzureSasCredential, où les jetons SAP en conflit déclenchent un ValueError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé de compte de stockage.
overwrite
bool

Indique si le fichier local doit être remplacé s’il existe déjà. La valeur par défaut est False . Dans ce cas, une erreur ValueError est déclenchée si le fichier existe déjà. Si la valeur est True, une tentative d’écriture est effectuée dans le fichier existant. Si un handle de flux est passé, cette valeur est ignorée.

max_concurrency
int

Nombre de connexions parallèles à télécharger.

offset
int

Début de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Doit être défini si la longueur est fournie.

length
int

Nombre d’octets à lire à partir du flux. Cette option est facultative, mais doit être fournie pour des performances optimales.

validate_content
bool

Si la valeur est true, calcule un hachage MD5 pour chaque segment de l’objet blob. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob. Notez également que, s’il est activé, l’algorithme de chargement à haut rendement en mémoire ne sera pas utilisé, car le calcul du hachage MD5 nécessite la mise en mémoire tampon de blocs entiers, ce qui va à l’encontre de l’objectif de l’algorithme économe en mémoire.

Type de retour

None

upload_blob_to_url

Charger des données vers une URL donnée

Les données seront chargées en tant qu’objet blob de blocs.

param str blob_url : URI complet de l’objet blob. Cela peut également inclure un jeton SAS.

données param : données à charger. Il peut s’agir d’octets, de texte, d’un objet itérable ou d’un fichier.

données de type : octets ou str ou itérable

async upload_blob_to_url(blob_url: str, data: Union[Iterable[AnyStr], IO[AnyStr]], credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> dict[str, Any]

Paramètres

credential
valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL de l’objet blob a déjà un jeton SAS. La valeur peut être une chaîne de jeton SAS, une instance d’azureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials à partir d’azure.identity. Si l’URI de ressource contient déjà un jeton SAS, celui-ci est ignoré au profit d’informations d’identification explicites.

  • sauf dans le cas d’AzureSasCredential, où les jetons SAP en conflit déclenchent un ValueError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé de compte de stockage.

paramtype credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, « TokenCredential"]] # pylint: disable=line-too-long

mot clé remplacement bool : indique si l’objet blob à charger doit remplacer les données actuelles. Si la valeur est True, upload_blob_to_url remplacera toutes les données existantes. Si la valeur est False, l’opération échoue avec un ResourceExistsError.

mot clé int max_concurrency : nombre de connexions parallèles à télécharger.

mot clé longueur int : nombre d’octets à lire à partir du flux. Cette option est facultative, mais doit être fournie pour des performances optimales.

mot clé métadonnées dict(str,str) : paires nom-valeur associées à l’objet blob en tant que métadonnées.

mot clé bool validate_content : si la valeur est true, calcule un hachage MD5 pour chaque segment de l’objet blob. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob. Notez également que, s’il est activé, l’algorithme de chargement à haut rendement en mémoire ne sera pas utilisé, car le calcul du hachage MD5 nécessite la mise en mémoire tampon de blocs entiers, ce qui va à l’encontre de l’objectif de l’algorithme économe en mémoire.

encodage mot clé str : encodage à utiliser si du texte est fourni comme entrée. La valeur par défaut est UTF-8.

retourne : dictée de propriété mise à jour d’objet blob (Etag et dernière modification)

rtype : dict(str, Any)

blob_url
data