Partager via

ShareFileClient Classe

  • Référence

Client pour interagir avec un fichier spécifique, bien que ce fichier n’existe pas encore.

Pour une configuration plus facultative, cliquez ici.

Héritage
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareFileClient

Constructeur

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

Paramètres

account_url
str
Obligatoire

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

share_name
str
Obligatoire

Nom du partage pour le fichier.

file_path
str
Obligatoire

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

snapshot
str
valeur par défaut: None

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

credential
valeur par défaut: None

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

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

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

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

allow_trailing_dot
bool

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

allow_source_trailing_dot
bool

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

api_version
str

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

Nouveautés de la version 12.1.0.

secondary_hostname
str

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

max_range_size
int

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

audience
str

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

Méthodes

abort_copy

Abandonner une opération de copie en cours.

Cela laisse un fichier de destination sans longueur et des métadonnées complètes. Cela génère une erreur si l’opération de copie est déjà terminée.
acquire_lease

Demande un nouveau bail.

Si le fichier n’a pas de bail actif, le service de fichiers crée un bail sur l’objet blob et retourne un nouveau bail.
clear_range

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

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

Fermez tous les descripteurs de fichiers ouverts.

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

Fermez un handle de fichier ouvert.
create_file

Crée un nouveau fichier.

Notez qu’il initialise uniquement le fichier sans contenu.
delete_file

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

Télécharge un fichier dans StorageStreamDownloader. La méthode readall() doit être utilisée pour lire tout le contenu ou readinto() doit être utilisée pour télécharger le fichier dans un flux. L’utilisation de segments() retourne un itérateur qui permet à l’utilisateur d’itérer sur le contenu en blocs.
from_connection_string

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

Un client pour interagir avec un fichier spécifique, bien que ce fichier n’existe pas encore.
get_file_properties

Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du fichier.
get_ranges

Retourne la liste des plages de pages valides pour un fichier ou instantané d’un fichier.
get_ranges_diff

Retourne la liste des plages de pages valides pour un fichier ou instantané d’un fichier.

Nouveautés de la version 12.6.0.
list_handles

Répertorie les handles pour le fichier.
rename_file

Renommez le fichier source.

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

Heure de création du fichier.

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

Heure de la dernière écriture du fichier.

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

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

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

Redimensionne un fichier à la taille spécifiée.
set_file_metadata

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

Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au fichier. Pour supprimer toutes les métadonnées du fichier, appelez cette opération sans dictée de métadonnées.
set_http_headers

Définit les en-têtes HTTP sur le fichier.
start_copy_from_url

Lance la copie des données d’une URL source dans le fichier référencé par le client.

La status de cette opération de copie est disponible à l’aide de la méthode get_properties.
upload_file

Charge un nouveau fichier.

param data : contenu du fichier.

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

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

type file_attributes : str ou ~azure.storage.fileshare.NTFSAttributes

param file_creation_time : heure de création du fichier Valeur par défaut : Maintenant.

type file_creation_time : str ou ~datetime.datetime

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

type file_last_write_time : str ou ~datetime.datetime

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

type file_permission : str

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

type permission_key : str
upload_range

Chargez une plage d’octets dans un fichier.
upload_range_from_url

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

abort_copy

Abandonner une opération de copie en cours.

Cela laisse un fichier de destination sans longueur et des métadonnées complètes. Cela génère une erreur si l’opération de copie est déjà terminée.

abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None

Paramètres

copy_id
str ou FileProperties
Obligatoire

Opération de copie à abandonner. Il peut s’agir d’un ID ou d’un instance de FileProperties.

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.0.

timeout
int

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

Type de retour

None

acquire_lease

Demande un nouveau bail.

Si le fichier n’a pas de bail actif, le service de fichiers crée un bail sur l’objet blob et retourne un nouveau bail.

acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient

Paramètres

lease_id
str
Obligatoire

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

timeout
int

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

Retours

Objet ShareLeaseClient.

Type de retour

ShareLeaseClient

Exemples

Acquisition d’un bail sur un fichier.


   source_file.create_file(1024)
   lease = source_file.acquire_lease()
   source_file.upload_file(b'hello world', lease=lease)

   lease.release()

clear_range

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

clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]

Paramètres

offset
int
Obligatoire

Début de la plage d’octets à utiliser pour effacer une section du fichier. La taille de la plage peut atteindre 4 Mo.

length
int
Obligatoire

Nombre d’octets à utiliser pour effacer une section du fichier. La taille de la plage peut atteindre 4 Mo.

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.0.

timeout
int

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

Retours

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

Type de retour

Dict[str, Any]

close

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

close()

close_all_handles

Fermez tous les descripteurs de fichiers ouverts.

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

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

Paramètres

timeout
int

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

Retours

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

Type de retour

dict[str, int]

close_handle

Fermez un handle de fichier ouvert.

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

Paramètres

handle
str ou Handle
Obligatoire

Handle spécifique à fermer.

timeout
int

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

Retours

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

Type de retour

dict[str, int]

create_file

Crée un nouveau fichier.

Notez qu’il initialise uniquement le fichier sans contenu.

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

Paramètres

size
int
Obligatoire

Spécifie la taille maximale du fichier, jusqu’à 1 To.

file_attributes
NTFSAttributes
Obligatoire

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

file_creation_time
str ou datetime
Obligatoire

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

file_last_write_time
str ou datetime
Obligatoire

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

file_permission
str
Obligatoire

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

permission_key
str
Obligatoire

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

file_change_time
str ou datetime

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

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

content_settings
ContentSettings

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

metadata
dict(str,str)

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

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

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

Type de retour

dict(str, Any)

Exemples

Créez un fichier.


   # Create and allocate bytes for the file (no content added yet)
   my_allocated_file.create_file(size=100)

delete_file

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

delete_file(**kwargs: Any) -> None

Paramètres

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Type de retour

None

Exemples

Supprimez un fichier.


   my_file.delete_file()

download_file

Télécharge un fichier dans StorageStreamDownloader. La méthode readall() doit être utilisée pour lire tout le contenu ou readinto() doit être utilisée pour télécharger le fichier dans un flux. L’utilisation de segments() retourne un itérateur qui permet à l’utilisateur d’itérer sur le contenu en blocs.

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Paramètres

offset
int
Obligatoire

Début de la plage d’octets à utiliser pour télécharger une section du fichier. Doit être défini si la longueur est fournie.

length
int
Obligatoire

Nombre d’octets à lire à partir du flux. Cette option est facultative, mais doit être fournie pour des performances optimales.

max_concurrency
int

Nombre maximal de connexions parallèles à utiliser.

validate_content
bool

Si la valeur est true, calcule un hachage MD5 pour chaque segment du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage envoyé. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier. Notez également que s’il est activé, l’algorithme de chargement à mémoire efficace ne sera pas utilisé, car le calcul du hachage MD5 nécessite la mise en mémoire tampon de blocs entiers, ce qui va à l’échec de l’objectif de l’algorithme d’efficacité de la mémoire.

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.0.

progress_hook
Callable[[int, int], None]

Rappel permettant de suivre la progression d’un téléchargement de longue durée. La signature est function(current : int, total : int) où current est le nombre d’octets transférés jusqu’à présent, et total correspond à la taille totale du téléchargement.

timeout
int

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

Retours

Objet de diffusion en continu (StorageStreamDownloader)

Type de retour

<xref:azure.storage.fileshare.StorageStreamDownloader>

Exemples

Téléchargez un fichier.


   with open(DEST_FILE, "wb") as data:
       stream = my_file.download_file()
       data.write(stream.readall())

from_connection_string

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

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

Paramètres

conn_str
str
Obligatoire

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

share_name
str
Obligatoire

Nom du partage.

file_path
str
Obligatoire

Chemin d'accès au fichier.

snapshot
str
valeur par défaut: None

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

credential
valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. 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.
audience
str

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

Retours

Un client de fichier.

Type de retour

ShareFileClient

Exemples

Crée le client de fichiers avec chaîne de connexion.


   from azure.storage.fileshare import ShareFileClient
   file = ShareFileClient.from_connection_string(
       self.connection_string,
       share_name="helloworld2",
       file_path="myfile")

from_file_url

Un client pour interagir avec un fichier spécifique, bien que ce fichier n’existe pas encore.

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

Paramètres

file_url
str
Obligatoire

URI complet du fichier.

snapshot
str
valeur par défaut: None

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

credential
valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. 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.
audience
str

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

Retours

Un client de fichier.

Type de retour

ShareFileClient

get_file_properties

Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du fichier.

get_file_properties(**kwargs: Any) -> FileProperties

Paramètres

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

FileProperties

Type de retour

FileProperties

get_ranges

Retourne la liste des plages de pages valides pour un fichier ou instantané d’un fichier.

get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]

Paramètres

offset
int
Obligatoire

Spécifie le décalage de début des octets sur lesquels obtenir des plages.

length
int
Obligatoire

Nombre d’octets à utiliser pour obtenir des plages.

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Liste des plages valides.

Type de retour

List[dict[str, int]]

get_ranges_diff

Retourne la liste des plages de pages valides pour un fichier ou instantané d’un fichier.

Nouveautés de la version 12.6.0.

get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Paramètres

offset
int
Obligatoire

Spécifie le décalage de début des octets sur lesquels obtenir des plages.

length
int
Obligatoire

Nombre d’octets à utiliser pour obtenir des plages.

previous_sharesnapshot
str
Obligatoire

Le paramètre instantané diff qui contient une valeur DateTime opaque qui spécifie un fichier précédent instantané à comparer à un instantané plus récent ou au fichier actif.

lease
ShareLeaseClient ou str

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

timeout
int

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

Retours

Tuple de deux listes de plages de fichiers sous forme de dictionnaires avec les clés « start » et « end ». Le premier élément est des plages de fichiers remplies, le 2e élément est des plages de fichiers effacées.

Type de retour

tuple(list(dict(str, str), list(dict(str, str))

list_handles

Répertorie les handles pour le fichier.

list_handles(**kwargs: Any) -> ItemPaged[Handle]

Paramètres

timeout
int

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

Retours

Une pagination automatique itérable de Handle

Type de retour

ItemPaged[Handle]

rename_file

Renommez le fichier source.

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

Heure de création du fichier.

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

Heure de la dernière écriture du fichier.

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

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

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

rename_file(new_name: str, **kwargs: Any) -> ShareFileClient

Paramètres

content_type
str

Type de contenu du nouveau fichier.

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

metadata
Dict[str,str]

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

source_lease
ShareLeaseClient ou str

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

destination_lease
ShareLeaseClient ou str

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

Retours

Nouveau client de fichier.

Type de retour

ShareFileClient

resize_file

Redimensionne un fichier à la taille spécifiée.

resize_file(size: int, **kwargs: Any) -> Dict[str, Any]

Paramètres

size
int
Obligatoire

Taille à laquelle redimensionner le fichier (en octets)

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

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

Type de retour

Dict[str, Any]

set_file_metadata

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

Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au fichier. Pour supprimer toutes les métadonnées du fichier, appelez cette opération sans dictée de métadonnées.

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

Paramètres

metadata
dict(str, str)
Obligatoire

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

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

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

Type de retour

dict(str, Any)

set_http_headers

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

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

Paramètres

content_settings
ContentSettings
Obligatoire

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

file_attributes
NTFSAttributes
Obligatoire

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

file_creation_time
str ou datetime
Obligatoire

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

file_last_write_time
str ou datetime
Obligatoire

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

file_permission
str
Obligatoire

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

permission_key
str
Obligatoire

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

file_change_time
str ou datetime

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

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

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

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

Type de retour

dict(str, Any)

start_copy_from_url

Lance la copie des données d’une URL source dans le fichier référencé par le client.

La status de cette opération de copie est disponible à l’aide de la méthode get_properties.

start_copy_from_url(source_url: str, **kwargs: Any) -> Any

Paramètres

source_url
str
Obligatoire

Spécifie l’URL du fichier source.

file_permission
str

Si spécifié, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier. Cette valeur peut être définie sur « source » pour copier le descripteur de sécurité à partir du fichier source. Sinon, si elle est définie, cette valeur sera utilisée pour remplacer la valeur source. Si elle n’est pas définie, la valeur d’autorisation est héritée du répertoire parent du fichier cible. Ce paramètre peut être utilisé si la taille de l’autorisation est <= 8 Ko, sinon, permission_key doit être utilisé. Si SDDL est spécifié en tant qu’entrée, il doit avoir propriétaire, groupe et dacl. Remarque : Une seule des file_permission ou permission_key doit être spécifiée.

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

permission_key
str

Clé de l’autorisation à définir pour le répertoire/fichier. Cette valeur peut être définie sur « source » pour copier le descripteur de sécurité à partir du fichier source. Sinon, si elle est définie, cette valeur sera utilisée pour remplacer la valeur source. Si elle n’est pas définie, la valeur d’autorisation est héritée du répertoire parent du fichier cible. Remarque : Une seule des file_permission ou permission_key doit être spécifiée.

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

file_attributes
NTFSAttributes

Cette valeur peut être définie sur « source » pour copier les attributs du fichier source vers le fichier cible, ou pour effacer tous les attributs, elle peut être définie sur « None ». Sinon, il peut être défini sur une liste d’attributs à définir sur le fichier cible. Si ce n’est pas défini, la valeur par défaut est « Archive ».

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

file_creation_time
str ou datetime

Cette valeur peut être définie sur « source » pour copier l’heure de création du fichier source vers le fichier cible, ou une datetime à définir comme heure de création sur le fichier cible. Il peut également s’agir d’une chaîne au format ISO 8601. Si ce n’est pas défini, l’heure de création est définie sur la valeur date-heure de la création (ou lorsqu’elle a été remplacée) du fichier cible par le moteur de copie.

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

file_last_write_time
str ou datetime

Cette valeur peut être définie sur « source » pour copier l’heure de la dernière écriture du fichier source vers le fichier cible, ou une datetime à définir comme heure de dernière écriture sur le fichier cible. Il peut également s’agir d’une chaîne au format ISO 8601. Si ce n’est pas défini, la valeur correspond à la dernière heure d’écriture du fichier par le moteur de copie.

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

file_change_time
str ou datetime

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

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

ignore_read_only
bool

Spécifie l’option permettant de remplacer le fichier cible s’il existe déjà et s’il a un jeu d’attributs en lecture seule.

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

set_archive_attribute
bool

Spécifie l’option permettant de définir l’attribut d’archive sur le fichier cible. True signifie que l’attribut archive sera défini sur le fichier cible malgré les remplacements d’attribut ou l’état du fichier source.

Nouveautés de la version 12.1.0 : ce paramètre a été introduit dans la version d’API « 2019-07-07 ».

metadata

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

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.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-file-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Type de retour

dict(str, Any)

Exemples

Copier un fichier à partir d’une URL


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

Charge un nouveau fichier.

param data : contenu du fichier.

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

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

type file_attributes : str ou ~azure.storage.fileshare.NTFSAttributes

param file_creation_time : heure de création du fichier Valeur par défaut : Maintenant.

type file_creation_time : str ou ~datetime.datetime

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

type file_last_write_time : str ou ~datetime.datetime

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

type file_permission : str

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

type permission_key : str

upload_file(data: bytes | str | Iterable | IO, length: int | None = None, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs) -> Dict[str, Any]

Paramètres

file_change_time

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

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

paramtype file_change_time : str ou ~datetime.datetime

mot clé métadonnées dict(str,str) : paires nom-valeur associées au fichier en tant que métadonnées.

mot clé ~azure.storage.fileshare.ContentSettings content_settings : objet ContentSettings utilisé pour définir les propriétés du fichier. Utilisé pour définir le type de contenu, l’encodage, la langue, la disposition, md5 et le contrôle du cache.

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

mot clé int max_concurrency : nombre maximal de connexions parallèles à utiliser.

mot clé bail : obligatoire si le fichier a un bail actif. La valeur peut être un objet ShareLeaseClient ou l’ID de bail sous forme de chaîne.

Nouveautés de la version 12.1.0.

bail paramtype : ~azure.storage.fileshare.ShareLeaseClient ou str

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

paramtype progress_hook : Callable[[int, Optional[int]], None]

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

encodage str mot clé : valeur par défaut UTF-8.

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

rtype : dict(str, Any)

Exemple : Charger un fichier.


   with open(SOURCE_FILE, "rb") as source:
       my_file.upload_file(source)

upload_range

Chargez une plage d’octets dans un fichier.

upload_range(data: bytes, offset: int, length: int, **kwargs) -> Dict[str, Any]

Paramètres

data
bytes
Obligatoire

Données à charger.

offset
int
Obligatoire

Début de la plage d’octets à utiliser pour charger une section du fichier. La plage peut atteindre 4 Mo.

length
int
Obligatoire

Nombre d’octets à utiliser pour charger une section du fichier. La taille de la plage peut atteindre 4 Mo.

validate_content
bool

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

file_last_write_mode
Literal["preserve", "now"]

Si l’heure de la dernière écriture du fichier doit être conservée ou remplacée. Les valeurs possibles sont « preserve » ou « now ». Si elle n’est pas spécifiée, l’heure de la dernière écriture du fichier est remplacée par la date/heure actuelle.

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

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.0.

timeout
int

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

encoding
str

La valeur par défaut est UTF-8.

Retours

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

Type de retour

Dict[str, Any]

upload_range_from_url

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

upload_range_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs: Any) -> Dict[str, Any]

Paramètres

offset
int
Obligatoire

Début de la plage d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo.

length
int
Obligatoire

Nombre d’octets à utiliser pour mettre à jour une section du fichier. La taille de la plage peut atteindre 4 Mo.

source_url
str
Obligatoire

URL d’une longueur maximale de 2 Ko qui spécifie un fichier ou un objet blob Azure. La valeur doit être encodée sous forme d'URL, comme dans une URI de demande. Si la source se trouve dans un autre compte, la source doit être publique ou doit être authentifiée via une signature d’accès partagé. Si la source est publique, aucune authentification n’est requise. Exemples : https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_offset
int
Obligatoire

Cela indique le début de la plage d’octets (inclus) qui doit être extraite de la source de copie. Le service lira le même nombre d’octets que la plage de destination (longueur-décalage).

source_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 conditionnel pour copier l'objet blob uniquement si l'objet blob source a été modifié depuis la date/l'heure indiquées.

source_if_unmodified_since
datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date 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 conditionnel pour copier l'objet blob uniquement si l'objet blob source n'a pas été modifié depuis la date/l'heure indiquées.

source_etag
str

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

source_match_condition
MatchConditions

Condition de correspondance source à utiliser sur l’etag.

file_last_write_mode
Literal["preserve", "now"]

Si l’heure de la dernière écriture du fichier doit être conservée ou remplacée. Les valeurs possibles sont « preserve » ou « now ». Si elle n’est pas spécifiée, l’heure de la dernière écriture du fichier est remplacée par la date/heure actuelle.

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

lease
ShareLeaseClient ou str

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

Nouveautés de la version 12.1.0.

timeout
int

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

source_authorization
str

Authentifiez-vous en tant que principal de service à l’aide d’une clé secrète client pour accéder à un objet blob source. Vérifiez que « porteur » est le préfixe de la chaîne source_authorization.

Attributs

api_version

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

location_mode

Mode d’emplacement que le client utilise actuellement.

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

primary_endpoint

URL complète du point de terminaison principal.

primary_hostname

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

secondary_endpoint

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

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

Exceptions

ValueError

secondary_hostname

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

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

url

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

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