Partager via

ShareClient Classe

  • Référence

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

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

Pour une configuration plus facultative, cliquez ici.

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

Constructeur

ShareClient(account_url: str, share_name: 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 partage, utilisez la from_share_url méthode de classe.

share_name
str
Obligatoire

Nom du partage avec lequel interagir.

snapshot
str
valeur par défaut: None

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

credential
valeur par défaut: None

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

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

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

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

allow_trailing_dot
bool

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

allow_source_trailing_dot
bool

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

api_version
str

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

Nouveautés de la version 12.1.0.

secondary_hostname
str

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

max_range_size
int

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

Méthodes

acquire_lease

Demande un nouveau bail.

Si le partage n’a pas de bail actif, le service de partage crée un bail sur le partage et retourne un nouveau bail.

Nouveautés de la version 12.5.0.
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.
create_directory

Crée un répertoire dans le partage et retourne un client pour interagir avec le répertoire.
create_permission_for_share

Créez une autorisation (un descripteur de sécurité) au niveau du partage.

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

Crée un partage sous le compte. Si un partage portant le même nom existe déjà, l’opération échoue.
create_snapshot

Crée une instantané du partage.

Une instantané est une version en lecture seule d’un partage qui est prise à un moment donné. Il peut être lu, copié ou supprimé, mais pas modifié. Les instantanés permettent de sauvegarder un partage tel qu’il apparaît à un moment donné.

Une instantané d’un partage a le même nom que le partage de base à partir duquel le instantané est extrait, avec une valeur DateTime ajoutée pour indiquer l’heure à laquelle la instantané a été prise.
delete_directory

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

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

Créez ShareClient à partir d’une chaîne de connexion.
from_share_url
get_directory_client

Obtenir un client pour interagir avec le répertoire spécifié. Le répertoire n’a pas besoin d’exister.
get_file_client

Obtenir un client pour interagir avec le fichier spécifié. Le fichier n’a pas besoin d’exister.
get_permission_for_share

Obtenez une autorisation (un descripteur de sécurité) pour une clé donnée.

Cette « autorisation » peut être utilisée pour les fichiers/répertoires dans le partage.
get_share_access_policy

Obtient les autorisations pour le partage. Les autorisations indiquent si les fichiers d’un partage peuvent être accessibles publiquement.
get_share_properties

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

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

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

Répertorie les répertoires et les fichiers sous le partage.
set_share_access_policy

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

Définit les métadonnées du partage.

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

Définit les propriétés du partage.

Nouveautés de la version 12.4.0.
set_share_quota

Définit le quota pour le partage.

acquire_lease

Demande un nouveau bail.

Si le partage n’a pas de bail actif, le service de partage crée un bail sur le partage et retourne un nouveau bail.

Nouveautés de la version 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Paramètres

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. La valeur par défaut est -1 (bail infini).

lease_id
str

ID de bail proposé, dans un format de chaîne GUID. Le service de partage 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 une action.


   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

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

create_directory

Crée un répertoire dans le partage et retourne un client pour interagir avec le répertoire.

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

Paramètres

directory_name
str
Obligatoire

Nom du répertoire.

metadata

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

timeout
int

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

Retours

ShareDirectoryClient

Type de retour

ShareDirectoryClient

create_permission_for_share

Créez une autorisation (un descripteur de sécurité) au niveau du partage.

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

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

Paramètres

file_permission
str
Obligatoire

Autorisation de fichier, un SDDL portable

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

Clé d’autorisation de fichier

Type de retour

str

create_share

Crée un partage sous le compte. Si un partage portant le même nom existe déjà, l’opération échoue.

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

Paramètres

metadata
dict(str,str)

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

quota
int

Quota à allouer.

access_tier

Spécifie le niveau d’accès du partage. Valeurs possibles : 'TransactionOptimized', 'Hot', 'Cool'

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.

protocols
str ou ShareProtocols

Protocoles à activer sur le partage. Un seul protocole peut être activé sur le partage.

root_squash
str ou ShareRootSquash

Racine squashing à définir sur le partage. Valide uniquement pour les partages NFS. Les valeurs possibles sont les suivantes : « NoRootSquash », « RootSquash », « AllSquash ».

Retours

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

Type de retour

Dict[str, Any]

Exemples

Crée un partage de fichiers.


   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

create_snapshot

Crée une instantané du partage.

Une instantané est une version en lecture seule d’un partage qui est prise à un moment donné. Il peut être lu, copié ou supprimé, mais pas modifié. Les instantanés permettent de sauvegarder un partage tel qu’il apparaît à un moment donné.

Une instantané d’un partage a le même nom que le partage de base à partir duquel le instantané est extrait, avec une valeur DateTime ajoutée pour indiquer l’heure à laquelle la instantané a été prise.

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

Paramètres

metadata
dict(str,str)

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

timeout
int

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

Retours

Dict de propriété mise à jour par partage (ID d’instantané, Etag et dernière modification).

Type de retour

dict[str, Any]

Exemples

Crée une instantané du partage de fichiers.


   share.create_snapshot()

delete_directory

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

delete_directory(directory_name: str, **kwargs: Any) -> None

Paramètres

directory_name
str
Obligatoire

Nom du répertoire.

timeout
int

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

Type de retour

None

delete_share

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

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

Paramètres

delete_snapshots
bool
Obligatoire

Indique si les instantanés doivent être supprimés.

lease

Obligatoire si le partage 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.5.0.

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

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.

Exemples

Supprime le partage et tous les instantanés.


   share.delete_share(delete_snapshots=True)

from_connection_string

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

from_connection_string(conn_str: str, share_name: 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

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

share_name
str
Obligatoire

Nom du partage.

snapshot
str
valeur par défaut: None

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

credential
valeur par défaut: None

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

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

Retours

Un client de partage.

Type de retour

ShareClient

Exemples

Obtient le client de partage à partir de la chaîne de connexion.


   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

from_share_url 

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

Paramètres

share_url
str
Obligatoire

URI complet du partage.

snapshot
str
valeur par défaut: None

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

credential
valeur par défaut: None

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

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

Retours

Un client de partage.

Type de retour

ShareClient

get_directory_client

Obtenir un client pour interagir avec le répertoire spécifié. Le répertoire n’a pas besoin d’exister.

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

Paramètres

directory_path
str
valeur par défaut: None

Chemin d’accès au répertoire spécifié.

Retours

Un client d’annuaire.

Type de retour

ShareDirectoryClient

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_path: str) -> ShareFileClient

Paramètres

file_path
str
Obligatoire

Chemin d’accès au fichier spécifié.

Retours

Un client de fichiers.

Type de retour

ShareFileClient

get_permission_for_share

Obtenez une autorisation (un descripteur de sécurité) pour une clé donnée.

Cette « autorisation » peut être utilisée pour les fichiers/répertoires dans le partage.

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

Paramètres

permission_key
str
Obligatoire

Clé de l’autorisation de fichier à récupérer

timeout
int

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

Retours

Une autorisation de fichier (un SDDL portable)

Type de retour

str

get_share_access_policy

Obtient les autorisations pour le partage. Les autorisations indiquent si les fichiers d’un partage peuvent être accessibles publiquement.

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

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.

lease

Obligatoire si le partage 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.5.0.

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

Retours

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

Type de retour

dict[str, Any]

get_share_properties

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

get_share_properties(**kwargs: Any) -> ShareProperties

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.

lease

Obligatoire si le partage 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.5.0.

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

Retours

Propriétés de partage.

Type de retour

ShareProperties

Exemples

Obtient les propriétés du partage.


   properties = share.get_share_properties()

get_share_stats

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

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

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

lease

Obligatoire si le partage 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.5.0.

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

Retours

Taille approximative des données (en octets) stockées sur le partage.

Type de retour

int

list_directories_and_files

Répertorie les répertoires et les fichiers sous le partage.

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

Paramètres

directory_name
str
Obligatoire

Nom d’un répertoire.

name_starts_with
str
Obligatoire

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

marker
str
Obligatoire

Jeton de continuation opaque. Cette valeur peut être récupérée à partir du champ next_marker d’un objet générateur précédent. S’il est spécifié, ce générateur commence à retourner les résultats à partir de ce point.

include
list[str]

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

Nouveautés de la version 12.6.0.

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

include_extended_info
bool

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

Nouveautés de la version 12.6.0.

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

timeout
int

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

Retours

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

Type de retour

Iterable[Dict[str,str]]

Exemples

Répertoriez les répertoires et les fichiers dans le partage.


   # Create a directory in the share
   dir_client = share.create_directory("mydir")

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

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

set_share_access_policy

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

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

Paramètres

signed_identifiers
dict(str, AccessPolicy)
Obligatoire

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

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.

lease

Obligatoire si le partage 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.5.0.

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

Retours

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

Type de retour

dict(str, Any)

set_share_metadata

Définit les métadonnées du partage.

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

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

Paramètres

metadata
dict(str, str)
Obligatoire

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

timeout
int

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

lease

Obligatoire si le partage 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.5.0.

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

Retours

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

Type de retour

dict(str, Any)

Exemples

Définit les métadonnées de partage.


   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

set_share_properties

Définit les propriétés du partage.

Nouveautés de la version 12.4.0.

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

Paramètres

access_tier
str ou <xref:azure.storage.fileshare.models.ShareAccessTier>

Spécifie le niveau d’accès du partage. Valeurs possibles : « TransactionOptimized », « Hot » et « Cool »

quota
int

Spécifie la taille maximale du partage en gigaoctets. Doit être supérieur à 0 et inférieur ou égal à 5 To.

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.

root_squash
str ou ShareRootSquash

Racine squashing à définir sur le partage. Valide uniquement pour les partages NFS. Les valeurs possibles sont les suivantes : « NoRootSquash », « RootSquash », « AllSquash ».

lease

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

Retours

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

Type de retour

dict(str, Any)

Exemples

Définit les propriétés du partage.


   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

set_share_quota

Définit le quota pour le partage.

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

Paramètres

quota
int
Obligatoire

Spécifie la taille maximale du partage en gigaoctets. Doit être supérieur à 0 et inférieur ou égal à 5 To.

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.

lease

Obligatoire si le partage 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.5.0.

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

Retours

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

Type de retour

dict(str, Any)

Exemples

Définit le quota de partage.


   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

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