FileService Classe

Référence

Le protocole SMB (Server Message Block) est actuellement le protocole de partage de fichiers le plus utilisé sur site. Le service De fichiers Microsoft Azure permet aux clients de tirer parti de la disponibilité et de la scalabilité du SMB IaaS (Cloud Infrastructure as a Service) d’Azure sans avoir à réécrire les applications clientes SMB.

Le service de Fichier Azure constitue également une alternative intéressante aux solutions traditionnelles DAS (stockage en attachement direct) et SAN (réseau de zone de stockage), dont l'installation, la configuration et l'exploitation sont souvent plus compliquées et coûteuses.

Héritage: StorageClient

FileService

Constructeur

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

Paramètres

Nom	Description
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. valeur par défaut: None
account_key	str La clé du compte de stockage. Il est utilisé pour l’authentification par clé partagée. valeur par défaut: None
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. valeur par défaut: None
protocol	str Protocole à utiliser pour les requêtes. La valeur par défaut est https. valeur par défaut: 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). valeur par défaut: core.windows.net
request_session	<xref:requests.Session> Objet de session à utiliser pour les requêtes http. valeur par défaut: None
connection_string	str S’il est spécifié, cela remplacera tous les autres paramètres en plus de la session de requête. Consultez http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ pour connaître le format chaîne de connexion. valeur par défaut: None
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. valeur par défaut: None

Variables

Nom	Description
MAX_SINGLE_GET_SIZE	int La taille de la première plage est effectuée par les méthodes get_file_to_* si max_connections est supérieur à 1. Moins de données seront retournées si le fichier 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_file_to_* si max_connections est supérieur à 1 et si le fichier est supérieur à MAX_SINGLE_GET_SIZE. Moins de données seront retournées si le reste du fichier 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.
MAX_RANGE_SIZE	int Taille des plages placées par les méthodes create_file_from_*. Des plages plus petites peuvent être placées s’il y a moins de données fournies. La taille de plage maximale prise en charge par le service est de 4 Mo.

Méthodes

abort_copy_file	Abandonne une opération de copy_file en attente et laisse un fichier de destination avec aucune longueur et des métadonnées complètes.
clear_range	Efface la plage spécifiée et libère l’espace utilisé dans le stockage pour cette plage.
close_handles	Retourne un générateur pour fermer les handles ouverts sur un répertoire ou un fichier sous le partage spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les handles ont été fermés. Les valeurs générées représentent le nombre de handles qui ont été fermés dans chaque transaction.
copy_file	Copie un fichier de façon 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 abandonner l’opération de copie. Le service de fichiers copie les fichiers au mieux. Si le fichier de destination existe, il est remplacé. Impossible de modifier le fichier de destination pendant que l’opération de copie est en cours.
create_directory	Crée un répertoire sous le partage ou le répertoire parent spécifié. Si le répertoire portant le même nom existe déjà, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_on_exists.
create_file	Crée un nouveau fichier. Consultez create_file_from_* pour connaître les fonctions de haut niveau qui gèrent la création et le chargement de fichiers volumineux avec des notifications de segmentation et de progression automatiques.
create_file_from_bytes	Crée un fichier à partir d’un tableau d’octets ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.
create_file_from_path	Crée un fichier Azure à partir d’un chemin d’accès de fichier local ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.
create_file_from_stream	Crée un fichier à partir d’un fichier/flux ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.
create_file_from_text	Crée un fichier à partir de str/unicode, ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.
create_permission_for_share	Créez une autorisation (un descripteur de sécurité) au niveau du partage. Cette « autorisation » peut être utilisée pour les fichiers/répertoires dans le partage. S’il existe déjà une « autorisation », elle retourne la clé de celle-ci, sinon elle crée une nouvelle autorisation au niveau du partage et retourne sa clé. :retourne une clé d’autorisation de fichier :rtype str
create_share	Crée un partage sous le compte spécifié. Si le partage portant le même nom existe déjà, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_on_exists.
delete_directory	Supprime le répertoire vide spécifié. Le répertoire doit être vide pour que vous puissiez le supprimer. La tentative de suppression de répertoires qui ne sont pas vides échoue. Si le répertoire n’existe pas, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_not_exist.
delete_file	Marque le fichier spécifié pour suppression. Le fichier est supprimé ultérieurement pendant le garbage collection.
delete_share	Marque le partage spécifié pour suppression. Si le partage n’existe pas, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_not_exist.
exists	Retourne une valeur booléenne indiquant si le partage existe si seul le nom du partage est donné. Si directory_name est spécifique, un booléen est retourné indiquant si le répertoire existe. Si file_name est également spécifié, une valeur booléenne est retournée indiquant si le fichier existe.
extract_date_and_request_id
generate_account_shared_access_signature	Génère une signature d’accès partagé pour le service de fichiers. Utilisez la signature retournée avec le paramètre sas_token du FileService.
generate_file_shared_access_signature	Génère une signature d’accès partagé pour le fichier. Utilisez la signature retournée avec le paramètre sas_token de FileService.
generate_share_shared_access_signature	Génère une signature d’accès partagé pour le partage. Utilisez la signature retournée avec le paramètre sas_token de FileService.
get_directory_metadata	Retourne toutes les métadonnées définies par l’utilisateur pour le répertoire spécifié.
get_directory_properties	Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le répertoire spécifié. Les données retournées n’incluent pas la liste des fichiers du répertoire.
get_file_metadata	Retourne toutes les métadonnées définies par l’utilisateur pour le fichier spécifié.
get_file_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 du fichier. Retourne une instance de avec FileProperties et une dictée de File métadonnées.
get_file_service_properties	Obtient les propriétés du service De fichiers d’un compte de stockage, y compris Azure Storage Analytics.
get_file_to_bytes	Télécharge un fichier sous forme de tableau d’octets, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des File propriétés, des métadonnées et du contenu.
get_file_to_path	Télécharge un fichier dans un chemin d’accès de fichier, avec des notifications automatiques de segmentation et de progression. Retourne une instance de fichier avec des propriétés et des métadonnées.
get_file_to_stream	Télécharge un fichier dans un flux, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des File propriétés et des métadonnées.
get_file_to_text	Télécharge un fichier sous forme de texte unicode, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des File propriétés, des métadonnées et du contenu.
get_permission_for_share	Créez une autorisation (un descripteur de sécurité) au niveau du partage. Cette « autorisation » peut être utilisée pour les fichiers/répertoires dans le partage. Si une « autorisation » existe déjà, elle doit retourner la clé de celle-ci, sinon crée une nouvelle autorisation au niveau du partage et retourne sa clé. :retourne une autorisation de fichier (un SDDL portable) :rtype str
get_share_acl	Obtient les autorisations pour le partage spécifié.
get_share_metadata	Retourne toutes les métadonnées définies par l’utilisateur pour le partage spécifié.
get_share_properties	Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le partage spécifié. Les données retournées n’incluent pas la liste des fichiers ou répertoires des partages.
get_share_stats	Obtient la taille approximative des données stockées sur le partage, arrondie au gigaoctet le plus proche. Notez que cette valeur peut ne pas inclure tous les fichiers récemment créés ou récemment redimensionnés.
get_share_stats_in_bytes	Obtient la taille approximative des données stockées sur le partage en octets. Notez que cette valeur peut ne pas inclure tous les fichiers récemment créés ou récemment redimensionnés.
list_directories_and_files	Retourne un générateur pour répertorier les répertoires et les fichiers sous le partage spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les répertoires et fichiers ont été retournés ou num_results est atteint. Si num_results est spécifié et que le partage contient plus de fichiers et de répertoires, le générateur a un champ next_marker rempli une fois qu’il est terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.
list_handles	Retourne un générateur pour répertorier les handles ouverts sur un répertoire ou un fichier sous le partage spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les handles ont été retournés ou num_results est atteint. Si num_results est spécifié et que le partage contient plus de fichiers et de répertoires, le générateur a un champ next_marker rempli une fois qu’il est terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.
list_ranges	Récupère les plages valides pour un fichier.
list_shares	Retourne un générateur pour répertorier les partages 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 partages 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 partages, le générateur aura un champ next_marker rempli une fois qu’il aura terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.
make_file_url	Crée l’URL pour accéder à un fichier.
resize_file	Redimensionne un fichier à la taille spécifiée. Si la valeur d'octet spécifiée est inférieure à la taille actuelle du fichier, toutes les plages au-dessus de la valeur d'octet spécifiée sont effacées.
set_directory_metadata	Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le répertoire spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au répertoire. Pour supprimer toutes les métadonnées du répertoire, appelez cette opération sans dictée de métadonnées.
set_directory_properties
set_file_metadata	Définit les métadonnées définies par l’utilisateur pour le fichier spécifié sous la forme d’une ou plusieurs paires nom-valeur.
set_file_properties	Définit les propriétés système sur le fichier. Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.
set_file_service_properties	Définit les propriétés du service De fichiers d’un compte de stockage, y compris Azure Storage Analytics. Si un élément (ex HourMetrics) est laissé comme Aucun, les paramètres existants sur le service pour cette fonctionnalité sont conservés.
set_proxy	Définit l’hôte et le port du serveur proxy pour le tunnelling HTTP CONNECT.
set_share_acl	Définit les autorisations pour le partage spécifié ou les stratégies d’accès stockées qui peuvent être utilisées avec les signatures d’accès partagé.
set_share_metadata	Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le partage spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au partage. Pour supprimer toutes les métadonnées du partage, appelez cette opération sans dictée de métadonnées.
set_share_properties	Définit les propriétés définies par le service pour le partage spécifié.
snapshot_share	Crée une instantané d’un partage existant sous le compte spécifié.
update_range	Écrit les octets spécifiés par le corps de la demande dans la plage spécifiée.
update_range_from_file_url	Écrit les octets d’un point de terminaison Azure File dans la plage spécifiée d’un autre point de terminaison Azure File.

abort_copy_file

Abandonne une opération de copy_file en attente et laisse un fichier de destination avec aucune longueur et des métadonnées complètes.

abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage de destination.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier de destination.
copy_id Obligatoire	str Identificateur de copie fourni dans le copy.id de l’opération de copy_file d’origine.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

clear_range

Efface la plage spécifiée et libère l’espace utilisé dans le stockage pour cette plage.

clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
start_range Obligatoire	int Début de la plage d’octets à utiliser pour effacer une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
end_range Obligatoire	int Fin de la plage d’octets à utiliser pour effacer une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

close_handles

Retourne un générateur pour fermer les handles ouverts sur un répertoire ou un fichier sous le partage spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les handles ont été fermés. Les valeurs générées représentent le nombre de handles qui ont été fermés dans chaque transaction.

close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name	str Chemin au répertoire. valeur par défaut: None
file_name	str Nom du fichier existant. valeur par défaut: None
recursive	bool Boolean qui spécifie si l’opération doit s’appliquer au répertoire spécifié dans l’URI, à ses fichiers, à ses sous-répertoires et à leurs fichiers. valeur par défaut: None
handle_id	str Obligatoire. Spécifie l’ID de handle ouvert sur le fichier ou le répertoire à fermer. Astrix (« * ») est un caractère générique qui spécifie tous les handles. valeur par défaut: None
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 s’il n’a pas terminé de fermer les handles. S’il est spécifié, ce générateur commence à fermer les handles à partir du point où le générateur précédent s’est arrêté. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

copy_file

Copie un fichier de façon 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 abandonner l’opération de copie. Le service de fichiers copie les fichiers au mieux.

Si le fichier de destination existe, il est remplacé. Impossible de modifier le fichier de destination pendant que l’opération de copie est en cours.

copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage de destination. Le partage doit exister.
directory_name Obligatoire	str Nom du répertoire de destination. Le répertoire doit exister.
file_name Obligatoire	str Nom du fichier de destination. Si le fichier de destination existe, il est remplacé. Sinon, il sera créé.
copy_source Obligatoire	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.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> Paires nom-valeur associées au fichier en tant que métadonnées. Si aucune paire nom-valeur n’est spécifiée, l’opération copie les métadonnées de l’objet blob ou du fichier source dans le fichier de destination. Si une ou plusieurs paires nom-valeur sont spécifiées, le fichier 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. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
CopyProperties	Propriétés de l’opération de copie telles que status, source et ID.

create_directory

Crée un répertoire sous le partage ou le répertoire parent spécifié. Si le répertoire portant le même nom existe déjà, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_on_exists.

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Nom du répertoire à créer, y compris le chemin d’accès au répertoire parent.
metadata	dict(str, str)<xref::> Un dict avec name_value paires à associer au partage en tant que métadonnées. Exemple :{'Category' :'test'} valeur par défaut: None
fail_on_exist	bool indique s’il faut lever une exception lorsque le répertoire existe. False par défaut. valeur par défaut: False
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
bool	True si le répertoire est créé, False si le répertoire existe déjà.

create_file

Crée un nouveau fichier.

Consultez create_file_from_* pour connaître les fonctions de haut niveau qui gèrent la création et le chargement de fichiers volumineux avec des notifications de segmentation et de progression automatiques.

create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier à créer ou à mettre à jour.
content_length Obligatoire	int Longueur du fichier en octets.
content_settings	ContentSettings Objet ContentSettings utilisé pour définir les propriétés de fichier. valeur par défaut: None
metadata	dict(str, str) Paires nom-valeur associées au fichier en tant que métadonnées. valeur par défaut: None
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

create_file_from_bytes

Crée un fichier à partir d’un tableau d’octets ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier à créer ou à mettre à jour.
file Obligatoire	str Contenu du fichier sous forme de tableau d’octets.
index	int Démarrez l’index dans le tableau d’octets. valeur par défaut: 0
count	int Nombre d’octets à charger. Définissez sur Aucune ou valeur négative pour charger tous les octets à partir de l’index. valeur par défaut: None
content_settings	ContentSettings Objet ContentSettings utilisé pour définir les propriétés de fichier. valeur par défaut: None
metadata	dict(str, str) Paires nom-valeur associées au fichier en tant que métadonnées. valeur par défaut: None
validate_content	bool Si la valeur est true, calcule un hachage MD5 pour chaque plage du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier. valeur par défaut: False
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 correspond à la taille du fichier, ou None si la taille totale est inconnue. valeur par défaut: None
max_connections	int Nombre maximal de connexions parallèles à utiliser. valeur par défaut: 2
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
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. valeur par défaut: None

create_file_from_path

Crée un fichier Azure à partir d’un chemin d’accès de fichier local ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier à créer ou à mettre à jour.
local_file_path Obligatoire	str Chemin du fichier local à charger en tant que contenu du fichier.
content_settings	ContentSettings Objet ContentSettings utilisé pour définir les propriétés du fichier. valeur par défaut: None
metadata	dict(str, str) Paires nom-valeur associées au fichier en tant que métadonnées. valeur par défaut: None
validate_content	bool Si la valeur est true, calcule un hachage MD5 pour chaque plage du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier. valeur par défaut: False
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 correspond à la taille du fichier, ou None si la taille totale est inconnue. valeur par défaut: None
max_connections	int Nombre maximal de connexions parallèles à utiliser. valeur par défaut: 2
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
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. valeur par défaut: None

create_file_from_stream

Crée un fichier à partir d’un fichier/flux ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier à créer ou à mettre à jour.
stream Obligatoire	IOBase Fichier/flux ouvert à charger en tant que contenu de fichier.
count Obligatoire	int Nombre d’octets à lire à partir du flux. Cela est obligatoire, un fichier ne peut pas être créé si le nombre est inconnu.
content_settings	ContentSettings Objet ContentSettings utilisé pour définir les propriétés de fichier. valeur par défaut: None
metadata	dict(str, str) Paires nom-valeur associées au fichier en tant que métadonnées. valeur par défaut: None
validate_content	bool Si la valeur est true, calcule un hachage MD5 pour chaque plage du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier. valeur par défaut: False
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 correspond à la taille du fichier, ou None si la taille totale est inconnue. valeur par défaut: None
max_connections	int Nombre maximal de connexions parallèles à utiliser. Notez que le chargement parallèle nécessite que le flux puisse être recherché. valeur par défaut: 2
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
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. valeur par défaut: None

create_file_from_text

Crée un fichier à partir de str/unicode, ou met à jour le contenu d’un fichier existant, avec des notifications de segmentation et de progression automatiques.

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier à créer ou à mettre à jour.
text Obligatoire	str Texte à charger dans le fichier.
encoding	str Encodage Python à utiliser pour convertir le texte en octets. valeur par défaut: utf-8
content_settings	ContentSettings Objet ContentSettings utilisé pour définir les propriétés de fichier. valeur par défaut: None
metadata	dict(str, str) Paires nom-valeur associées au fichier en tant que métadonnées. valeur par défaut: None
validate_content	bool Si la valeur est true, calcule un hachage MD5 pour chaque plage du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier. valeur par défaut: False
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
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. valeur par défaut: None

Créez une autorisation (un descripteur de sécurité) au niveau du partage. Cette « autorisation » peut être utilisée pour les fichiers/répertoires dans le partage. S’il existe déjà une « autorisation », elle retourne la clé de celle-ci, sinon elle crée une nouvelle autorisation au niveau du partage et retourne sa clé.

:retourne une clé d’autorisation de fichier :rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	Nom du partage.
file_permission Obligatoire	Autorisation de fichier, un SDDL portable
timeout	Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Crée un partage sous le compte spécifié. Si le partage portant le même nom existe déjà, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_on_exists.

create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage à créer.
metadata	dict(str, str) Un dict avec name_value paires à associer au partage en tant que métadonnées. Exemple :{'Category' :'test'} valeur par défaut: None
quota	int Spécifie la taille maximale du partage en gigaoctets. Doit être supérieure à 0, et inférieure ou égale à 5 To (5120) valeur par défaut: None
fail_on_exist	bool Spécifiez s’il faut lever une exception lorsque le partage existe. False par défaut. valeur par défaut: False
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
bool	True si le partage est créé, False si le partage existe déjà.

delete_directory

Supprime le répertoire vide spécifié. Le répertoire doit être vide pour que vous puissiez le supprimer. La tentative de suppression de répertoires qui ne sont pas vides échoue.

Si le répertoire n’existe pas, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_not_exist.

delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Nom du répertoire à supprimer, y compris le chemin d’accès au répertoire parent.
fail_not_exist	bool Spécifiez s’il faut lever une exception lorsque le répertoire n’existe pas. valeur par défaut: False
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
bool	True si le répertoire est supprimé, False sinon.

delete_file

Marque le fichier spécifié pour suppression. Le fichier est supprimé ultérieurement pendant le garbage collection.

delete_file(share_name, directory_name, file_name, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Marque le partage spécifié pour suppression. Si le partage n’existe pas, l’opération échoue sur le service. Par défaut, l’exception est avalée par le client. Pour exposer l’exception, spécifiez True pour fail_not_exist.

delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage à supprimer.
fail_not_exist	bool Spécifiez s’il faut lever une exception lorsque le partage n’existe pas. False par défaut. valeur par défaut: False
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. Spécifiez cet argument pour supprimer un instantané spécifique uniquement. delete_snapshots doit être Aucun si cela est spécifié. valeur par défaut: None
delete_snapshots	DeleteSnapshot Pour supprimer un partage contenant des instantanés, il doit être spécifié en tant que DeleteSnapshot.Include. valeur par défaut: None

Retours

Type	Description
bool	True si le partage est supprimé, le partage false n’existe pas.

exists

Retourne une valeur booléenne indiquant si le partage existe si seul le nom du partage est donné. Si directory_name est spécifique, un booléen est retourné indiquant si le répertoire existe. Si file_name est également spécifié, une valeur booléenne est retournée indiquant si le fichier existe.

exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom d’un partage.
directory_name	str Chemin d’accès à un répertoire. valeur par défaut: None
file_name	str Nom d’un fichier. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
bool	Boolean indiquant si la ressource existe.

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Paramètres

Nom	Description
retry_context Obligatoire

generate_account_shared_access_signature

Génère une signature d’accès partagé pour le service de fichiers. Utilisez la signature retournée avec le paramètre sas_token du FileService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Paramètres

Nom	Description
resource_types Obligatoire	<xref:ResourceTypes> Spécifie les types de ressources accessibles avec la sap du compte.
permission Obligatoire	<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.
expiry Obligatoire	datetime ou str 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.
start	datetime ou str 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. valeur par défaut: None
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. valeur par défaut: None
protocol	str Spécifie le protocole autorisé pour une requête effectuée. Les valeurs possibles sont HTTPS et HTTP (https,http) ou HTTPS uniquement (https). La valeur par défaut est https,http. Notez que HTTP uniquement n’est pas une valeur autorisée. valeur par défaut: None

Retours

Type	Description
str	Jeton de signature d’accès partagé (sas).

generate_file_shared_access_signature

Génère une signature d’accès partagé pour le fichier. Utilisez la signature retournée avec le paramètre sas_token de FileService.

generate_file_shared_access_signature(share_name, directory_name=None, file_name=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)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage.
directory_name	str Nom du répertoire. Les jetons SAP ne pouvant pas être créés pour les répertoires, ce paramètre ne doit être présent que si file_name est fourni. valeur par défaut: None
file_name	str Nom du fichier. valeur par défaut: None
permission	FilePermissions 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, création, é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. valeur par défaut: None
expiry	datetime ou str 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. valeur par défaut: None
start	datetime ou str 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. valeur par défaut: None
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_file_service_properties. valeur par défaut: None
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. valeur par défaut: None
protocol	str Spécifie le protocole autorisé pour une requête effectuée. Les valeurs possibles sont HTTPS et HTTP (https,http) ou HTTPS uniquement (https). La valeur par défaut est https,http. Notez que HTTP uniquement n’est pas une valeur autorisée. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None

Retours

Type	Description
str	Jeton de signature d’accès partagé (sas).

Génère une signature d’accès partagé pour le partage. Utilisez la signature retournée avec le paramètre sas_token de FileService.

generate_share_shared_access_signature(share_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)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage.
permission	SharePermissions 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, création, é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. valeur par défaut: None
expiry	datetime ou str 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. valeur par défaut: None
start	datetime ou str 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. valeur par défaut: None
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_share_acl. valeur par défaut: None
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. valeur par défaut: None
protocol	str Spécifie le protocole autorisé pour une requête effectuée. Les valeurs possibles sont HTTPS et HTTP (https,http) ou HTTPS uniquement (https). La valeur par défaut est https,http. Notez que HTTP uniquement n’est pas une valeur autorisée. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None
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é. valeur par défaut: None

Retours

Type	Description
str	Jeton de signature d’accès partagé (sas).

get_directory_metadata

Retourne toutes les métadonnées définies par l’utilisateur pour le répertoire spécifié.

get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
dict(str, str)	Dictionnaire représentant le nom des métadonnées du répertoire, les paires de valeurs.

get_directory_properties

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le répertoire spécifié. Les données retournées n’incluent pas la liste des fichiers du répertoire.

get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin d’accès à un répertoire existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
Directory	pour le répertoire spécifié dans un objet de répertoire.

get_file_metadata

Retourne toutes les métadonnées définies par l’utilisateur pour le fichier spécifié.

get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
dict(str, str)	Dictionnaire représentant le nom des métadonnées de fichier, les paires de valeurs.

get_file_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 du fichier. Retourne une instance de avec FileProperties et une dictée de File métadonnées.

get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
File	objet de fichier comprenant des propriétés et des métadonnées.

get_file_service_properties

Obtient les propriétés du service De fichiers d’un compte de stockage, y compris Azure Storage Analytics.

get_file_service_properties(timeout=None)

Paramètres

Nom	Description
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
ServiceProperties	Propriétés du service de fichiers.

get_file_to_bytes

Télécharge un fichier sous forme de tableau d’octets, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des File propriétés, des métadonnées et du contenu.

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
start_range	int Début de la plage d’octets à utiliser pour télécharger une section du fichier. 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. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
end_range	int Fin de la plage d’octets à utiliser pour télécharger une section du fichier. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
validate_content	bool Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée du fichier. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence. valeur par défaut: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille du fichier s’il est connu. valeur par défaut: None
max_connections	int Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets du fichier. S’il s’agit du fichier entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si le fichier est modifié simultanément pour appliquer l’atomicité ou si de nombreux fichiers sont censés être vides, car une demande supplémentaire est requise pour les fichiers vides si max_connections est supérieur à 1. valeur par défaut: 2
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. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
File	Un fichier avec des propriétés, du contenu et des métadonnées.

get_file_to_path

Télécharge un fichier dans un chemin d’accès de fichier, avec des notifications automatiques de segmentation et de progression. Retourne une instance de fichier avec des propriétés et des métadonnées.

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
file_path Obligatoire	str Chemin du fichier dans lequel écrire.
open_mode	str Mode à utiliser lors de l’ouverture du fichier. Notez que la spécification de l’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. valeur par défaut: wb
start_range	int Début de la plage d’octets à utiliser pour télécharger une section du fichier. 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. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
end_range	int Fin de la plage d’octets à utiliser pour télécharger une section du fichier. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
validate_content	bool Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée du fichier. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence. valeur par défaut: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille du fichier s’il est connu. valeur par défaut: None
max_connections	int Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets du fichier. S’il s’agit du fichier entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si le fichier est modifié simultanément pour appliquer l’atomicité ou si de nombreux fichiers sont censés être vides, car une demande supplémentaire est requise pour les fichiers vides si max_connections est supérieur à 1. valeur par défaut: 2
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. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
File	Fichier avec des propriétés et des métadonnées.

get_file_to_stream

Télécharge un fichier dans un flux, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des File propriétés et des métadonnées.

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
stream Obligatoire	IOBase Fichier/flux ouvert dans lequel écrire.
start_range	int Début de la plage d’octets à utiliser pour télécharger une section du fichier. 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. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
end_range	int Fin de la plage d’octets à utiliser pour télécharger une section du fichier. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
validate_content	bool Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée du fichier. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence. valeur par défaut: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille du fichier s’il est connu. valeur par défaut: None
max_connections	int Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets du fichier. S’il s’agit du fichier entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si le fichier est modifié simultanément pour appliquer l’atomicité ou si de nombreux fichiers sont censés être vides, car une demande supplémentaire est requise pour les fichiers vides si max_connections est supérieur à 1. valeur par défaut: 2
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. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
File	Fichier avec des propriétés et des métadonnées.

get_file_to_text

Télécharge un fichier sous forme de texte unicode, avec une segmentation automatique et des notifications de progression. Retourne une instance de avec des File propriétés, des métadonnées et du contenu.

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
encoding	str Encodage Python à utiliser lors du décodage des données de fichier. valeur par défaut: utf-8
start_range	int Début de la plage d’octets à utiliser pour télécharger une section du fichier. 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. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
end_range	int Fin de la plage d’octets à utiliser pour télécharger une section du fichier. Si end_range est donné, start_range doivent être fournis. Les start_range et end_range sont inclusifs. Exemple : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
validate_content	bool Si la valeur est true, valide un hachage MD5 pour chaque partie récupérée du fichier. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que le service retourne uniquement des MD5 transactionnels pour les segments de 4 Mo ou moins, de sorte que la première demande d’obtention sera de taille automatique. MAX_CHUNK_GET_SIZE au lieu de soi- même. MAX_SINGLE_GET_SIZE. Si soi- même. MAX_CHUNK_GET_SIZE a été défini sur une valeur supérieure à 4 Mo, une erreur sera levée. Comme le calcul du MD5 prend du temps et que d’autres demandes devront être effectuées en raison de la taille réduite du segment, il peut y avoir une augmentation de la latence. valeur par défaut: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Rappel pour la progression avec la fonction de signature (current, total) où current correspond au nombre d’octets transférés jusqu’à présent, et total correspond à la taille du fichier s’il est connu. valeur par défaut: None
max_connections	int Si la valeur est égale ou supérieure à 2, une obtention initiale est effectuée pour la première fois. MAX_SINGLE_GET_SIZE octets du fichier. S’il s’agit du fichier entier, la méthode retourne à ce stade. Si ce n’est pas le cas, il télécharge les données restantes en parallèle à l’aide du nombre de threads égal à max_connections. Chaque segment sera de taille automatique. MAX_CHUNK_GET_SIZE. Si la valeur est 1, une seule demande d’obtention volumineuse est effectuée. Cela n’est généralement pas recommandé, mais disponible si très peu de threads doivent être utilisés, si les requêtes réseau sont très coûteuses ou si un flux non recherché empêche le téléchargement parallèle. Cela peut également être utile si le fichier est modifié simultanément pour appliquer l’atomicité ou si de nombreux fichiers sont censés être vides, car une demande supplémentaire est requise pour les fichiers vides si max_connections est supérieur à 1. valeur par défaut: 2
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. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
File	Un fichier avec des propriétés, du contenu et des métadonnées.

Créez une autorisation (un descripteur de sécurité) au niveau du partage. Cette « autorisation » peut être utilisée pour les fichiers/répertoires dans le partage. Si une « autorisation » existe déjà, elle doit retourner la clé de celle-ci, sinon crée une nouvelle autorisation au niveau du partage et retourne sa clé.

:retourne une autorisation de fichier (un SDDL portable) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	Nom du partage.
file_permission_key Obligatoire	Clé de l’autorisation de fichier à récupérer
timeout	Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Obtient les autorisations pour le partage spécifié.

get_share_acl(share_name, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
dict(str, AccessPolicy)	Dictionnaire des stratégies d’accès associées au partage.

Retourne toutes les métadonnées définies par l’utilisateur pour le partage spécifié.

get_share_metadata(share_name, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
dict(str, str)	Dictionnaire représentant le nom des métadonnées de partage et les paires de valeurs.

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le partage spécifié. Les données retournées n’incluent pas la liste des fichiers ou répertoires des partages.

get_share_properties(share_name, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
Share	Partage qui expose les propriétés et les métadonnées.

Obtient la taille approximative des données stockées sur le partage, arrondie au gigaoctet le plus proche.

Notez que cette valeur peut ne pas inclure tous les fichiers récemment créés ou récemment redimensionnés.

get_share_stats(share_name, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
int	taille approximative des données stockées sur le partage.

Obtient la taille approximative des données stockées sur le partage en octets.

Notez que cette valeur peut ne pas inclure tous les fichiers récemment créés ou récemment redimensionnés.

get_share_stats_in_bytes(share_name, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
int	taille approximative des données stockées sur le partage.

list_directories_and_files

Retourne un générateur pour répertorier les répertoires et les fichiers sous le partage spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les répertoires et fichiers ont été retournés ou num_results est atteint.

Si num_results est spécifié et que le partage contient plus de fichiers et de répertoires, le générateur a un champ next_marker rempli une fois qu’il est terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.

list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name	str Chemin au répertoire. valeur par défaut: None
num_results	int Spécifie le nombre maximal de fichiers à retourner, y compris tous les éléments de répertoire. Si la demande ne spécifie pas num_results ou spécifie une valeur supérieure à 5 000, le serveur retourne jusqu’à 5 000 éléments. La définition de num_results sur une valeur inférieure ou égale à zéro entraîne le code de réponse d’erreur 400 (Demande incorrecte). valeur par défaut: None
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é. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
prefix	str Répertoriez uniquement les fichiers et/ou répertoires avec le préfixe donné. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

list_handles

Retourne un générateur pour répertorier les handles ouverts sur un répertoire ou un fichier sous le partage spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les handles ont été retournés ou num_results est atteint.

list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name	str Chemin au répertoire. valeur par défaut: None
file_name	str Nom du fichier existant. valeur par défaut: None
recursive	bool Boolean qui spécifie si l’opération doit s’appliquer au répertoire spécifié dans l’URI, à ses fichiers, à ses sous-répertoires et à leurs fichiers. valeur par défaut: None
max_results	int Spécifie le nombre maximal de descripteurs pris sur les fichiers et/ou répertoires à retourner. Si la demande ne spécifie pas max_results ou spécifie une valeur supérieure à 5 000, le serveur retourne jusqu’à 5 000 éléments. La définition de max_results sur une valeur inférieure ou égale à zéro entraîne le code de réponse d’erreur 400 (Demande incorrecte). valeur par défaut: None
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 max_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é. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

list_ranges

Récupère les plages valides pour un fichier.

list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
start_range	int Spécifie le décalage de début des octets sur lesquels répertorier les plages. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
end_range	int Spécifie le décalage de fin des octets sur lesquels répertorier les plages. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
snapshot	str Chaîne qui représente la version instantané, le cas échéant. valeur par défaut: None

Retours

Type	Description
<xref:a> list <xref:of> FileRange	une liste de plages valides

list_shares

Retourne un générateur pour répertorier les partages 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 partages 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 partages, le générateur aura un champ next_marker rempli une fois qu’il aura terminé. Ce marqueur peut être utilisé pour créer un générateur si d’autres résultats sont souhaités.

list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

Paramètres

Nom	Description
prefix	str Filtre les résultats pour renvoyer uniquement les partages dont le nom commence par le préfixe spécifié. valeur par défaut: None
num_results	int Indique le nombre maximal de partages à retourner. valeur par défaut: None
include_metadata	bool Spécifie que les métadonnées de partage doivent être retournées dans la réponse. valeur par défaut: False
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é. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None
include_snapshots	bool Spécifie que les instantanés de partage doivent être retournés dans la réponse. valeur par défaut: False

make_file_url

Crée l’URL pour accéder à un fichier.

make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier.
protocol	str Protocole à utiliser : « http » ou « https ». S’il n’est pas spécifié, utilise le protocole spécifié lors de l’initialisation de FileService. valeur par défaut: None
sas_token	str Jeton de signature d’accès partagé créé avec generate_shared_access_signature. valeur par défaut: None

Retours

Type	Description
str	URL d’accès aux fichiers.

resize_file

Redimensionne un fichier à la taille spécifiée. Si la valeur d'octet spécifiée est inférieure à la taille actuelle du fichier, toutes les plages au-dessus de la valeur d'octet spécifiée sont effacées.

resize_file(share_name, directory_name, file_name, content_length, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
content_length Obligatoire	int Longueur à laquelle redimensionner le fichier.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

set_directory_metadata

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

set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
metadata	dict(str, str)<xref:./> Dict contenant des paires nom-valeur à associer au répertoire en tant que métadonnées. Exemple : {'category' :'test'} valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

set_directory_properties

set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	Nom du partage
directory_name Obligatoire	Nom du répertoire
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

set_file_metadata

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

set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
metadata	dict(str, str) Dict contenant des paires nom-valeur. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au fichier. Pour supprimer toutes les métadonnées du fichier, appelez cette opération sans en-tête de métadonnées. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

set_file_properties

Définit les propriétés système sur le fichier. Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.

set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
content_settings Obligatoire	ContentSettings Objet ContentSettings utilisé pour définir les propriétés du fichier.
file_permission	str Autorisation de fichier, un SDDL portable valeur par défaut: None
smb_properties	SMBProperties Définit les propriétés de fichier associées À SMB
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

set_file_service_properties

Définit les propriétés du service De fichiers d’un compte de stockage, y compris Azure Storage Analytics. Si un élément (ex HourMetrics) est laissé comme Aucun, les paramètres existants sur le service pour cette fonctionnalité sont conservés.

set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Paramètres

Nom	Description
hour_metrics	<xref:Metrics> Les paramètres de métriques d’heure fournissent un résumé des statistiques de requête regroupées par API dans des agrégats horaires pour les fichiers. valeur par défaut: None
minute_metrics	<xref:Metrics> Les paramètres de métriques de minute fournissent des statistiques de requête pour chaque minute pour les fichiers. valeur par défaut: None
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 est désactivé pour le service. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

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

Nom	Description
host Obligatoire	str Adresse du proxy. Ex : '192.168.0.100'
port Obligatoire	int Port du proxy. Ex : 6000
user	str Utilisateur pour l’autorisation de proxy. valeur par défaut: None
password	str Mot de passe pour l’autorisation de proxy. valeur par défaut: None

Définit les autorisations pour le partage spécifié ou les stratégies d’accès stockées qui peuvent être utilisées avec les signatures d’accès partagé.

set_share_acl(share_name, signed_identifiers=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
signed_identifiers	dict(str, AccessPolicy) Dictionnaire des stratégies d’accès à associer au partage. Le dictionnaire peut contenir jusqu’à 5 éléments. Un dictionnaire vide efface les stratégies d’accès définies sur le service. valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

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

set_share_metadata(share_name, metadata=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
metadata	dict(str, str) Dict contenant des paires nom-valeur à associer au partage en tant que métadonnées. Exemple : {'category' :'test'} valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Définit les propriétés définies par le service pour le partage spécifié.

set_share_properties(share_name, quota, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
quota Obligatoire	int Spécifie la taille maximale du partage en gigaoctets. Doit être supérieur à 0 et inférieur ou égal à 5 To (5120 Go).
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Crée une instantané d’un partage existant sous le compte spécifié.

snapshot_share(share_name, metadata=None, quota=None, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage pour lequel créer une instantané.
metadata	<xref:<xref:a dict> of <xref:str to str:>> Un dict avec name_value paires à associer au partage en tant que métadonnées. Exemple :{'Category' :'test'} valeur par défaut: None
quota	int Spécifie la taille maximale du partage en gigaoctets. Doit être supérieure à 0, et inférieure ou égale à 5 To (5120) valeur par défaut: None
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Retours

Type	Description
Share	instantané propriétés

update_range

Écrit les octets spécifiés par le corps de la demande dans la plage spécifiée.

update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
data Obligatoire	bytes Contenu de la plage.
start_range Obligatoire	int Début de la plage d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
end_range Obligatoire	int Fin de la plage d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
validate_content	bool Si la valeur est true, calcule un hachage MD5 du contenu de la page. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage qui a été envoyé. Cela est principalement utile pour la détection des bits sur le réseau si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier. valeur par défaut: False
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

update_range_from_file_url

Écrit les octets d’un point de terminaison Azure File dans la plage spécifiée d’un autre point de terminaison Azure File.

update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)

Paramètres

Nom	Description
share_name Obligatoire	str Nom du partage existant.
directory_name Obligatoire	str Chemin au répertoire.
file_name Obligatoire	str Nom du fichier existant.
start_range Obligatoire	int Début de la plage d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
end_range Obligatoire	int Fin de la plage d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
source Obligatoire	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.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range Obligatoire	int Début de la plage d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo. Les paramètres start_range et end_range sont inclusifs. Ex : start_range=0, end_range=511 télécharge les 512 premiers octets du fichier.
timeout	int Le paramètre timeout est exprimé en secondes. valeur par défaut: None

Attributs

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432

Partager via

FileService Classe

Constructeur

Paramètres

Variables

Méthodes

abort_copy_file

Paramètres

clear_range

Paramètres

close_handles

Paramètres

copy_file

Paramètres

Retours

create_directory

Paramètres

Retours

create_file

Paramètres

create_file_from_bytes

Paramètres

create_file_from_path

Paramètres

create_file_from_stream

Paramètres

create_file_from_text

Paramètres

create_permission_for_share

Paramètres

create_share

Paramètres

Retours

delete_directory

Paramètres

Retours

delete_file

Paramètres

delete_share

Paramètres

Retours

exists

Paramètres

Retours

extract_date_and_request_id

Paramètres

generate_account_shared_access_signature

Paramètres

Retours

generate_file_shared_access_signature

Paramètres

Retours

generate_share_shared_access_signature

Paramètres

Retours

get_directory_metadata

Paramètres

Retours

get_directory_properties

Paramètres

Retours

get_file_metadata

Paramètres

Retours

get_file_properties

Paramètres

Retours

get_file_service_properties

Paramètres

Retours

get_file_to_bytes

Paramètres

Retours

get_file_to_path

Paramètres

Retours

get_file_to_stream

Paramètres

Retours

get_file_to_text