ShareDirectoryClient Classe

Un client pour interagir avec un répertoire spécifique, même s’il n’existe pas encore.

Pour les opérations relatives à un sous-répertoire ou à un fichier spécifique dans ce partage, les clients de ces entités peuvent également être récupérés à l’aide des get_subdirectory_client fonctions et get_file_client .

Pour plus de configuration facultative, cliquez ici.

Héritage

azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin

ShareDirectoryClient

Constructeur

ShareDirectoryClient(account_url: str, share_name: str, directory_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

Paramètres

account_url

str

Obligatoire

URI du compte de stockage. Pour créer un client en fonction de l’URI complet du répertoire, utilisez la from_directory_url méthode de classe.

share_name

str

Obligatoire

Nom du partage pour le répertoire.

directory_path

str

Obligatoire

Chemin d’accès du répertoire avec lequel interagir. Si elle est spécifiée, cette valeur remplace une valeur de répertoire spécifiée dans l’URL du répertoire.

snapshot

str

valeur par défaut: None

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

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL du compte a déjà un jeton SAS. La valeur peut être une chaîne de jeton SAS, une instance d’azureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials à partir d’azure.identity. Si l’URI de ressource contient déjà un jeton SAS, celui-ci est ignoré au profit d’informations d’identification explicites.

• sauf dans le cas d’AzureSasCredential, où les jetons SAP en conflit déclenchent un ValueError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé de compte de stockage.

token_intent

Literal['backup']

Obligatoire lors de l’utilisation de TokenCredential pour l’authentification et ignoré pour d’autres formes d’authentification. Spécifie l’intention de toutes les demandes lors de l’utilisation de l’authentification TokenCredential . Les valeurs possibles sont les suivantes :

backup : spécifie que les demandes sont destinées aux opérations de type de sauvegarde/administrateur, ce qui signifie que toutes les listes de contrôle d’accès des fichiers/répertoires sont ignorées et que des autorisations complètes sont accordées. L’utilisateur doit également disposer de l’autorisation RBAC requise.

allow_trailing_dot

bool

Si la valeur est true, le point de fin n’est pas supprimé de l’URI cible.

allow_source_trailing_dot

bool

Si la valeur est true, le point de fin n’est pas supprimé de l’URI source.

api_version

str

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

Nouveautés de la version 12.1.0.

secondary_hostname

str

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

max_range_size

int

Taille de plage maximale utilisée pour un chargement de fichier. La valeur par défaut est 4*1024*1024.

audience

str

Audience à utiliser lors de la demande de jetons pour l’authentification Azure Active Directory. A un effet uniquement lorsque les informations d’identification sont de type TokenCredential. La valeur peut être https://storage.azure.com/ (par défaut) ou https ://.file.core.windows.net.

Méthodes

close	Cette méthode consiste à fermer les sockets ouverts par le client. Il n’est pas nécessaire de l’utiliser lors de l’utilisation avec un gestionnaire de contexte.
close_all_handles	Fermez tous les descripteurs de fichiers ouverts. Cette opération se bloque jusqu’à ce que le service ait fermé tous les handles ouverts.
close_handle	Fermez un handle de fichier ouvert.
create_directory	Crée un répertoire sous le répertoire référencé par le client.
create_subdirectory	Crée un sous-répertoire et retourne un client pour interagir avec le sous-répertoire.
delete_directory	Marque le répertoire pour suppression. Le répertoire est supprimé ultérieurement pendant le garbage collection.
delete_file	Marque le fichier spécifié pour suppression. Le fichier est supprimé ultérieurement pendant le garbage collection.
delete_subdirectory	Supprime un sous-répertoire.
exists	Retourne La valeur True si un répertoire existe et la valeur False dans le cas contraire.
from_connection_string	Créez ShareDirectoryClient à partir d’une chaîne de connexion.
from_directory_url	Créez un ShareDirectoryClient à partir d’une URL d’annuaire.
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_client	Obtenir un client pour interagir avec un fichier spécifique. Le fichier n’a pas besoin d’exister.
get_subdirectory_client	Obtenir un client pour interagir avec un sous-répertoire spécifique. Le sous-répertoire n’a pas besoin d’exister.
list_directories_and_files	Répertorie tous les répertoires et fichiers sous le répertoire.
list_handles	Répertorie les handles ouverts sur un répertoire ou un fichier sous le répertoire.
rename_directory	Renommez le répertoire source. :p aramtype file_attributes :~azure.storage.fileshare.NTFSAttributes ou str :mot clé file_creation_time : Heure de création du répertoire. :p aramtype file_creation_time :~datetime.datetime ou str :mot clé file_last_write_time : Heure de la dernière écriture du fichier. :p aramtype file_last_write_time :~datetime.datetime ou str :mot clé file_change_time : Modifiez l’heure du répertoire. Si elle n’est pas spécifiée, l’heure de modification est définie sur la date/heure actuelle. Nouveautés de la version 12.8.0 : Ce paramètre a été introduit dans la version d’API « 2021-06-08 ».
set_directory_metadata	Définit les métadonnées du répertoire. 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 avec une dictée de métadonnées vide.
set_http_headers	Définit les en-têtes HTTP sur le répertoire.
upload_file	Crée un fichier dans le répertoire et retourne un ShareFileClient pour interagir avec le fichier.

close

Cette méthode consiste à fermer les sockets ouverts par le client. Il n’est pas nécessaire de l’utiliser lors de l’utilisation avec un gestionnaire de contexte.

close()

close_all_handles

Fermez tous les descripteurs de fichiers ouverts.

Cette opération se bloque jusqu’à ce que le service ait fermé tous les handles ouverts.

close_all_handles(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

Paramètres

recursive

bool

Obligatoire

Boolean qui spécifie si l’opération doit s’appliquer au répertoire spécifié par le client, à ses fichiers, à ses sous-répertoires et à leurs fichiers. La valeur par défaut est false.

timeout

int

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

Retours

Nombre de handles fermés (il peut s’agir de 0 si le handle spécifié est introuvable) et le nombre de handles n’a pas pu se fermer dans un dict.

Type de retour

dict[str, int]

close_handle

Fermez un handle de fichier ouvert.

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

Paramètres

handle

str ou Handle

Obligatoire

Handle spécifique à fermer.

timeout

int

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

Retours

Nombre de handles fermés (il peut s’agir de 0 si le handle spécifié est introuvable) et le nombre de handles n’a pas pu se fermer dans un dict.

Type de retour

dict[str, int]

create_directory

Crée un répertoire sous le répertoire référencé par le client.

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

Paramètres

file_attributes

NTFSAttributes

Attributs du système de fichiers pour les fichiers et les répertoires. Si elle n’est pas définie, la valeur par défaut est « none » et les attributs sont définis sur « Archive ». Voici un exemple pour quand le type var est str : 'Temporary|Archiver'. file_attributes valeur ne respecte pas la casse.

file_creation_time

str ou datetime

Heure de création du répertoire. Valeur par défaut : « now ».

file_last_write_time

str ou datetime

Heure de la dernière écriture pour le répertoire. Valeur par défaut : « now ».

file_permission

str

Si elle est spécifiée, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier. Cet en-tête peut être utilisé si la taille de l’autorisation est <= 8 Ko, sinon l’en-tête file-permission-key doit être utilisé. Valeur par défaut : hériter. Si SDDL est spécifié comme entrée, il doit avoir propriétaire, groupe et dacl. Remarque : Une seule des clés file-permission ou file-permission-key doit être spécifiée.

file_permission_key

str

Clé de l’autorisation à définir pour le répertoire/fichier. Remarque : Une seule des clés file-permission ou file-permission-key doit être spécifiée.

file_change_time

str ou datetime

Modifiez l’heure du répertoire. Si elle n’est pas spécifiée, l’heure de modification est définie sur la date/heure actuelle.

Nouveauté de la version 12.8.0 : ce paramètre a été introduit dans la version d’API « 2021-06-08 ».

metadata

dict(str,str)

Paires nom-valeur associées au répertoire en tant que métadonnées.

timeout

int

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

Retours

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

Type de retour

dict(str, Any)

Exemples

Crée un répertoire.

   my_directory.create_directory()

create_subdirectory

Crée un sous-répertoire et retourne un client pour interagir avec le sous-répertoire.

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

Paramètres

directory_name

str

Obligatoire

Nom du sous-répertoire.

metadata

dict(str,str)

Paires nom-valeur associées au sous-répertoire en tant que métadonnées.

timeout

int

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

Retours

ShareDirectoryClient

Type de retour

ShareDirectoryClient

Exemples

Créez un sous-répertoire.

   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

Marque le répertoire pour suppression. Le répertoire est supprimé ultérieurement pendant le garbage collection.

delete_directory(**kwargs: Any) -> None

Paramètres

timeout

int

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

Type de retour

None

Exemples

Supprime un répertoire.

   my_directory.delete_directory()

delete_file

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

delete_file(file_name: str, **kwargs: Any | None) -> None

Paramètres

file_name

str

Obligatoire

Nom du fichier à supprimer.

timeout

int

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

Type de retour

None

Exemples

Supprimez un fichier dans un répertoire.

   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

Supprime un sous-répertoire.

delete_subdirectory(directory_name: str, **kwargs) -> None

Paramètres

directory_name

str

Obligatoire

Nom du sous-répertoire.

timeout

int

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

Type de retour

None

Exemples

Supprimer un sous-répertoire.

   parent_dir.delete_subdirectory("subdir")

exists

Retourne La valeur True si un répertoire existe et la valeur False dans le cas contraire.

exists(**kwargs: Any) -> bool

Paramètres

timeout

int

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

Retours

True si le répertoire existe, False dans le cas contraire.

Type de retour

bool

from_connection_string

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

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

Paramètres

conn_str

str

Obligatoire

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

share_name

str

Obligatoire

Nom du partage.

directory_path

str

Obligatoire

Chemin d'accès du répertoire.

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL du compte a déjà un jeton SAS. La valeur peut être une chaîne de jeton SAS, une instance d’azureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials à partir d’azure.identity. Si l’URI de ressource contient déjà un jeton SAS, celui-ci est ignoré au profit d’informations d’identification explicites.

• sauf dans le cas d’AzureSasCredential, où les jetons SAP en conflit déclenchent un ValueError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé de compte de stockage.

audience

str

Audience à utiliser lors de la demande de jetons pour l’authentification Azure Active Directory. A un effet uniquement lorsque les informations d’identification sont de type TokenCredential. La valeur peut être https://storage.azure.com/ (par défaut) ou https ://.file.core.windows.net.

Retours

Un client d’annuaire.

Type de retour

ShareDirectoryClient

from_directory_url

Créez un ShareDirectoryClient à partir d’une URL d’annuaire.

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

Paramètres

directory_url

str

Obligatoire

URI complet du répertoire.

snapshot

str

valeur par défaut: None

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

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cela est facultatif si l’URL du compte a déjà un jeton SAS. La valeur peut être une chaîne de jeton SAS, une instance d’azureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials à partir d’azure.identity. Si l’URI de ressource contient déjà un jeton SAS, celui-ci est ignoré au profit d’informations d’identification explicites.

• sauf dans le cas d’AzureSasCredential, où les jetons SAP en conflit déclenchent un ValueError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé de compte de stockage.

audience

str

Audience à utiliser lors de la demande de jetons pour l’authentification Azure Active Directory. A un effet uniquement lorsque les informations d’identification sont de type TokenCredential. La valeur peut être https://storage.azure.com/ (par défaut) ou https ://.file.core.windows.net.

Retours

Un client d’annuaire.

Type de retour

ShareDirectoryClient

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(**kwargs: Any) -> DirectoryProperties

Paramètres

timeout

int

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

Retours

DirectoryProperties

Type de retour

DirectoryProperties

get_file_client

Obtenir un client pour interagir avec un fichier spécifique.

Le fichier n’a pas besoin d’exister.

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

Paramètres

file_name

str

Obligatoire

Nom du fichier.

Retours

Un client de fichiers.

Type de retour

ShareFileClient

get_subdirectory_client

Obtenir un client pour interagir avec un sous-répertoire spécifique.

Le sous-répertoire n’a pas besoin d’exister.

get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Paramètres

directory_name

str

Obligatoire

Nom du sous-répertoire.

Retours

Un client d’annuaire.

Type de retour

ShareDirectoryClient

Exemples

Obtient le client de sous-répertoire.

   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

Répertorie tous les répertoires et fichiers sous le répertoire.

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

Paramètres

name_starts_with

str

Obligatoire

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

include

list[str]

Incluez ce paramètre pour spécifier un ou plusieurs jeux de données à inclure dans la réponse. Les valeurs de str possibles sont « timestamps », « Etag », « Attributes », « PermissionKey ».

Nouveautés de la version 12.6.0.

Cet argument mot clé a été introduit dans la version d’API « 2020-10-02 ».

include_extended_info

bool

Si cette valeur est définie sur true, l’ID de fichier est retourné dans les résultats répertoriés.

Nouveautés de la version 12.6.0.

Cet argument mot clé a été introduit dans la version d’API « 2020-10-02 ».

timeout

int

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

Retours

Itérable de pagination automatique de DirectoryProperties et FileProperties de type dict

Type de retour

ItemPaged[DirectoryProperties <xref:and> FileProperties]

Exemples

Répertorier les répertoires et les fichiers.

   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

Répertorie les handles ouverts sur un répertoire ou un fichier sous le répertoire.

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

Paramètres

recursive

bool

Obligatoire

Boolean qui spécifie si l’opération doit s’appliquer au répertoire spécifié par le client, à ses fichiers, à ses sous-répertoires et à leurs fichiers. La valeur par défaut est false.

timeout

int

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

Retours

Une pagination automatique itérable de Handle

Type de retour

ItemPaged[Handle]

rename_directory

Renommez le répertoire source.

:p aramtype file_attributes :~azure.storage.fileshare.NTFSAttributes ou str :mot clé file_creation_time :

Heure de création du répertoire.

:p aramtype file_creation_time :~datetime.datetime ou str :mot clé file_last_write_time :

Heure de la dernière écriture du fichier.

:p aramtype file_last_write_time :~datetime.datetime ou str :mot clé file_change_time :

Modifiez l’heure du répertoire. Si elle n’est pas spécifiée, l’heure de modification est définie sur la date/heure actuelle.

Nouveautés de la version 12.8.0 : Ce paramètre a été introduit dans la version d’API « 2021-06-08 ».

rename_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

Paramètres

metadata

Dict[str,str]

Paire nom-valeur à associer à un objet de stockage de fichiers.

destination_lease

ShareLeaseClient ou str

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

Retours

Nouveau client d’annuaire.

Type de retour

ShareDirectoryClient

set_directory_metadata

Définit les métadonnées du répertoire.

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 avec une dictée de métadonnées vide.

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

Paramètres

metadata

dict(str, str)

Obligatoire

Paires nom-valeur associées au répertoire en tant que métadonnées.

timeout

int

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

Retours

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

Type de retour

dict(str, Any)

set_http_headers

Définit les en-têtes HTTP sur le répertoire.

set_http_headers(file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

Paramètres

file_attributes

NTFSAttributes

Obligatoire

Attributs du système de fichiers pour les fichiers et les répertoires. S’il n’est pas défini, indique la conservation des valeurs existantes. Voici un exemple pour quand le type var est str : 'Temporary|Archiver'

file_creation_time

str ou datetime

Obligatoire

Heure de création du fichier Valeur par défaut : Conserver.

file_last_write_time

str ou datetime

Obligatoire

Heure de la dernière écriture du fichier Valeur par défaut : Conserver.

file_permission

str

Obligatoire

Si spécifié, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier. Cet en-tête peut être utilisé si la taille de l’autorisation est <= 8 Ko, sinon l’en-tête x-ms-file-permission-key doit être utilisé. Valeur par défaut : hériter. Si SDDL est spécifié en tant qu’entrée, il doit avoir propriétaire, groupe et dacl. Remarque : une seule des x-ms-file-permission ou x-ms-file-permission-key doit être spécifiée.

permission_key

str

Obligatoire

Clé de l’autorisation à définir pour le répertoire/fichier. Remarque : une seule des x-ms-file-permission ou x-ms-file-permission-key doit être spécifiée.

file_change_time

str ou datetime

Modifiez l’heure du répertoire. Si elle n’est pas spécifiée, l’heure de modification est définie sur la date/heure actuelle.

Nouveautés de la version 12.8.0 : Ce paramètre a été introduit dans la version d’API « 2021-06-08 ».

timeout

int

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

Retours

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

Type de retour

dict(str, Any)

upload_file

Crée un fichier dans le répertoire et retourne un ShareFileClient pour interagir avec le fichier.

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

Paramètres

file_name

str

Obligatoire

Nom du fichier.

data

Obligatoire

Contenu du fichier.

length

int

Obligatoire

Longueur du fichier en octets. Spécifiez sa taille maximale, jusqu’à 1 Tio.

metadata

dict(str,str)

Paires nom-valeur associées au fichier en tant que métadonnées.

content_settings

ContentSettings

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

validate_content

bool

Si la valeur est true, calcule un hachage MD5 pour chaque plage du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage envoyé. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier.

max_concurrency

int

Nombre maximal de connexions parallèles à utiliser.

progress_hook

Callable[[int, Optional[int]], None]

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

timeout

int

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

encoding

str

La valeur par défaut est UTF-8.

Retours

ShareFileClient

Type de retour

ShareFileClient

Exemples

Chargez un fichier dans un répertoire.

   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

Attributs

api_version

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

location_mode

Mode d’emplacement que le client utilise actuellement.

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

primary_endpoint

URL complète du point de terminaison principal.

primary_hostname

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

secondary_endpoint

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

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

Exceptions

ValueError

secondary_hostname

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

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

url

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

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