BlockBlobService Classe
Les objets blob de blocs vous permettent de télécharger efficacement des objets blob volumineux. Les objets BLOB de blocs sont composés de blocs, chacun étant identifié par un ID de bloc. Vous créez ou modifiez un objet BLOB de blocs en écrivant un ensemble de blocs et en validant leur ID de bloc. Chaque bloc peut avoir une taille différente, jusqu’à un maximum de 100 Mo, et un objet blob de blocs peut inclure jusqu’à 50 000 blocs. La taille maximale d’un objet blob de blocs est donc d’environ 4,75 To (100 Mo x 50 000 blocs). Si vous écrivez un objet blob de blocs dont la taille ne dépasse pas 64 Mo, vous pouvez le charger dans son intégralité avec une seule opération d’écriture ; consultez create_blob_from_bytes.
:type ~azure.storage.common.TokenCredential
- Héritage
-
BlockBlobService
Constructeur
BlockBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, connection_string=None, socket_timeout=None, token_credential=None)
Paramètres
- account_name
- str
nom du compte de stockage. Il permet d’authentifier les demandes signées avec une clé de compte et de construire le point de terminaison de stockage. Elle est obligatoire, sauf si une chaîne de connexion est donnée ou si un domaine personnalisé est utilisé avec l’authentification anonyme.
- account_key
- str
La clé du compte de stockage. Il est utilisé pour l’authentification par clé partagée. Si aucune clé de compte ou jeton sas n’est spécifié, l’accès anonyme est utilisé.
- sas_token
- str
Jeton de signature d’accès partagé à utiliser pour authentifier les demandes au lieu de la clé de compte. Si la clé de compte et le jeton sas sont tous deux spécifiés, la clé de compte est utilisée pour la signature. Si aucun n’est spécifié, l’accès anonyme est utilisé.
- is_emulated
- bool
Indique s’il faut utiliser l’émulateur. Valeur par défaut False. S’il est spécifié, remplace tous les autres paramètres en plus de chaîne de connexion session et de requête.
- protocol
- str
Protocole à utiliser pour les requêtes. La valeur par défaut est https.
- endpoint_suffix
- str
Composant de base hôte de l’URL, moins le nom du compte. La valeur par défaut est Azure (core.windows.net). Remplacez cela pour utiliser le cloud chinois (core.chinacloudapi.cn).
- custom_domain
- str
Domaine personnalisé à utiliser. Cela peut être défini dans le portail Azure. Par exemple, « www.mydomain.com ».
- request_session
- <xref:requests.Session>
Objet de session à utiliser pour les requêtes http.
- connection_string
- str
S’il est spécifié, cela remplacera tous les autres paramètres en plus de la session de requête. Consultez http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ pour connaître le format chaîne de connexion.
- socket_timeout
- int
S’il est spécifié, cela remplacera le délai d’expiration du socket par défaut. Le délai d’attente spécifié est en secondes. Consultez DEFAULT_SOCKET_TIMEOUT dans _constants.py pour connaître la valeur par défaut.
- token_credential
Informations d’identification de jeton utilisées pour authentifier les requêtes HTTPS. La valeur du jeton doit être mise à jour avant son expiration.
Variables
- MAX_SINGLE_PUT_SIZE
- int
La plus grande taille de chargement prise en charge dans un seul appel put. Cette méthode est utilisée par les méthodes create_blob_from_* si la longueur du contenu est connue et est inférieure à cette valeur.
- MAX_BLOCK_SIZE
- int
Taille des blocs placés par les méthodes create_blob_from_* si la longueur du contenu est inconnue ou supérieure à MAX_SINGLE_PUT_SIZE. Des blocs plus petits peuvent être placés. La taille de bloc maximale prise en charge par le service est de 100 Mo.
- MIN_LARGE_BLOCK_UPLOAD_THRESHOLD
- int
Taille de bloc minimale à laquelle l’algorithme de chargement de blocs optimisé en mémoire est pris en compte. Cet algorithme s’applique uniquement aux méthodes create_blob_from_file et create_blob_from_stream et empêche la mise en mémoire tampon complète des blocs. En plus de la taille de bloc, la validation et le chiffrement ContentMD5 doivent être désactivés, car ces options nécessitent que les blocs soient mis en mémoire tampon.
Méthodes
abort_copy_blob |
Abandonne une opération de copy_blob en attente et laisse un objet blob de destination sans aucune longueur et des métadonnées complètes. |
acquire_blob_lease |
Demande un nouveau bail. Si l'objet blob n'a pas de bail actif, le service BLOB crée un bail dans l'objet blob et retourne un nouvel ID de bail. |
acquire_container_lease |
Demande un nouveau bail. Si le conteneur n'a pas de bail actif, le service BLOB crée un bail dans le conteneur et retourne un nouvel ID de bail. |
batch_delete_blobs |
Envoie un lot de plusieurs demandes de suppression d’objets blob. La méthode de suppression d’objet blob supprime l’objet blob ou le instantané spécifié. Notez que la suppression d’un objet blob supprime également tous ses instantanés. Pour plus d'informations, consultez https://docs.microsoft.com/rest/api/storageservices/delete-blob |
batch_set_standard_blob_tier |
Envoie un lot de plusieurs requêtes de niveaux d’objet blob de blocs. Cette API est uniquement prise en charge pour les objets blob de blocs sur des comptes de stockage standard. |
break_blob_lease |
Interrompt le bail si l’objet blob a un bail actif. Une fois un bail résilié, il ne peut pas être renouvelé. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Lorsqu’un bail est rompu, la période d’arrêt de bail est autorisée à s’écouler, pendant laquelle aucune opération de bail à l’exception de l’arrêt et de la mise en production ne peut être effectuée sur l’objet blob. Lorsqu'un bail est correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis. Un bail qui a été résilié peut également être libéré, auquel cas un autre client peut immédiatement acquérir le bail sur l'objet blob. |
break_container_lease |
Arrêtez le bail, si le conteneur a un bail actif. Une fois un bail résilié, il ne peut pas être renouvelé. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Lorsqu’un bail est rompu, la période d’arrêt de bail est autorisée à s’écouler, pendant laquelle aucune opération de bail à l’exception de l’arrêt et de la libération ne peut être effectuée sur le conteneur. Lorsqu'un bail est correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis. |
change_blob_lease |
Modifie l'ID du bail d'un bail actif. Une modification doit inclure l’ID de bail actuel et un nouvel ID de bail. |
change_container_lease |
Modifiez l’ID de bail d’un bail actif. Une modification doit inclure l’ID de bail actuel et un nouvel ID de bail. |
copy_blob |
Copie un objet blob. Cette opération retourne un objet de propriétés d’opération de copie. L’opération de copie peut être configurée pour être asynchrone, opération de meilleur effort ou opération synchrone. La source doit être un objet blob de blocs si requires_sync est true. 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 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. Vous pouvez appeler get_blob_properties sur l’objet blob de destination pour case activée le status de l’opération de copie. L’objet blob final est validé à la fin de la copie. Nom du conteneur de destination. Le conteneur doit exister. :p aram str blob_name : nom de l’objet blob de destination. Si l’objet blob de destination existe, il sera remplacé. Sinon, il sera créé. :p aram str copy_source : URL d’une longueur maximale de 2 Ko qui spécifie un fichier ou un objet blob Azure. 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/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?instantané= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken :p métadonnéesaram : 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 copiera 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. :type metadata : dict(str, str) :p aram datetime source_if_modified_since : 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 conditionnel pour copier l'objet blob uniquement si l'objet blob source a été modifié depuis la date/l'heure indiquées. :p aram datetime source_if_unmodified_since : 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 conditionnel pour copier l'objet blob uniquement si l'objet blob source n'a pas été modifié depuis la date/l'heure indiquées. :p aram ETag source_if_match : valeur ETag ou caractère générique (). Spécifiez cet en-tête conditionnel pour copier l’objet blob source uniquement si son ETag correspond à la valeur spécifiée. Si les valeurs ETag ne correspondent pas, le service Blob retourne status code 412 (Échec de la condition préalable). Cet en-tête ne peut pas être spécifié si la source est un fichier Azure. :p aram ETag source_if_none_match : valeur ETag ou caractère générique (). Spécifiez cet en-tête conditionnel pour copier l'objet blob source uniquement si son ETag ne correspond pas à la valeur spécifiée. Si les valeurs sont identiques, le service BLOB renvoie le code d'état 412 (Échec de la précondition). Cet en-tête ne peut pas être spécifié si la source est un fichier Azure. :p aram datetime destination_if_modified_since : 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 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). :p aram datetime destination_if_unmodified_since : 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 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). :p aram ETag destination_if_match : valeur ETag ou caractère générique (). Spécifiez une valeur ETag pour cet en-tête conditionnel afin de copier l’objet blob uniquement si la valeur ETag spécifiée correspond à la valeur ETag d’un objet blob de destination existant. Si l’ETag pour l’objet blob de destination ne correspond pas à l’ETag spécifié pour If-Match, le service Blob retourne status code 412 (Échec de la condition préalable). :p aram ETag destination_if_none_match : valeur ETag ou caractère générique (). Spécifiez une valeur d'ETag pour cet en-tête conditionnel pour copier l'objet blob uniquement si la valeur d'ETag spécifiée ne correspond pas à la valeur d'ETag pour l'objet blob de destination. Spécifiez le caractère générique (*) pour exécuter l'opération uniquement si l'objet blob de destination n'existe pas. Si la condition spécifiée n'est pas remplie, le service BLOB retourne le code d'état 412 (Échec de la précondition). :p aram str destination_lease_id : 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). :p aram str source_lease_id : 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. :p aram int timeout : le paramètre de délai d’expiration est exprimé en secondes. :p aram bool requires_sync : applique que le service ne retourne pas de réponse tant que la copie n’est pas terminée. :p aram StandardBlobTier standard_blob_tier : 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. :p aram RehydratePriority rehydrate_priority : indique la priorité avec laquelle réhydrater un objet blob archivé :return : Copier les propriétés de l’opération, telles que status, source et ID. :rtype : CopyProperties |
create_blob_from_bytes |
Crée un objet blob à partir d’un tableau d’octets ou met à jour le contenu d’un objet blob existant avec des notifications automatiques de segment et de progression. |
create_blob_from_path |
Crée un objet blob à partir d’un chemin d’accès de fichier ou met à jour le contenu d’un objet blob existant avec des notifications automatiques de segmentation et de progression. |
create_blob_from_stream |
Crée un objet blob à partir d’un fichier/flux, ou met à jour le contenu d’un objet blob existant, avec des notifications automatiques de segmentation et de progression. |
create_blob_from_text |
Crée un objet blob à partir de str/unicode, ou met à jour le contenu d’un objet blob existant, avec des notifications de segmentation et de progression automatiques. |
create_container |
Crée un conteneur sous le compte spécifié. Si le conteneur portant le même nom existe déjà, l’opération échoue si fail_on_exist a la valeur True. |
delete_blob |
Marque l’objet blob ou le instantané spécifié pour suppression. L'objet blob est ensuite supprimé lors du garbage collection. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération Supprimer l’objet blob. Si une stratégie de rétention de suppression est activée pour le service, cette opération supprime de manière réversible l’objet blob ou le instantané et conserve l’objet blob ou le instantané pendant le nombre de jours spécifié. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. L’objet blob supprimé de manière réversible ou instantané est accessible via l’API Répertorier les objets blob en spécifiant l’option include=Include.Deleted. L’objet blob ou les instantané supprimés de manière réversible peuvent être restaurés à l’aide de l’API Annuler la suppression. |
delete_container |
Marque le conteneur spécifié pour suppression. Le conteneur et les objets blob contenus dans ce conteneur sont supprimés lors du garbage collection. |
exists |
Retourne une valeur booléenne indiquant si le conteneur existe (si blob_name a la valeur None) ou une valeur booléenne indiquant si l’objet blob existe. |
extract_date_and_request_id | |
generate_account_shared_access_signature |
Génère une signature d’accès partagé pour le service blob. Utilisez la signature retournée avec le paramètre sas_token de n’importe quel blobService. |
generate_blob_shared_access_signature |
Génère une signature d’accès partagé pour l’objet blob ou l’un de ses instantanés. Utilisez la signature retournée avec le paramètre sas_token de n’importe quel blobService. |
generate_container_shared_access_signature |
Génère une signature d’accès partagé pour le conteneur. Utilisez la signature retournée avec le paramètre sas_token de n’importe quel blobService. |
get_blob_account_information |
Obtient des informations relatives au compte de stockage. Les informations peuvent également être récupérées si l’utilisateur dispose d’une signature d’accès partagé à un conteneur ou à un objet blob. |
get_blob_metadata |
Retourne toutes les métadonnées définies par l’utilisateur pour l’objet blob ou le instantané spécifié. |
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. Retourne Blob avec BlobProperties et un dictée de métadonnées. |
get_blob_service_properties |
Obtient les propriétés du service Blob d’un compte de stockage, y compris Azure Storage Analytics. |
get_blob_service_stats |
Récupère des statistiques relatives à la réplication pour le service BLOB. Elle est disponible uniquement lorsque la réplication géoredondante avec accès en lecture est activée pour le compte de stockage. Avec la réplication géographique redondante, le stockage Azure conserve vos données dans deux emplacements. Dans les deux emplacements, le stockage Azure conserve constamment plusieurs réplicas sains de vos données. L'emplacement où vous lisez, créez, mettez à jour ou supprimez les données est l'emplacement du compte de stockage principal. L’emplacement principal existe dans la région que vous choisissez au moment où vous créez un compte via le portail Azure Management Azure Classic, par exemple, USA Centre Nord. L'emplacement dans lequel vos données sont répliquées est l'emplacement secondaire. L'emplacement secondaire est automatiquement déterminé en fonction de l'emplacement principal ; il se trouve dans un deuxième centre de données qui réside dans la même région que l'emplacement principal. L'accès en lecture seule est disponible à partir de l'emplacement secondaire, si la réplication géographique redondante avec accès en lecture est activée pour votre compte de stockage. |
get_blob_to_bytes |
Télécharge un objet blob sous la forme d’un tableau d’octets, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des Blob propriétés, des métadonnées et du contenu. |
get_blob_to_path |
Télécharge un objet blob dans un chemin d’accès de fichier, avec des notifications automatiques de segmentation et de progression. Retourne une instance de avec des Blob propriétés et des métadonnées. |
get_blob_to_stream |
Télécharge un objet blob dans un flux, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des Blob propriétés et des métadonnées. |
get_blob_to_text |
Télécharge un objet blob sous forme de texte unicode, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des Blob propriétés, des métadonnées et du contenu. |
get_block_list |
Récupère la liste de blocs qui ont été téléchargés dans le cadre d'un objet blob de blocs. Deux listes de blocs sont tenues à jour pour un objet blob : Liste de blocs validée : liste des blocs qui ont été correctement validés dans un objet blob donné avec Put Block List. Liste de blocs non validée : liste des blocs qui ont été chargés pour un objet blob à l’aide de Put Block, mais qui n’ont pas encore été validés. Ces blocs sont stockés dans Azure et associés à un objet blob, mais ne font pas partie de l'objet blob. |
get_container_acl |
Obtient les autorisations pour le conteneur spécifié. Les autorisations indiquent si les données de conteneur sont accessibles publiquement. |
get_container_metadata |
Retourne toutes les métadonnées définies par l’utilisateur pour le conteneur spécifié. |
get_container_properties |
Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le conteneur spécifié. Les données renvoyées ne comprennent pas la liste d'objets blob du conteneur. |
get_user_delegation_key |
Obtenez une clé de délégation utilisateur dans le but de signer des jetons SAP. Des informations d’identification de jeton doivent être présentes sur l’objet de service pour que cette demande réussisse. |
list_blob_names |
Retourne un générateur pour répertorier les noms d’objets blob sous le conteneur spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les objets blob ont été retournés ou num_results sont atteints. Si num_results est spécifié et que le compte a plus que ce nombre d’objets blob, le générateur dispose d’un champ next_marker rempli une fois terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités. |
list_blobs |
Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les objets blob ont été retournés ou num_results est atteint. Si num_results est spécifié et que le compte a plus que ce nombre d’objets blob, le générateur aura un champ next_marker rempli une fois qu’il aura terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités. |
list_containers |
Retourne un générateur pour répertorier les conteneurs sous le compte spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les conteneurs ont été retournés ou num_results est atteint. Si num_results est spécifié et que le compte a plus que ce nombre de conteneurs, le générateur aura un champ next_marker rempli une fois qu’il aura terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités. |
make_blob_url |
Crée l’URL pour accéder à un objet blob. |
make_container_url |
Crée l’URL pour accéder à un conteneur. |
put_block |
Crée un bloc à valider dans le cadre d'un objet blob. |
put_block_from_url |
Crée un bloc à valider dans le cadre d'un objet blob. |
put_block_list |
Écrit un objet blob en spécifiant la liste des ID de bloc qui composent l'objet blob. Pour être écrit dans le cadre d’un objet blob, un bloc doit avoir été correctement écrit sur le serveur lors d’une opération Put Block antérieure. Vous pouvez appeler Put Block List pour mettre à jour un objet blob en chargeant uniquement les blocs qui ont changé, puis en validant ensemble les blocs nouveaux et existants. Vous pouvez faire cela en spécifiant si un bloc doit être validé à partir de la liste de blocs validés ou de la liste de blocs non validés, ou si la version du bloc téléchargée en dernier doit être validée en indiquant la liste auquel le bloc appartient. |
release_blob_lease |
Libère le bail. Le bail peut être libéré si l'ID de bail spécifié dans la demande correspond à celui associé à l'objet blob. La libération du bail permet à un autre client d'acquérir immédiatement le bail pour l'objet blob dès qu'il a été libéré. |
release_container_lease |
Permet de libérer le bail. Le bail peut être libéré si le lease_id spécifié correspond à celui associé au conteneur. La libération du bail permet à un autre client d'acquérir immédiatement le bail pour le conteneur dès que la libération est terminée. |
renew_blob_lease |
Renouvelle le bail. Le bail peut être renouvelé si l'ID de bail spécifié dans la demande correspond à celui associé à l'objet blob. Notez que le bail peut être renouvelé même s'il a expiré, tant que l'objet blob n'a pas été modifié ou n'a pas été reloué depuis l'expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée. |
renew_container_lease |
Renouvelle le bail. Le bail peut être renouvelé si l’ID de bail spécifié correspond à celui associé au conteneur. Notez que le bail peut être renouvelé même s'il a expiré, tant que le conteneur n'a pas été reloué depuis l'expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée. |
set_blob_metadata |
Définit les métadonnées définies par l’utilisateur pour l’objet blob spécifié en tant qu’une ou plusieurs paires nom-valeur. |
set_blob_properties |
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_blob_service_properties |
Définit les propriétés du service Blob d’un compte de stockage, y compris Azure Storage Analytics. Si un élément (ex Journalisation) est laissé comme Aucun, les paramètres existants sur le service pour cette fonctionnalité sont conservés. |
set_container_acl |
Définit les autorisations pour le conteneur spécifié ou les stratégies d’accès stocké qui peuvent être utilisées avec les signatures d’accès partagé. Les autorisations indiquent si les objets blob dans un conteneur sont accessibles publiquement. |
set_container_metadata |
Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le conteneur spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au conteneur. Pour supprimer toutes les métadonnées du conteneur, appelez cette opération sans dictée de métadonnées. |
set_proxy |
Définit l’hôte et le port du serveur proxy pour le tunnelling HTTP CONNECT. |
set_standard_blob_tier |
Définit les niveaux d’objet blob de blocs sur l’objet blob. Cette API est uniquement prise en charge pour les objets blob de blocs sur les comptes de stockage standard. :p aram RehydratePriority rehydrate_priority : indique la priorité avec laquelle réhydrater un objet blob archivé |
snapshot_blob |
Crée un instantané en lecture seule d'un objet blob. |
undelete_blob |
L’opération d’annulation de la suppression de l’objet blob restaure le contenu et les métadonnées de l’objet blob ou des instantané supprimés de manière réversible. La tentative de suppression d’un objet blob ou d’un instantané qui n’est pas supprimé de manière réversible réussit sans aucune modification. |
abort_copy_blob
Abandonne une opération de copy_blob en attente et laisse un objet blob de destination sans aucune longueur et des métadonnées complètes.
abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)
Paramètres
- copy_id
- str
Identificateur de copie fourni dans le copy.id de l’opération de copy_blob d’origine.
- lease_id
- str
Obligatoire si l'objet blob de destination a un bail infini actif.
acquire_blob_lease
Demande un nouveau bail. Si l'objet blob n'a pas de bail actif, le service BLOB crée un bail dans l'objet blob et retourne un nouvel ID de bail.
acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
Paramètres
- lease_duration
- int
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).
- proposed_lease_id
- str
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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
Retours
str
acquire_container_lease
Demande un nouveau bail. Si le conteneur n'a pas de bail actif, le service BLOB crée un bail dans le conteneur et retourne un nouvel ID de bail.
acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- lease_duration
- int
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).
- proposed_lease_id
- str
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.
Retours
str
batch_delete_blobs
Envoie un lot de plusieurs demandes de suppression d’objets blob.
La méthode de suppression d’objet blob supprime l’objet blob ou le instantané spécifié. Notez que la suppression d’un objet blob supprime également tous ses instantanés. Pour plus d'informations, consultez https://docs.microsoft.com/rest/api/storageservices/delete-blob
batch_delete_blobs(batch_delete_sub_requests, timeout=None)
Paramètres
- batch_delete_sub_requests
- list(BatchDeleteSubRequest)
L’objet blob delete demande à envoyer en tant que lot.
Retours
Réponse HTTP de suppression par lot analysée
Type de retour
batch_set_standard_blob_tier
Envoie un lot de plusieurs requêtes de niveaux d’objet blob de blocs. Cette API est uniquement prise en charge pour les objets blob de blocs sur des comptes de stockage standard.
batch_set_standard_blob_tier(batch_set_blob_tier_sub_requests, timeout=None)
Paramètres
- batch_set_blob_tier_sub_requests
- list(BatchSetBlobTierSubRequest)
Le niveau d’objet blob de blocs défini demande à envoyer en tant que lot.
- timeout
- int
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
Retours
Réponse HTTP de niveau de jeu de lots analysée qui indique si chaque sous-requête réussit.
Type de retour
break_blob_lease
Interrompt le bail si l’objet blob a un bail actif. Une fois un bail résilié, il ne peut pas être renouvelé. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Lorsqu’un bail est rompu, la période d’arrêt de bail est autorisée à s’écouler, pendant laquelle aucune opération de bail à l’exception de l’arrêt et de la mise en production ne peut être effectuée sur l’objet blob. Lorsqu'un bail est correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis.
Un bail qui a été résilié peut également être libéré, auquel cas un autre client peut immédiatement acquérir le bail sur l'objet blob.
break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
Paramètres
- lease_break_period
- int
Pour une opération d’arrêt, il s’agit de la durée proposée en secondes que le bail doit continuer avant d’être rompu, entre 0 et 60 secondes. Cette période de résiliation n'est utilisée que si elle est plus courte que la durée du bail restante. Si elle est plus longue, la durée restante du bail est utilisée. Un nouveau bail ne sera pas disponible avant l'expiration de la période de résiliation, mais le bail peut être conservé au-delà de cette période. Si cet en-tête n’apparaît pas avec une opération d’arrêt, un bail à durée fixe se termine après l’expiration de la période de bail restante, et un bail infini se termine immédiatement.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
Retours
int
break_container_lease
Arrêtez le bail, si le conteneur a un bail actif. Une fois un bail résilié, il ne peut pas être renouvelé. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Lorsqu’un bail est rompu, la période d’arrêt de bail est autorisée à s’écouler, pendant laquelle aucune opération de bail à l’exception de l’arrêt et de la libération ne peut être effectuée sur le conteneur. Lorsqu'un bail est correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis.
break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- lease_break_period
- int
Il s’agit de la durée proposée en secondes pendant laquelle le bail doit se poursuivre avant sa rupture, entre 0 et 60 secondes. Cette période de résiliation n'est utilisée que si elle est plus courte que la durée du bail restante. Si elle est plus longue, la durée restante du bail est utilisée. Un nouveau bail ne sera pas disponible avant l'expiration de la période de résiliation, mais le bail peut être conservé au-delà de cette période. Si cet en-tête n’apparaît pas avec une opération d’arrêt, un bail à durée fixe se termine après l’expiration de la période de bail restante, et un bail infini se termine immédiatement.
- 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.
Retours
int
change_blob_lease
Modifie l'ID du bail d'un bail actif. Une modification doit inclure l’ID de bail actuel et un nouvel ID de bail.
change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
Paramètres
- proposed_lease_id
- str
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 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
change_container_lease
Modifiez l’ID de bail d’un bail actif. Une modification doit inclure l’ID de bail actuel et un nouvel ID de bail.
change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- proposed_lease_id
- str
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 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.
copy_blob
Copie un objet blob. Cette opération retourne un objet de propriétés d’opération de copie. L’opération de copie peut être configurée pour être asynchrone, opération de meilleur effort ou opération synchrone.
La source doit être un objet blob de blocs si requires_sync est true. 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 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.
Vous pouvez appeler get_blob_properties sur l’objet blob de destination pour case activée le status de l’opération de copie. L’objet blob final est validé à la fin de la copie.
Nom du conteneur de destination. Le conteneur doit exister. :p aram str blob_name : nom de l’objet blob de destination. Si l’objet blob de destination existe, il sera remplacé. Sinon, il sera créé. :p aram str copy_source : URL d’une longueur maximale de 2 Ko qui spécifie un fichier ou un objet blob Azure. 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/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?instantané= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken :p métadonnéesaram : 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 copiera 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. :type metadata : dict(str, str) :p aram datetime source_if_modified_since : 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 conditionnel pour copier l'objet blob uniquement si l'objet blob source a été modifié depuis la date/l'heure indiquées. :p aram datetime source_if_unmodified_since : 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 conditionnel pour copier l'objet blob uniquement si l'objet blob source n'a pas été modifié depuis la date/l'heure indiquées. :p aram ETag source_if_match : valeur ETag ou caractère générique (). Spécifiez cet en-tête conditionnel pour copier l’objet blob source uniquement si son ETag correspond à la valeur spécifiée. Si les valeurs ETag ne correspondent pas, le service Blob retourne status code 412 (Échec de la condition préalable). Cet en-tête ne peut pas être spécifié si la source est un fichier Azure. :p aram ETag source_if_none_match : valeur ETag ou caractère générique (). Spécifiez cet en-tête conditionnel pour copier l'objet blob source uniquement si son ETag ne correspond pas à la valeur spécifiée. Si les valeurs sont identiques, le service BLOB renvoie le code d'état 412 (Échec de la précondition). Cet en-tête ne peut pas être spécifié si la source est un fichier Azure. :p aram datetime destination_if_modified_since : 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 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). :p aram datetime destination_if_unmodified_since : 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 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). :p aram ETag destination_if_match : valeur ETag ou caractère générique (). Spécifiez une valeur ETag pour cet en-tête conditionnel afin de copier l’objet blob uniquement si la valeur ETag spécifiée correspond à la valeur ETag d’un objet blob de destination existant. Si l’ETag pour l’objet blob de destination ne correspond pas à l’ETag spécifié pour If-Match, le service Blob retourne status code 412 (Échec de la condition préalable). :p aram ETag destination_if_none_match : valeur ETag ou caractère générique (). Spécifiez une valeur d'ETag pour cet en-tête conditionnel pour copier l'objet blob uniquement si la valeur d'ETag spécifiée ne correspond pas à la valeur d'ETag pour l'objet blob de destination. Spécifiez le caractère générique (*) pour exécuter l'opération uniquement si l'objet blob de destination n'existe pas. Si la condition spécifiée n'est pas remplie, le service BLOB retourne le code d'état 412 (Échec de la précondition). :p aram str destination_lease_id : 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). :p aram str source_lease_id : 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. :p aram int timeout : le paramètre de délai d’expiration est exprimé en secondes. :p aram bool requires_sync : applique que le service ne retourne pas de réponse tant que la copie n’est pas terminée. :p aram StandardBlobTier standard_blob_tier : 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. :p aram RehydratePriority rehydrate_priority : indique la priorité avec laquelle réhydrater un objet blob archivé :return : Copier les propriétés de l’opération, telles que status, source et ID. :rtype : CopyProperties
copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, timeout=None, requires_sync=None, standard_blob_tier=None, rehydrate_priority=None)
Paramètres
- container_name
- str
- blob_name
- copy_source
- metadata
- source_if_modified_since
- source_if_unmodified_since
- source_if_match
- source_if_none_match
- destination_if_modified_since
- destination_if_unmodified_since
- destination_if_match
- destination_if_none_match
- destination_lease_id
- source_lease_id
- timeout
- requires_sync
- standard_blob_tier
- rehydrate_priority
create_blob_from_bytes
Crée un objet blob à partir d’un tableau d’octets ou met à jour le contenu d’un objet blob existant avec des notifications automatiques de segment et de progression.
create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)
Paramètres
- count
- int
Nombre d’octets à charger. Définissez sur Aucune ou valeur négative pour charger tous les octets à partir de l’index.
- content_settings
- ContentSettings
Objet ContentSettings utilisé pour définir des propriétés d’objet blob.
Paires nom-valeur associées à l'objet blob en tant que métadonnées.
- 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 comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) 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 totale est inconnue.
- max_connections
- int
Nombre maximal de connexions parallèles à utiliser lorsque la taille de l’objet blob dépasse 64 Mo.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
- 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.
Retours
ETag et dernières propriétés modifiées pour l’objet blob de blocs
Type de retour
create_blob_from_path
Crée un objet blob à partir d’un chemin d’accès de fichier ou met à jour le contenu d’un objet blob existant avec des notifications automatiques de segmentation et de progression.
create_blob_from_path(container_name, blob_name, file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)
Paramètres
- content_settings
- ContentSettings
Objet ContentSettings utilisé pour définir des propriétés d’objet blob.
Paires nom-valeur associées à l'objet blob en tant que métadonnées.
- 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 comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob. Notez également que s’il est activé, l’algorithme de chargement à 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.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) 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 totale est inconnue.
- max_connections
- int
Nombre maximal de connexions parallèles à utiliser lorsque la taille de l’objet blob dépasse 64 Mo.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
- 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.
Retours
ETag et dernières propriétés modifiées pour l’objet blob de blocs
Type de retour
create_blob_from_stream
Crée un objet blob à partir d’un fichier/flux, ou met à jour le contenu d’un objet blob existant, avec des notifications automatiques de segmentation et de progression.
create_blob_from_stream(container_name, blob_name, stream, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, use_byte_buffer=False, standard_blob_tier=None, cpk=None)
Paramètres
- count
- int
Nombre d’octets à lire à partir du flux. Cette option est facultative, mais doit être fournie pour des performances optimales.
- content_settings
- ContentSettings
Objet ContentSettings utilisé pour définir des propriétés d’objet blob.
Paires nom-valeur associées à l'objet blob en tant que métadonnées.
- 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 comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob. Notez également que s’il est activé, l’algorithme de chargement à 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.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) 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 totale est inconnue.
- max_connections
- int
Nombre maximal de connexions parallèles à utiliser lorsque la taille de l’objet blob dépasse 64 Mo. Notez que le chargement parallèle nécessite que le flux soit recherché.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
- use_byte_buffer
- bool
Si la valeur est True, cela force l’utilisation du chemin de chargement de mise en mémoire tampon de bloc complet d’origine. Par défaut, cette valeur est False et utilise un algorithme de chargement en continu efficace en mémoire dans les conditions suivantes : Le flux fourni est recherché, « require_encryption » est False et MAX_BLOCK_SIZE >= MIN_LARGE_BLOCK_UPLOAD_THRESHOLD. Il faut tenir compte des inconvénients de l’utilisation de cette approche. Pour obtenir une efficacité en mémoire, un flux IOBase ou un objet de type fichier est segmenté en blocs logiques à l’aide d’un wrapper SubStream. Pour lire les données correctes, chaque Sous-flux doit acquérir un verrou afin qu’il puisse rechercher en toute sécurité la bonne position sur le flux sous-jacent partagé. Si max_connections > 1, la concurrence entraîne une quantité considérable de recherche sur le flux sous-jacent. Pour les entrées les plus courantes telles qu’un objet de flux de type fichier, la recherche est une opération peu coûteuse et ce n’est pas très préoccupant. Toutefois, pour d’autres variantes de flux, ce n’est peut-être pas le cas. Le compromis pour l’efficacité de la mémoire doit être évalué par rapport au coût de la recherche avec votre flux d’entrée. La classe SubStream tente de mettre en mémoire tampon jusqu’à 4 Mo en interne pour réduire la quantité d’appels de recherche et de lecture vers le flux sous-jacent. Cela est particulièrement utile lors du chargement de blocs plus volumineux.
- 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.
Retours
ETag et dernières propriétés modifiées pour l’objet blob de blocs
Type de retour
create_blob_from_text
Crée un objet blob à partir de str/unicode, ou met à jour le contenu d’un objet blob existant, avec des notifications de segmentation et de progression automatiques.
create_blob_from_text(container_name, blob_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)
Paramètres
- content_settings
- ContentSettings
Objet ContentSettings utilisé pour définir des propriétés d’objet blob.
Paires nom-valeur associées à l'objet blob en tant que métadonnées.
- 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 comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) 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 totale est inconnue.
- max_connections
- int
Nombre maximal de connexions parallèles à utiliser lorsque la taille de l’objet blob dépasse 64 Mo.
- 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 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
- 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.
Retours
ETag et propriétés de la dernière modification pour l’objet blob de blocs
Type de retour
create_container
Crée un conteneur sous le compte spécifié. Si le conteneur portant le même nom existe déjà, l’opération échoue si fail_on_exist a la valeur True.
create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)
Paramètres
- container_name
- str
Nom du conteneur à créer. Le nom du conteneur ne peut contenir que des lettres minuscules, des chiffres et des traits d’union, et doit commencer par une lettre ou un nombre. Chaque trait d’union doit être précédé et suivi d’un caractère autre qu’un tiret. Le nom doit avoir entre 3 et 63 caractères.
Un dict avec name_value paires à associer au conteneur en tant que métadonnées. Exemple :{'Category' :'test'}
- public_access
- PublicAccess
Les valeurs possibles sont les suivantes : conteneur, objet blob.
- fail_on_exist
- bool
Spécifiez s’il faut lever une exception lorsque le conteneur existe.
Retours
True si le conteneur est créé, False si le conteneur existe déjà.
Type de retour
delete_blob
Marque l’objet blob ou le instantané spécifié pour suppression. L'objet blob est ensuite supprimé lors du garbage collection.
Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération Supprimer l’objet blob.
Si une stratégie de rétention de suppression est activée pour le service, cette opération supprime de manière réversible l’objet blob ou le instantané et conserve l’objet blob ou le instantané pendant le nombre de jours spécifié. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. L’objet blob supprimé de manière réversible ou instantané est accessible via l’API Répertorier les objets blob en spécifiant l’option include=Include.Deleted. L’objet blob ou les instantané supprimés de manière réversible peuvent être restaurés à l’aide de l’API Annuler la suppression.
delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie l’objet blob instantané à supprimer.
- delete_snapshots
- DeleteSnapshot
Obligatoire si l'objet blob a des instantanés associés.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
delete_container
Marque le conteneur spécifié pour suppression. Le conteneur et les objets blob contenus dans ce conteneur sont supprimés lors du garbage collection.
delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- fail_not_exist
- bool
Spécifiez s’il faut lever une exception quand le conteneur n’existe pas.
- lease_id
- str
Si elle est spécifiée, delete_container réussit uniquement si le bail du conteneur est actif et correspond à cet ID. Obligatoire si le conteneur a un bail actif.
- if_modified_since
- datetime
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.
Retours
True si le conteneur est supprimé, le conteneur False n’existe pas.
Type de retour
exists
Retourne une valeur booléenne indiquant si le conteneur existe (si blob_name a la valeur None) ou une valeur booléenne indiquant si l’objet blob existe.
exists(container_name, blob_name=None, snapshot=None, timeout=None)
Paramètres
- blob_name
- str
Nom d’un objet blob. Si aucun n’est, l’existence du conteneur est vérifiée.
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie le instantané.
Retours
Boolean indiquant si la ressource existe.
Type de retour
extract_date_and_request_id
static extract_date_and_request_id(retry_context)
Paramètres
- retry_context
generate_account_shared_access_signature
Génère une signature d’accès partagé pour le service blob. Utilisez la signature retournée avec le paramètre sas_token de n’importe quel blobService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)
Paramètres
- resource_types
- <xref:ResourceTypes>
Spécifie les types de ressources accessibles avec la signature d’accès partagé du compte.
- permission
- <xref:AccountPermissions>
Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.
Heure à laquelle la signature d’accès partagé ne devient plus valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.
Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.
- ip
- str
Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP à partir de laquelle la demande provient ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, si vous spécifiez sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la signature d’accès partagé, la demande est restreinte à ces adresses IP.
- protocol
- str
Spécifie le protocole autorisé pour une demande effectuée. La valeur par défaut est https,http. Pour les valeurs possibles, consultez Protocol.
Retours
Jeton de signature d’accès partagé (SAS).
Type de retour
generate_blob_shared_access_signature
Génère une signature d’accès partagé pour l’objet blob ou l’un de ses instantanés. Utilisez la signature retournée avec le paramètre sas_token de n’importe quel blobService.
generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie l’objet blob instantané à accorder l’autorisation.
- permission
- BlobPermissions
Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Les autorisations doivent être classées en lecture, écriture, suppression, liste. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.
Heure à laquelle la signature d’accès partagé ne devient plus valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.
Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.
- id
- str
Valeur unique d’une longueur maximale de 64 caractères qui correspond à une stratégie d’accès stockée. Pour créer une stratégie d’accès stockée, utilisez set_container_acl.
- ip
- str
Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP à partir de laquelle la demande provient ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, si vous spécifiez sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la signature d’accès partagé, la demande est restreinte à ces adresses IP.
- protocol
- str
Spécifie le protocole autorisé pour une demande effectuée. La valeur par défaut est https,http. Pour les valeurs possibles, consultez Protocol.
- cache_control
- str
Valeur d’en-tête de réponse pour Cache-Control lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_disposition
- str
Valeur d’en-tête de réponse pour Content-Disposition lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_encoding
- str
Valeur d’en-tête de réponse pour Content-Encoding lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_language
- str
Valeur d’en-tête de réponse pour Content-Language lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_type
- str
Valeur d’en-tête de réponse pour Content-Type lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- user_delegation_key
- UserDelegationKey
Au lieu d’une clé de compte, l’utilisateur peut passer une clé de délégation d’utilisateur. Une clé de délégation d’utilisateur peut être obtenue auprès du service en s’authentifiant avec une identité AAD ; Pour ce faire, appelez get_user_delegation_key. Lorsqu’elle est présente, la signature d’accès partagé est signée avec la clé de délégation utilisateur à la place.
Retours
Jeton de signature d’accès partagé (SAS).
Type de retour
generate_container_shared_access_signature
Génère une signature d’accès partagé pour le conteneur. Utilisez la signature retournée avec le paramètre sas_token de n’importe quel blobService.
generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)
Paramètres
- permission
- ContainerPermissions
Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Les autorisations doivent être classées en lecture, écriture, suppression, liste. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.
Heure à laquelle la signature d’accès partagé ne devient plus valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.
Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.
- id
- str
Valeur unique d’une longueur maximale de 64 caractères qui correspond à une stratégie d’accès stockée. Pour créer une stratégie d’accès stockée, utilisez set_blob_service_properties.
- ip
- str
Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP à partir de laquelle la demande provient ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, si vous spécifiez sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la signature d’accès partagé, la demande est restreinte à ces adresses IP.
- protocol
- str
Spécifie le protocole autorisé pour une demande effectuée. La valeur par défaut est https,http. Pour les valeurs possibles, consultez Protocol.
- cache_control
- str
Valeur d’en-tête de réponse pour Cache-Control lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_disposition
- str
Valeur d’en-tête de réponse pour Content-Disposition lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_encoding
- str
Valeur d’en-tête de réponse pour Content-Encoding lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_language
- str
Valeur d’en-tête de réponse pour Content-Language lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- content_type
- str
Valeur d’en-tête de réponse pour Content-Type lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.
- user_delegation_key
- UserDelegationKey
Au lieu d’une clé de compte, l’utilisateur peut passer une clé de délégation d’utilisateur. Une clé de délégation d’utilisateur peut être obtenue auprès du service en s’authentifiant avec une identité AAD ; Pour ce faire, appelez get_user_delegation_key. Lorsqu’elle est présente, la signature d’accès partagé est signée avec la clé de délégation utilisateur à la place.
Retours
Jeton de signature d’accès partagé (SAS).
Type de retour
get_blob_account_information
Obtient des informations relatives au compte de stockage. Les informations peuvent également être récupérées si l’utilisateur dispose d’une signature d’accès partagé à un conteneur ou à un objet blob.
get_blob_account_information(container_name=None, blob_name=None, timeout=None)
Paramètres
- container_name
- str
Nom du conteneur existant. Facultatif, sauf si vous utilisez un jeton SAP pour un conteneur ou un objet blob spécifique, auquel cas cela est obligatoire.
- blob_name
- str
Nom de l’objet blob existant. Facultatif, sauf si vous utilisez un jeton SAS pour un objet blob spécifique, auquel cas cela est obligatoire.
Retours
get_blob_metadata
Retourne toutes les métadonnées définies par l’utilisateur pour l’objet blob ou le instantané spécifié.
get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur opaque qui, lorsqu’elle est présente, spécifie l’objet blob instantané à récupérer.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
Dé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é.
Retours
Dictionnaire représentant le nom des métadonnées d’objet blob et les paires de valeurs.
Type de retour
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. Retourne Blob avec BlobProperties et un dictée de métadonnées.
get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie l’objet blob instantané à récupérer.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
Dé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é.
Retours
objet blob comprenant des propriétés et des métadonnées.
Type de retour
get_blob_service_properties
Obtient les propriétés du service Blob d’un compte de stockage, y compris Azure Storage Analytics.
get_blob_service_properties(timeout=None)
Paramètres
Retours
Objet blob ServiceProperties avec une propriété de target_version attachée.
get_blob_service_stats
Récupère des statistiques relatives à la réplication pour le service BLOB. Elle est disponible uniquement lorsque la réplication géoredondante avec accès en lecture est activée pour le compte de stockage.
Avec la réplication géographique redondante, le stockage Azure conserve vos données dans deux emplacements. Dans les deux emplacements, le stockage Azure conserve constamment plusieurs réplicas sains de vos données. L'emplacement où vous lisez, créez, mettez à jour ou supprimez les données est l'emplacement du compte de stockage principal. L’emplacement principal existe dans la région que vous choisissez au moment où vous créez un compte via le portail Azure Management Azure Classic, par exemple, USA Centre Nord. L'emplacement dans lequel vos données sont répliquées est l'emplacement secondaire. L'emplacement secondaire est automatiquement déterminé en fonction de l'emplacement principal ; il se trouve dans un deuxième centre de données qui réside dans la même région que l'emplacement principal. L'accès en lecture seule est disponible à partir de l'emplacement secondaire, si la réplication géographique redondante avec accès en lecture est activée pour votre compte de stockage.
get_blob_service_stats(timeout=None)
Paramètres
Retours
Statistiques du service BLOB.
Type de retour
get_blob_to_bytes
Télécharge un objet blob sous la forme d’un tableau d’octets, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des Blob propriétés, des métadonnées et du contenu.
get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie l’objet blob instantané à récupérer.
- start_range
- int
Début de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si aucune end_range n’est donnée, tous les octets après le start_range sont téléchargés. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets de l’objet blob.
- end_range
- int
Fin de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si end_range est donné, start_range doivent être fournis. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets de l’objet blob.
- validate_content
- bool
Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée de l’objet blob. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les blocs de 4 Mo ou moins, de sorte que la première requête get sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur est levée. Comme le calcul du MD5 prend du temps de traitement et que davantage de demandes devront être effectuées en raison de la taille réduite des blocs, il peut y avoir une certaine augmentation de la latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature(current, total) où current est le nombre d’octets transférés jusqu’à présent, et total est la taille de l’objet blob si elle est connue.
- max_connections
- int
Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour le premier self. MAX_SINGLE_GET_SIZE octets de l’objet blob. S’il s’agit de l’objet blob entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle en utilisant le nombre de threads égal à max_connections. Chaque bloc sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule requête get volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si de nombreux objets blob sont censés être vides, car une demande supplémentaire est requise pour les objets blob vides si max_connections est supérieur à 1.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
Dé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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
Retours
Objet blob avec des propriétés et des métadonnées. Si max_connections est supérieur à 1, la content_md5 (si elle est définie sur l’objet blob) ne sera pas retournée. Si vous avez besoin de cette valeur, utilisez get_blob_properties ou définissez max_connections sur 1.
Type de retour
get_blob_to_path
Télécharge un objet blob dans un chemin d’accès de fichier, avec des notifications automatiques de segmentation et de progression. Retourne une instance de avec des Blob propriétés et des métadonnées.
get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- open_mode
- str
Mode à utiliser lors de l’ouverture du fichier. Notez que la spécification d’ajout uniquement open_mode empêche le téléchargement parallèle. Par conséquent, max_connections devez avoir la valeur 1 si cette open_mode est utilisée.
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie le instantané d’objet blob à récupérer.
- start_range
- int
Début de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si aucune end_range n’est donnée, tous les octets après le start_range sont téléchargés. Les start_range et end_range sont inclusifs. Par exemple : start_range=0, end_range=511 télécharge les 512 premiers octets d’objet blob.
- end_range
- int
Fin de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Par exemple : start_range=0, end_range=511 télécharge les 512 premiers octets d’objet blob.
- validate_content
- bool
Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée de l’objet blob. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille de l’objet blob s’il est connu.
- max_connections
- int
Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets de l’objet blob. S’il s’agit de l’objet blob entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si de nombreux objets blob sont censés être vides, car une demande supplémentaire est requise pour les objets blob vides si max_connections est supérieur à 1.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
Dé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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
Retours
Objet blob avec des propriétés et des métadonnées. Si max_connections est supérieur à 1, le content_md5 (s’il est défini sur l’objet blob) n’est pas retourné. Si vous avez besoin de cette valeur, utilisez get_blob_properties ou définissez max_connections sur 1.
Type de retour
get_blob_to_stream
Télécharge un objet blob dans un flux, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des Blob propriétés et des métadonnées.
get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie le instantané d’objet blob à récupérer.
- start_range
- int
Début de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si aucune end_range n’est donnée, tous les octets après le start_range sont téléchargés. Les start_range et end_range sont inclusifs. Par exemple : start_range=0, end_range=511 télécharge les 512 premiers octets d’objet blob.
- end_range
- int
Fin de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Par exemple : start_range=0, end_range=511 télécharge les 512 premiers octets d’objet blob.
- validate_content
- bool
Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée de l’objet blob. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille de l’objet blob s’il est connu.
- max_connections
- int
Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets de l’objet blob. S’il s’agit de l’objet blob entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si de nombreux objets blob sont censés être vides, car une demande supplémentaire est requise pour les objets blob vides si max_connections est supérieur à 1.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
Dé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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
Retours
Objet blob avec des propriétés et des métadonnées. Si max_connections est supérieur à 1, le content_md5 (s’il est défini sur l’objet blob) n’est pas retourné. Si vous avez besoin de cette valeur, utilisez get_blob_properties ou définissez max_connections sur 1.
Type de retour
get_blob_to_text
Télécharge un objet blob sous forme de texte unicode, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des Blob propriétés, des métadonnées et du contenu.
get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- snapshot
- str
Le paramètre instantané est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie le instantané d’objet blob à récupérer.
- start_range
- int
Début de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si aucune end_range n’est donnée, tous les octets après le start_range sont téléchargés. Les start_range et end_range sont inclusifs. Par exemple : start_range=0, end_range=511 télécharge les 512 premiers octets d’objet blob.
- end_range
- int
Fin de la plage d’octets à utiliser pour télécharger une section de l’objet blob. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Par exemple : start_range=0, end_range=511 télécharge les 512 premiers octets d’objet blob.
- validate_content
- bool
Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée de l’objet blob. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille de l’objet blob s’il est connu.
- max_connections
- int
Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets de l’objet blob. S’il s’agit de l’objet blob entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si de nombreux objets blob sont censés être vides, car une demande supplémentaire est requise pour les objets blob vides si max_connections est supérieur à 1.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
Dé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
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
Retours
Objet blob avec des propriétés et des métadonnées. Si max_connections est supérieur à 1, le content_md5 (s’il est défini sur l’objet blob) n’est pas retourné. Si vous avez besoin de cette valeur, utilisez get_blob_properties ou définissez max_connections sur 1.
Type de retour
get_block_list
Récupère la liste de blocs qui ont été téléchargés dans le cadre d'un objet blob de blocs. Deux listes de blocs sont tenues à jour pour un objet blob :
Liste de blocs validée : liste des blocs qui ont été correctement validés dans un objet blob donné avec Put Block List.
Liste de blocs non validée : liste des blocs qui ont été chargés pour un objet blob à l’aide de Put Block, mais qui n’ont pas encore été validés. Ces blocs sont stockés dans Azure et associés à un objet blob, mais ne font pas partie de l'objet blob.
get_block_list(container_name, blob_name, snapshot=None, block_list_type=None, lease_id=None, timeout=None)
Paramètres
- block_list_type
- str
Indique quelle liste retourner : liste des blocs validés, liste des blocs non validés ou ces deux listes. Les valeurs valides sont les suivantes : commit, non validée ou all.
Retours
répertorier les blocs validés et/ou non validés pour l’objet Blob de blocs
Type de retour
get_container_acl
Obtient les autorisations pour le conteneur spécifié. Les autorisations indiquent si les données de conteneur sont accessibles publiquement.
get_container_acl(container_name, lease_id=None, timeout=None)
Paramètres
- lease_id
S’il est spécifié, get_container_acl réussit uniquement si le bail du conteneur est actif et correspond à cet ID.
Retours
Dictionnaire des stratégies d’accès associées au conteneur. dict de str to AccessPolicy et une propriété public_access si l’accès public est activé
get_container_metadata
Retourne toutes les métadonnées définies par l’utilisateur pour le conteneur spécifié.
get_container_metadata(container_name, lease_id=None, timeout=None)
Paramètres
- lease_id
- str
S’il est spécifié, get_container_metadata réussit uniquement si le bail du conteneur est actif et correspond à cet ID.
Retours
Dictionnaire représentant le nom des métadonnées du conteneur, les paires de valeurs.
Type de retour
get_container_properties
Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le conteneur spécifié. Les données renvoyées ne comprennent pas la liste d'objets blob du conteneur.
get_container_properties(container_name, lease_id=None, timeout=None)
Paramètres
- lease_id
- str
S’il est spécifié, get_container_properties réussit uniquement si le bail du conteneur est actif et correspond à cet ID.
Retours
pour le conteneur spécifié dans un objet conteneur.
Type de retour
get_user_delegation_key
Obtenez une clé de délégation utilisateur dans le but de signer des jetons SAP. Des informations d’identification de jeton doivent être présentes sur l’objet de service pour que cette demande réussisse.
get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)
Paramètres
Retours
Clé de délégation utilisateur.
Type de retour
list_blob_names
Retourne un générateur pour répertorier les noms d’objets blob sous le conteneur spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les objets blob ont été retournés ou num_results sont atteints.
Si num_results est spécifié et que le compte a plus que ce nombre d’objets blob, le générateur dispose d’un champ next_marker rempli une fois terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.
list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)
Paramètres
- prefix
- str
Filtre les résultats pour renvoyer uniquement les objets blob dont le nom commence par le préfixe spécifié.
- num_results
- int
Spécifie le nombre maximal d'objets blob à renvoyer, y compris tous les éléments <xref:azure.storage.blob.blockblobservice.BlobPrefix>. Si la demande ne spécifie pas num_results ou spécifie une valeur supérieure à 5 000, le serveur retourne jusqu’à 5 000 éléments. Si vous définissez num_results sur une valeur inférieure ou égale à zéro, le code de réponse d’erreur est 400 (requête incorrecte).
- include
- Include
Spécifie un ou plusieurs jeux de données supplémentaires à inclure dans la réponse.
- delimiter
- str
Lorsque la requête inclut ce paramètre, l’opération retourne un BlobPrefix élément dans la liste des résultats qui sert d’espace réservé pour tous les objets blob dont les noms commencent par la même sous-chaîne jusqu’à l’apparence du caractère délimiteur. Le délimiteur peut être un caractère ou une chaîne.
- marker
- str
Jeton de continuation opaque. Cette valeur peut être récupérée à partir du champ next_marker d’un objet générateur précédent si num_results a été spécifié et que ce générateur a terminé l’énumération des résultats. S’il est spécifié, ce générateur commence à retourner les résultats à partir du point où le générateur précédent s’est arrêté.
list_blobs
Retourne un générateur pour répertorier les objets blob sous le conteneur spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les objets blob ont été retournés ou num_results est atteint.
Si num_results est spécifié et que le compte a plus que ce nombre d’objets blob, le générateur aura un champ next_marker rempli une fois qu’il aura terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.
list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)
Paramètres
- prefix
- str
Filtre les résultats pour renvoyer uniquement les objets blob dont le nom commence par le préfixe spécifié.
- num_results
- int
Spécifie le nombre maximal d'objets blob à renvoyer, y compris tous les éléments <xref:azure.storage.blob.blockblobservice.BlobPrefix>. Si la demande ne spécifie pas num_results ou spécifie une valeur supérieure à 5 000, le serveur retourne jusqu’à 5 000 éléments. La définition de num_results sur une valeur inférieure ou égale à zéro entraîne le code de réponse d’erreur 400 (Demande incorrecte).
- include
- Include
Spécifie un ou plusieurs jeux de données supplémentaires à inclure dans la réponse.
- delimiter
- str
Lorsque la requête inclut ce paramètre, l’opération retourne un BlobPrefix élément dans la liste des résultats qui agit comme espace réservé pour tous les objets blob dont le nom commence par la même sous-chaîne jusqu’à l’apparence du caractère délimiteur. Le délimiteur peut être un caractère ou une chaîne.
- marker
- str
Jeton de continuation opaque. Cette valeur peut être récupérée à partir du champ next_marker d’un objet générateur précédent si num_results a été spécifié et que ce générateur a terminé l’énumération des résultats. S’il est spécifié, ce générateur commence à retourner les résultats à partir du point où le générateur précédent s’est arrêté.
list_containers
Retourne un générateur pour répertorier les conteneurs sous le compte spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les conteneurs ont été retournés ou num_results est atteint.
Si num_results est spécifié et que le compte a plus que ce nombre de conteneurs, le générateur aura un champ next_marker rempli une fois qu’il aura terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.
list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)
Paramètres
- prefix
- str
Filtre les résultats pour renvoyer uniquement les conteneurs dont le nom commence par le préfixe spécifié.
- num_results
- int
Indique le nombre maximal de conteneurs à retourner. Une demande de liste unique peut retourner jusqu’à 1 000 contianers et potentiellement un jeton de continuation qui doit être suivi pour obtenir des résutls supplémentaires.
- include_metadata
- bool
Spécifie que les métadonnées de conteneur doivent être retournées dans la réponse.
- marker
- str
Jeton de continuation opaque. Cette valeur peut être récupérée à partir du champ next_marker d’un objet générateur précédent si num_results a été spécifié et que ce générateur a terminé l’énumération des résultats. S’il est spécifié, ce générateur commence à retourner les résultats à partir du point où le générateur précédent s’est arrêté.
make_blob_url
Crée l’URL pour accéder à un objet blob.
make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)
Paramètres
- protocol
- str
Protocole à utiliser : « http » ou « https ». S’il n’est pas spécifié, utilise le protocole spécifié lors de l’initialisation de BaseBlobService.
- sas_token
- str
Jeton de signature d’accès partagé créé avec generate_shared_access_signature.
- snapshot
- str
Valeur de chaîne qui identifie de manière unique le instantané. La valeur de ce paramètre de requête indique la version instantané.
Retours
URL d’accès aux objets blob.
Type de retour
make_container_url
Crée l’URL pour accéder à un conteneur.
make_container_url(container_name, protocol=None, sas_token=None)
Paramètres
- protocol
- str
Protocole à utiliser : « http » ou « https ». S’il n’est pas spécifié, utilise le protocole spécifié lors de l’initialisation de BaseBlobService.
- sas_token
- str
Jeton de signature d’accès partagé créé avec generate_shared_access_signature.
Retours
URL d’accès au conteneur.
Type de retour
put_block
Crée un bloc à valider dans le cadre d'un objet blob.
put_block(container_name, blob_name, block, block_id, validate_content=False, lease_id=None, timeout=None, cpk=None)
Paramètres
- block_id
- str
Valeur de chaîne qui identifie le bloc. La taille de la chaîne doit être inférieure ou égale à 64 octets. Pour un objet blob donné, le block_id doit avoir la même taille pour chaque bloc.
- 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 qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob.
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é.
put_block_from_url
Crée un bloc à valider dans le cadre d'un objet blob.
put_block_from_url(container_name, blob_name, copy_source_url, block_id, source_range_start=None, source_range_end=None, source_content_md5=None, lease_id=None, timeout=None, cpk=None)
Paramètres
- copy_source_url
- str
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_range_start
- int
Cela indique le début de la plage d’octets (inclus) qui doit être extraite de la source de copie.
- source_range_end
- int
Cela indique la fin de la plage d’octets (inclus) qui doit être extraite de la source de copie.
- block_id
- str
Valeur de chaîne qui identifie le bloc. La taille de la chaîne doit être inférieure ou égale à 64 octets. Pour un objet blob donné, le block_id doit avoir la même taille pour chaque bloc.
- source_content_md5
- str
Si cette valeur est donnée, le service calcule le hachage MD5 du contenu du bloc et compare à cette valeur.
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é.
put_block_list
Écrit un objet blob en spécifiant la liste des ID de bloc qui composent l'objet blob. Pour être écrit dans le cadre d’un objet blob, un bloc doit avoir été correctement écrit sur le serveur lors d’une opération Put Block antérieure.
Vous pouvez appeler Put Block List pour mettre à jour un objet blob en chargeant uniquement les blocs qui ont changé, puis en validant ensemble les blocs nouveaux et existants. Vous pouvez faire cela en spécifiant si un bloc doit être validé à partir de la liste de blocs validés ou de la liste de blocs non validés, ou si la version du bloc téléchargée en dernier doit être validée en indiquant la liste auquel le bloc appartient.
put_block_list(container_name, blob_name, block_list, content_settings=None, metadata=None, validate_content=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)
Paramètres
- block_list
- list(BlobBlock)
Liste de contenant les ID de <xref:azure.storeage.blob.models.BlobBlock> bloc et l’état du bloc.
- content_settings
- ContentSettings
Objet ContentSettings utilisé pour définir des propriétés sur l’objet blob.
Paires nom-valeur associées à l'objet blob en tant que métadonnées.
- validate_content
- bool
Si la valeur est true, calcule un hachage MD5 du contenu de la liste de blocage. Le service de stockage vérifie le hachage du contenu de la liste de blocage qui est arrivé avec le hachage envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que cette case activée est associée au contenu de la liste de blocs, et non au contenu de l’objet blob lui-même.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas, et l’opération échoue si elle existe.
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é.
- 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.
Retours
ETag et dernières propriétés modifiées pour l’objet blob de blocs mis à jour
Type de retour
release_blob_lease
Libère le bail. Le bail peut être libéré si l'ID de bail spécifié dans la demande correspond à celui associé à l'objet blob. La libération du bail permet à un autre client d'acquérir immédiatement le bail pour l'objet blob dès qu'il a été libéré.
release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
Paramètres
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
release_container_lease
Permet de libérer le bail. Le bail peut être libéré si le lease_id spécifié correspond à celui associé au conteneur. La libération du bail permet à un autre client d'acquérir immédiatement le bail pour le conteneur dès que la libération est terminée.
release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- 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.
renew_blob_lease
Renouvelle le bail. Le bail peut être renouvelé si l'ID de bail spécifié dans la demande correspond à celui associé à l'objet blob. Notez que le bail peut être renouvelé même s'il a expiré, tant que l'objet blob n'a pas été modifié ou n'a pas été reloué depuis l'expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée.
renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
Paramètres
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
Retours
str
renew_container_lease
Renouvelle le bail. Le bail peut être renouvelé si l’ID de bail spécifié correspond à celui associé au conteneur. Notez que le bail peut être renouvelé même s'il a expiré, tant que le conteneur n'a pas été reloué depuis l'expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée.
renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- 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.
Retours
str
set_blob_metadata
Définit les métadonnées définies par l’utilisateur pour l’objet blob spécifié en tant qu’une ou plusieurs paires nom-valeur.
set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
Dict contenant des paires nom et 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.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
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é.
Retours
ETag et dernières propriétés modifiées pour l’objet blob mis à jour
Type de retour
set_blob_properties
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_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
Paramètres
- content_settings
- ContentSettings
Objet ContentSettings utilisé pour définir des propriétés d’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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
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é.
Retours
ETag et dernières propriétés modifiées pour l’objet blob mis à jour
Type de retour
set_blob_service_properties
Définit les propriétés du service Blob d’un compte de stockage, y compris Azure Storage Analytics. Si un élément (ex Journalisation) est laissé comme Aucun, les paramètres existants sur le service pour cette fonctionnalité sont conservés.
set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)
Paramètres
- hour_metrics
- Metrics
Les paramètres des métriques d’heure fournissent un résumé des statistiques de requête regroupées par API dans des agrégats horaires pour les objets blob.
- minute_metrics
- Metrics
Les paramètres des métriques de minute fournissent des statistiques de requête pour chaque minute pour les objets blob.
- cors
- list(CorsRule)
Vous pouvez inclure jusqu’à cinq éléments CorsRule dans la liste. Si une liste vide est spécifiée, toutes les règles CORS sont supprimées et CORS sont désactivées pour le service.
- target_version
- str
Indique la version par défaut à utiliser pour les requêtes si la version d’une requête entrante n’est pas spécifiée.
- delete_retention_policy
- DeleteRetentionPolicy
La stratégie de rétention de suppression spécifie s’il faut conserver les objets blob supprimés. Il spécifie également le nombre de jours et de versions d’objet blob à conserver.
- static_website
- StaticWebsite
Spécifie si la fonctionnalité de site web statique est activée et, si oui, indique le document d’index et le document d’erreur 404 à utiliser.
set_container_acl
Définit les autorisations pour le conteneur spécifié ou les stratégies d’accès stocké qui peuvent être utilisées avec les signatures d’accès partagé. Les autorisations indiquent si les objets blob dans un conteneur sont accessibles publiquement.
set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Paramètres
- signed_identifiers
- dict(str, AccessPolicy)
Dictionnaire des stratégies d’accès à associer au conteneur. Le dictionnaire peut contenir jusqu’à 5 éléments. Un dictionnaire vide efface les stratégies d’accès définies sur le service.
- public_access
- PublicAccess
Les valeurs possibles sont les suivantes : conteneur, objet blob.
- lease_id
- str
S’il est spécifié, set_container_acl réussit uniquement si le bail du conteneur est actif et correspond à cet ID.
- 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 a été modifiée depuis la date/heure spécifiée.
- if_unmodified_since
- datetime
Valeur datetime. Azure s’attend à ce que la valeur de date 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.
Retours
ETag et dernières propriétés modifiées pour le conteneur mis à jour
Type de retour
set_container_metadata
Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le conteneur spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au conteneur. Pour supprimer toutes les métadonnées du conteneur, appelez cette opération sans dictée de métadonnées.
set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)
Paramètres
dict contenant des paires nom-valeur à associer au conteneur en tant que métadonnées. Exemple : {'category' :'test'}
- lease_id
- str
S’il est spécifié, set_container_metadata réussit uniquement si le bail du conteneur est actif et correspond à cet ID.
- if_modified_since
- datetime
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é.
Retours
ETag et dernières propriétés modifiées pour le conteneur mis à jour
Type de retour
set_proxy
Définit l’hôte et le port du serveur proxy pour le tunnelling HTTP CONNECT.
set_proxy(host, port, user=None, password=None)
Paramètres
set_standard_blob_tier
Définit les niveaux d’objet blob de blocs sur l’objet blob. Cette API est uniquement prise en charge pour les objets blob de blocs sur les comptes de stockage standard.
:p aram RehydratePriority rehydrate_priority : indique la priorité avec laquelle réhydrater un objet blob archivé
set_standard_blob_tier(container_name, blob_name, standard_blob_tier, timeout=None, rehydrate_priority=None)
Paramètres
- 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.
- timeout
- int
Le paramètre timeout est exprimé en secondes. Cette méthode peut effectuer plusieurs appels au service Azure et le délai d’expiration s’applique à chaque appel individuellement.
- rehydrate_priority
snapshot_blob
Crée un instantané en lecture seule d'un objet blob.
snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)
Paramètres
Spécifie une paire nom-valeur définie par l'utilisateur associée à l'objet blob. Si aucune paire nom-valeur n'est spécifiée, l'opération copie les métadonnées de l'objet blob de base dans l'instantané. Si une ou plusieurs paires nom-valeur sont spécifiées, l'instantané 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 de base.
- 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.
- if_match
- str
Spécifiez une valeur ETag ou le caractère générique *. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée.
- if_none_match
- str
Valeur ETag ou caractère générique (). Spécifiez cet en-tête pour effectuer l’opération uniquement si l’ETag de la ressource ne correspond pas à la valeur spécifiée. Spécifiez le caractère générique () pour effectuer l’opération uniquement si la ressource n’existe pas et l’échec de l’opération si elle existe.
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é.
Retours
instantané propriétés
Type de retour
undelete_blob
L’opération d’annulation de la suppression de l’objet blob restaure le contenu et les métadonnées de l’objet blob ou des instantané supprimés de manière réversible. La tentative de suppression d’un objet blob ou d’un instantané qui n’est pas supprimé de manière réversible réussit sans aucune modification.
undelete_blob(container_name, blob_name, timeout=None)
Paramètres
Attributs
protocol
request_session
socket_timeout
MAX_BLOCK_SIZE
MAX_BLOCK_SIZE = 4194304
MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 4194304
MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
MAX_SINGLE_PUT_SIZE
MAX_SINGLE_PUT_SIZE = 67108864
MIN_LARGE_BLOCK_UPLOAD_THRESHOLD
MIN_LARGE_BLOCK_UPLOAD_THRESHOLD = 4194305
Azure SDK for Python