Partager via


DataLakeDirectoryClient Classe

Client pour interagir avec le répertoire DataLake, même si le répertoire n’existe pas encore.

Pour les opérations relatives à un sous-répertoire ou à un fichier spécifique sous le répertoire, un client de répertoire ou un client de fichier peut être récupéré à l’aide des get_sub_directory_client fonctions ou get_file_client .

Héritage
azure.storage.filedatalake._path_client.PathClient
DataLakeDirectoryClient

Constructeur

DataLakeDirectoryClient(account_url: str, file_system_name: str, directory_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Paramètres

account_url
str
Obligatoire

URI du compte de stockage.

file_system_name
str
Obligatoire

Système de fichiers pour le ou les fichiers.

directory_name
str
Obligatoire

Chemin d’accès entier du répertoire. par exemple {répertoire sous système de fichiers}/{répertoire avec lequel interagir}

credential
valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cette option est facultative si l’URL du compte a déjà un jeton SAP. La valeur peut être une chaîne de jeton SAS, une instance d’une classe AzureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials d’azure.identity. Si l’URI de ressource contient déjà un jeton SAP, 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 une ValeurError. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé du compte de stockage.
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 entraîner une compatibilité des fonctionnalités réduite.

Exemples

Création du DataLakeServiceClient à partir de la chaîne de connexion.


   from azure.storage.filedatalake import DataLakeDirectoryClient
   DataLakeDirectoryClient.from_connection_string(connection_string, "myfilesystem", "mydirectory")

Variables

url
str

URL complète du point de terminaison vers le système de fichiers, y compris le jeton SAS s’il est utilisé.

primary_endpoint
str

URL complète du point de terminaison principal.

primary_hostname
str

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

Méthodes

acquire_lease

Demande un nouveau bail. Si le fichier ou le répertoire n’a pas de bail actif, le service DataLake crée un bail sur le fichier/répertoire 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éez un nouveau répertoire.

create_file

Créez un fichier et retournez le client de fichier avec lequel interagir.

create_sub_directory

Créez un sous-répertoire et retournez le client de sous-répertoire avec lequel interagir.

delete_directory

Marque le répertoire spécifié pour suppression.

delete_sub_directory

Marque le sous-répertoire spécifié pour suppression.

exists

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

from_connection_string

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

get_access_control
get_directory_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 répertoire. Il ne retourne pas le contenu du répertoire.

get_file_client

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

Le fichier n’a pas besoin d’exister.

get_sub_directory_client

Obtenir un client pour interagir avec le sous-répertoire spécifié du répertoire actif.

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

remove_access_control_recursive

Supprime le Access Control sur un chemin d’accès et des sous-chemins.

rename_directory

Renommez le répertoire source.

set_access_control

Définissez le propriétaire, le groupe, les autorisations ou la liste de contrôle d’accès pour un chemin d’accès.

set_access_control_recursive

Définit le Access Control sur un chemin et des sous-chemins.

set_http_headers

Définit les propriétés système sur le fichier ou le répertoire.

Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.

set_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.

update_access_control_recursive

Modifie le Access Control sur un chemin et des sous-chemins.

acquire_lease

Demande un nouveau bail. Si le fichier ou le répertoire n’a pas de bail actif, le service DataLake crée un bail sur le fichier/répertoire et retourne un nouvel ID de bail.

acquire_lease(lease_duration: int | None = -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

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.

close() -> None

create_directory

Créez un nouveau répertoire.

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

Paramètres

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 selon la condition spécifiée par le paramètre match_condition.

match_condition
MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk
CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

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

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

Type de retour

Exemples

Créer un répertoire.


   directory_client.create_directory()

create_file

Créez un fichier et retournez le client de fichier avec lequel interagir.

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’un instance de FileProperties.

content_settings
ContentSettings

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

metadata

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 obtenue 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 d’entrées de contrôle d’accès séparées par des virgules. 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. Une durée de bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification.

expires_on
datetime ou int

Délai de définition de l’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 d’expires_on est datetime, l’heure d’expiration est définie comme 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, etc. 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 octal à 4 chiffres (par exemple, 0766) sont prises en charge.

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.

cpk
CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

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

create_sub_directory

Créez un sous-répertoire et retournez le client de sous-répertoire avec lequel interagir.

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

Paramètres

sub_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 obtenue 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 d’entrées de contrôle d’accès séparées par des virgules. 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. Une durée de 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, etc. 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 octal à 4 chiffres (par exemple, 0766) sont prises en charge.

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.

cpk
CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

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

DataLakeDirectoryClient pour le sous-répertoire.

delete_directory

Marque le répertoire spécifié pour suppression.

delete_directory(**kwargs) -> None

Paramètres

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

Aucun

Exemples

Supprimer le répertoire.


   new_directory.delete_directory()

delete_sub_directory

Marque le sous-répertoire spécifié pour suppression.

delete_sub_directory(sub_directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Paramètres

sub_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 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

DataLakeDirectoryClient pour le sous-répertoire

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-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 s’il existe un répertoire, False dans le cas contraire.

Type de retour

from_connection_string

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

from_connection_string(conn_str: str, file_system_name: str, directory_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. 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.
directory_name
str
Obligatoire

Nom du répertoire avec lequel interagir. Le répertoire se trouve sous le système de fichiers.

credential
Obligatoire

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.

Retours

un DataLakeDirectoryClient

Type de retour

get_access_control

get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]

Paramètres

upn
bool
Obligatoire

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.

lease
DataLakeLeaseClient ou str

Obligatoire si le fichier/répertoire 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 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.

response dict

dict de réponse.

get_directory_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 répertoire. Il ne retourne pas le contenu du répertoire.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Paramètres

lease
DataLakeLeaseClient ou str

Obligatoire si le répertoire ou le fichier 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 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.

cpk
CustomerProvidedEncryptionKey

Déchiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS. Obligatoire si le répertoire a été créé avec une clé fournie par le client.

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.

Type de retour

Exemples

Obtention des propriétés d’un fichier/répertoire.


   props = new_directory.get_directory_properties()

get_file_client

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

Le fichier n’a pas besoin d’exister.

get_file_client(file: FileProperties | str) -> 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. Par exemple, répertoire/sous-répertoire/fichier

Retours

A DataLakeFileClient.

Type de retour

get_sub_directory_client

Obtenir un client pour interagir avec le sous-répertoire spécifié du répertoire actif.

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

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Paramètres

sub_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

remove_access_control_recursive

Supprime le Access Control sur un chemin d’accès et des sous-chemins.

remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Paramètres

acl
str
Obligatoire

Supprime 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 et d’un identificateur d’utilisateur ou de groupe au format « [scope:][type]:[id] ».

progress_hook
<xref:func>(AccessControlChanges)

Rappel dans lequel l’appelant peut suivre la progression de l’opération et collecter les chemins qui n’ont pas pu changer Access Control.

continuation_token
str

Jeton de continuation facultatif qui peut être utilisé pour reprendre une opération précédemment arrêtée.

batch_size
int

facultatif. Si la taille du jeu de données dépasse la taille du lot, l’opération est fractionnée en plusieurs demandes afin que la progression puisse être suivie. La taille du lot doit être comprise entre 1 et 2000. La valeur par défaut quand elle n’est pas spécifiée est 2000.

max_batches
int

facultatif. Définit le nombre maximal de lots qu’une seule modification Access Control opération peut exécuter. Si le maximum est atteint avant que tous les sous-chemins ne soient traités, le jeton de continuation peut être utilisé pour reprendre l’opération. La valeur vide indique que le nombre maximal de lots non liés et l’opération se poursuit jusqu’à la fin.

continue_on_failure
bool

Si la valeur est False, l’opération s’arrête rapidement en cas d’erreurs utilisateur (4XX). Si la valeur est True, l’opération ignore les erreurs utilisateur et poursuit l’opération sur d’autres sous-entités du répertoire. Le jeton de continuation n’est retourné que lorsque continue_on_failure a la valeur True en cas d’erreurs utilisateur. S’il n’est pas défini, la valeur par défaut est False pour cela.

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ésumé des opérations récursives, y compris le nombre de réussites et d’échecs, ainsi qu’un jeton de continuation en cas de fin prématurée de l’opération.

Type de retour

Exceptions

L’utilisateur peut redémarrer l’opération à l’aide de continuation_token champ d’AzureError si le jeton est disponible.

rename_directory

Renommez le répertoire source.

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

Paramètres

new_name
str
Obligatoire

nom du nouveau répertoire que l’utilisateur souhaite renommer. La valeur doit avoir le format suivant : « {filesystem}/{directory}/{subdirectory} ».

source_lease
DataLakeLeaseClient ou str

ID de bail pour le chemin d’accès source. S’il est spécifié, le chemin d’accès source doit avoir un bail actif et l’ID de bail doit correspondre.

lease
DataLakeLeaseClient ou str

Obligatoire si le fichier/répertoire 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.

source_if_modified_since
datetime

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

source_if_unmodified_since
datetime

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

source_etag
str

Valeur ETag source ou 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.

source_match_condition
MatchConditions

Condition de correspondance source à 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

DataLakeDirectoryClient

Exemples

Renommez le répertoire source.


   new_dir_name = "testdir2"
   print("Renaming the directory named '{}' to '{}'.".format(dir_name, new_dir_name))
   new_directory = directory_client\
       .rename_directory(new_name=directory_client.file_system_name + '/' + new_dir_name)

set_access_control

Définissez le propriétaire, le groupe, les autorisations ou la liste de contrôle d’accès pour un chemin d’accès.

set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]

Paramètres

owner
str
Obligatoire

facultatif. Propriétaire du fichier ou du répertoire.

group
str
Obligatoire

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

permissions
str
Obligatoire

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, etc. 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 octal à 4 chiffres (par exemple, 0766) sont prises en charge. les autorisations et acl s’excluent mutuellement.

acl
str
Obligatoire

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. 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] ». les autorisations et acl s’excluent mutuellement.

lease
DataLakeLeaseClient ou str

Obligatoire si le fichier/répertoire 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.

response dict

dicté de réponse (Etag et dernière modification).

set_access_control_recursive

Définit le Access Control sur un chemin et des sous-chemins.

set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Paramètres

acl
str
Obligatoire

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. 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] ».

progress_hook
<xref:func>(AccessControlChanges)

Rappel dans lequel l’appelant peut suivre la progression de l’opération et collecter les chemins d’accès qui n’ont pas pu changer Access Control.

continuation_token
str

Jeton de continuation facultatif qui peut être utilisé pour reprendre l’opération précédemment arrêtée.

batch_size
int

facultatif. Si la taille du jeu de données dépasse la taille du lot, l’opération est divisée en plusieurs demandes afin que la progression puisse être suivie. La taille du lot doit être comprise entre 1 et 2000. La valeur par défaut quand elle n’est pas spécifiée est 2000.

max_batches
int

facultatif. Définit le nombre maximal de lots que Access Control opération de modification unique peut exécuter. Si le maximum est atteint avant le traitement de tous les sous-chemins, le jeton de continuation peut être utilisé pour reprendre l’opération. La valeur vide indique que le nombre maximal de lots dans les lots non liés et l’opération se poursuit jusqu’à la fin.

continue_on_failure
bool

Si la valeur est False, l’opération se termine rapidement en cas d’erreurs utilisateur (4XX). Si la valeur est True, l’opération ignore les erreurs utilisateur et poursuit l’opération sur d’autres sous-entités du répertoire. Le jeton de continuation est retourné uniquement quand continue_on_failure a la valeur True en cas d’erreurs utilisateur. Si ce n’est pas le cas, 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-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ésumé des opérations récursives, y compris le nombre de réussites et d’échecs, ainsi qu’un jeton de continuation au cas où l’opération s’arrêtait prématurément.

Type de retour

Exceptions

L’utilisateur peut redémarrer l’opération à l’aide de continuation_token champ d’AzureError si le jeton est disponible.

set_http_headers

Définit les propriétés système sur le fichier ou le répertoire.

Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.

set_http_headers(content_settings: ContentSettings | None = None, **kwargs) -> Dict[str, Any]

Paramètres

content_settings
ContentSettings
Obligatoire

Objet ContentSettings utilisé pour définir les propriétés de fichier/répertoire.

lease
DataLakeLeaseClient ou str

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 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

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

Type de retour

set_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.

set_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
DataLakeLeaseClient ou str

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 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.

cpk
CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

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

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

update_access_control_recursive

Modifie le Access Control sur un chemin et des sous-chemins.

update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Paramètres

acl
str
Obligatoire

Modifie les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. 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] ».

progress_hook
<xref:func>(AccessControlChanges)

Rappel dans lequel l’appelant peut suivre la progression de l’opération et collecter les chemins d’accès qui n’ont pas pu changer Access Control.

continuation_token
str

Jeton de continuation facultatif qui peut être utilisé pour reprendre l’opération précédemment arrêtée.

batch_size
int

facultatif. Si la taille du jeu de données dépasse la taille du lot, l’opération est divisée en plusieurs demandes afin que la progression puisse être suivie. La taille du lot doit être comprise entre 1 et 2000. La valeur par défaut quand elle n’est pas spécifiée est 2000.

max_batches
int

facultatif. Définit le nombre maximal de lots que Access Control opération de modification unique peut exécuter. Si le maximum est atteint avant le traitement de tous les sous-chemins, le jeton de continuation peut être utilisé pour reprendre l’opération. La valeur vide indique que le nombre maximal de lots dans les lots non liés et l’opération se poursuit jusqu’à la fin.

continue_on_failure
bool

Si la valeur est False, l’opération se termine rapidement en cas d’erreurs utilisateur (4XX). Si la valeur est True, l’opération ignore les erreurs utilisateur et poursuit l’opération sur d’autres sous-entités du répertoire. Le jeton de continuation est retourné uniquement quand continue_on_failure a la valeur True en cas d’erreurs utilisateur. Si ce n’est pas le cas, 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-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ésumé des opérations récursives, y compris le nombre de réussites et d’échecs, ainsi qu’un jeton de continuation au cas où l’opération s’arrêtait prématurément.

Type de retour

Exceptions

L’utilisateur peut redémarrer l’opération à l’aide de continuation_token champ d’AzureError si le jeton est disponible.

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 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

secondary_hostname

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

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