Sdílet prostřednictvím

ShareClient Třída

  • Reference

Klient pro interakci s konkrétní sdílenou složkou, i když tato sdílená složka ještě nemusí existovat.

Pro operace související s konkrétním adresářem nebo souborem v této sdílené složce je možné klienty pro tyto entity načíst také pomocí get_directory_client funkcí a get_file_client .

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

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

Konstruktor

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)

Parametry

account_url
str
Vyžadováno

Identifikátor URI účtu úložiště Pokud chcete vytvořit klienta s úplným identifikátorem URI sdílené složky, použijte metodu from_share_url třídy .

share_name
str
Vyžadováno

Název sdílené složky, se kterou chcete pracovat.

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

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.

Metody

acquire_lease

Požádá o nové zapůjčení.

Pokud sdílená složka nemá aktivní zapůjčení, služba Sdílení vytvoří zapůjčení sdílené složky a vrátí nové zapůjčení.

Novinka ve verzi 12.5.0.
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_directory

Vytvoří adresář ve sdílené složce a vrátí klienta pro interakci s adresářem.
create_permission_for_share

Vytvořte oprávnění (popisovač zabezpečení) na úrovni sdílené složky.

Toto oprávnění lze použít pro soubory nebo adresáře ve sdílené složce. Pokud "oprávnění" již existuje, vrátí jeho klíč, v opačném případě vytvoří nové oprávnění na úrovni sdílené složky a vrátí jeho klíč.
create_share

Vytvoří novou sdílenou složku pod účtem. Pokud sdílená složka se stejným názvem již existuje, operace se nezdaří.
create_snapshot

Vytvoří snímek sdílené složky.

Snímek je verze sdílené složky jen pro čtení, která se pořídí v určitém okamžiku. Dá se číst, kopírovat nebo odstraňovat, ale ne upravovat. Snímky poskytují způsob, jak zálohovat sdílenou složku tak, jak se zobrazí v daném okamžiku.

Snímek sdílené složky má stejný název jako základní sdílená složka, ze které se snímek pořídí, s připojenou hodnotou DateTime, která označuje čas pořízení snímku.
delete_directory

Označí adresář k odstranění. Adresář se později odstraní během uvolňování paměti.
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 ShareClient z připojovacího řetězce.
from_share_url
get_directory_client

Získejte klienta pro interakci se zadaným adresářem. Adresář ještě nemusí existovat.
get_file_client

Získejte klienta pro interakci se zadaným souborem. Soubor ještě nemusí existovat.
get_permission_for_share

Získejte oprávnění (popisovač zabezpečení) pro daný klíč.

Toto oprávnění lze použít pro soubory nebo adresáře ve sdílené složce.
get_share_access_policy

Získá oprávnění pro sdílenou složku. Oprávnění označují, jestli se k souborům ve sdílené složce může přistupovat veřejně.
get_share_properties

Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadanou sdílenou složku. Vrácená data nezahrnují seznam souborů nebo adresářů sdílených složek.
get_share_stats

Získá přibližnou velikost dat uložených ve sdílené složce v bajtech.

Všimněte si, že tato hodnota nemusí zahrnovat všechny nedávno vytvořené soubory nebo soubory, které nedávno přeusily jejich velikost.
list_directories_and_files

Zobrazí seznam adresářů a souborů ve sdílené složce.
set_share_access_policy

Nastaví oprávnění pro sdílenou složku nebo uložené zásady přístupu, které se můžou používat se sdílenými přístupovými podpisy. Oprávnění označují, jestli se k souborům ve sdílené složce může přistupovat veřejně.
set_share_metadata

Nastaví metadata sdílené složky.

Každé volání této operace nahradí všechna existující metadata připojená ke sdílené složce. Pokud chcete ze sdílené složky odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.
set_share_properties

Nastaví vlastnosti sdílené složky.

Novinka ve verzi 12.4.0.
set_share_quota

Nastaví kvótu pro sdílenou složku.

acquire_lease

Požádá o nové zapůjčení.

Pokud sdílená složka nemá aktivní zapůjčení, služba Sdílení vytvoří zapůjčení sdílené složky a vrátí nové zapůjčení.

Novinka ve verzi 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Parametry

lease_duration
int

Určuje dobu zapůjčení v sekundách nebo zápornou (-1) pro zapůjčení, jehož platnost nikdy nevyprší. Nenekonečná zapůjčení může být 15 až 60 sekund. Dobu zapůjčení nelze změnit pomocí obnovení nebo změny. Výchozí hodnota je -1 (nekonečné zapůjčení).

lease_id
str

Navrhované ID zapůjčení ve formátu řetězce GUID Služba Share Service vrátí hodnotu 400 (neplatný požadavek), pokud navrhované ID zapůjčení není ve správném formátu.

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

A ShareLeaseClient objekt.

Návratový typ

ShareLeaseClient

Příklady

Získání zapůjčení sdílené složky.


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

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_directory

Vytvoří adresář ve sdílené složce a vrátí klienta pro interakci s adresářem.

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

Parametry

directory_name
str
Vyžadováno

Název adresáře.

metadata

Páry název-hodnota přidružené k adresáři jako metadata.

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

ShareDirectoryClient

Návratový typ

ShareDirectoryClient

create_permission_for_share

Vytvořte oprávnění (popisovač zabezpečení) na úrovni sdílené složky.

Toto oprávnění lze použít pro soubory nebo adresáře ve sdílené složce. Pokud "oprávnění" již existuje, vrátí jeho klíč, v opačném případě vytvoří nové oprávnění na úrovni sdílené složky a vrátí jeho klíč.

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

Parametry

file_permission
str
Vyžadováno

Oprávnění k souborům, portable SDDL

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

Klíč oprávnění k souboru

Návratový typ

str

create_share

Vytvoří novou sdílenou složku pod účtem. Pokud sdílená složka se stejným názvem již existuje, operace se nezdaří.

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

Parametry

metadata
dict(str,str)

Páry název-hodnota přidružené ke sdílené složce jako metadata.

quota
int

Kvóta, která má být přidělena.

access_tier

Určuje úroveň přístupu sdílené složky. Možné hodnoty: TransactionOptimized, Hot, Cool

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.

protocols
str nebo ShareProtocols

Protokoly, které se mají povolit pro sdílenou složku. Pro sdílenou složku je možné povolit pouze jeden protokol.

root_squash
str nebo ShareRootSquash

Root squash nastavit na sdílenou složku. Platí jenom pro sdílené složky NFS. Mezi možné hodnoty patří: NoRootSquash, RootSquash, AllSquash.

Návraty

Sdílení aktualizovaného diktu vlastnosti (značka Etag a poslední změna)

Návratový typ

Dict[str, Any]

Příklady

Vytvoří sdílenou složku.


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

create_snapshot

Vytvoří snímek sdílené složky.

Snímek je verze sdílené složky jen pro čtení, která se pořídí v určitém okamžiku. Dá se číst, kopírovat nebo odstraňovat, ale ne upravovat. Snímky poskytují způsob, jak zálohovat sdílenou složku tak, jak se zobrazí v daném okamžiku.

Snímek sdílené složky má stejný název jako základní sdílená složka, ze které se snímek pořídí, s připojenou hodnotou DateTime, která označuje čas pořízení snímku.

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

Parametry

metadata
dict(str,str)

Páry název-hodnota přidružené ke sdílené složce jako metadata.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Dikt vlastnosti aktualizace sdílené složky (ID snímku, značka Etag a poslední změna)

Návratový typ

dict[str, Any]

Příklady

Vytvoří snímek sdílené složky.


   share.create_snapshot()

delete_directory

Označí adresář k odstranění. Adresář se později odstraní během uvolňování paměti.

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

Parametry

directory_name
str
Vyžadováno

Název adresáře.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

None

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(delete_snapshots: bool | None = False, **kwargs) -> None

Parametry

delete_snapshots
bool
Vyžadováno

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

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Příklady

Odstraní sdílenou složku a všechny snímky.


   share.delete_share(delete_snapshots=True)

from_connection_string

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

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

Parametry

conn_str
str
Vyžadováno

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

share_name
str
Vyžadováno

Název sdílené složky.

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

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 obsahuje. 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 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 sdílené složky.

Návratový typ

ShareClient

Příklady

Získá klienta sdílené složky z připojovacího řetězce.


   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

Parametry

share_url
str
Vyžadováno

Úplný identifikátor URI sdílené složky.

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

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 obsahuje. 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 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 sdílené složky.

Návratový typ

ShareClient

get_directory_client

Získejte klienta pro interakci se zadaným adresářem. Adresář ještě nemusí existovat.

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

Parametry

directory_path
str
výchozí hodnota: None

Cesta k zadanému adresáři

Návraty

Klient adresáře.

Návratový typ

ShareDirectoryClient

get_file_client

Získejte klienta pro interakci se zadaným souborem. Soubor ještě nemusí existovat.

get_file_client(file_path: str) -> ShareFileClient

Parametry

file_path
str
Vyžadováno

Cesta k zadanému souboru

Návraty

Souborový klient.

Návratový typ

ShareFileClient

get_permission_for_share

Získejte oprávnění (popisovač zabezpečení) pro daný klíč.

Toto oprávnění lze použít pro soubory nebo adresáře ve sdílené složce.

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

Parametry

permission_key
str
Vyžadováno

Klíč oprávnění k souboru, který se má načíst

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Oprávnění k souboru (přenosný SDDL)

Návratový typ

str

get_share_access_policy

Získá oprávnění pro sdílenou složku. Oprávnění označují, jestli se k souborům ve sdílené složce může přistupovat veřejně.

get_share_access_policy(**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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

Návraty

Přístup k informacím o zásadách v diktování

Návratový typ

dict[str, Any]

get_share_properties

Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadanou sdílenou složku. Vrácená data nezahrnují seznam souborů nebo adresářů sdílených složek.

get_share_properties(**kwargs: Any) -> ShareProperties

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

Návraty

Vlastnosti sdílené složky.

Návratový typ

ShareProperties

Příklady

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


   properties = share.get_share_properties()

get_share_stats

Získá přibližnou velikost dat uložených ve sdílené složce v bajtech.

Všimněte si, že tato hodnota nemusí zahrnovat všechny nedávno vytvořené soubory nebo soubory, které nedávno přeusily jejich velikost.

get_share_stats(**kwargs: Any) -> int

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

Návraty

Přibližná velikost dat (v bajtech) uložených ve sdílené složce

Návratový typ

int

list_directories_and_files

Zobrazí seznam adresářů a souborů ve sdílené složce.

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

Parametry

directory_name
str
Vyžadováno

Název adresáře.

name_starts_with
str
Vyžadováno

Filtruje výsledky tak, aby vrátily pouze adresáře, jejichž názvy začínají zadanou předponou.

marker
str
Vyžadováno

Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru. Pokud je zadán, tento generátor začne vracet výsledky od tohoto okamžiku.

include
list[str]

Zahrnutím tohoto parametru určíte jednu nebo více datových sad, které se mají zahrnout do odpovědi. Možné hodnoty str jsou "timestamps", "Etag", "Attributes", "PermissionKey".

Novinka ve verzi 12.6.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API z 2020-10-02.

include_extended_info
bool

Pokud je nastavená hodnota true, vrátí se v seznamu výsledků ID souboru.

Novinka ve verzi 12.6.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API z 2020-10-02.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Automatické stránkování umožňující dict-like DirectoryProperties a FileProperties

Návratový typ

Iterable[Dict[str,str]]

Příklady

Zobrazí seznam adresářů a souborů ve sdílené složce.


   # 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

Nastaví oprávnění pro sdílenou složku nebo uložené zásady přístupu, které se můžou používat se sdílenými přístupovými podpisy. Oprávnění označují, jestli se k souborům ve sdílené složce může přistupovat veřejně.

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

Parametry

signed_identifiers
dict(str, AccessPolicy)
Vyžadováno

Slovník zásad přístupu, který se má přidružit ke sdílené složce. Slovník může obsahovat až 5 prvků. Prázdný slovník vymaže zásady přístupu nastavené pro službu.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

Návraty

Dikt vlastnosti aktualizace sdílené složky (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

set_share_metadata

Nastaví metadata sdílené složky.

Každé volání této operace nahradí všechna existující metadata připojená ke sdílené složce. Pokud chcete ze sdílené složky odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.

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

Parametry

metadata
dict(str, str)
Vyžadováno

Dvojice název-hodnota přidružené ke sdílené složce jako metadata.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

Návraty

Dikt vlastnosti aktualizace sdílené složky (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Příklady

Nastaví metadata sdílené složky.


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

set_share_properties

Nastaví vlastnosti sdílené složky.

Novinka ve verzi 12.4.0.

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

Parametry

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

Určuje úroveň přístupu sdílené složky. Možné hodnoty: TransactionOptimized, Hot a Cool

quota
int

Určuje maximální velikost sdílené složky v gigabajtech. Musí být větší než 0 a menší nebo roven 5 TB.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

root_squash
str nebo ShareRootSquash

Root squash nastavit na sdílenou složku. Platí jenom pro sdílené složky NFS. Mezi možné hodnoty patří: 'NoRootSquash', 'RootSquash', 'AllSquash'.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Návraty

Dikt vlastnosti aktualizace sdílené složky (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Příklady

Nastaví vlastnosti sdílené složky.


   # 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

Nastaví kvótu pro sdílenou složku.

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

Parametry

quota
int
Vyžadováno

Určuje maximální velikost sdílené složky v gigabajtech. Musí být větší než 0 a menší nebo roven 5 TB.

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 se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

lease

Vyžaduje se, pokud má sdílená složka aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.5.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2020-08-04.

Návraty

Dikt vlastnosti aktualizace sdílené složky (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Příklady

Nastaví kvótu sdílených složek.


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

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