BlobClient Classe

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

Héritage

azure.storage.blob._shared.base_client_async.AsyncStorageAccountHostsMixin

BlobClient

azure.storage.blob._blob_client.BlobClient

BlobClient

azure.storage.blob._encryption.StorageEncryptionMixin

BlobClient

Constructeur

BlobClient(account_url: str, container_name: str, blob_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | AsyncTokenCredential | 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 de l’objet blob, utilisez le from_blob_url classmethod.

container_name

str

Obligatoire

Nom du conteneur pour l’objet blob.

blob_name

str

Obligatoire

Nom de l’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.

snapshot

str

valeur par défaut: None

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

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.

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.

Méthodes

abort_copy	Abandonner une opération de copie en cours. Cela laissera un objet blob de destination avec des métadonnées de longueur nulle et complètes. Cela génère une erreur si l’opération de copie est déjà terminée.
acquire_lease	Demande un nouveau bail. Si l’objet blob n’a pas de bail actif, le service Blob crée un bail sur l’objet blob et retourne un nouveau bail.
append_block	Valide un nouveau bloc de données à la fin de l’objet blob d’ajout existant.
append_block_from_url	Crée un nouveau bloc à commiter dans le cadre d’un objet blob, où le contenu est lu à partir d’une URL source.
clear_page	Efface une plage de pages.
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.
commit_block_list	L’opération Commit Block List écrit un objet blob en spécifiant la liste des ID de blocs qui composent l’objet blob.
create_append_blob	Crée un objet blob d’ajout. Cette opération crée un nouvel objet blob d’ajout de longueur 0. Le contenu d’un objet blob existant est remplacé par l’objet blob d’ajout nouvellement initialisé. Pour ajouter du contenu à l’objet blob d’ajout, appelez la append_block méthode ou append_block_from_url .
create_page_blob	Crée un objet blob de page de la taille spécifiée.
create_snapshot	Crée un instantané de l'objet blob. Un instantané est une version en lecture seule d'un objet blob capturé à un instant donné. Il peut être lu, copié ou supprimé, mais pas modifié. Les instantanés sont une façon de sauvegarder un objet blob à un instant T. Une instantané d’un objet blob a le même nom que l’objet blob de base à partir duquel le instantané est extrait, avec une valeur DateTime ajoutée pour indiquer l’heure à laquelle le instantané a été pris.
delete_blob	Marque l'objet blob spécifié en vue de sa 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 réversible supprime l’objet blob et conserve l’objet blob pendant un nombre spécifié de jours. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. L’objet blob supprimé de manière réversible est accessible en list_blobs spécifiant l’option include=['deleted']. L’objet blob supprimé de manière réversible peut être restauré à l’aide de l’opération <xref:azure.storage.blob.aio.undelete> .
delete_immutability_policy	L’opération Supprimer la stratégie d’immuabilité supprime la stratégie d’immuabilité sur l’objet blob. Nouveautés de la version 12.10.0 : cette opération a été introduite dans la version d’API « 2020-10-02 ».
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 asynchrone qui permet à l’utilisateur d’itérer sur le contenu en blocs.
exists	Retourne True si un objet blob existe avec les paramètres définis, et retourne False dans le cas contraire.
from_blob_url	Créez BlobClient à partir d’une URL d’objet blob. Cela ne prend pas en charge l’URL d’objet blob personnalisée avec « / » dans le nom de l’objet blob.
from_connection_string	Créez BlobClient à partir d’une chaîne de connexion.
get_account_information	Obtient des informations relatives au compte de stockage dans lequel réside l’objet blob. 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_properties	Retourne toutes les métadonnées définies par l'utilisateur, les propriétés HTTP standard et les propriétés système pour l'objet blob. Elle ne retourne pas le contenu de l'objet blob.
get_blob_tags	L’opération Obtenir les balises permet aux utilisateurs d’obtenir des balises sur un objet blob ou une version spécifique de l’objet blob, mais pas instantané. Nouveautés de la version 12.4.0 : cette opération a été introduite dans la version d’API « 2019-12-12 ».
get_block_list	L’opération Obtenir la liste de blocs récupère la liste des blocs qui ont été chargés dans le cadre d’un objet blob de blocs.
get_page_range_diff_for_managed_disk	Retourne la liste des plages de pages valides pour un disque managé ou un instantané. Notes Cette opération n’est disponible que pour les comptes de disque managé. Nouveautés de la version 12.2.0 : cette opération a été introduite dans la version d’API « 2019-07-07 ».
get_page_ranges	DEPRECATED : renvoie la liste des plages de pages valides pour un objet blob de pages ou instantané d’un objet blob de page.
list_page_ranges	Retourne la liste des plages de pages valides pour un objet blob de pages ou instantané d’un objet blob de pages. Si previous_snapshot est spécifié, le résultat est un diff de modifications entre l’objet blob cible et le instantané précédent.
query_blob	Permet aux utilisateurs de sélectionner/projeter sur des données d’objet blob/ou d’objet blob instantané en fournissant des expressions de requête simples. Cette opération retourne un BlobQueryReader, les utilisateurs doivent utiliser readall() ou readinto() pour obtenir des données de requête.
resize_blob	Redimensionne un objet blob de pages à la taille spécifiée. Si la valeur spécifiée est inférieure à la taille actuelle de l'objet blob, alors toutes les pages au-dessus de la valeur spécifiée sont effacées.
seal_append_blob	L’opération Seal scelle l’objet blob Append pour le rendre en lecture seule. Nouveautés de la version 12.4.0.
set_blob_metadata	Définit les métadonnées définies par l’utilisateur pour l’objet blob sous la forme d’une ou plusieurs paires nom-valeur.
set_blob_tags	L’opération Définir des balises permet aux utilisateurs de définir des balises sur un objet blob ou une version spécifique de l’objet blob, mais pas instantané. Chaque appel à cette opération remplace toutes les balises existantes attachées à l’objet blob. Pour supprimer toutes les balises de l’objet blob, appelez cette opération sans aucune balise définie. Nouveautés de la version 12.4.0 : cette opération a été introduite dans la version d’API « 2019-12-12 ».
set_http_headers	Définit les propriétés système de l'objet blob. Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.
set_immutability_policy	L’opération Définir la stratégie d’immuabilité définit la stratégie d’immuabilité sur l’objet blob. Nouveautés de la version 12.10.0 : cette opération a été introduite dans la version d’API « 2020-10-02 ».
set_legal_hold	L’opération Set Legal Hold définit une conservation légale sur l’objet blob. Nouveautés de la version 12.10.0 : cette opération a été introduite dans la version d’API « 2020-10-02 ».
set_premium_page_blob_tier	Définit les niveaux d’objet blob de page sur l’objet blob. Cette API est uniquement prise en charge pour les objets blob de pages sur les comptes Premium.
set_sequence_number	Définit le numéro de séquence d’objets blob.
set_standard_blob_tier	Cette opération définit le niveau sur un objet 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.
stage_block	Crée un bloc à valider dans le cadre d'un objet blob.
stage_block_from_url	Crée un bloc à commiter dans le cadre d’un objet blob où le contenu est lu à partir d’une URL.
start_copy_from_url	Copie un objet blob à partir de l’URL donnée. Cette opération retourne un dictionnaire contenant copy_status et copy_id, qui peut être utilisé pour case activée la status de l’opération de copie ou l’abandonner. copy_status sera « réussite » si la copie s’est terminée de manière synchrone ou « en attente » si la copie a été démarrée de manière asynchrone. Pour les copies asynchrones, le status peut être vérifié en interrogeant la get_blob_properties méthode et en vérifiant la copie status. Définissez requires_sync sur True pour forcer la copie à être synchrone. Le service BLOB copie sur une base du meilleur effort. L’objet blob source d’une opération de copie peut être un objet blob de bloc, un objet blob d’ajout ou un objet blob de pages. Si l’objet blob de destination existe déjà, il doit être du même type d’objet blob que l’objet blob source. Tout objet blob de destination existant sera remplacé. L'objet blob de destination ne peut pas être modifié pendant qu'une opération de copie est en cours. Lors de la copie à partir d’un objet blob de pages, le service Blob crée un objet blob de page de destination de la longueur de l’objet blob source, contenant initialement tous les zéros. Puis les plages de pages source sont énumérées, et des plages non vides sont copiées. Pour un objet blob de bloc ou un objet blob d’ajout, le service Blob crée un objet blob validé de longueur nulle avant de revenir à partir de cette opération. Lors de la copie à partir d’un objet blob de blocs, tous les blocs validés et leurs ID de blocs sont copiés. Les blocs non validés ne sont pas copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source. Lors de la copie à partir d’un objet blob d’ajout, tous les blocs validés sont copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source.
undelete_blob	Restaure les objets blob ou les instantanés supprimés de manière réversible. L’opération réussit uniquement si elle est utilisée dans le nombre de jours spécifié défini dans la stratégie de rétention de suppression. Si le contrôle de version d’objet blob est activé, l’objet blob de base ne peut pas être restauré à l’aide de cette méthode. Utilisez plutôt start_copy_from_url avec l’URL de la version d’objet blob que vous souhaitez promouvoir vers la version actuelle.
upload_blob	Crée un objet blob à partir d’une source de données avec segmentation automatique.
upload_blob_from_url	Crée un objet blob de blocs où le contenu de l’objet blob est lu à partir d’une URL donnée. Le contenu d’un objet blob existant est remplacé par le nouvel objet blob.
upload_page	L’opération Charger des pages écrit une plage de pages dans un objet blob de pages.
upload_pages_from_url	L’opération Charger des pages écrit une plage de pages dans un objet blob de pages où le contenu est lu à partir d’une URL.

abort_copy

Abandonner une opération de copie en cours.

Cela laissera un objet blob de destination avec des métadonnées de longueur nulle et complètes. Cela génère une erreur si l’opération de copie est déjà terminée.

async abort_copy(copy_id: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> None

Paramètres

copy_id

str ou BlobProperties

Obligatoire

Opération de copie à abandonner. Il peut s’agir d’un ID ou d’un instance de BlobProperties.

Type de retour

None

acquire_lease

Demande un nouveau bail.

Si l’objet blob n’a pas de bail actif, le service Blob crée un bail sur l’objet blob et retourne un nouveau bail.

async acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> 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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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

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.

Type de retour

BlobLeaseClient

append_block

Valide un nouveau bloc de données à la fin de l’objet blob d’ajout existant.

async append_block(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Paramètres

data

Obligatoire

Contenu du bloc.

length

int

Obligatoire

Taille du bloc en octets.

validate_content

bool

Si la valeur est true, calcule un hachage MD5 du contenu du bloc. 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.

maxsize_condition

int

En-tête conditionnel facultatif. Longueur maximale en octets autorisée pour l’objet blob d’ajout. Si l’opération Ajouter un bloc 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 demande échoue avec l’erreur MaxBlobSizeConditionNotMet (code HTTP status 412 - Échec de la condition préalable).

appendpos_condition

int

En-tête conditionnel facultatif, utilisé uniquement pour l’opération Ajouter un bloc. Nombre indiquant le décalage d’octet à comparer. Le bloc d’ajout réussit uniquement si la position d’ajout est égale à ce nombre. Si ce n’est pas le cas, la demande échoue avec l’erreur AppendPositionConditionNotMet (http status code 412 - Échec de la condition préalable).

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

encoding

str

La valeur par défaut est UTF-8.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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

Dict de propriété mise à jour d’objet blob (Etag, dernière modification, décalage d’ajout, nombre de blocs validés).

Type de retour

dict(str, Any)

append_block_from_url

Crée un nouveau bloc à commiter dans le cadre d’un objet blob, où le contenu est lu à partir d’une URL source.

async append_block_from_url(copy_source_url: str, source_offset: int | None = None, source_length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Paramètres

copy_source_url

str

Obligatoire

URL des données sources. Il peut pointer vers n’importe quel objet blob ou fichier Azure, qui est public ou qui a une signature d’accès partagé attachée.

source_offset

int

Obligatoire

Cela indique le début de la plage d’octets (inclus) qui doit être extrait de la source de copie.

source_length

int

Obligatoire

Cela indique la fin de la plage d’octets à extraire de la source de copie.

source_content_md5

bytearray

S’il est donné, le service calcule le hachage MD5 du contenu du bloc et compare cette valeur.

maxsize_condition

int

En-tête conditionnel facultatif. Longueur maximale en octets autorisée pour l’objet blob d’ajout. Si l’opération Ajouter un bloc 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 demande échoue avec l’erreur MaxBlobSizeConditionNotMet (code HTTP status 412 - Échec de la condition préalable).

appendpos_condition

int

En-tête conditionnel facultatif, utilisé uniquement pour l’opération Ajouter un bloc. Nombre indiquant le décalage d’octet à comparer. Le bloc d’ajout réussit uniquement si la position d’ajout est égale à ce nombre. Si ce n’est pas le cas, la demande échoue avec l’erreur AppendPositionConditionNotMet (http status code 412 - Échec de la condition préalable).

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

etag

str

Valeur ETag de destination ou 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 de destination à 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.

source_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 effectuer l’opération uniquement si la ressource source a été modifiée depuis l’heure spécifiée.

source_if_unmodified_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 effectuer l’opération uniquement si la ressource source n’a pas été modifiée depuis la date/heure spécifiée.

source_etag

str

Valeur ETag source ou 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.

source_match_condition

MatchConditions

Condition de correspondance source à utiliser sur l’etag.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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.

source_authorization

str

Authentifiez-vous en tant que principal de service à l’aide d’une clé secrète client pour accéder à un objet blob source. Vérifiez que « porteur » est le préfixe de la chaîne source_authorization.

clear_page

Efface une plage de pages.

async clear_page(offset: int, length: int, **kwargs: Any) -> Dict[str, str | datetime]

Paramètres

offset

int

Obligatoire

Début de la plage d’octets à utiliser pour écrire dans une section de l’objet blob. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

length

int

Obligatoire

Nombre d’octets à utiliser pour écrire dans une section de l’objet blob. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

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_sequence_number_lte

int

Si le numéro de séquence de l’objet blob est inférieur ou égal à la valeur spécifiée, la demande se poursuit ; sinon, il échoue.

if_sequence_number_lt

int

Si le numéro de séquence de l’objet blob est inférieur à la valeur spécifiée, la demande se poursuit ; sinon, il échoue.

if_sequence_number_eq

int

Si le numéro de séquence de l’objet blob est égal à la valeur spécifiée, la demande se poursuit ; sinon, il échoue.

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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é.

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

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict(str, Any)

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.

async close()

commit_block_list

L’opération Commit Block List écrit un objet blob en spécifiant la liste des ID de blocs qui composent l’objet blob.

async commit_block_list(block_list: List[BlobBlock], content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

block_list

list

Obligatoire

Liste des blockblobs.

content_settings

ContentSettings

Obligatoire

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.

metadata

dict[str, str]

Obligatoire

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

tags

dict(str, str)

Paires nom-valeur associées à l’objet blob en tant que balise. Les étiquettes respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs des étiquettes doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent : minuscules et majuscules, chiffres (0-9), espace ( >><<+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_)

Nouveautés de la version 12.4.0.

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.

immutability_policy

ImmutabilityPolicy

Spécifie la stratégie d’immuabilité d’un objet blob, d’un instantané d’objet blob ou d’une version d’objet blob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

legal_hold

bool

Spécifie si une conservation légale doit être définie sur l’objet blob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

validate_content

bool

Si la valeur est true, calcule un hachage MD5 du contenu de la page. 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.

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict(str, Any)

create_append_blob

Crée un objet blob d’ajout. Cette opération crée un nouvel objet blob d’ajout de longueur 0. Le contenu d’un objet blob existant est remplacé par l’objet blob d’ajout nouvellement initialisé. Pour ajouter du contenu à l’objet blob d’ajout, appelez la append_block méthode ou append_block_from_url .

async create_append_blob(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Paramètres

content_settings

ContentSettings

Obligatoire

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.

metadata

dict(str, str)

Obligatoire

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

tags

dict(str, str)

Paires nom-valeur associées à l’objet blob en tant que balise. Les étiquettes respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs des étiquettes doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent : minuscules et majuscules, chiffres (0-9), espace ( >><<+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_)

Nouveautés de la version 12.4.0.

immutability_policy

ImmutabilityPolicy

Spécifie la stratégie d’immuabilité d’un objet blob, d’un instantané d’objet blob ou d’une version d’objet blob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

legal_hold

bool

Spécifie si une conservation légale doit être définie sur l’objet blob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict[str, Any]

create_page_blob

Crée un objet blob de page de la taille spécifiée.

async create_page_blob(size: int, content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, premium_page_blob_tier: str | PremiumPageBlobTier | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

size

int

Obligatoire

Cela spécifie la taille maximale de l’objet blob de page, jusqu’à 1 To. La taille de l'objet blob de pages doit être alignée à une limite de 512 octets.

content_settings

ContentSettings

Obligatoire

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.

metadata

dict(str, str)

Obligatoire

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

premium_page_blob_tier

PremiumPageBlobTier

Obligatoire

Valeur de niveau d’objet blob de page sur laquelle définir l’objet blob. Le niveau est corrélé à la taille de l’objet blob et au nombre d’E/S par seconde autorisées. Cela s’applique uniquement aux objets blob de pages sur les comptes de stockage Premium.

tags

dict(str, str)

Paires nom-valeur associées à l’objet blob en tant que balise. Les étiquettes respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs des étiquettes doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent : minuscules et majuscules, chiffres (0-9), espace ( >><<+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_)

Nouveautés de la version 12.4.0.

sequence_number

int

Uniquement pour les objets blob de page. Le numéro de séquence est une valeur contrôlée par l'utilisateur que vous pouvez utiliser pour suivre les demandes. La valeur du numéro de séquence doit être comprise entre 0 et 2^63 - 1. La valeur par défaut 0.

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.

immutability_policy

ImmutabilityPolicy

Spécifie la stratégie d’immuabilité d’un objet blob, d’un instantané d’objet blob ou d’une version d’objet blob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

legal_hold

bool

Spécifie si une conservation légale doit être définie sur l’objet blob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict[str, Any]

create_snapshot

Crée un instantané de l'objet blob.

Un instantané est une version en lecture seule d'un objet blob capturé à un instant donné. Il peut être lu, copié ou supprimé, mais pas modifié. Les instantanés sont une façon de sauvegarder un objet blob à un instant T.

Une instantané d’un objet blob a le même nom que l’objet blob de base à partir duquel le instantané est extrait, avec une valeur DateTime ajoutée pour indiquer l’heure à laquelle le instantané a été pris.

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

Paramètres

metadata

dict(str, str)

Obligatoire

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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

Dict de propriété mise à jour d’objet blob (ID d’instantané, Etag et dernière modification).

Type de retour

dict[str, Any]

delete_blob

Marque l'objet blob spécifié en vue de sa 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 réversible supprime l’objet blob et conserve l’objet blob pendant un nombre spécifié de jours. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. L’objet blob supprimé de manière réversible est accessible en list_blobs spécifiant l’option include=['deleted']. L’objet blob supprimé de manière réversible peut être restauré à l’aide de l’opération <xref:azure.storage.blob.aio.undelete> .

async delete_blob(delete_snapshots: str = None, **kwargs: Any) -> None

Paramètres

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. S’il est spécifié, delete_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 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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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

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.

Type de retour

None

delete_immutability_policy

L’opération Supprimer la stratégie d’immuabilité supprime la stratégie d’immuabilité sur l’objet blob.

Nouveautés de la version 12.10.0 : cette opération a été introduite dans la version d’API « 2020-10-02 ».

async delete_immutability_policy(**kwargs: Any) -> None

Paramètres

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

Paires de valeurs de clé d’étiquettes d’objet blob.

Type de retour

Dict[str, str]

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 asynchrone qui permet à l’utilisateur d’itérer sur le contenu en blocs.

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

Paramètres

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 d’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 de l’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 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 l'objet blob a un bail actif. S’il est spécifié, 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 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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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 pas de décodage.

progress_hook

Callable[[int, int], Awaitable[None]]

Rappel asynchrone 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 correspond à la taille totale du téléchargement.

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. 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 True si un objet blob existe avec les paramètres définis, et retourne False dans le cas contraire.

async exists(**kwargs: Any) -> bool

Paramètres

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 à case activée si elle existe.

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.

Retours

boolean

Type de retour

bool

from_blob_url

Créez BlobClient à partir d’une URL d’objet blob. Cela ne prend pas en charge l’URL d’objet blob personnalisée avec « / » dans le nom de l’objet blob.

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

Paramètres

blob_url

str

Obligatoire

L’URL complète du point de terminaison vers l’objet blob, y compris le jeton SAS et instantané si elle est utilisée. Il peut s’agir du point de terminaison principal ou du point de terminaison secondaire selon le location_mode actuel.

credential

Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

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 l’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.

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. S’il est spécifié, cela remplacera la instantané dans l’URL.

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

Un client Blob.

Type de retour

BlobClient

from_connection_string

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

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

Paramètres

conn_str

str

Obligatoire

Une chaîne de connexion à un compte de stockage Azure.

container_name

str

Obligatoire

Nom du conteneur pour l’objet blob.

blob_name

str

Obligatoire

Nom de l’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.

credential

Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

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 l’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 du 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.

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

Un client Blob.

Type de retour

BlobClient

get_account_information

Obtient des informations relatives au compte de stockage dans lequel réside l’objet blob.

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 ».

async get_account_information(**kwargs: int | None) -> 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_properties

Retourne toutes les métadonnées définies par l'utilisateur, les propriétés HTTP standard et les propriétés système pour l'objet blob. Elle ne retourne pas le contenu de l'objet blob.

async get_blob_properties(**kwargs: Any) -> BlobProperties

Paramètres

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.

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 pour obtenir les propriétés.

Nouveautés de la version 12.4.0.

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

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

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.

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é.

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.

Retours

BlobProperties

Type de retour

BlobProperties

get_blob_tags

L’opération Obtenir les balises permet aux utilisateurs d’obtenir des balises sur un objet blob ou une version spécifique de l’objet blob, mais pas instantané.

Nouveautés de la version 12.4.0 : cette opération a été introduite dans la version d’API « 2019-12-12 ».

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

Paramètres

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 à laquelle ajouter des balises.

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'"

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.

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.

Retours

Paires clé-valeur d’étiquettes d’objet blob.

Type de retour

Dict[str, str]

get_block_list

L’opération Obtenir la liste de blocs récupère la liste des blocs qui ont été chargés dans le cadre d’un objet blob de blocs.

async get_block_list(block_list_type: str | None = 'committed', **kwargs: Any) -> Tuple[List[BlobBlock], List[BlobBlock]]

Paramètres

block_list_type

str

Obligatoire

Indique quelle liste retourner : liste des blocs validés, liste des blocs non validés ou ces deux listes. Les valeurs possibles sont les suivantes : « committed », « uncommitted », « all »

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_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.

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.

Retours

Un tuple de deux listes - blocs validés et non validés

Type de retour

tuple(list(BlobBlock), list(BlobBlock))

get_page_range_diff_for_managed_disk

Retourne la liste des plages de pages valides pour un disque managé ou un instantané.

Notes

Cette opération n’est disponible que pour les comptes de disque managé.

Nouveautés de la version 12.2.0 : cette opération a été introduite dans la version d’API « 2019-07-07 ».

async get_page_range_diff_for_managed_disk(previous_snapshot_url: str, offset: int | None = None, length: int | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Paramètres

previous_snapshot_url

Obligatoire

Spécifie l’URL d’une instantané précédente du disque managé. La réponse contient uniquement les pages qui ont été modifiées entre l’objet blob cible et son instantané précédent.

offset

int

Obligatoire

Début de la plage d’octets à utiliser pour obtenir des plages de pages valides. Si aucune longueur n’est donnée, tous les octets après le décalage seront recherchés. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

length

int

Obligatoire

Nombre d’octets à utiliser pour obtenir des plages de pages valides. Si la longueur est donnée, le décalage doit être fourni. Cette plage retourne des plages de pages valides du démarrage du décalage à la longueur spécifiée. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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

Tuple de deux listes de plages de pages sous forme de dictionnaires avec les clés « start » et « end ». Le premier élément est des plages de pages remplies, le 2e élément est des plages de pages effacées.

Type de retour

tuple(list(dict(str, str), list(dict(str, str))

get_page_ranges

DEPRECATED : renvoie la liste des plages de pages valides pour un objet blob de pages ou instantané d’un objet blob de page.

async get_page_ranges(offset: int | None = None, length: int | None = None, previous_snapshot_diff: str | Dict[str, Any] | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Paramètres

offset

int

Obligatoire

Début de la plage d’octets à utiliser pour obtenir des plages de pages valides. Si aucune longueur n’est donnée, tous les octets après le décalage seront recherchés. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

length

int

Obligatoire

Nombre d’octets à utiliser pour obtenir des plages de pages valides. Si la longueur est donnée, le décalage doit être fourni. Cette plage retourne des plages de pages valides du démarrage du décalage à la longueur spécifiée. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

previous_snapshot_diff

str

Obligatoire

Le paramètre instantané diff qui contient une valeur DateTime opaque qui spécifie un instantané d’objet blob précédent à comparer à un instantané plus récent ou à l’objet blob actuel.

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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

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

Tuple de deux listes de plages de pages sous forme de dictionnaires avec les clés « start » et « end ». Le premier élément est des plages de pages remplies, le 2e élément est des plages de pages effacées.

Type de retour

tuple(list(dict(str, str), list(dict(str, str))

list_page_ranges

Retourne la liste des plages de pages valides pour un objet blob de pages ou instantané d’un objet blob de pages. Si previous_snapshot est spécifié, le résultat est un diff de modifications entre l’objet blob cible et le instantané précédent.

list_page_ranges(*, offset: int | None = None, length: int | None = None, previous_snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> AsyncItemPaged[PageRange]

Paramètres

offset

int

Début de la plage d’octets à utiliser pour obtenir des plages de pages valides. Si aucune longueur n’est donnée, tous les octets après le décalage seront recherchés. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

length

int

Nombre d’octets à utiliser pour obtenir des plages de pages valides. Si la longueur est donnée, le décalage doit être fourni. Cette plage retourne des plages de pages valides du démarrage du décalage à la longueur spécifiée. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

previous_snapshot

str ou Dict[str, Any]

Valeur instantané qui spécifie que la réponse contiendra uniquement les pages qui ont été modifiées entre l’objet blob cible et les instantané précédentes. Les pages modifiées incluent des pages mises à jour et effacées. L’objet blob cible peut être un instantané, tant que le instantané spécifié par previous_snapshot est le plus ancien des deux.

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

results_per_page

int

Nombre maximal de plages de pages à récupérer par appel d’API.

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

Itérable (pagination automatique) de PageRange.

Type de retour

ItemPaged[PageRange]

query_blob

Permet aux utilisateurs de sélectionner/projeter sur des données d’objet blob/ou d’objet blob instantané en fournissant des expressions de requête simples. Cette opération retourne un BlobQueryReader, les utilisateurs doivent utiliser readall() ou readinto() pour obtenir des données de requête.

query_blob(query_expression: str, **kwargs: Any) -> BlobQueryReader

Paramètres

query_expression

str

Obligatoire

Obligatoire. une instruction de requête. Pour plus d’informations, consultez https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error

Callable[BlobQueryError]

Fonction à appeler sur toutes les erreurs de traitement retournées par le service.

blob_format

DelimitedTextDialect ou DelimitedJsonDialect ou QuickQueryDialect ou str

facultatif. Définit la sérialisation des données actuellement stockées dans l’objet blob. La valeur par défaut consiste à traiter les données blob comme des données CSV mises en forme dans le dialecte par défaut. Cela peut être remplacé par un DelimitedTextDialect personnalisé, ou DelimitedJsonDialect ou « ParquetDialect » (passé sous la forme d’une chaîne ou d’une énumération). Ces dialectes peuvent être transmis via leurs classes respectives, l’énumération QuickQueryDialect ou sous forme de chaîne

output_format

DelimitedTextDialect ou DelimitedJsonDialect ou list[ArrowDialect] ou QuickQueryDialect ou str

facultatif. Définit la sérialisation de sortie pour le flux de données. Par défaut, les données sont retournées telles qu’elles sont représentées dans l’objet blob (les formats Parquet sont par défaut DelimitedTextDialect). En fournissant un format de sortie, les données blob sont reformatées en fonction de ce profil. Cette valeur peut être un DelimitedTextDialect ou un DelimitedJsonDialect ou ArrowDialect. Ces dialectes peuvent être transmis via leurs classes respectives, l’énumération QuickQueryDialect ou sous forme de chaîne

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

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

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.

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é.

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.

Retours

Objet de diffusion en continu (BlobQueryReader)

Type de retour

BlobQueryReader

resize_blob

Redimensionne un objet blob de pages à la taille spécifiée.

Si la valeur spécifiée est inférieure à la taille actuelle de l'objet blob, alors toutes les pages au-dessus de la valeur spécifiée sont effacées.

async resize_blob(size: int, **kwargs: Any) -> Dict[str, str | datetime]

Paramètres

size

int

Obligatoire

Taille utilisée pour redimensionner l’objet blob. La taille maximale d’un objet blob de pages est de 1 To. La taille de l'objet blob de pages doit être alignée à une limite de 512 octets.

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

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

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.

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.

premium_page_blob_tier

PremiumPageBlobTier

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.

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.

Retours

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict(str, Any)

seal_append_blob

L’opération Seal scelle l’objet blob Append pour le rendre en lecture seule.

Nouveautés de la version 12.4.0.

async seal_append_blob(**kwargs) -> Dict[str, str | datetime | int]

Paramètres

appendpos_condition

int

En-tête conditionnel facultatif, utilisé uniquement pour l’opération Append Block. Nombre indiquant le décalage d’octets à comparer. Append Block réussit uniquement si la position d’ajout est égale à ce nombre. Si ce n’est pas le cas, la requête échoue avec l’erreur AppendPositionConditionNotMet (code HTTP status 412 - Échec de la condition préalable).

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

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

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.

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.

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.

Retours

Dict de propriété mise à jour d’objet blob (Etag, dernière modification, décalage d’ajout, nombre de blocs validés).

Type de retour

dict(str, Any)

set_blob_metadata

Définit les métadonnées définies par l’utilisateur pour l’objet blob sous la forme d’une ou plusieurs paires nom-valeur.

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

Paramètres

metadata

dict(str, str)

Obligatoire

Dict contenant des paires nom-valeur. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées à l'objet blob. Pour supprimer toutes les métadonnées de l'objet blob, appelez cette opération sans en-tête de métadonnées.

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

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

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.

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é.

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.

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.

Retours

Dict de propriété mise à jour d’objet blob (Etag et dernière modification)

set_blob_tags

L’opération Définir des balises permet aux utilisateurs de définir des balises sur un objet blob ou une version spécifique de l’objet blob, mais pas instantané. Chaque appel à cette opération remplace toutes les balises existantes attachées à l’objet blob. Pour supprimer toutes les balises de l’objet blob, appelez cette opération sans aucune balise définie.

Nouveautés de la version 12.4.0 : cette opération a été introduite dans la version d’API « 2019-12-12 ».

async set_blob_tags(tags: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

Paramètres

tags

dict(str, str)

Obligatoire

Paires nom-valeur associées à l’objet blob en tant que balise. Les balises respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs de balise doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent : lettres minuscules et majuscules, chiffres (0-9), espace ( >><<), plus (+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_)

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.

validate_content

bool

Si la valeur est true, calcule un hachage MD5 du contenu des balises. 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.

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'"

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.

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.

Retours

Dict de propriété mise à jour d’objet blob (Etag et dernière modification)

Type de retour

Dict[str, Any]

set_http_headers

Définit les propriétés système de l'objet blob.

Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.

async set_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None

Paramètres

content_settings

ContentSettings

Obligatoire

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 de cache.

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

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

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.

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.

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.

Retours

Dict de propriété mise à jour d’objet blob (Etag et dernière modification)

Type de retour

Dict[str, Any]

set_immutability_policy

L’opération Définir la stratégie d’immuabilité définit la stratégie d’immuabilité sur l’objet blob.

Nouveautés de la version 12.10.0 : cette opération a été introduite dans la version d’API « 2020-10-02 ».

async set_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]

Paramètres

immutability_policy

ImmutabilityPolicy

Obligatoire

Spécifie la stratégie d’immuabilité d’un objet blob, d’un instantané d’objet blob ou d’une version d’objet blob.

Nouveautés de la version 12.10.0 : cette fonctionnalité a été introduite dans la version d’API « 2020-10-02 ».

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.

Retours

Paires clé-valeur d’étiquettes d’objet blob.

Type de retour

Dict[str, str]

set_legal_hold

L’opération Set Legal Hold définit une conservation légale sur l’objet blob.

Nouveautés de la version 12.10.0 : cette opération a été introduite dans la version d’API « 2020-10-02 ».

async set_legal_hold(legal_hold: bool, **kwargs: Any) -> Dict[str, str | datetime | bool]

Paramètres

legal_hold

bool

Obligatoire

Spécifie si une conservation légale doit être définie sur l’objet blob.

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.

Retours

Paires de valeurs de clé d’étiquettes d’objet blob.

Type de retour

Dict[str, Union[str, datetime, bool]]

set_premium_page_blob_tier

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

async set_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None

Paramètres

premium_page_blob_tier

PremiumPageBlobTier

Obligatoire

Valeur de niveau d’objet blob de page sur laquelle définir l’objet blob. Le niveau est corrélé à la taille de l’objet blob et au nombre d’E/S par seconde autorisées. Cela s’applique uniquement aux objets blob de pages sur les comptes de stockage Premium.

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

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.

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.

Type de retour

None

set_sequence_number

Définit le numéro de séquence d’objets blob.

async set_sequence_number(sequence_number_action: str | SequenceNumberAction, sequence_number: str | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

sequence_number_action

str

Obligatoire

Cette propriété indique comment le service doit modifier le numéro séquentiel de l'objet blob. Consultez la rubrique SequenceNumberAction (éventuellement en anglais) pour plus d'informations.

sequence_number

str

Obligatoire

Cette propriété définit le numéro de séquence de l'objet blob. Le numéro de séquence est une propriété contrôlée par l'utilisateur que vous pouvez utiliser pour suivre les demandes et gérer les problèmes d'accès concurrentiel.

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

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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

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

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict(str, Any)

set_standard_blob_tier

Cette opération définit le niveau sur un objet 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.

async set_standard_blob_tier(standard_blob_tier: str | StandardBlobTier, **kwargs: Any) -> None

Paramètres

standard_blob_tier

str ou StandardBlobTier

Obligatoire

Indique le niveau à définir sur l’objet 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.

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

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.

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.

Type de retour

None

stage_block

Crée un bloc à valider dans le cadre d'un objet blob.

async stage_block(block_id: str, data: Iterable | IO, length: int | None = None, **kwargs) -> None

Paramètres

block_id

str

Obligatoire

Valeur de chaîne qui identifie le bloc. La chaîne doit avoir une taille inférieure ou égale à 64 octets. Pour un objet blob donné, le block_id doit avoir la même taille pour chaque bloc.

data

Obligatoire

Données d’objet blob.

length

int

Obligatoire

Taille du bloc.

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 l'objet blob a un bail actif. La valeur peut être un objet BlobLeaseClient ou l’ID de bail sous forme de chaîne.

encoding

str

La valeur par défaut est UTF-8.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

Nouveautés de la version 12.2.0.

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.

Type de retour

None

stage_block_from_url

Crée un bloc à commiter dans le cadre d’un objet blob où le contenu est lu à partir d’une URL.

async stage_block_from_url(block_id: str | int, source_url: str, source_offset: int | None = None, source_length: int | None = None, source_content_md5: bytes | bytearray | None = None, **kwargs) -> None

Paramètres

block_id

str

Obligatoire

Valeur de chaîne qui identifie le bloc. La chaîne doit avoir une taille inférieure ou égale à 64 octets. Pour un objet blob donné, le block_id doit avoir la même taille pour chaque bloc.

source_url

str

Obligatoire

URL.

source_offset

int

Obligatoire

Début de la plage d’octets à utiliser pour le bloc. Doit être défini si la longueur de la source est fournie.

source_length

int

Obligatoire

Taille du bloc en octets.

source_content_md5

bytearray

Obligatoire

Spécifiez le md5 calculé pour la plage d’octets qui doivent être lus à partir de la source de copie.

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.

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é.

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.

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.

source_authorization

str

Authentifiez-vous en tant que principal de service à l’aide d’une clé secrète client pour accéder à un objet blob source. Vérifiez que « porteur » est le préfixe de la chaîne source_authorization.

Type de retour

None

start_copy_from_url

Copie un objet blob à partir de l’URL donnée.

Cette opération retourne un dictionnaire contenant copy_status et copy_id, qui peut être utilisé pour case activée la status de l’opération de copie ou l’abandonner. copy_status sera « réussite » si la copie s’est terminée de manière synchrone ou « en attente » si la copie a été démarrée de manière asynchrone. Pour les copies asynchrones, le status peut être vérifié en interrogeant la get_blob_properties méthode et en vérifiant la copie status. Définissez requires_sync sur True pour forcer la copie à être synchrone. Le service BLOB copie sur une base du meilleur effort.

L’objet blob source d’une opération de copie peut être un objet blob de bloc, un objet blob d’ajout ou un objet blob de pages. Si l’objet blob de destination existe déjà, il doit être du même type d’objet blob que l’objet blob source. Tout objet blob de destination existant sera remplacé. L'objet blob de destination ne peut pas être modifié pendant qu'une opération de copie est en cours.

Lors de la copie à partir d’un objet blob de pages, le service Blob crée un objet blob de page de destination de la longueur de l’objet blob source, contenant initialement tous les zéros. Puis les plages de pages source sont énumérées, et des plages non vides sont copiées.

Pour un objet blob de bloc ou un objet blob d’ajout, le service Blob crée un objet blob validé de longueur nulle avant de revenir à partir de cette opération. Lors de la copie à partir d’un objet blob de blocs, tous les blocs validés et leurs ID de blocs sont copiés. Les blocs non validés ne sont pas copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source.

Lors de la copie à partir d’un objet blob d’ajout, tous les blocs validés sont copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source.

async start_copy_from_url(source_url: str, metadata: Dict[str, str] | None = None, incremental_copy: bool = False, **kwargs: Any) -> Dict[str, str | datetime]

Paramètres

source_url

str

Obligatoire

URL d’une longueur maximale de 2 Ko qui spécifie un fichier ou un objet blob. La valeur doit être encodée sous forme d'URL, comme dans une URI de demande. Si la source se trouve dans un autre compte, la source doit être publique ou doit être authentifiée via une signature d’accès partagé. Si la source est publique, aucune authentification n’est requise. Exemples : https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? instantané=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata

dict(str, str)

Obligatoire

Paires nom-valeur associées à l'objet blob en tant que métadonnées. Si aucune paire nom-valeur n’est spécifiée, l’opération copie les métadonnées de l’objet blob ou du fichier source vers l’objet blob de destination. Si une ou plusieurs paires nom-valeur sont spécifiées, l’objet blob de destination est créé avec les métadonnées spécifiées et les métadonnées ne sont pas copiées à partir de l’objet blob ou du fichier source.

incremental_copy

bool

Obligatoire

Copie le instantané de l’objet blob de pages source dans un objet blob de page de destination. La instantané est copiée de telle sorte que seules les modifications différentielles entre les instantané précédemment copiées soient transférées vers la destination. Les instantanés copiés sont des copies complètes du instantané d’origine et peuvent être lus ou copiés comme d’habitude. Valeur par défaut False.

tags

dict(str, str) ou Literal["COPY"]

Paires nom-valeur associées à l’objet blob en tant que balise. Les balises respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs de balise doivent être comprises entre 0 et 256 caractères. Les caractères de clé et de valeur d’étiquette valides incluent : lettres minuscules et majuscules, chiffres (0-9), espace ( >><<), plus (+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_).

Le littéral « COPY » (respectant la casse) peut être passé pour copier des balises à partir de l’objet blob source. Cette option est disponible uniquement lorsque incremental_copy=False et requires_sync=True.

Nouveautés de la version 12.4.0.

immutability_policy

ImmutabilityPolicy

Spécifie la stratégie d’immuabilité d’un objet blob, d’un instantané d’objet blob ou d’une version d’objet blob.

Nouveautés de la version 12.10.0 : cette fonctionnalité a été introduite dans la version d’API « 2020-10-02 ».

legal_hold

bool

Spécifie si une conservation légale doit être définie sur l’objet blob.

Nouveautés de la version 12.10.0 : cette fonctionnalité a été introduite dans la version d’API « 2020-10-02 ».

source_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 conditionnel pour copier l'objet blob uniquement si l'objet blob source a été modifié depuis la date/l'heure indiquées.

source_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 conditionnel pour copier l'objet blob uniquement si l'objet blob source n'a pas été modifié depuis la date/l'heure indiquées.

source_etag

str

Valeur ETag source ou 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.

source_match_condition

MatchConditions

Condition de correspondance source à utiliser sur l’etag.

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 conditionnel pour copier l'objet blob uniquement si l'objet blob de destination a été modifié depuis la date/l'heure indiquées. Si l'objet blob de destination n'a pas été modifié, le service BLOB retourne le code d'état 412 (Échec de la précondition).

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 conditionnel pour copier l'objet blob uniquement si l'objet blob de destination n'a pas été modifié depuis la date/l'heure indiquées. Si l'objet blob de destination a été modifié, le service BLOB retourne le code d'état 412 (Échec de la précondition).

etag

str

Valeur ETag de destination ou 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 de destination à 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.

destination_lease

BlobLeaseClient ou str

L'ID de bail spécifié pour cet en-tête doit correspondre à l'ID de bail de l'objet blob de destination. Si la demande n'inclut pas l'ID de bail ou si elle n'est pas valide, l'opération échoue avec un code d'état 412 (Échec de la précondition).

source_lease

BlobLeaseClient ou str

Spécifiez ceci pour effectuer l’opération Copier l’objet blob uniquement si l’ID de bail donné correspond à l’ID de bail actif de l’objet blob source.

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.

premium_page_blob_tier

PremiumPageBlobTier

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.

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.

rehydrate_priority

RehydratePriority

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

seal_destination_blob

bool

Scellez l’objet blob d’ajout de destination. Cette opération concerne uniquement l’objet blob d’ajout.

Nouveautés de la version 12.4.0.

requires_sync

bool

Applique que le service ne retourne pas de réponse tant que la copie n’est pas terminée.

source_authorization

str

Authentifiez-vous en tant que principal de service à l’aide d’une clé secrète client pour accéder à un objet blob source. Vérifiez que « porteur » est le préfixe de la chaîne source_authorization. Cette option n’est disponible que lorsque incremental_copy a la valeur False et requires_sync a la valeur True.

Nouveautés de la version 12.9.0.

encryption_scope

str

Étendue de chiffrement prédéfinie utilisée pour chiffrer les données sur l’objet blob copié de synchronisation. 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.10.0.

Retours

Dictionnaire de propriétés de copie (etag, last_modified, copy_id, copy_status).

Type de retour

dict[str, Union[str, datetime]]

undelete_blob

Restaure les objets blob ou les instantanés supprimés de manière réversible.

L’opération réussit uniquement si elle est utilisée dans le nombre de jours spécifié défini dans la stratégie de rétention de suppression.

Si le contrôle de version d’objet blob est activé, l’objet blob de base ne peut pas être restauré à l’aide de cette méthode. Utilisez plutôt start_copy_from_url avec l’URL de la version d’objet blob que vous souhaitez promouvoir vers la version actuelle.

async undelete_blob(**kwargs: Any) -> None

Paramètres

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.

Type de retour

None

upload_blob

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

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

Paramètres

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.

tags

dict(str, str)

Paires nom-valeur associées à l’objet blob en tant que balise. Les étiquettes respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs des étiquettes doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent : minuscules et majuscules, chiffres (0-9), espace ( >><<+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_)

Nouveautés de la version 12.4.0.

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

Si elle est spécifiée, upload_blob réussit uniquement si le bail de l’objet blob est actif et correspond à cet ID. Obligatoire si l'objet blob a un bail actif.

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

premium_page_blob_tier

PremiumPageBlobTier

Valeur de niveau d’objet blob de page sur laquelle définir l’objet blob. Le niveau est corrélé à la taille de l’objet blob et au nombre d’E/S par seconde autorisées. Cela s’applique uniquement aux objets blob de pages sur les comptes de stockage Premium.

immutability_policy

ImmutabilityPolicy

Spécifie la stratégie d’immuabilité d’un objet blob, d’un instantané d’objet blob ou d’une version d’objet blob. Actuellement, ce paramètre de l’API upload_blob() s’adresse uniquement à BlockBlob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

legal_hold

bool

Spécifie si une conservation légale doit être définie sur l’objet blob. Actuellement, ce paramètre de l’API upload_blob() s’adresse uniquement à BlockBlob.

Nouveautés de la version 12.10.0 : ceci a été introduit dans la version d’API « 2020-10-02 ».

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 Ajouter un bloc 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 demande é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

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, 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]], Awaitable[None]]

Rappel asynchrone pour suivre la progression d’un chargement de longue durée. La signature est function(current : int, total : Optional[int]) où current correspond au 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.

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. 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

Dict de propriété mise à jour d’objet blob (Etag et dernière modification)

Type de retour

dict[str, Any]

upload_blob_from_url

Crée un objet blob de blocs où le contenu de l’objet blob est lu à partir d’une URL donnée. Le contenu d’un objet blob existant est remplacé par le nouvel objet blob.

async upload_blob_from_url(source_url: str, **kwargs: Any) -> Dict[str, Any]

Paramètres

source_url

str

Obligatoire

URL d’une longueur maximale de 2 Ko qui spécifie un fichier ou un objet blob. La valeur doit être encodée sous forme d'URL, comme dans une URI de demande. Si la source se trouve dans un autre compte, la source doit être publique ou doit être authentifiée via une signature d’accès partagé. Si la source est publique, aucune authentification n’est requise. Exemples : https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? instantané=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

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.

include_source_blob_properties

bool

Indique si les propriétés de l’objet blob source doivent être copiées. La valeur par défaut est True.

tags

dict(str, str)

Paires nom-valeur associées à l’objet blob en tant que balise. Les étiquettes respectent la casse. L’ensemble de balises peut contenir au maximum 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères, et les valeurs des étiquettes doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent : minuscules et majuscules, chiffres (0-9), espace ( >><<+), moins (-), point (.), solidus (/), deux-points (:), égal à (=), trait de soulignement (_)

source_content_md5

bytearray

Spécifiez le md5 utilisé pour vérifier l’intégrité des octets sources.

source_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 effectuer l’opération uniquement si la ressource source a été modifiée depuis l’heure spécifiée.

source_if_unmodified_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 effectuer l’opération uniquement si la ressource source n’a pas été modifiée depuis la date/heure spécifiée.

source_etag

str

Valeur ETag source ou 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.

source_match_condition

MatchConditions

Condition de correspondance source à utiliser sur l’etag.

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

etag

str

Valeur ETag de destination ou 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 de destination à utiliser sur l’etag.

destination_lease

BlobLeaseClient ou str

L'ID de bail spécifié pour cet en-tête doit correspondre à l'ID de bail de l'objet blob de destination. Si la demande n'inclut pas l'ID de bail ou si elle n'est pas valide, l'opération échoue avec un code d'état 412 (Échec de la précondition).

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.

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.

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é.

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 nom. Si une étendue de chiffrement par défaut a été définie au niveau du conteneur, cette valeur la remplacera si l’étendue au niveau du conteneur est configurée pour autoriser les remplacements. Dans le cas contraire, une erreur est générée.

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.

source_authorization

str

Authentifiez-vous en tant que principal de service à l’aide d’une clé secrète client pour accéder à un objet blob source. Vérifiez que « porteur » est le préfixe de la chaîne source_authorization.

upload_page

L’opération Charger des pages écrit une plage de pages dans un objet blob de pages.

async upload_page(page: bytes, offset: int, length: int, **kwargs) -> Dict[str, str | datetime]

Paramètres

page

bytes

Obligatoire

Contenu de la page.

offset

int

Obligatoire

Début de la plage d’octets à utiliser pour écrire dans une section de l’objet blob. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

length

int

Obligatoire

Nombre d’octets à utiliser pour écrire dans une section de l’objet blob. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

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.

validate_content

bool

Si la valeur est true, calcule un hachage MD5 du contenu de la page. 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.

if_sequence_number_lte

int

Si le numéro de séquence de l’objet blob est inférieur ou égal à la valeur spécifiée, la demande se poursuit ; sinon, il échoue.

if_sequence_number_lt

int

Si le numéro de séquence de l’objet blob est inférieur à la valeur spécifiée, la demande se poursuit ; sinon, il échoue.

if_sequence_number_eq

int

Si le numéro de séquence de l’objet blob est égal à la valeur spécifiée, la demande se poursuit ; sinon, il échoue.

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

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 n'a pas été modifiée depuis la date/l'heure indiquées.

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.

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é.

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.

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.

Retours

Dict de propriété mise à jour d’objet blob (Etag et dernière modification).

Type de retour

dict(str, Any)

upload_pages_from_url

L’opération Charger des pages écrit une plage de pages dans un objet blob de pages où le contenu est lu à partir d’une URL.

async upload_pages_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs) -> Dict[str, Any]

Paramètres

source_url

str

Obligatoire

URL des données sources. Il peut pointer vers n’importe quel objet blob ou fichier Azure, qui est public ou qui a une signature d’accès partagé attachée.

offset

int

Obligatoire

Début de la plage d’octets à utiliser pour écrire dans une section de l’objet blob. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

length

int

Obligatoire

Nombre d’octets à utiliser pour écrire dans une section de l’objet blob. Les pages doivent être alignées avec des limites de 512 octets, le décalage de début doit être un module de 512 et la longueur doit être un module de 512.

source_offset

int

Obligatoire

Cela indique le début de la plage d’octets (inclus) qui doit être extraite de la source de copie. Le service lira le même nombre d’octets que la plage de destination (longueur-décalage).

source_content_md5

bytes

Si cette valeur est donnée, le service calcule le hachage MD5 du contenu du bloc et compare à cette valeur.

source_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 source a été modifiée depuis l’heure spécifiée.

source_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 effectuer l’opération uniquement si la ressource source n’a pas été modifiée depuis la date/heure spécifiée.

source_etag

str

Valeur ETag source ou 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.

source_match_condition

MatchConditions

Condition de correspondance source à utiliser sur l’etag.

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_sequence_number_lte

int

Si le numéro de séquence de l’objet blob est inférieur ou égal à la valeur spécifiée, la demande se poursuit ; sinon, elle échoue.

if_sequence_number_lt

int

Si le numéro de séquence de l’objet blob est inférieur à la valeur spécifiée, la requête continue ; sinon, elle échoue.

if_sequence_number_eq

int

Si le numéro de séquence de l’objet blob est égal à la valeur spécifiée, la requête continue ; sinon, elle échoue.

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

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.

etag

str

Valeur ETag de destination ou 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 de destination à 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é.

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.

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.

source_authorization

str

Authentifiez-vous en tant que principal de service à l’aide d’une clé secrète client pour accéder à un objet blob source. Vérifiez que « porteur » est le préfixe de la chaîne source_authorization.

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