ContainerClient Classe

Référence

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 .

Pour une configuration plus facultative, cliquez ici.

Héritage: azure.storage.blob._shared.base_client.StorageAccountHostsMixin

ContainerClient

azure.storage.blob._encryption.StorageEncryptionMixin

ContainerClient

Constructeur

ContainerClient(account_url: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Paramètres

account_url: str

Obligatoire

URI du compte de stockage. Pour créer un client en fonction de l’URI complet du conteneur, utilisez le from_container_url classmethod.

container_name: str

Obligatoire

Nom du conteneur pour l’objet blob.

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cette option est facultative si l’URL du compte a déjà un jeton SAP. La valeur peut être une chaîne de jeton SAS, une instance d’une classe AzureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials d’azure.identity. Si l’URI de ressource contient déjà un jeton SAP, 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 une ValeurError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé du compte de stockage.

api_version: str

Version de l’API de stockage à utiliser pour les requêtes. La valeur par défaut est la version de service la plus récente compatible avec le KIT de développement logiciel (SDK) actuel. La définition d’une version antérieure peut entraîner une compatibilité des fonctionnalités réduite.

Nouveautés de la version 12.2.0.

secondary_hostname: str

Nom d’hôte du point de terminaison secondaire.

max_block_size: int

Taille de segment maximale pour le chargement d’un objet blob de blocs en blocs. La valeur par défaut est 4*1024*1024 ou 4 Mo.

max_single_put_size: int

Si la taille de l’objet blob est inférieure ou égale max_single_put_size, l’objet blob est chargé avec une seule requête HTTP PUT. Si la taille de l’objet blob est supérieure à max_single_put_size, l’objet blob est chargé en blocs. La valeur par défaut est 64*1024*1024 ou 64 Mo.

min_large_block_upload_threshold: int

Taille de segment minimale requise pour utiliser l’algorithme mémoire efficace lors du chargement d’un objet blob de blocs. La valeur par défaut est 4*1024*1024+1.

use_byte_buffer: bool

Utilisez une mémoire tampon d’octets pour les chargements d’objets blob de blocs. Valeur par défaut False.

max_page_size: int

Taille de segment maximale pour le chargement d’un objet blob de pages. La valeur par défaut est 4*1024*1024 ou 4 Mo.

max_single_get_size: int

Taille maximale d’un objet blob à télécharger en un seul appel, la partie dépassée est téléchargée en blocs (peut être parallèle). La valeur par défaut est 32*1024*1024 ou 32 Mo.

max_chunk_get_size: int

Taille de segment maximale utilisée pour le téléchargement d’un objet blob. La valeur par défaut est 4*1024*1024 ou 4 Mo.

Méthodes

acquire_lease	Demande un nouveau bail. Si le conteneur n'a pas de bail actif, le service BLOB crée un bail dans le conteneur et retourne un nouvel ID de bail.
close	Cette méthode consiste à fermer les sockets ouverts par le client. Il n’a pas besoin d’être utilisé lors de l’utilisation avec un gestionnaire de contexte.
create_container	Crée un conteneur sous le compte spécifié. Si un conteneur portant le même nom existe déjà, l'opération échoue.
delete_blob	Marque l’objet blob ou le instantané spécifié pour suppression. L'objet blob est ensuite supprimé lors du garbage collection. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération delete_blob. Si une stratégie de rétention de suppression est activée pour le service, cette opération supprime l’objet blob ou le instantané et conserve l’objet blob ou le instantané pendant un nombre de jours spécifié. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. Les objets blob ou les instantané supprimés de manière réversible sont accessibles en list_blobs spécifiant l’option include=["deleted"]. L’objet blob ou les instantané supprimés de manière réversible peuvent être restaurés à l’aide de<xref:azure.storage.blob.BlobClient.undelete>
delete_blobs	Marque les objets blob ou les instantanés spécifiés pour suppression. Les objets blob sont supprimés ultérieurement pendant le garbage collection. Notez que pour supprimer des objets blob, vous devez supprimer tous leurs instantanés. Vous pouvez supprimer les deux en même temps avec l’opération delete_blobs. Si une stratégie de rétention de suppression est activée pour le service, cette opération réversible supprime les objets blob ou les instantanés et conserve les objets blob ou les instantanés pendant un nombre de jours spécifié. Après le nombre de jours spécifié, les données des objets blob sont supprimées du service pendant le garbage collection. Les objets blob ou les instantanés supprimés de manière réversible sont accessibles en list_blobs spécifiant include=["deleted"] Les objets blob supprimés de manière réversible ou les instantanés peuvent être restaurés à l’aide de <xref:azure.storage.blob.BlobClient.undelete> Le nombre maximal d’objets blob pouvant être supprimés dans une requête unique est de 256.
delete_container	Marque le conteneur spécifié pour suppression. Le conteneur et les objets blob contenus dans ce conteneur sont supprimés lors du garbage collection.
download_blob	Télécharge un objet blob dans StorageStreamDownloader. La méthode readall() doit être utilisée pour lire tout le contenu ou readinto() doit être utilisée pour télécharger l’objet blob dans un flux. L’utilisation de chunks() retourne un itérateur qui permet à l’utilisateur d’itérer sur le contenu en blocs.
exists	Retourne La valeur True si un conteneur existe et la valeur False dans le cas contraire.
find_blobs_by_tags	Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié dont les balises correspondent à l’expression de recherche donnée. Le générateur suit tardivement les jetons de continuation retournés par le service.
from_connection_string	Créez ContainerClient à partir d’une chaîne de connexion.
from_container_url	Créez ContainerClient à partir d’une URL de conteneur.
get_account_information	Obtient des informations relatives au compte de stockage. Les informations peuvent également être récupérées si l’utilisateur dispose d’une signature d’accès partagé à un conteneur ou à un objet blob. Les clés du dictionnaire retourné incluent « sku_name » et « account_kind ».
get_blob_client	Obtenir un client pour interagir avec l’objet blob spécifié. L’objet blob n’a pas besoin d’exister.
get_container_access_policy	Obtient les autorisations pour le conteneur spécifié. Les autorisations indiquent si les données de conteneur sont accessibles publiquement.
get_container_properties	Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le conteneur spécifié. Les données renvoyées ne comprennent pas la liste d'objets blob du conteneur.
list_blob_names	Retourne un générateur pour répertorier les noms des objets blob sous le conteneur spécifié. Le générateur suit tardivement les jetons de continuation retournés par le service. Notez qu’aucune propriété ou métadonnées supplémentaires ne sera retournée lors de l’utilisation de cette API. En outre, cette API n’a pas la possibilité d’inclure des objets blob supplémentaires tels que des instantanés, des versions, des objets blob supprimés de manière réversible, etc. Pour obtenir l’une de ces données, utilisez list_blobs.
list_blobs	Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié. Le générateur suit tardivement les jetons de continuation retournés par le service.
set_container_access_policy	Définit les autorisations pour le conteneur spécifié ou les stratégies d’accès stockées qui peuvent être utilisées avec les signatures d’accès partagé. Les autorisations indiquent si les objets blob dans un conteneur sont accessibles publiquement.
set_container_metadata	Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le conteneur spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au conteneur. Pour supprimer toutes les métadonnées du conteneur, appelez cette opération sans dictée de métadonnées.
set_premium_page_blob_tier_blobs	Définit les niveaux d’objet blob de page sur tous les objets blob. Cette API est uniquement prise en charge pour les objets blob de pages sur les comptes Premium. Le nombre maximal d’objets blob pouvant être mis à jour dans une requête unique est de 256.
set_standard_blob_tier_blobs	Cette opération définit le niveau sur les objets blob de blocs. Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob. Le nombre maximal d’objets blob pouvant être mis à jour dans une requête unique est de 256.
upload_blob	Crée un objet blob à partir d’une source de données avec segmentation automatique.
walk_blobs	Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié. Le générateur suit tardivement les jetons de continuation retournés par le service. Cette opération répertorie les objets blob conformément à une hiérarchie, comme délimité par le caractère de délimiteur spécifié.

acquire_lease

Demande un nouveau bail. Si le conteneur n'a pas de bail actif, le service BLOB crée un bail dans le conteneur et retourne un nouvel ID de bail.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> BlobLeaseClient

Paramètres

lease_duration: int

Obligatoire

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail infini).

lease_id: str

Obligatoire

ID de bail proposé, dans un format de chaîne GUID. Le service Blob retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Objet BlobLeaseClient, qui peut être exécuté dans un gestionnaire de contexte.

Type de retour

BlobLeaseClient

close

Cette méthode consiste à fermer les sockets ouverts par le client. Il n’a pas besoin d’être utilisé lors de l’utilisation avec un gestionnaire de contexte.

close()

create_container

Crée un conteneur sous le compte spécifié. Si un conteneur portant le même nom existe déjà, l'opération échoue.

create_container(metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Paramètres

metadata: dict[str, str]

Obligatoire

dict avec name_value paires à associer au conteneur en tant que métadonnées. Exemple :{'Category':'test'}

public_access: PublicAccess

Obligatoire

Les valeurs possibles sont les suivantes : 'container', 'blob'.

container_encryption_scope: dict ou ContainerEncryptionScope

Spécifie l’étendue de chiffrement par défaut à définir sur le conteneur et à utiliser pour toutes les écritures ultérieures.

Nouveautés de la version 12.2.0.

timeout: int

Retours

Dictionnaire d’en-têtes de réponse.

Type de retour

Dict[str, Union[str, datetime]]

delete_blob

Marque l’objet blob ou le instantané spécifié pour suppression.

L'objet blob est ensuite supprimé lors du garbage collection. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération delete_blob.

Si une stratégie de rétention de suppression est activée pour le service, cette opération supprime l’objet blob ou le instantané et conserve l’objet blob ou le instantané pendant un nombre de jours spécifié. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. Les objets blob ou les instantané supprimés de manière réversible sont accessibles en list_blobs spécifiant l’option include=["deleted"]. L’objet blob ou les instantané supprimés de manière réversible peuvent être restaurés à l’aide de<xref:azure.storage.blob.BlobClient.undelete>

delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None

Paramètres

blob: str ou BlobProperties

Obligatoire

Objet blob avec lequel interagir. Si elle est spécifiée, cette valeur remplace une valeur d’objet blob spécifiée dans l’URL de l’objet blob.

delete_snapshots: str

Obligatoire

Obligatoire si l'objet blob a des instantanés associés. Ces valeurs comprennent :

« only » : supprime uniquement les instantanés d’objets blob.
« include » : supprime l’objet blob ainsi que tous les instantanés.

version_id: str

Le paramètre d’id de version est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie la version de l’objet blob à supprimer.

Nouveautés de la version 12.4.0.

Cet argument mot clé a été introduit dans la version de l’API « 2019-12-12 ».

lease: BlobLeaseClient ou str

Obligatoire si l'objet blob a un bail actif. La valeur peut être un objet BlobLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

if_unmodified_since: datetime

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition: str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout: int

Type de retour

None

delete_blobs

Marque les objets blob ou les instantanés spécifiés pour suppression.

Les objets blob sont supprimés ultérieurement pendant le garbage collection. Notez que pour supprimer des objets blob, vous devez supprimer tous leurs instantanés. Vous pouvez supprimer les deux en même temps avec l’opération delete_blobs.

Si une stratégie de rétention de suppression est activée pour le service, cette opération réversible supprime les objets blob ou les instantanés et conserve les objets blob ou les instantanés pendant un nombre de jours spécifié. Après le nombre de jours spécifié, les données des objets blob sont supprimées du service pendant le garbage collection. Les objets blob ou les instantanés supprimés de manière réversible sont accessibles en list_blobs spécifiant include=["deleted"] Les objets blob supprimés de manière réversible ou les instantanés peuvent être restaurés à l’aide de <xref:azure.storage.blob.BlobClient.undelete>

Le nombre maximal d’objets blob pouvant être supprimés dans une requête unique est de 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Paramètres

blobs: str ou dict(str, Any) ou BlobProperties

Obligatoire

Objets blob à supprimer. Il peut s’agir d’un objet blob unique ou de plusieurs valeurs peuvent être fournies, où chaque valeur est le nom de l’objet blob (str) ou BlobProperties.

Notes

Lorsque le type d’objet blob est dict, voici une liste de clés, de règles de valeur.

nom de l’objet blob :

clé : 'name', type de valeur : str

instantané que vous souhaitez supprimer :

key : 'instantané', type de valeur: str

ID de version :

key: 'version_id', type de valeur: str

s’il faut supprimer des instantanés lors de la suppression d’un objet blob :

key : 'delete_snapshots', valeur: 'include' ou 'only'

si l’objet blob a été modifié ou non :

key : 'if_modified_since', 'if_unmodified_since', type de valeur : datetime

Etag:

key : 'etag', type de valeur : str

correspond à l’etag ou non :

clé : 'match_condition', type de valeur : MatchConditions

condition de correspondance des balises :

key: 'if_tags_match_condition', type de valeur: str

Bail:

key : 'lease_id', type de valeur : Union[str, LeaseClient]

délai d’expiration pour la sous-requête :

key : 'timeout', type de valeur : int

delete_snapshots: str

Obligatoire si un objet blob a des instantanés associés. Ces valeurs comprennent :

« only » : supprime uniquement les instantanés d’objets blob.
« include » : supprime l’objet blob ainsi que tous les instantanés.

if_modified_since: datetime

if_unmodified_since: datetime

if_tags_match_condition: str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

raise_on_any_failure: bool

Il s’agit d’une param booléenne qui prend par défaut la valeur True. Lorsque cette option est définie, une exception est levée même en cas d’échec d’une seule opération.

timeout: int

Retours

Itérateur de réponses, une pour chaque objet blob dans l’ordre

Type de retour

Iterator[HttpResponse]

delete_container

Marque le conteneur spécifié pour suppression. Le conteneur et les objets blob contenus dans ce conteneur sont supprimés lors du garbage collection.

delete_container(**kwargs: Any) -> None

Paramètres

lease: BlobLeaseClient ou str

S’il est spécifié, delete_container réussit uniquement si le bail du conteneur est actif et correspond à cet ID. Obligatoire si le conteneur a un bail actif.

if_modified_since: datetime

if_unmodified_since: datetime

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Type de retour

None

download_blob

Télécharge un objet blob dans StorageStreamDownloader. La méthode readall() doit être utilisée pour lire tout le contenu ou readinto() doit être utilisée pour télécharger l’objet blob dans un flux. L’utilisation de chunks() retourne un itérateur qui permet à l’utilisateur d’itérer sur le contenu en blocs.

download_blob(blob: str | BlobProperties, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Paramètres

blob: str ou BlobProperties

Obligatoire

Objet blob avec lequel interagir. Si elle est spécifiée, cette valeur remplace une valeur d’objet blob spécifiée dans l’URL de l’objet blob.

offset: int

Obligatoire

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

Obligatoire

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

version_id: str

Le paramètre id de version est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie la version de l’objet blob à télécharger.

Nouveautés de la version 12.4.0.

Cet argument mot clé a été introduit dans la version d’API « 2019-12-12 ».

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 détecter les bitflips sur le réseau si l’utilisation de http au lieu de https, car 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 économe 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.

lease: BlobLeaseClient ou str

Obligatoire si l'objet blob a un bail actif. Si elle est spécifiée, download_blob réussit uniquement si le bail de l’objet blob est actif et correspond à cet ID. La valeur peut être un objet BlobLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition: str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur l’objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

cpk: CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS. Comme la clé de chiffrement elle-même est fournie dans la demande, une connexion sécurisée doit être établie pour transférer la clé.

max_concurrency: int

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

encoding: str

Encodage pour décoder les octets téléchargés. La valeur par défaut est None, c’est-à-dire aucun décodage.

progress_hook: Callable[[int, int], None]

Rappel pour suivre la progression d’un téléchargement de longue durée. La signature est function(current: int, total: int) où current est le nombre d’octets transférés jusqu’à présent, et total est la taille totale du téléchargement.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici. Cette méthode peut effectuer plusieurs appels au service et le délai d’expiration s’applique à chaque appel individuellement. plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.

Retours

Objet de diffusion en continu (StorageStreamDownloader)

Type de retour

StorageStreamDownloader

exists

Retourne La valeur True si un conteneur existe et la valeur False dans le cas contraire.

exists(**kwargs: Any) -> bool

Paramètres

timeout: int

Retours

boolean

Type de retour

bool

find_blobs_by_tags

Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié dont les balises correspondent à l’expression de recherche donnée. Le générateur suit tardivement les jetons de continuation retournés par le service.

find_blobs_by_tags(filter_expression: str, **kwargs: Any | None) -> ItemPaged[FilteredBlob]

Paramètres

filter_expression: str

Obligatoire

Expression permettant de rechercher des objets blob dont les balises correspondent à la condition spécifiée. par exemple « "yourtagname"='firsttag' et « yourtagname2"='secondtag' »

results_per_page: int

Résultat maximal par page lors de la pagination.

timeout: int

Retours

Réponse itérable (pagination automatique) de FilteredBlob.

Type de retour

ItemPaged[BlobProperties]

from_connection_string

Créez ContainerClient à partir d’une chaîne de connexion.

from_connection_string(conn_str: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Paramètres

conn_str: str

Obligatoire

Chaîne de connexion à un compte de stockage Azure.

container_name: str

Obligatoire

Nom du conteneur pour l’objet blob.

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL du compte a déjà un jeton SAS ou si la chaîne de connexion a déjà des valeurs de clé d’accès partagé. 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. Les informations d’identification fournies ici sont prioritaires sur celles de la chaîne de connexion. 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.

Retours

Un client conteneur.

Type de retour

ContainerClient

from_container_url

Créez ContainerClient à partir d’une URL de conteneur.

from_container_url(container_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Paramètres

container_url: str

Obligatoire

URL complète du point de terminaison vers le conteneur, y compris le jeton SAS s’il est utilisé. Il peut s’agir du point de terminaison principal ou du point de terminaison secondaire selon le location_mode actuel.

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL du compte a déjà un jeton SAS ou si la chaîne de connexion a déjà des valeurs de clé d’accès partagé. 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.

Retours

Un client conteneur.

Type de retour

ContainerClient

get_account_information

Obtient des informations relatives au compte de stockage.

Les informations peuvent également être récupérées si l’utilisateur dispose d’une signature d’accès partagé à un conteneur ou à un objet blob. Les clés du dictionnaire retourné incluent « sku_name » et « account_kind ».

get_account_information(**kwargs: Any) -> Dict[str, str]

Retours

Dict d’informations de compte (référence SKU et type de compte).

Type de retour

dict(str, str)

get_blob_client

Obtenir un client pour interagir avec l’objet blob spécifié.

L’objet blob n’a pas besoin d’exister.

get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient

Paramètres

blob: str ou BlobProperties

Obligatoire

Objet blob avec lequel interagir.

snapshot: str

valeur par défaut: None

L’objet blob facultatif instantané sur lequel opérer. Il peut s’agir de la chaîne d’ID instantané ou de la réponse retournée par create_snapshot.

version_id: str

Le paramètre d’id de version est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie la version de l’objet blob à utiliser.

Retours

A BlobClient.

Type de retour

BlobClient

get_container_access_policy

Obtient les autorisations pour le conteneur spécifié. Les autorisations indiquent si les données de conteneur sont accessibles publiquement.

get_container_access_policy(**kwargs: Any) -> Dict[str, Any]

Paramètres

lease: BlobLeaseClient ou str

Si elle est spécifiée, get_container_access_policy réussit uniquement si le bail du conteneur est actif et correspond à cet ID.

timeout: int

Retours

Accéder aux informations de stratégie dans un dict.

Type de retour

dict[str, Any]

get_container_properties

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le conteneur spécifié. Les données renvoyées ne comprennent pas la liste d'objets blob du conteneur.

get_container_properties(**kwargs: Any) -> ContainerProperties

Paramètres

lease: BlobLeaseClient ou str

Si elle est spécifiée, get_container_properties réussit uniquement si le bail du conteneur est actif et correspond à cet ID.

timeout: int

Retours

Propriétés du conteneur spécifié dans un objet conteneur.

Type de retour

ContainerProperties

list_blob_names

Retourne un générateur pour répertorier les noms des objets blob sous le conteneur spécifié. Le générateur suit tardivement les jetons de continuation retournés par le service.

Notez qu’aucune propriété ou métadonnées supplémentaires ne sera retournée lors de l’utilisation de cette API. En outre, cette API n’a pas la possibilité d’inclure des objets blob supplémentaires tels que des instantanés, des versions, des objets blob supprimés de manière réversible, etc. Pour obtenir l’une de ces données, utilisez list_blobs.

list_blob_names(**kwargs: Any) -> ItemPaged[str]

Paramètres

name_starts_with: str

Filtre les résultats pour renvoyer uniquement les objets blob dont le nom commence par le préfixe spécifié.

timeout: int

Retours

Réponse itérable (pagination automatique) de noms d’objets blob sous forme de chaînes.

Type de retour

ItemPaged[str]

list_blobs

Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié. Le générateur suit tardivement les jetons de continuation retournés par le service.

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

Paramètres

name_starts_with: str

Obligatoire

Filtre les résultats pour renvoyer uniquement les objets blob dont le nom commence par le préfixe spécifié.

include: list[str] ou str

Obligatoire

Spécifie un ou plusieurs jeux de données supplémentaires à inclure dans la réponse. Les options sont les suivantes : « instantanés », « métadonnées », « uncommittedblobs », « copy », « deleted », « deletedwithversions », « tags », « versions », « immutabilitypolicy », « legalhold ».

timeout: int

Retours

Réponse itérable (pagination automatique) de BlobProperties.

Type de retour

ItemPaged[BlobProperties]

set_container_access_policy

Définit les autorisations pour le conteneur spécifié ou les stratégies d’accès stockées qui peuvent être utilisées avec les signatures d’accès partagé. Les autorisations indiquent si les objets blob dans un conteneur sont accessibles publiquement.

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

signed_identifiers: dict[str, AccessPolicy]

Obligatoire

Dictionnaire des stratégies d’accès à associer au conteneur. Le dictionnaire peut contenir jusqu’à 5 éléments. Un dictionnaire vide efface les stratégies d’accès définies sur le service.

public_access: PublicAccess

Obligatoire

Les valeurs possibles sont les suivantes : « container », « blob ».

lease: BlobLeaseClient ou str

Obligatoire si le conteneur a un bail actif. La valeur peut être un objet BlobLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur datetime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour effectuer l’opération uniquement si la ressource a été modifiée depuis la date/heure spécifiée.

if_unmodified_since: datetime

Valeur datetime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

timeout: int

Retours

Dict de propriété mise à jour du conteneur (Etag et dernière modification).

Type de retour

dict[str, str,

datetime]

set_container_metadata

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le conteneur spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au conteneur. Pour supprimer toutes les métadonnées du conteneur, appelez cette opération sans dictée de métadonnées.

set_container_metadata(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

metadata: dict[str, str]

Obligatoire

Dict contenant des paires nom-valeur à associer au conteneur en tant que métadonnées. Exemple : {'category':'test'}

lease: BlobLeaseClient ou str

S’il est spécifié, set_container_metadata réussit uniquement si le bail du conteneur est actif et correspond à cet ID.

if_modified_since: datetime

if_unmodified_since: datetime

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

timeout: int

Retours

Dict de propriété mise à jour du conteneur (Etag et dernière modification).

Type de retour

dict[str, str,

datetime]

set_premium_page_blob_tier_blobs

Définit les niveaux d’objet blob de page sur tous les objets blob. Cette API est uniquement prise en charge pour les objets blob de pages sur les comptes Premium.

Le nombre maximal d’objets blob pouvant être mis à jour dans une requête unique est de 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Paramètres

premium_page_blob_tier: PremiumPageBlobTier

Obligatoire

Valeur de niveau d’objet blob de pages sur laquelle définir l’objet blob. Le niveau correspond à la taille de l’objet blob et au nombre d’IOPS autorisées. Cela s’applique uniquement aux objets blob de pages sur les comptes de stockage Premium.

Notes

Si vous souhaitez définir un niveau différent sur différents objets blob, définissez ce paramètre positionnel sur None.

Ensuite, le niveau d’objet blob sur chaque BlobProperties est pris.

blobs: str ou dict(str, Any) ou BlobProperties

Obligatoire

Objets blob avec lesquels interagir. Il peut s’agir d’un objet blob unique, ou de plusieurs valeurs peuvent être fournies, où chaque valeur est le nom de l’objet blob (str) ou BlobProperties.

Notes

Lorsque le type d’objet blob est dicté, voici une liste de clés, de règles de valeur.

nom de l’objet blob :

key: 'name', type de valeur: str

Niveau d’objet blob Premium :

clé : 'blob_tier', type de valeur : PremiumPageBlobTier

Bail:

key : 'lease_id', type de valeur : Union[str, LeaseClient]

délai d’expiration pour la sous-requête :

key : 'timeout', type de valeur : int

timeout: int

raise_on_any_failure: bool

Il s’agit d’une param booléenne qui prend par défaut la valeur True. Lorsque cette option est définie, une exception est levée même en cas d’échec d’une seule opération.

Retours

Itérateur de réponses, une pour chaque objet blob dans l’ordre

Type de retour

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Cette opération définit le niveau sur les objets blob de blocs.

Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob.

Le nombre maximal d’objets blob pouvant être mis à jour dans une requête unique est de 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Paramètres

standard_blob_tier: str ou StandardBlobTier

Obligatoire

Indique le niveau à définir sur tous les objets blob. Les options incluent « Chaud », « Cool », « Archive ». Le niveau chaud est optimisé pour le stockage des données fréquemment consultées. Le niveau de stockage froid est optimisé pour stocker des données rarement consultées et stockées pendant au moins un mois. Le niveau archive est optimisé pour le stockage des données rarement accessibles et stockées pendant au moins six mois avec des exigences de latence flexibles.

Notes

Si vous souhaitez définir un niveau différent sur différents objets blob, définissez ce paramètre positionnel sur Aucun.

Ensuite, le niveau d’objet blob sur chaque BlobProperties sera pris.

blobs: str ou dict(str, Any) ou BlobProperties

Obligatoire

Objets blob avec lesquels interagir. Il peut s’agir d’un objet blob unique ou de plusieurs valeurs peuvent être fournies, où chaque valeur est le nom de l’objet blob (str) ou BlobProperties.

Notes

Lorsque le type d’objet blob est dict, voici une liste de clés, de règles de valeur.

nom de l’objet blob :

clé : 'name', type de valeur : str

niveau d’objet blob standard :

key: 'blob_tier', type de valeur : StandardBlobTier

priorité de réalimentation :

clé : 'rehydrate_priority', type de valeur : RehydratePriority

Bail:

key : 'lease_id', type de valeur : Union[str, LeaseClient]

instantané :

key : « instantané », type de valeur : str

ID de version :

key : « version_id », type de valeur : str

condition de correspondance des balises :

key: 'if_tags_match_condition', type de valeur: str

délai d’expiration pour la sous-requête :

key : 'timeout', type de valeur : int

rehydrate_priority: RehydratePriority

Indique la priorité avec laquelle réhydrater un objet blob archivé

if_tags_match_condition: str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout: int

raise_on_any_failure: bool

Il s’agit d’une param booléenne qui prend par défaut la valeur True. Lorsque cette option est définie, une exception est levée même en cas d’échec d’une seule opération.

Retours

Itérateur de réponses, une pour chaque objet blob dans l’ordre

Type de retour

Iterator[HttpResponse]

upload_blob

Crée un objet blob à partir d’une source de données avec segmentation automatique.

upload_blob(name: str | BlobProperties, data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> BlobClient

Paramètres

name: str ou BlobProperties

Obligatoire

Objet blob avec lequel interagir. Si elle est spécifiée, cette valeur remplace une valeur d’objet blob spécifiée dans l’URL de l’objet blob.

data

Obligatoire

Données d’objet blob à charger.

blob_type: BlobType

Obligatoire

Type de l’objet blob. Il peut s’agir de BlockBlob, PageBlob ou AppendBlob. La valeur par défaut est BlockBlob.

length: int

Obligatoire

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

metadata: dict(str, str)

Obligatoire

Paires nom-valeur associées à l'objet blob en tant que métadonnées.

overwrite: bool

Indique si l’objet blob à charger doit remplacer les données actuelles. Si la valeur est True, upload_blob remplacera les données existantes. Si la valeur est False, l’opération échoue avec ResourceExistsError. L’exception à ce qui précède concerne l’ajout de types d’objets blob : si la valeur est False et que les données existent déjà, une erreur ne sera pas générée et les données seront ajoutées à l’objet blob existant. Si le paramètre overwrite=True est défini, l’objet blob d’ajout existant est supprimé et un nouvel objet blob est créé. Valeur par défaut False.

content_settings: ContentSettings

Objet ContentSettings utilisé pour définir des propriétés d’objet blob. Utilisé pour définir le type de contenu, l’encodage, la langue, la disposition, md5 et le contrôle du cache.

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 envoyé. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https, car 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 à mémoire efficace 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’échec de l’objectif de l’algorithme d’efficacité de la mémoire.

lease: BlobLeaseClient ou str

Obligatoire si le conteneur a un bail actif. La valeur peut être un objet BlobLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

if_unmodified_since: datetime

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition: str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout: int

premium_page_blob_tier: PremiumPageBlobTier

standard_blob_tier: StandardBlobTier

Valeur de niveau d’objet blob standard sur laquelle définir l’objet blob. Pour cette version de la bibliothèque, cela s’applique uniquement aux objets blob de blocs sur des comptes de stockage standard.

maxsize_condition: int

En-tête conditionnel facultatif. Longueur maximale en octets autorisée pour l’objet blob d’ajout. Si l’opération Append Block entraîne le dépassement de cette limite ou si la taille de l’objet blob est déjà supérieure à la valeur spécifiée dans cet en-tête, la requête échoue avec l’erreur MaxBlobSizeConditionNotMet (code HTTP status 412 - Échec de la condition préalable).

max_concurrency: int

Nombre maximal de connexions parallèles à utiliser lorsque la taille de l’objet blob dépasse 64 Mo.

cpk: CustomerProvidedEncryptionKey

encryption_scope: str

Étendue de chiffrement prédéfinie utilisée pour chiffrer les données sur le service. Une étendue de chiffrement peut être créée à l’aide de l’API de gestion et référencée ici par son nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplace si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Sinon, une erreur est générée.

Nouveautés de la version 12.2.0.

encoding: str

La valeur par défaut est UTF-8.

progress_hook: Callable[[int, Optional[int]], None]

Rappel pour suivre la progression d’un chargement de longue durée. La signature est function(current: int, total: Optional[int]) où current est le nombre d’octets transférés jusqu’à présent, et total correspond à la taille de l’objet blob ou None si la taille est inconnue.

Retours

BlobClient pour interagir avec l’objet blob nouvellement chargé.

Type de retour

BlobClient

walk_blobs

Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié. Le générateur suit tardivement les jetons de continuation retournés par le service. Cette opération répertorie les objets blob conformément à une hiérarchie, comme délimité par le caractère de délimiteur spécifié.

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any | None) -> ItemPaged[BlobProperties]

Paramètres

name_starts_with: str

Obligatoire

Filtre les résultats pour renvoyer uniquement les objets blob dont le nom commence par le préfixe spécifié.

include: list[str] ou str

Obligatoire

delimiter: str

Obligatoire

Lorsque la requête inclut ce paramètre, l’opération retourne un élément BlobPrefix dans le corps de la réponse qui agit comme espace réservé pour tous les objets blob dont le nom commence par la même sous-chaîne jusqu’à l’apparence du caractère délimiteur. Le délimiteur peut être un caractère ou une chaîne.

timeout: int

Retours

Réponse itérable (pagination automatique) de BlobProperties.

Type de retour

ItemPaged[BlobProperties]

Attributs

api_version

Version de l’API de stockage utilisée pour les requêtes.

location_mode

Mode d’emplacement que le client utilise actuellement.

Par défaut, il s’agit de « primary ». Les options incluent « principal » et « secondaire ».

primary_endpoint

URL complète du point de terminaison principal.

primary_hostname

Nom d’hôte du point de terminaison principal.

secondary_endpoint

URL de point de terminaison secondaire complète si configurée.

S’il n’est pas disponible, un objet ValueError est déclenché. Pour spécifier explicitement un nom d’hôte secondaire, utilisez l’argument facultatif secondary_hostname mot clé lors de l’instanciation.

Exceptions

ValueError

secondary_hostname

Nom d’hôte du point de terminaison secondaire.

S’il n’est pas disponible, il s’agit de Aucun. Pour spécifier explicitement un nom d’hôte secondaire, utilisez l’argument facultatif secondary_hostname mot clé lors de l’instanciation.

url

URL de point de terminaison complète de cette entité, y compris le jeton SAP s’il est utilisé.

Il peut s’agir du point de terminaison principal ou du point de terminaison secondaire en fonction du actuel location_mode. :returns : URL de point de terminaison complète de cette entité, y compris le jeton SAP s’il est utilisé. :rtype: str