BaseBlobService Classe
Il s’agit de la classe main qui gère les ressources Blob.
Le service BLOB stocke des données texte et binaires en tant qu'objets blob dans le cloud. Le service BLOB offre les trois ressources suivantes : le compte de stockage, les conteneurs et les objets blob. Dans votre compte de stockage, les conteneurs fournissent une façon d'organiser les ensembles d'objets blob. Pour plus d’informations, consultez : https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx
:type ~azure.storage.common.TokenCredential
- Héritage
-
BaseBlobService
Constructeur
BaseBlobService(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 une 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 des deux 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. Si elle est spécifiée, remplace tous les autres paramètres en plus des chaîne de connexion et de la session 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 cette valeur pour utiliser le cloud chine (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. Voir http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ pour le format chaîne de connexion
- socket_timeout
- int
Si elle est spécifiée, cela remplace le délai d’expiration du socket par défaut. Le délai d’expiration 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_GET_SIZE
- int
La taille de la première plage est effectuée par les méthodes get_blob_to_* si max_connections est supérieur à 1. Moins de données seront retournées si l’objet blob est plus petit que celui-ci.
- MAX_CHUNK_GET_SIZE
- int
La taille de la plage suivante est effectuée par les méthodes get_blob_to_* si max_connections est supérieur à 1 et que l’objet blob est supérieur à MAX_SINGLE_GET_SIZE. Moins de données seront retournées si le reste de l’objet blob est plus petit que celui-ci. Si cette valeur est supérieure à 4 Mo, content_validation génère une erreur si cette option est activée. Toutefois, si content_validation n’est pas souhaité, une taille supérieure à 4 Mo peut être optimale. La définition de cette valeur ci-dessous 4 Mo n’est pas recommandée.
- key_encryption_key
- object
Clé de chiffrement de clé éventuellement fournie par l’utilisateur. S’il est fourni, sera utilisé pour chiffrer/déchiffrer dans les méthodes prises en charge. Pour les méthodes nécessitant un déchiffrement, le key_encryption_key OU le programme de résolution doit être fourni. Si les deux sont fournis, le programme de résolution est prioritaire. Doit implémenter les méthodes suivantes pour les API nécessitant un chiffrement : wrap_key(key)–encapsule la clé (octets) spécifiée à l’aide d’un algorithme de choix de l’utilisateur. Retourne la clé chiffrée sous forme d’octets. get_key_wrap_algorithm()–retourne l’algorithme utilisé pour encapsuler la clé symétrique spécifiée. get_kid()–retourne un ID de clé de chaîne pour cette clé-chiffrement-clé. Doit implémenter les méthodes suivantes pour les API nécessitant un déchiffrement : unwrap_key(clé, algorithme) – retourne la forme non décapée de la clé symétrique spécifiée à l’aide de l’algorithme spécifié par chaîne. get_kid()–retourne un ID de clé de chaîne pour cette clé-chiffrement-clé.
- key_resolver_function
- kid) (<xref:function>
Fonction permettant de résoudre les clés fournies éventuellement par l’utilisateur. S’il est fourni, sera utilisé pour déchiffrer dans les méthodes prises en charge. Pour les méthodes nécessitant un déchiffrement, le key_encryption_key OU le programme de résolution doit être fourni. Si les deux sont fournis, le programme de résolution est prioritaire. Il utilise la chaîne kid pour retourner une clé de chiffrement de clé implémentant l’interface définie ci-dessus.
- require_encryption
- bool
Indicateur qui peut être défini pour garantir que tous les messages ont été correctement chargés dans la file d’attente et que tous ceux téléchargés et correctement lus à partir de la file d’attente sont/ont été chiffrés sur le serveur. Si cet indicateur est défini, tous les paramètres requis pour le chiffrement/déchiffrement doivent être fournis. Consultez les commentaires ci-dessus sur le key_encryption_key et le programme de résolution.
Méthodes
abort_copy_blob |
Abandonne une opération de copy_blob en attente et laisse un objet blob de destination avec 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 |
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 de manière asynchrone. Cette opération retourne un objet de propriétés d’opération de copie, y compris un ID de copie que vous pouvez utiliser pour case activée ou annuler l’opération de copie. Le service BLOB copie sur une base du meilleur effort. L’objet blob source d’une opération de copie peut être un objet blob de bloc, un objet blob d’ajout ou un objet blob de pages. Si l’objet blob de destination existe déjà, il doit être du même type d’objet blob que l’objet blob source. Tout objet blob de destination existant sera remplacé. L'objet blob de destination ne peut pas être modifié pendant qu'une opération de copie est en cours. Lors de la copie à partir d’un objet blob de pages, le service Blob crée un objet blob de page de destination de la longueur de l’objet blob source, contenant initialement tous les zéros. Puis les plages de pages source sont énumérées, et des plages non vides sont copiées. Pour un objet blob de bloc ou un objet blob d’ajout, le service Blob crée un objet blob validé de longueur nulle avant de revenir à partir de cette opération. Lors de la copie à partir d’un objet blob de blocs, tous les blocs validés et leurs ID de blocs sont copiés. Les blocs non validés ne sont pas copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source. Lors de la copie à partir d’un objet blob d’ajout, tous les blocs validés sont copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source. Pour tous les types d’objets blob, 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. |
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 l’objet blob ou le instantané et conserve l’objet blob ou le instantané pendant un nombre de jours spécifié. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. Les objets blob ou les instantané supprimés de manière réversible sont accessibles via l’API List Blobs en spécifiant l’option include=Include.Deleted. Les objets 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 la suppression. Le conteneur et les objets blob contenus dans ce conteneur sont supprimés lors du garbage collection. |
exists |
Renvoie une valeur booléenne indiquant si le conteneur existe (si blob_name est 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 SAP dans 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 une 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 de créer 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 de segmentation et de progression automatiques. 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 des notifications de segmentation et de progression automatiques. 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 des notifications de segmentation et de progression automatiques. Retourne une instance de avec des Blob propriétés, des métadonnées et du contenu. |
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 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_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 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. |
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. |
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. |
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 avec 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. Une durée de 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 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
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. Une durée de 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 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
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
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 de manière asynchrone. Cette opération retourne un objet de propriétés d’opération de copie, y compris un ID de copie que vous pouvez utiliser pour case activée ou annuler l’opération de copie. Le service BLOB copie sur une base du meilleur effort.
L’objet blob source d’une opération de copie peut être un objet blob de bloc, un objet blob d’ajout ou un objet blob de pages. Si l’objet blob de destination existe déjà, il doit être du même type d’objet blob que l’objet blob source. Tout objet blob de destination existant sera remplacé. L'objet blob de destination ne peut pas être modifié pendant qu'une opération de copie est en cours.
Lors de la copie à partir d’un objet blob de pages, le service Blob crée un objet blob de page de destination de la longueur de l’objet blob source, contenant initialement tous les zéros. Puis les plages de pages source sont énumérées, et des plages non vides sont copiées.
Pour un objet blob de bloc ou un objet blob d’ajout, le service Blob crée un objet blob validé de longueur nulle avant de revenir à partir de cette opération. Lors de la copie à partir d’un objet blob de blocs, tous les blocs validés et leurs ID de blocs sont copiés. Les blocs non validés ne sont pas copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source.
Lors de la copie à partir d’un objet blob d’ajout, tous les blocs validés sont copiés. À la fin de l’opération de copie, l’objet blob de destination aura le même nombre de blocs validés que la source.
Pour tous les types d’objets blob, 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.
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)
Paramètres
- blob_name
- str
Nom de l’objet blob de destination. Si l’objet blob de destination existe, il est remplacé. Sinon, il sera créé.
- copy_source
- str
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
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.
- source_if_modified_since
- datetime
Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête conditionnel pour copier l'objet blob uniquement si l'objet blob source a été modifié depuis la date/l'heure indiquées.
- source_if_unmodified_since
- datetime
Valeur DateTime. Azure s’attend à ce que la valeur de date 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.
- source_if_match
- <xref:ETag>
Spécifiez une valeur ETag ou le 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 d'ETag ne correspondent pas, le service BLOB retourne 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.
- source_if_none_match
- <xref:ETag>
Spécifiez une valeur ETag ou le 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.
- destination_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 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).
- destination_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 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).
- destination_if_match
- <xref:ETag>
Spécifiez une valeur ETag ou le 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 de 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).
- destination_if_none_match
- <xref:ETag>
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 ne correspond pas à la valeur ETag de l’objet blob de destination. Spécifiez le caractère générique () pour effectuer 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).
- destination_lease_id
- str
L'ID de bail spécifié pour cet en-tête doit correspondre à l'ID de bail de l'objet blob de destination. Si la demande n'inclut pas l'ID de bail ou si elle n'est pas valide, l'opération échoue avec un code d'état 412 (Échec de la précondition).
- source_lease_id
- str
Spécifiez cette option 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.
Retours
Copiez les propriétés de l’opération telles que status, source et ID.
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 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.
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 l’objet blob ou le instantané et conserve l’objet blob ou le instantané pendant un nombre de jours spécifié. Après le nombre de jours spécifié, les données de l’objet blob sont supprimées du service pendant le garbage collection. Les objets blob ou les instantané supprimés de manière réversible sont accessibles via l’API List Blobs en spécifiant l’option include=Include.Deleted. Les objets 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 le instantané d’objet blob à 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 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.
delete_container
Marque le conteneur spécifié pour la 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 lorsque le conteneur n’existe pas.
- lease_id
- str
S’il est spécifié, delete_container réussit uniquement si le bail du conteneur est actif et correspond à cet ID. Obligatoire si le conteneur a un bail actif.
- if_modified_since
- datetime
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
True si le conteneur est supprimé, le conteneur False n’existe pas.
Type de retour
exists
Renvoie une valeur booléenne indiquant si le conteneur existe (si blob_name est 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, le conteneur sera vérifié pour l’existence.
- 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 sap 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é devient non 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 transmise 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 transmise 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 d’où provient la demande 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, la spécification de sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la sap limite la demande à ces adresses IP.
- protocol
- str
Spécifie le protocole autorisé pour une requête 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 le instantané d’objet blob à accorder.
- 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 trié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é devient non 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 transmise 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 transmise 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 d’où provient la demande 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, la spécification de sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la sap limite la demande à ces adresses IP.
- protocol
- str
Spécifie le protocole autorisé pour une requête 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 utilisateur peut être obtenue à partir du service en authentification 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 trié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é devient non 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 transmise 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 transmise 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 d’où provient la demande 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, la spécification de sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la sap limite la demande à ces adresses IP.
- protocol
- str
Spécifie le protocole autorisé pour une requête 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 utilisateur peut être obtenue à partir du service en authentification 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 SAP dans 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 SAP 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 le instantané d’objet blob à récupérer.
- 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é.
Retours
Dictionnaire représentant le nom des métadonnées d’objet blob, 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 une 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 le instantané d’objet blob à récupérer.
- 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é.
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 de créer 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 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 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 de segmentation et de progression automatiques. 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 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_stream
Télécharge un objet blob dans un flux, avec des notifications de segmentation et de progression automatiques. 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 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_text
Télécharge un objet blob sous forme de texte unicode, avec des notifications de segmentation et de progression automatiques. 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 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_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 of 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
Si elle est spécifiée, 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.baseblobservice.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 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(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.baseblobservice.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_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 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_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 les noms commencent par le préfixe spécifié.
- num_results
- int
Indique le nombre maximal de conteneurs à retourner. Une demande de liste unique peut renvoyer jusqu’à 1 000 contianers et potentiellement un jeton de continuation qui doit être suivi pour obtenir des informations 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
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
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_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 4194304
MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
Azure SDK for Python