Partager via

ShareServiceClient Classe

  • Référence

Client pour interagir avec le service de partage de fichiers au niveau du compte.

Ce client fournit des opérations pour récupérer et configurer les propriétés du compte, ainsi que pour répertorier, créer et supprimer des partages dans le compte. Pour les opérations relatives à un partage spécifique, un client pour cette entité peut également être récupéré à l’aide de la get_share_client fonction .

Pour une configuration plus facultative, cliquez ici.

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

Constructeur

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

Paramètres

account_url
str
Obligatoire

URL du compte de stockage de partage de fichiers. Toutes les autres entités incluses dans le chemin d’URL (par exemple, partage ou fichier) sont ignorées. Cette URL peut éventuellement être authentifiée avec un jeton SAS.

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.

Exemples

Créez le client de service de partage avec l’URL et les informations d’identification.


   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient(
       account_url=self.account_url,
       credential=self.access_key
   )

Méthodes

close

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

Crée un partage sous le compte spécifié. Si un partage portant le même nom existe déjà, l'opération échoue. Retourne un client avec lequel interagir avec le partage nouvellement créé.
delete_share

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

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

Obtient les propriétés du service de partage de fichiers d’un compte de stockage, y compris Azure Storage Analytics.
get_share_client

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

Retourne la pagination automatique itérable de ShareProperties de type dicté sous le compte spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les partages ont été retournés.
set_service_properties

Définit les propriétés du service de partage de fichiers d’un compte de stockage, y compris Azure Storage Analytics. Si un élément (par exemple, hour_metrics) reste aucun, les paramètres existants sur le service pour cette fonctionnalité sont conservés.
undelete_share

Restaure le partage supprimé de manière réversible.

L’opération ne réussit que si elle est utilisée dans le nombre de jours spécifié défini dans la stratégie de rétention de suppression.

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

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_share

Crée un partage sous le compte spécifié. Si un partage portant le même nom existe déjà, l'opération échoue. Retourne un client avec lequel interagir avec le partage nouvellement créé.

create_share(share_name: str, **kwargs) -> ShareClient

Paramètres

share_name
str
Obligatoire

Nom du partage à créer.

metadata
dict(str,str)

Un dict avec name_value paires à associer au partage en tant que métadonnées. Exemple :{'Category':'test'}

quota
int

Quota en octets.

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

ShareClient pour le partage nouvellement créé.

Type de retour

ShareClient

Exemples

Créez un partage dans le service de partage de fichiers.


   file_service.create_share(share_name="fileshare1")

delete_share

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

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

Paramètres

share_name
str ou ShareProperties
Obligatoire

Partage à supprimer. Il peut s’agir du nom du partage ou d’un instance de ShareProperties.

delete_snapshots
bool
Obligatoire

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

timeout
int

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

Type de retour

None

Exemples

Supprimez un partage dans le service de partage de fichiers.


   file_service.delete_share(share_name="fileshare1")

from_connection_string

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

from_connection_string(conn_str: 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.

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 du service de partage de fichiers.

Type de retour

ShareServiceClient

Exemples

Créez le client de service de partage avec la chaîne de connexion.


   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient.from_connection_string(self.connection_string)

get_service_properties

Obtient les propriétés du service de partage de fichiers d’un compte de stockage, y compris Azure Storage Analytics.

get_service_properties(**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.

Retours

Dictionnaire contenant des propriétés de service de fichiers telles que la journalisation analytique, les métriques d’heure/minute, les règles cors, etc.

Type de retour

Dict[str, Any]

Exemples

Obtenir les propriétés du service de partage de fichiers.


   properties = file_service.get_service_properties()

get_share_client

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

get_share_client(share: ShareProperties | str, snapshot: Dict[str, Any] | str | None = None) -> ShareClient

Paramètres

share
str ou ShareProperties
Obligatoire

Partage. Il peut s’agir du nom du partage ou d’un instance de ShareProperties.

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 <xref:azure.storage.fileshare.create_snapshot>.

Retours

A ShareClient.

Type de retour

ShareClient

Exemples

Obtient le client de partage.


   from azure.storage.fileshare import ShareServiceClient
   file_service = ShareServiceClient.from_connection_string(self.connection_string)

   # Get a share client to interact with a specific share
   share = file_service.get_share_client("fileshare2")

list_shares

Retourne la pagination automatique itérable de ShareProperties de type dicté sous le compte spécifié. Le générateur suit paresseusement les jetons de continuation retournés par le service et s’arrête lorsque tous les partages ont été retournés.

list_shares(name_starts_with: str | None = None, include_metadata: bool | None = False, include_snapshots: bool | None = False, **kwargs) -> ItemPaged[ShareProperties]

Paramètres

name_starts_with
str
Obligatoire

Filtre les résultats pour renvoyer uniquement les partages dont le nom commence par le name_starts_with spécifié.

include_metadata
bool
Obligatoire

Spécifie que les métadonnées de partage doivent être retournées dans la réponse.

include_snapshots
bool
Obligatoire

Spécifie que le partage instantané être retourné dans la réponse.

include_deleted
bool

Spécifie que les partages supprimés doivent être retournés dans la réponse. Il s’agit uniquement du compte de partage activé pour la suppression réversible.

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 (pagination automatique) de ShareProperties.

Type de retour

ItemPaged[ShareProperties]

Exemples

Répertorier les partages dans le service de partage de fichiers.


   # List the shares in the file service
   my_shares = list(file_service.list_shares())

   # Print the shares
   for share in my_shares:
       print(share)

set_service_properties

Définit les propriétés du service de partage de fichiers d’un compte de stockage, y compris Azure Storage Analytics. Si un élément (par exemple, hour_metrics) reste aucun, les paramètres existants sur le service pour cette fonctionnalité sont conservés.

set_service_properties(hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, protocol: ShareProtocolSettings | None = None, **kwargs) -> None

Paramètres

hour_metrics
Metrics
Obligatoire

Les paramètres de métriques d’heure fournissent un résumé des statistiques de requête regroupées par API dans des agrégats horaires pour les fichiers.

minute_metrics
Metrics
Obligatoire

Les paramètres de métriques de minute fournissent des statistiques de requête pour chaque minute pour les fichiers.

cors
list(CorsRule)
Obligatoire

Vous pouvez inclure jusqu’à cinq éléments CorsRule dans la liste. Si une liste vide est spécifiée, toutes les règles CORS sont supprimées et CORS est désactivé pour le service.

protocol
ShareProtocolSettings
Obligatoire

Définit les paramètres de protocole

timeout
int

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

Type de retour

None

Exemples

Définit les propriétés du service de partage de fichiers.


   # Create service properties
   from azure.storage.fileshare import Metrics, CorsRule, RetentionPolicy

   # Create metrics for requests statistics
   hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
   minute_metrics = Metrics(enabled=True, include_apis=True,
                            retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create CORS rules
   cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
   allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
   allowed_methods = ['GET', 'PUT']
   max_age_in_seconds = 500
   exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
   allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
   cors_rule2 = CorsRule(
       allowed_origins,
       allowed_methods,
       max_age_in_seconds=max_age_in_seconds,
       exposed_headers=exposed_headers,
       allowed_headers=allowed_headers)

   cors = [cors_rule1, cors_rule2]

   # Set the service properties
   file_service.set_service_properties(hour_metrics, minute_metrics, cors)

undelete_share

Restaure le partage supprimé de manière réversible.

L’opération ne réussit que si elle est utilisée dans le nombre de jours spécifié défini dans la stratégie de rétention de suppression.

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

undelete_share(deleted_share_name: str, deleted_share_version: str, **kwargs: Any) -> ShareClient

Paramètres

deleted_share_name
str
Obligatoire

Spécifie le nom du partage supprimé à restaurer.

deleted_share_version
str
Obligatoire

Spécifie la version du partage supprimé à restaurer.

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

ShareClient pour le partage non supprimé.

Type de retour

ShareClient

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