azure.storage.filedatalake.FileSystemClient class

Demande un nouveau bail. Si le système de fichiers n’a pas de bail actif, le service DataLake crée un bail sur le système de fichiers et retourne un nouvel ID de bail.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient

Paramètres

lease_duration: int

Obligatoire

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail infini).

lease_id: str

Obligatoire

ID de bail proposé, dans un format de chaîne GUID. Le service DataLake retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Retours

Objet DataLakeLeaseClient, qui peut être exécuté dans un gestionnaire de contexte.

Type de retour

DataLakeLeaseClient

Exemples

Acquisition d’un bail sur le système de fichiers.


   # Acquire a lease on the file system
   lease = file_system_client.acquire_lease()

   # Delete file system by passing in the lease
   file_system_client.delete_file_system(lease=lease)

Cette méthode consiste à fermer les sockets ouverts par le client. Il n’a pas besoin d’être utilisé lors de l’utilisation avec un gestionnaire de contexte.

close() -> None

Créer un répertoire

create_directory(directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient

Paramètres

directory: str ou DirectoryProperties

Obligatoire

Répertoire avec lequel interagir. Il peut s’agir du nom du répertoire ou d’un instance de DirectoryProperties.

metadata: dict(str, str)

Obligatoire

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 chemin d’accès.

lease: DataLakeLeaseClient ou str

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

umask: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Lors de la création d’un fichier ou d’un répertoire et que le dossier parent n’a pas de liste de contrôle d’accès par défaut, l’umask limite les autorisations du fichier ou du répertoire à créer. L’autorisation résultante est donnée par p & ^u, où p est l’autorisation et vous êtes l’umask. Par exemple, si p est 0777 et que vous avez la valeur 0057, l’autorisation résultante est 0720. L’autorisation par défaut est 0777 pour un répertoire et 0666 pour un fichier. L’umask par défaut est 0027. L’umask doit être spécifié en notation octale à 4 chiffres (par exemple, 0766).

owner: str

Propriétaire du fichier ou du répertoire.

group: str

Groupe propriétaire du fichier ou du répertoire.

acl: str

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste séparée par des virgules d’entrées de contrôle d’accès. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type, d’un identificateur d’utilisateur ou de groupe et d’autorisations au format « [scope:][type]:[id]:[permissions] ».

lease_id: str

ID de bail proposé, dans un format de chaîne GUID. Le service DataLake retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

lease_duration: int

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification.

permissions: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Définit les autorisations d’accès POSIX pour le propriétaire du fichier, le groupe propriétaire du fichier et d’autres personnes. Chaque classe peut se voir accorder l’autorisation de lecture, d’écriture ou d’exécution. Le bit collant est également pris en charge. La notation symbolique (rwxrw-rw-) et la notation octale à 4 chiffres (par exemple, 0766) sont prises en charge.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Retours

DataLakeDirectoryClient

Exemples

Créez un répertoire dans le système de fichiers.


   directory_client = file_system_client.create_directory("mydirectory")

Créer un fichier

create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Paramètres

file: str ou FileProperties

Obligatoire

Fichier avec lequel interagir. Il peut s’agir du nom du fichier ou d’une instance de FileProperties.

content_settings: ContentSettings

Obligatoire

Objet ContentSettings utilisé pour définir les propriétés de chemin d’accès.

metadata: dict(str, str)

Obligatoire

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

lease: DataLakeLeaseClient ou str

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

umask: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Lors de la création d’un fichier ou d’un répertoire et que le dossier parent n’a pas de liste de contrôle d’accès par défaut, l’umask limite les autorisations du fichier ou du répertoire à créer. L’autorisation résultante est donnée par p & ^u, où p est l’autorisation et vous êtes l’umask. Par exemple, si p est 0777 et que vous avez la valeur 0057, l’autorisation résultante est 0720. L’autorisation par défaut est 0777 pour un répertoire et 0666 pour un fichier. L’umask par défaut est 0027. L’umask doit être spécifié en notation octale à 4 chiffres (par exemple, 0766).

owner: str

Propriétaire du fichier ou du répertoire.

group: str

Groupe propriétaire du fichier ou du répertoire.

acl: str

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste séparée par des virgules d’entrées de contrôle d’accès. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type, d’un identificateur d’utilisateur ou de groupe et d’autorisations au format « [scope:][type]:[id]:[permissions] ».

lease_id: str

ID de bail proposé, dans un format de chaîne GUID. Le service DataLake retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

lease_duration: int

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification.

expires_on: datetime ou int

Heure d’expiration du fichier. Si le type de expires_on est un int, l’heure d’expiration est définie comme le nombre de millisecondes écoulées à partir de l’heure de création. Si le type de expires_on est dateheure, l’heure d’expiration est définie en valeur absolue sur l’heure fournie. Si aucune information de fuseau horaire n’est fournie, cela sera interprété comme UTC.

permissions: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Définit les autorisations d’accès POSIX pour le propriétaire du fichier, le groupe propriétaire du fichier et d’autres personnes. Chaque classe peut se voir accorder l’autorisation de lecture, d’écriture ou d’exécution. Le bit collant est également pris en charge. La notation symbolique (rwxrw-rw-) et la notation octale à 4 chiffres (par exemple, 0766) sont prises en charge.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Retours

DataLakeFileClient

Exemples

Créez un fichier dans le système de fichiers.


   file_client = file_system_client.create_file("myfile")

Crée un système de fichiers sous le compte spécifié.

Si le système de fichiers portant le même nom existe déjà, un ResourceExistsError est déclenché. Cette méthode retourne un client avec lequel interagir avec le système de fichiers nouvellement créé.

create_file_system(metadata: Dict[str, str] | None = None, public_access: PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

metadata: dict(str, str)

Obligatoire

dict avec des paires nom-valeur à associer au système de fichiers en tant que métadonnées. Exemple : {'Category':'test'}

public_access: PublicAccess

Obligatoire

Pour spécifier si les données du système de fichiers sont accessibles publiquement et le niveau d’accès.

encryption_scope_options: dict ou EncryptionScopeOptions

Spécifie l’étendue de chiffrement par défaut à définir sur le système de fichiers et à utiliser pour toutes les écritures futures.

Nouveautés de la version 12.9.0.

timeout: int

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

Retours

Dictionnaire d’en-têtes de réponse.

Type de retour

Dict[str, Union[str, datetime]]

Exemples

Création d’un système de fichiers dans le service datalake.


   file_system_client.create_file_system()

Marque le chemin d’accès spécifié pour la suppression.

delete_directory(directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Paramètres

directory: str ou DirectoryProperties

Obligatoire

Répertoire avec lequel interagir. Il peut s’agir du nom du répertoire ou d’un instance de DirectoryProperties.

lease: DataLakeLeaseClient ou str

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

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Retours

DataLakeDirectoryClient

Exemples

Supprimez le répertoire dans le système de fichiers.


   file_system_client.delete_directory("mydirectory")

Marque le fichier spécifié pour suppression.

delete_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Paramètres

file: str ou FileProperties

Obligatoire

Fichier avec lequel interagir. Il peut s’agir du nom du fichier ou d’un instance de FileProperties.

lease: DataLakeLeaseClient ou str

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

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Retours

DataLakeFileClient

Exemples

Supprimez le fichier dans le système de fichiers.


   file_system_client.delete_file("myfile")

Marque le système de fichiers spécifié pour suppression.

Le système de fichiers et tous les fichiers qu’il contient sont supprimés ultérieurement pendant le garbage collection. Si le système de fichiers est introuvable, un ResourceNotFoundError est déclenché.

delete_file_system(**kwargs: Any) -> None

Paramètres

lease: str ou DataLakeLeaseClient

S’il est spécifié, delete_file_system réussit uniquement si le bail du système de fichiers est actif et correspond à cet ID. Obligatoire si le système de fichiers a un bail actif.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Type de retour

None

Exemples

Suppression d’un système de fichiers dans le service datalake.


   file_system_client.delete_file_system()

Retourne La valeur True si un système de fichiers 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-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

True si un système de fichiers existe, False dans le cas contraire.

Type de retour

bool

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

:return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient

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

Paramètres

conn_str: str

Obligatoire

Chaîne de connexion à un compte de stockage Azure.

file_system_name: str

Obligatoire

Nom du système de fichiers avec lequel interagir.

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 ou si la chaîne de connexion a déjà des valeurs de clé d’accès partagé. La valeur peut être une chaîne de jeton SAS, une instance d’azureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials à partir d’azure.identity. Les informations d’identification fournies ici sont prioritaires sur celles de la chaîne de connexion. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé de compte de stockage.

Exemples

Créer FileSystemClient à partir de la chaîne de connexion


   from azure.storage.filedatalake import FileSystemClient
   file_system_client = FileSystemClient.from_connection_string(self.connection_string, "filesystem")

Obtenir un client pour interagir avec le répertoire spécifié.

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

get_directory_client(directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Paramètres

directory: str ou DirectoryProperties

Obligatoire

Répertoire avec lequel interagir. Il peut s’agir du nom du répertoire ou d’un instance de DirectoryProperties.

Retours

A DataLakeDirectoryClient.

Type de retour

DataLakeDirectoryClient

Exemples

Obtention du client d’annuaire pour interagir avec un répertoire spécifique.


   # Get the DataLakeDirectoryClient from the FileSystemClient to interact with a specific file
   directory_client = file_system_client.get_directory_client("mynewdirectory")

Obtenir un client pour interagir avec le fichier spécifié.

Le fichier n’a pas besoin d’exister.

get_file_client(file_path: FileProperties | str) -> DataLakeFileClient

Paramètres

file_path: str ou FileProperties

Obligatoire

Fichier avec lequel interagir. Il peut s’agir du chemin d’accès du fichier (à partir du répertoire racine) ou d’un instance de FileProperties. Par exemple, répertoire/sous-répertoire/fichier

Retours

A DataLakeFileClient.

Type de retour

DataLakeFileClient

Exemples

Obtention du client de fichiers pour interagir avec un fichier spécifique.


   # Get the FileClient from the FileSystemClient to interact with a specific file
   file_client = file_system_client.get_file_client("mynewfile")

Obtient les autorisations pour le système de fichiers spécifié. Les autorisations indiquent si les données du système de fichiers sont accessibles publiquement.

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

Paramètres

lease: DataLakeLeaseClient ou str

Si elle est spécifiée, l’opération réussit uniquement si le bail du système de fichiers est actif et correspond à cet ID.

timeout: int

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

Retours

Accéder aux informations de stratégie dans un dict.

Type de retour

dict[str, Any]

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

get_file_system_properties(**kwargs: Any) -> FileSystemProperties

Paramètres

lease: str ou DataLakeLeaseClient

S’il est spécifié, get_file_system_properties réussit uniquement si le bail du système de fichiers est actif et correspond à cet ID.

timeout: int

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

Retours

Propriétés du système de fichiers spécifié dans un objet de système de fichiers.

Type de retour

FileSystemProperties

Exemples

Obtention des propriétés sur le système de fichiers.


   properties = file_system_client.get_file_system_properties()

Retourne un générateur pour répertorier les chemins d’accès (il peut s’agir de fichiers ou de répertoires) sous le système de fichiers spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service.

get_paths(path: str | None = None, recursive: bool | None = True, max_results: int | None = None, **kwargs) -> ItemPaged[PathProperties]

Paramètres

path: str

Obligatoire

Filtre les résultats pour renvoyer uniquement les chemins d’accès sous le chemin spécifié.

recursive: Optional[bool]

Obligatoire

facultatif. Définissez True pour récursive, False pour itérative.

max_results: int

Obligatoire

Valeur facultative qui spécifie le nombre maximal d’éléments à retourner par page. Si elle est omise ou supérieure à 5 000, la réponse inclut jusqu’à 5 000 éléments par page.

upn

facultatif. Valide uniquement lorsque l’espace de noms hiérarchique est activé pour le compte. Si la valeur est « true », les valeurs d’identité utilisateur retournées dans les en-têtes de réponse x-ms-owner, x-ms-group et x-ms-acl sont transformées des ID d’objet Azure Active Directory en noms d’utilisateur principal. Si « false », les valeurs sont retournées en tant qu’ID d’objet Azure Active Directory. La valeur par défaut est false. Notez que les ID d’objet de groupe et d’application ne sont pas traduits, car ils n’ont pas de noms conviviaux uniques.

timeout: int

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

Retours

Réponse itérable (pagination automatique) de PathProperties.

Type de retour

ItemPaged[PathProperties]

Exemples

Répertorier les chemins d’accès dans le système de fichiers.


   path_list = file_system_client.get_paths()
   for path in path_list:
       print(path.name + '\n')

Retourne un générateur pour répertorier les chemins d’accès supprimés (fichier ou répertoire) sous le système de fichiers spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service.

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

list_deleted_paths(**kwargs: Any) -> ItemPaged[DeletedPathProperties]

Paramètres

path_prefix: str

Filtre les résultats pour renvoyer uniquement les chemins d’accès sous le chemin spécifié.

results_per_page: int

Valeur facultative qui spécifie le nombre maximal d’éléments à retourner par page. Si elle est omise ou supérieure à 5 000, la réponse inclut jusqu’à 5 000 éléments par page.

timeout: int

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

Retours

Réponse itérable (pagination automatique) de DeletedPathProperties.

Type de retour

ItemPaged[DeletedPathProperties]

Définit les autorisations pour le système de fichiers ou les stratégies d’accès stockés spécifiés qui peuvent être utilisées avec les signatures d’accès partagé. Les autorisations indiquent si les fichiers d’un système de fichiers sont accessibles publiquement.

set_file_system_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

signed_identifiers: dict[str, AccessPolicy]

Obligatoire

Dictionnaire des stratégies d’accès à associer au système de fichiers. Le dictionnaire peut contenir jusqu’à 5 éléments. Un dictionnaire vide efface les stratégies d’accès définies sur le service.

public_access: PublicAccess

Obligatoire

Pour spécifier si les données du système de fichiers sont accessibles publiquement et le niveau d’accès.

lease: DataLakeLeaseClient ou str

Obligatoire si le système de fichiers a un bail actif. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur datetime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour effectuer l’opération uniquement si la ressource a été modifiée depuis la date/heure spécifiée.

if_unmodified_since: datetime

Valeur datetime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

timeout: int

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

Retours

Dict de propriété mise à jour par le système de fichiers (Etag et dernière modification).

Type de retour

dict[str, str,

datetime]

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

set_file_system_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]

Paramètres

metadata: dict[str, str]

Obligatoire

dict contenant des paires nom-valeur à associer au système de fichiers en tant que métadonnées. Exemple : {'category':'test'}

lease: str ou DataLakeLeaseClient

S’il est spécifié, set_file_system_metadata réussit uniquement si le bail du système de fichiers est actif et correspond à cet ID.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

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

Retours

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

Type de retour

Dict[str, str]

Exemples

Définition des métadonnées sur le système de fichiers.


   # Create key, value pairs for metadata
   metadata = {'type': 'test'}

   # Set metadata on the file system
   file_system_client.set_file_system_metadata(metadata=metadata)

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

Mode d’emplacement que le client utilise actuellement.

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

URL complète du point de terminaison principal.

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

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

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

Exceptions

ValueError

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

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

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

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

acquire_lease	Demande un nouveau bail. Si le système de fichiers n’a pas de bail actif, le service DataLake crée un bail sur le système de fichiers et retourne un nouvel ID de bail.
close	Cette méthode consiste à fermer les sockets ouverts par le client. Il n’a pas besoin d’être utilisé lors de l’utilisation avec un gestionnaire de contexte.
create_directory	Créer un répertoire
create_file	Créer un fichier
create_file_system	Crée un système de fichiers sous le compte spécifié. Si le système de fichiers portant le même nom existe déjà, un ResourceExistsError est déclenché. Cette méthode retourne un client avec lequel interagir avec le système de fichiers nouvellement créé.
delete_directory	Marque le chemin d’accès spécifié pour la suppression.
delete_file	Marque le fichier spécifié pour suppression.
delete_file_system	Marque le système de fichiers spécifié pour suppression. Le système de fichiers et tous les fichiers qu’il contient sont supprimés ultérieurement pendant le garbage collection. Si le système de fichiers est introuvable, un ResourceNotFoundError est déclenché.
exists	Retourne La valeur True si un système de fichiers existe et la valeur False dans le cas contraire.
from_connection_string	Créez FileSystemClient à partir d’une chaîne de connexion. :return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient
get_directory_client	Obtenir un client pour interagir avec le répertoire spécifié. Le répertoire n’a pas besoin d’exister.
get_file_client	Obtenir un client pour interagir avec le fichier spécifié. Le fichier n’a pas besoin d’exister.
get_file_system_access_policy	Obtient les autorisations pour le système de fichiers spécifié. Les autorisations indiquent si les données du système de fichiers sont accessibles publiquement.
get_file_system_properties	Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le système de fichiers spécifié. Les données retournées n’incluent pas la liste des chemins d’accès du système de fichiers.
get_paths	Retourne un générateur pour répertorier les chemins d’accès (il peut s’agir de fichiers ou de répertoires) sous le système de fichiers spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service.
list_deleted_paths	Retourne un générateur pour répertorier les chemins d’accès supprimés (fichier ou répertoire) sous le système de fichiers spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service. Nouveautés de la version 12.4.0 : cette opération a été introduite dans la version d’API « 2020-06-12 ».
set_file_system_access_policy	Définit les autorisations pour le système de fichiers ou les stratégies d’accès stockés spécifiés qui peuvent être utilisées avec les signatures d’accès partagé. Les autorisations indiquent si les fichiers d’un système de fichiers sont accessibles publiquement.
set_file_system_metadata	Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le système de fichiers spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au système de fichiers. Pour supprimer toutes les métadonnées du système de fichiers, appelez cette opération sans dictée de métadonnées.

Partager via

FileSystemClient Classe

Constructeur

Paramètres

Exemples

Variables

Méthodes

acquire_lease

Paramètres

Retours

Type de retour

Exemples

close

create_directory

Paramètres

Retours

Exemples

create_file

Paramètres

Retours

Exemples

create_file_system

Paramètres

Retours

Type de retour

Exemples

delete_directory

Paramètres

Retours

Exemples

delete_file

Paramètres

Retours

Exemples

delete_file_system

Paramètres

Type de retour

Exemples

exists

Paramètres

Retours

Type de retour

from_connection_string

Paramètres

Exemples

get_directory_client

Paramètres

Retours

Type de retour

Exemples

get_file_client

Paramètres

Retours

Type de retour

Exemples

get_file_system_access_policy

Paramètres

Retours

Type de retour

get_file_system_properties

Paramètres

Retours

Type de retour

Exemples

get_paths

Paramètres

Retours

Type de retour

Exemples

list_deleted_paths

Paramètres

Retours

Type de retour

set_file_system_access_policy

Paramètres

Retours

Type de retour

set_file_system_metadata

Paramètres

Retours