ShareServiceClient Třída

  • Reference

Klient pro interakci se službou sdílení souborů na úrovni účtu.

Tento klient poskytuje operace pro načtení a konfiguraci vlastností účtu a také výpis, vytvoření a odstranění sdílených složek v rámci účtu. U operací souvisejících s konkrétní sdílenou složkou je možné pomocí funkce načíst také klienta pro danou entitu get_share_client .

Další volitelnou konfiguraci potřebujete kliknutím sem.

Dědičnost
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareServiceClient

Konstruktor

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

Parametry

account_url
str
Vyžadováno

Adresa URL účtu úložiště sdílené složky. Všechny ostatní entity zahrnuté v cestě URL (např. sdílená složka nebo soubor) budou zahozeny. Tuto adresu URL je možné volitelně ověřit pomocí tokenu SAS.

credential
výchozí hodnota: None

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už token SAS má. Hodnotou může být řetězec tokenu SAS, instance AzureSasCredential nebo AzureNamedKeyCredential z azure.core.credentials, sdílený přístupový klíč účtu nebo instance třídy TokenCredentials z azure.identity. Pokud identifikátor URI prostředku už obsahuje token SAS, bude se tento token ignorovat ve prospěch explicitních přihlašovacích údajů.

  • s výjimkou případu AzureSasCredential, kde konfliktní tokeny SAS způsobí chybu ValueError. Pokud používáte instanci AzureNamedKeyCredential, název by měl být název účtu úložiště a klíč by měl být klíč účtu úložiště.
token_intent
Literal['backup']

Požadováno při použití TokenCredential pro ověřování a ignorováno pro jiné formy ověřování. Určuje záměr pro všechny požadavky při použití ověřování TokenCredential . Možné hodnoty:

zálohování – Určuje, že požadavky jsou určené pro operace typu zálohování nebo správce, což znamená, že všechny seznamy ACL souborů a adresářů se obcházejí a udělují se úplná oprávnění. Uživatel musí mít také požadované oprávnění RBAC.

allow_trailing_dot
bool

Pokud je hodnota true, koncová tečka se z cílového identifikátoru URI neořízne.

allow_source_trailing_dot
bool

Pokud je hodnota true, koncová tečka se ze zdrojového identifikátoru URI neořízne.

api_version
str

Verze rozhraní API služby Storage, která se má použít pro požadavky. Výchozí hodnota je nejnovější verze služby, která je kompatibilní s aktuální sadou SDK. Nastavení na starší verzi může mít za následek snížení kompatibility funkcí.

Novinka ve verzi 12.1.0.

secondary_hostname
str

Název hostitele sekundárního koncového bodu.

max_range_size
int

Maximální velikost rozsahu použitá pro nahrání souboru. Výchozí hodnota je 4*1024*1024.

Příklady

Vytvořte klienta služby sdílení s adresou URL a přihlašovacími údaji.


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

Metody

close

Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.
create_share

Vytvoří novou sdílenou složku pod zadaným účtem. Pokud sdílená složka se stejným názvem již existuje, operace se nezdaří. Vrátí klienta, se kterým chcete pracovat s nově vytvořenou sdílenou složkou.
delete_share

Označí zadanou sdílenou složku k odstranění. Sdílená složka se později odstraní během uvolňování paměti.
from_connection_string

Vytvořte ShareServiceClient z připojovacího řetězce.
get_service_properties

Získá vlastnosti služby sdílené složky účtu úložiště, včetně Azure Analýza úložiště.
get_share_client

Získejte klienta k interakci se zadanou sdílenou složkou. Sdílená složka ještě nemusí existovat.
list_shares

Vrátí možnost automatického stránkování shareproperties podobného diktování pod zadaným účtem. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny sdílené složky.
set_service_properties

Nastaví vlastnosti služby sdílené složky účtu úložiště, včetně Azure Analýza úložiště. Pokud je prvek (např. hour_metrics) ponechán jako Žádný, stávající nastavení služby pro danou funkci se zachovají.
undelete_share

Obnoví obnovitelně odstraněnou sdílenou složku.

Operace bude úspěšná pouze v případě, že se použije v zadaném počtu dnů nastaveném v zásadách uchovávání informací o odstranění.

Novinka ve verzi 12.2.0: Tato operace byla zavedena ve verzi rozhraní API 2019-12-12.

close

Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.

close()

create_share

Vytvoří novou sdílenou složku pod zadaným účtem. Pokud sdílená složka se stejným názvem již existuje, operace se nezdaří. Vrátí klienta, se kterým chcete pracovat s nově vytvořenou sdílenou složkou.

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

Parametry

share_name
str
Vyžadováno

Název sdílené složky, která se má vytvořit.

metadata
dict(str,str)

Dikt s name_value páry, které se přidruží ke sdílené složce jako metadata. Příklad:{'Category':'test'}

quota
int

Kvóta v bajtech.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

ShareClient pro nově vytvořenou sdílenou složku.

Návratový typ

ShareClient

Příklady

Vytvořte sdílenou složku ve službě sdílené složky.


   file_service.create_share(share_name="fileshare1")

delete_share

Označí zadanou sdílenou složku k odstranění. Sdílená složka se později odstraní během uvolňování paměti.

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

Parametry

share_name
str nebo ShareProperties
Vyžadováno

Sdílená složka, která se má odstranit. Může to být buď název sdílené složky, nebo instance ShareVlastnosti.

delete_snapshots
bool
Vyžadováno

Označuje, jestli mají být snímky odstraněny.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

None

Příklady

Odstraňte sdílenou složku ve službě sdílených složek.


   file_service.delete_share(share_name="fileshare1")

from_connection_string

Vytvořte ShareServiceClient z připojovacího řetězce.

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

Parametry

conn_str
str
Vyžadováno

Připojovací řetězec k účtu služby Azure Storage.

credential
výchozí hodnota: None

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už token SAS má. Hodnotou může být řetězec tokenu SAS, instance AzureSasCredential nebo AzureNamedKeyCredential z azure.core.credentials, sdílený přístupový klíč účtu nebo instance třídy TokenCredentials z azure.identity. Pokud identifikátor URI prostředku už obsahuje token SAS, bude se tento token ignorovat ve prospěch explicitních přihlašovacích údajů.

  • s výjimkou případu AzureSasCredential, kde konfliktní tokeny SAS způsobí chybu ValueError. Pokud používáte instanci AzureNamedKeyCredential, název by měl být název účtu úložiště a klíč by měl být klíč účtu úložiště.

Návraty

Klient služby sdílené složky.

Návratový typ

ShareServiceClient

Příklady

Vytvořte klienta služby sdílení s připojovacím řetězcem.


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

get_service_properties

Získá vlastnosti služby sdílené složky účtu úložiště, včetně Azure Analýza úložiště.

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

Parametry

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Slovník obsahující vlastnosti souborové služby, jako je protokolování analýz, metriky hodin a minut, pravidla cors atd.

Návratový typ

Dict[str, Any]

Příklady

Získejte vlastnosti služby sdílených složek.


   properties = file_service.get_service_properties()

get_share_client

Získejte klienta k interakci se zadanou sdílenou složkou. Sdílená složka ještě nemusí existovat.

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

Parametry

share
str nebo ShareProperties
Vyžadováno

Sdílená složka. Může to být buď název sdílené složky, nebo instance ShareVlastnosti.

snapshot
str
výchozí hodnota: None

Volitelný snímek sdílené složky, na kterém se má pracovat. Může to být řetězec ID snímku nebo odpověď vrácená z <xref:azure.storage.fileshare.create_snapshot>.

Návraty

A ShareClient.

Návratový typ

ShareClient

Příklady

Získá klienta sdílené složky.


   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

Vrátí možnost automatického stránkování shareproperties podobného diktování pod zadaným účtem. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny sdílené složky.

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

Parametry

name_starts_with
str
Vyžadováno

Filtruje výsledky tak, aby vracely pouze sdílené složky, jejichž názvy začínají zadaným name_starts_with.

include_metadata
bool
Vyžadováno

Určuje, že se v odpovědi vrátí metadata sdílené složky.

include_snapshots
bool
Vyžadováno

Určuje, že se v odpovědi vrátí snímek sdílené složky.

include_deleted
bool

Určuje, že se v odpovědi vrátí odstraněné sdílené složky. To se týká jenom sdílení účtu s povoleným obnovitelném odstraněním.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Iterable (automatické stránkování) ShareProperties.

Návratový typ

ItemPaged[ShareProperties]

Příklady

Seznam sdílených složek ve službě sdílených složek


   # 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

Nastaví vlastnosti služby sdílené složky účtu úložiště, včetně Azure Analýza úložiště. Pokud je prvek (např. hour_metrics) ponechán jako Žádný, stávající nastavení služby pro danou funkci se zachovají.

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

Parametry

hour_metrics
Metrics
Vyžadováno

Nastavení hodinové metriky poskytuje souhrn statistik žádostí seskupených podle rozhraní API v agregovaných po hodinách pro soubory.

minute_metrics
Metrics
Vyžadováno

Nastavení minutových metrik poskytuje statistiky žádostí o každou minutu pro soubory.

cors
list(CorsRule)
Vyžadováno

Do seznamu můžete zahrnout až pět prvků CorsRule. Pokud je zadaný prázdný seznam, odstraní se všechna pravidla CORS a cors se pro službu zakáže.

protocol
ShareProtocolSettings
Vyžadováno

Nastaví protokol.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

None

Příklady

Nastaví vlastnosti služby sdílené složky.


   # 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

Obnoví obnovitelně odstraněnou sdílenou složku.

Operace bude úspěšná pouze v případě, že se použije v zadaném počtu dnů nastaveném v zásadách uchovávání informací o odstranění.

Novinka ve verzi 12.2.0: Tato operace byla zavedena ve verzi rozhraní API 2019-12-12.

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

Parametry

deleted_share_name
str
Vyžadováno

Určuje název odstraněné sdílené složky, která se má obnovit.

deleted_share_version
str
Vyžadováno

Určuje verzi odstraněné sdílené složky, která se má obnovit.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

ShareClient pro nesdílenou sdílenou složku.

Návratový typ

ShareClient

Atributy

api_version

Verze rozhraní API služby Storage, která se používá pro požadavky.

location_mode

Režim umístění, který klient aktuálně používá.

Ve výchozím nastavení to bude "primární". Mezi možnosti patří "primární" a "sekundární".

primary_endpoint

Úplná adresa URL primárního koncového bodu.

primary_hostname

Název hostitele primárního koncového bodu.

secondary_endpoint

Úplná adresa URL sekundárního koncového bodu, pokud je nakonfigurovaná.

Pokud není k dispozici, bude vyvolána chyba ValueError. Pokud chcete explicitně zadat název sekundárního hostitele, použijte volitelný argument secondary_hostname klíčového slova pro vytvoření instance.

Výjimky

ValueError

secondary_hostname

Název hostitele sekundárního koncového bodu.

Pokud není k dispozici, bude to Žádný. Pokud chcete explicitně zadat název sekundárního hostitele, použijte volitelný argument secondary_hostname klíčového slova pro vytvoření instance.

url

Úplná adresa URL koncového bodu pro tuto entitu, včetně tokenu SAS, pokud je použit.

To může být primární koncový bod nebo sekundární koncový bod v závislosti na aktuálním location_mode. :returns: Úplná adresa URL koncového bodu pro tuto entitu, včetně tokenu SAS, pokud je použit. :rtype: str