ShareFileClient Třída

Reference

Klient pro interakci s konkrétním souborem, i když tento soubor ještě nemusí existovat.

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

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

ShareFileClient

Konstruktor

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

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 souboru, použijte metodu from_file_url třídy.

share_name: str

Vyžadováno

Název sdílené složky souboru.

file_path: str

Vyžadováno

Cesta k souboru, se kterým chcete pracovat. Pokud je tato hodnota zadána, přepíše hodnotu souboru zadanou v adrese URL souboru.

snapshot: str

výchozí hodnota: None

Volitelný snímek souboru, se 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.

audience: str

Cílová skupina, která se má použít při žádosti o tokeny pro ověřování Azure Active Directory. Má vliv pouze v případě, že jsou přihlašovací údaje typu TokenCredential. Hodnota může být https://storage.azure.com/ (výchozí) nebo https://.file.core.windows.net.

Metody

abort_copy	Přerušení probíhající operace kopírování Cílový soubor tak zůstane s nulovou délkou a úplnými metadaty. Pokud už operace kopírování skončila, dojde k chybě.
acquire_lease	Požádá o nové zapůjčení. Pokud soubor nemá aktivní zapůjčení, souborová služba vytvoří zapůjčení objektu blob a vrátí nové zapůjčení.
clear_range	Vymaže zadaný rozsah a uvolní místo použité v úložišti pro daný rozsah.
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_all_handles	Zavřete všechny otevřené popisovače souborů. Tato operace bude blokována, dokud služba zavře všechny otevřené popisovače.
close_handle	Zavřete otevřený popisovač souboru.
create_file	Vytvoří nový soubor. Všimněte si, že inicializuje pouze soubor bez obsahu.
delete_file	Označí zadaný soubor k odstranění. Soubor se později odstraní během uvolňování paměti.
download_file	Stáhne soubor do storageStreamDownloaderu. Metoda readall() musí být použita ke čtení veškerého obsahu nebo readinto() musí být použita ke stažení souboru do datového proudu. Použití chunks() vrátí iterátor, který uživateli umožní iterovat obsah v blocích.
from_connection_string	Vytvořte ShareFileClient z připojovacího řetězce.
from_file_url	Klient pro interakci s konkrétním souborem, i když tento soubor ještě nemusí existovat.
get_file_properties	Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru.
get_ranges	Vrátí seznam platných rozsahů stránek pro soubor nebo snímek souboru.
get_ranges_diff	Vrátí seznam platných rozsahů stránek pro soubor nebo snímek souboru. Novinka ve verzi 12.6.0.
list_handles	Vypíše popisovače pro soubor.
rename_file	Přejmenujte zdrojový soubor. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes nebo str :keyword file_creation_time: Čas vytvoření souboru. :p aramtype file_creation_time:~datetime.datetime nebo str :keyword file_last_write_time: Čas posledního zápisu souboru :p aramtype file_last_write_time:~datetime.datetime nebo str :keyword file_change_time: Změňte čas souboru. Pokud není zadaný, čas změny se nastaví na aktuální datum a čas. Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API 2021-06-08.
resize_file	Změní velikost souboru na zadanou velikost.
set_file_metadata	Nastaví uživatelem definovaná metadata pro zadaný soubor jako jeden nebo více dvojic název-hodnota. Každé volání této operace nahradí všechna existující metadata připojená k souboru. Pokud chcete ze souboru odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.
set_http_headers	Nastaví hlavičky PROTOKOLU HTTP v souboru.
start_copy_from_url	Zahájí kopírování dat ze zdrojové adresy URL do souboru, na který odkazuje klient. Stav této operace kopírování lze zjistit pomocí metody get_properties .
upload_file	Nahraje nový soubor. param data: Obsah souboru. param int length: Délka souboru v bajtech. Zadejte jeho maximální velikost, až do 1 TiB. param file_attributes: Atributy systému souborů pro soubory a adresáře. Pokud nenastavíte, výchozí hodnota bude "None" a atributy se nastaví na "Archiv". Tady je příklad pro případ, že typ var je str: 'Temporary\|Archiv'. file_attributes hodnota nerozlišuje malá a velká písmena. typ file_attributes: str nebo ~azure.storage.fileshare.NTFSAttributes param file_creation_time: Čas vytvoření souboru Výchozí hodnota: Nyní. typ file_creation_time: str nebo ~datetime.datetime param file_last_write_time: Čas posledního zápisu souboru Výchozí hodnota: Nyní. type file_last_write_time: str nebo ~datetime.datetime param file_permission: Pokud je zadáno, musí být pro adresář nebo soubor nastaveno oprávnění (popisovač zabezpečení). Tuto hlavičku lze použít, pokud je <velikost oprávnění = 8 kB, jinak se použije hlavička x-ms-file-permission-key. Výchozí hodnota: Dědit. Pokud je jako vstup zadán SDDL, musí mít vlastníka, skupinu a dacl. Poznámka: Mělo by být zadáno pouze jedno z x-ms-file-permission-permission nebo x-ms-file-permission-key. typ file_permission: str param permission_key: Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Mělo by být zadáno pouze jedno z x-ms-file-permission-permission nebo x-ms-file-permission-key. typ permission_key: str
upload_range	Nahrajte do souboru rozsah bajtů.
upload_range_from_url	Zapíše bajty z jednoho koncového bodu služby Azure File do zadaného rozsahu jiného koncového bodu služby Azure File.

abort_copy

Přerušení probíhající operace kopírování

Cílový soubor tak zůstane s nulovou délkou a úplnými metadaty. Pokud už operace kopírování skončila, dojde k chybě.

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

Parametry

copy_id: str nebo FileProperties

Vyžadováno

Operace kopírování, která se má přerušit. Může to být ID nebo instance FileVlastnosti.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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

acquire_lease

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

Pokud soubor nemá aktivní zapůjčení, souborová služba vytvoří zapůjčení objektu blob a vrátí nové zapůjčení.

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

Parametry

lease_id: str

Vyžadováno

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

timeout: int

Návraty

A ShareLeaseClient objekt.

Návratový typ

ShareLeaseClient

Příklady

Získání zapůjčení souboru


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

   lease.release()

clear_range

Vymaže zadaný rozsah a uvolní místo použité v úložišti pro daný rozsah.

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

Parametry

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se má použít k vymazání části souboru. Rozsah může mít velikost až 4 MB.

length: int

Vyžadováno

Počet bajtů, které se mají použít k vymazání části souboru Rozsah může mít velikost až 4 MB.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

timeout: int

Návraty

Dikt vlastností aktualizovaných souborů (značka Etag a poslední změna)

Návratový typ

Dict[str, Any]

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

close_all_handles

Zavřete všechny otevřené popisovače souborů.

Tato operace bude blokována, dokud služba zavře všechny otevřené popisovače.

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

Parametry

timeout: int

Návraty

Počet uzavřených popisovačů (může to být 0, pokud zadaný popisovač nebyl nalezen) a počet popisovačů se nepodařilo zavřít v diktu.

Návratový typ

dict[str, int]

close_handle

Zavřete otevřený popisovač souboru.

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

Parametry

handle: str nebo Handle

Vyžadováno

Konkrétní popisovač, který se má zavřít.

timeout: int

Návraty

Počet uzavřených popisovačů (může to být 0, pokud zadaný popisovač nebyl nalezen) a počet popisovačů se nepodařilo zavřít v diktu.

Návratový typ

dict[str, int]

create_file

Vytvoří nový soubor.

Všimněte si, že inicializuje pouze soubor bez obsahu.

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

Parametry

size: int

Vyžadováno

Určuje maximální velikost souboru, až 1 TB.

file_attributes: NTFSAttributes

Vyžadováno

Atributy systému souborů pro soubory a adresáře. Pokud nenastavíte, výchozí hodnota bude "None" a atributy se nastaví na "Archiv". Tady je příklad pro případ, že typ var je str: 'Temporary|Archiv'. file_attributes hodnota nerozlišuje malá a velká písmena.

file_creation_time: str nebo datetime

Vyžadováno

Čas vytvoření souboru Výchozí hodnota: Nyní.

file_last_write_time: str nebo datetime

Vyžadováno

Čas posledního zápisu souboru Výchozí hodnota: Nyní.

file_permission: str

Vyžadováno

Pokud je zadáno oprávnění (popisovač zabezpečení), nastaví se pro adresář nebo soubor. Tuto hlavičku lze použít, pokud je <velikost oprávnění = 8 kB, jinak se použije hlavička x-ms-file-permission-key. Výchozí hodnota: Dědit. Pokud je jako vstup zadán SDDL, musí mít vlastníka, skupinu a dacl. Poznámka: Mělo by být zadáno pouze jedno z x-ms-file-permission-permission nebo x-ms-file-permission-key.

permission_key: str

Vyžadováno

Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Mělo by být zadáno pouze jedno z x-ms-file-permission-permission nebo x-ms-file-permission-key.

file_change_time: str nebo datetime

Změňte čas souboru. Pokud není zadaný, čas změny se nastaví na aktuální datum a čas.

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API z 8. 6. 2021.

content_settings: ContentSettings

ContentSettings objekt použitý k nastavení vlastností souboru. Slouží k nastavení typu obsahu, kódování, jazyka, dispozice, md5 a řízení mezipaměti.

metadata: dict(str,str)

Dvojice název-hodnota přidružené k souboru jako metadata.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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 aktualizovaného souboru (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Příklady

Vytvořte soubor.


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

delete_file

Označí zadaný soubor k odstranění. Soubor se později odstraní během uvolňování paměti.

delete_file(**kwargs: Any) -> None

Parametry

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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

Příklady

Odstranění souboru


   my_file.delete_file()

download_file

Stáhne soubor do storageStreamDownloaderu. Metoda readall() musí být použita ke čtení veškerého obsahu nebo readinto() musí být použita ke stažení souboru do datového proudu. Použití chunks() vrátí iterátor, který uživateli umožní iterovat obsah v blocích.

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

Parametry

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se má použít ke stažení části souboru. Musí být nastavena, pokud je k dispozici délka.

length: int

Vyžadováno

Počet bajtů, které se mají číst z datového proudu Tato možnost je volitelná, ale pro zajištění optimálního výkonu by měla být dodána.

max_concurrency: int

Maximální počet paralelních připojení, která se mají použít.

validate_content: bool

Pokud je true, vypočítá hodnotu hash MD5 pro každý blok souboru. Služba úložiště zkontroluje hodnotu hash doručeného obsahu s odeslanou hodnotou hash. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že tato hodnota hash MD5 se se souborem neukládá. Všimněte si také, že pokud je povolená, nebude použit algoritmus nahrávání efektivní z paměti, protože výpočet hodnoty hash MD5 vyžaduje ukládání celých bloků do vyrovnávací paměti, a tím se poškodí účel algoritmu efektivního pro paměť.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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

Zpětné volání ke sledování průběhu dlouhotrvajícího stahování. Podpis je function(current: int, total: int), kde current je počet dosud přenesených bajtů, a celkový počet je celková velikost staženého souboru.

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

Objekt streamování (StorageStreamDownloader)

Návratový typ

<xref:azure.storage.fileshare.StorageStreamDownloader>

Příklady

Stáhněte si soubor.


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

from_connection_string

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

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

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.

file_path: str

Vyžadováno

Cesta k souboru.

snapshot: str

výchozí hodnota: None

Volitelný snímek souboru, se 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ě.

audience: str

Cílová skupina, která se má použít při žádosti o tokeny pro ověřování Azure Active Directory. Má účinek pouze v případě, že přihlašovací údaje jsou typu TokenCredential. Hodnota může být https://storage.azure.com/ (výchozí) nebo https://.file.core.windows.net.

Návraty

Souborový klient.

Návratový typ

ShareFileClient

Příklady

Vytvoří souborového klienta s připojovací řetězec.


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

from_file_url

Klient pro interakci s konkrétním souborem, i když tento soubor ještě nemusí existovat.

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

Parametry

file_url: str

Vyžadováno

Úplný identifikátor URI souboru.

snapshot: str

výchozí hodnota: None

Volitelný snímek souboru, se 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

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

audience: str

Návraty

Souborový klient.

Návratový typ

ShareFileClient

get_file_properties

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru.

get_file_properties(**kwargs: Any) -> FileProperties

Parametry

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

timeout: int

Návraty

Vlastnosti souboru

Návratový typ

FileProperties

get_ranges

Vrátí seznam platných rozsahů stránek pro soubor nebo snímek souboru.

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

Parametry

offset: int

Vyžadováno

Určuje počáteční posun bajtů, přes který se mají získat rozsahy.

length: int

Vyžadováno

Počet bajtů, které se mají použít k získání rozsahů

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

timeout: int

Návraty

Seznam platných oblastí.

Návratový typ

List[dict[str, int]]

get_ranges_diff

Vrátí seznam platných rozsahů stránek pro soubor nebo snímek souboru.

Novinka ve verzi 12.6.0.

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

Parametry

offset: int

Vyžadováno

Určuje počáteční posun bajtů, přes který se mají získat rozsahy.

length: int

Vyžadováno

Počet bajtů, které se mají použít k získání rozsahů

previous_sharesnapshot: str

Vyžadováno

Parametr rozdílu snímku, který obsahuje neprůselnou hodnotu DateTime, která určuje předchozí snímek souboru, který se má porovnat s novějším snímkem nebo aktuálním souborem.

lease: ShareLeaseClient nebo str

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

timeout: int

Návraty

Kolekce členů se dvěma seznamy rozsahů souborů jako slovníky s klíči "start" a "end". První prvek jsou vyplněné oblasti souborů, druhý prvek je vymazán rozsahy souborů.

Návratový typ

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

list_handles

Vypíše popisovače pro soubor.

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

Parametry

timeout: int

Návraty

Automatické stránkování s možností iterování popisovače

Návratový typ

ItemPaged[Handle]

rename_file

Přejmenujte zdrojový soubor.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes nebo str :keyword file_creation_time:

Čas vytvoření souboru.

:p aramtype file_creation_time:~datetime.datetime nebo str :keyword file_last_write_time:

Čas posledního zápisu souboru

:p aramtype file_last_write_time:~datetime.datetime nebo str :keyword file_change_time:

Změňte čas souboru. Pokud není zadaný, čas změny se nastaví na aktuální datum a čas.

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API 2021-06-08.

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

Parametry

content_type: str

Typ obsahu nového souboru.

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API 2021-06-08.

metadata: Dict[str,str]

Dvojice název-hodnota, která se má přidružit k objektu úložiště souborů.

source_lease: ShareLeaseClient nebo str

Vyžaduje se, pokud má zdrojový soubor aktivní zapůjčení. Hodnota může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

destination_lease: ShareLeaseClient nebo str

Vyžaduje se, pokud má cílový soubor aktivní zapůjčení. Hodnota může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Návraty

Nový klient souborů.

Návratový typ

ShareFileClient

resize_file

Změní velikost souboru na zadanou velikost.

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

Parametry

size: int

Vyžadováno

Velikost, na kterou chcete změnit velikost souboru (v bajtech)

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

timeout: int

Návraty

Dikt vlastností aktualizovaných souborů (značka Etag a poslední změna)

Návratový typ

Dict[str, Any]

set_file_metadata

Nastaví uživatelem definovaná metadata pro zadaný soubor jako jeden nebo více dvojic název-hodnota.

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

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

Parametry

metadata: dict(str, str)

Vyžadováno

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

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

timeout: int

Návraty

Dikt vlastností aktualizovaných souborů (značka Etag a poslední změna)

Návratový typ

dict(str, Any)

set_http_headers

Nastaví hlavičky PROTOKOLU HTTP v souboru.

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

Parametry

content_settings: ContentSettings

Vyžadováno

ContentSettings objekt použitý k nastavení vlastností souboru. Slouží k nastavení typu obsahu, kódování, jazyka, dispozice, md5 a řízení mezipaměti.

file_attributes: NTFSAttributes

Vyžadováno

Atributy systému souborů pro soubory a adresáře. Pokud není nastavená, znamená zachování existujících hodnot. Tady je příklad, kdy je typ var str: 'Temporary|Archiv"

file_creation_time: str nebo datetime

Vyžadováno

Čas vytvoření souboru Výchozí hodnota: Zachovat.

file_last_write_time: str nebo datetime

Vyžadováno

Čas posledního zápisu pro soubor Výchozí hodnota: Zachovat.

file_permission: str

Vyžadováno

Pokud je zadáno, musí být pro adresář nebo soubor nastaveno oprávnění (popisovač zabezpečení). Tuto hlavičku lze použít, pokud je <velikost oprávnění = 8 kB, jinak se použije hlavička x-ms-file-permission-key. Výchozí hodnota: Dědit. Pokud je jako vstup zadán SDDL, musí mít vlastníka, skupinu a seznam dacl. Poznámka: Měl by být zadán pouze jeden z x-ms-file-permission nebo x-ms-file-permission-key.

permission_key: str

Vyžadováno

Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Měl by být zadán pouze jeden z x-ms-file-permission nebo x-ms-file-permission-key.

file_change_time: str nebo datetime

Změňte čas souboru. Pokud není zadaný, čas změny se nastaví na aktuální datum a čas.

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API 2021-06-08.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

timeout: int

Návraty

Dikt vlastností aktualizovaných souborů (značka Etag a poslední změna)

Návratový typ

dict(str, Any)

start_copy_from_url

Zahájí kopírování dat ze zdrojové adresy URL do souboru, na který odkazuje klient.

Stav této operace kopírování lze zjistit pomocí metody get_properties .

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

Parametry

source_url: str

Vyžadováno

Určuje adresu URL zdrojového souboru.

file_permission: str

Pokud je zadáno oprávnění (popisovač zabezpečení), nastaví se pro adresář nebo soubor. Tuto hodnotu lze nastavit na "zdroj", aby se popisovač zabezpečení zkopíroval ze zdrojového souboru. V opačném případě se tato hodnota použije k přepsání zdrojové hodnoty. Pokud není hodnota oprávnění nastavená, zdědí se z nadřazeného adresáře cílového souboru. Toto nastavení lze použít, pokud je <velikost oprávnění = 8 kB, jinak se použije permission_key. Pokud je jako vstup zadán SDDL, musí mít vlastníka, skupinu a dacl. Poznámka: Měl by být zadán pouze jeden z file_permission nebo permission_key.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

permission_key: str

Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Tuto hodnotu lze nastavit na "zdroj", aby se popisovač zabezpečení zkopíroval ze zdrojového souboru. V opačném případě se tato hodnota použije k přepsání zdrojové hodnoty. Pokud není hodnota oprávnění nastavená, zdědí se z nadřazeného adresáře cílového souboru. Poznámka: Měl by být zadán pouze jeden z file_permission nebo permission_key.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

file_attributes: NTFSAttributes

Tato hodnota může být nastavena na "source", pokud chcete kopírovat atributy souboru ze zdrojového souboru do cílového souboru, nebo pokud chcete vymazat všechny atributy, můžete ji nastavit na "Žádné". V opačném případě může být nastaven na seznam atributů, které se mají nastavit v cílovém souboru. Pokud tato možnost není nastavená, výchozí hodnota je Archiv.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

file_creation_time: str nebo datetime

Tato hodnota může být nastavena na "zdroj", pokud chcete zkopírovat čas vytvoření ze zdrojového souboru do cílového souboru, nebo datetime nastavit jako čas vytvoření cílového souboru. Může to být také řetězec ve formátu ISO 8601. Pokud tato možnost není nastavená, nastaví se čas vytvoření na hodnotu data a času vytvoření (nebo přepsání) cílového souboru pomocí modulu kopírování.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

file_last_write_time: str nebo datetime

Tato hodnota může být nastavena na "zdroj", aby se zkopíroval čas posledního zápisu ze zdrojového souboru do cílového souboru, nebo datum a čas, který se má nastavit jako čas posledního zápisu do cílového souboru. Může to být také řetězec ve formátu ISO 8601. Pokud tato hodnota není nastavená, bude hodnota posledním časem zápisu do souboru modulem kopírování.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

file_change_time: str nebo datetime

Změňte čas souboru. Pokud není zadaný, čas změny se nastaví na aktuální datum a čas.

Novinka ve verzi 12.9.0: Tento parametr byl zaveden ve verzi rozhraní API z 8. 6. 2021.

ignore_read_only: bool

Určuje možnost přepsání cílového souboru, pokud již existuje a má nastavený atribut jen pro čtení.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

set_archive_attribute: bool

Určuje možnost nastavení atributu archivu v cílovém souboru. True znamená, že atribut archivu se nastaví u cílového souboru bez ohledu na přepsání atributů nebo stav zdrojového souboru.

Novinka ve verzi 12.1.0: Tento parametr byl zaveden ve verzi rozhraní API z 7. 7. 2019.

metadata

Dvojice název-hodnota přidružené k souboru jako metadata.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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

dict(str, Any)

Příklady

Kopírování souboru z adresy URL


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

Nahraje nový soubor.

param data: Obsah souboru.

param int length: Délka souboru v bajtech. Zadejte jeho maximální velikost, až do 1 TiB.

param file_attributes: Atributy systému souborů pro soubory a adresáře. Pokud nenastavíte, výchozí hodnota bude "None" a atributy se nastaví na "Archiv". Tady je příklad pro případ, že typ var je str: 'Temporary|Archiv'. file_attributes hodnota nerozlišuje malá a velká písmena.

typ file_attributes: str nebo ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: Čas vytvoření souboru Výchozí hodnota: Nyní.

typ file_creation_time: str nebo ~datetime.datetime

param file_last_write_time: Čas posledního zápisu souboru Výchozí hodnota: Nyní.

type file_last_write_time: str nebo ~datetime.datetime

param file_permission: Pokud je zadáno, musí být pro adresář nebo soubor nastaveno oprávnění (popisovač zabezpečení). Tuto hlavičku lze použít, pokud je <velikost oprávnění = 8 kB, jinak se použije hlavička x-ms-file-permission-key. Výchozí hodnota: Dědit. Pokud je jako vstup zadán SDDL, musí mít vlastníka, skupinu a dacl. Poznámka: Mělo by být zadáno pouze jedno z x-ms-file-permission-permission nebo x-ms-file-permission-key.

typ file_permission: str

param permission_key: Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Mělo by být zadáno pouze jedno z x-ms-file-permission-permission nebo x-ms-file-permission-key.

typ permission_key: str

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

Parametry

file_change_time

Změňte čas souboru. Pokud není zadaný, čas změny se nastaví na aktuální datum a čas.

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API z 8. 6. 2021.

paramtype file_change_time: str nebo ~datetime.datetime

metadata keyword dict(str,str): Dvojice název-hodnota přidružené k souboru jako metadata.

keyword ~azure.storage.fileshare.ContentSettings content_settings: Objekt ContentSettings použitý k nastavení vlastností souboru. Slouží k nastavení typu obsahu, kódování, jazyka, dispozice, md5 a řízení mezipaměti.

keyword bool validate_content: Pokud je true, vypočítá hodnotu hash MD5 pro každý rozsah souboru. Služba úložiště zkontroluje hodnotu hash doručeného obsahu s odeslanou hodnotou hash. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že tato hodnota hash MD5 se se souborem neukládá.

keyword int max_concurrency: Maximální počet paralelních připojení, která se mají použít.

Zapůjčení klíčového slova: Vyžaduje se, pokud má soubor aktivní zapůjčení. Hodnotou může být objekt ShareLeaseClient nebo ID zapůjčení jako řetězec.

Novinka ve verzi 12.1.0.

zapůjčení paramtype: ~azure.storage.fileshare.ShareLeaseClient nebo str

keyword progress_hook: Zpětné volání ke sledování průběhu dlouhotrvajícího nahrávání. Podpis je function(current: int, total: Optional[int]), kde current je počet doposud přenesených bajtů, a total je velikost objektu blob, nebo None (Žádný), pokud je velikost neznámá.

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

keyword int timeout: 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.

kódování klíčového slova str: Výchozí hodnota je UTF-8.

returns: File-updated property dict (Etag and last modified).

rtype: dict(str, Any)

Příklad: Nahrání souboru


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

upload_range

Nahrajte do souboru rozsah bajtů.

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

Parametry

data: bytes

Vyžadováno

Data, která se mají nahrát.

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se má použít k nahrání oddílu souboru. Rozsah může být až 4 MB.

length: int

Vyžadováno

Počet bajtů, které se mají použít k nahrání oddílu souboru Rozsah může být až 4 MB.

validate_content: bool

Pokud je true, vypočítá hodnotu hash MD5 obsahu stránky. Služba úložiště zkontroluje hodnotu hash doručeného obsahu s odeslanou hodnotou hash. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že tato hodnota hash MD5 se se souborem neukládá.

file_last_write_mode: Literal["preserve", "now"]

Pokud by měl být čas posledního zápisu souboru zachován nebo přepsán. Možné hodnoty jsou "zachovat" nebo "nyní". Pokud není zadaný, čas posledního zápisu souboru se změní na aktuální datum a čas.

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API z 8. 6. 2021.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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.

encoding: str

Výchozí hodnota je UTF-8.

Návraty

Dikt vlastnosti aktualizovaného souboru (značka Etag a naposledy změněno)

Návratový typ

Dict[str, Any]

upload_range_from_url

Zapíše bajty z jednoho koncového bodu služby Azure File do zadaného rozsahu jiného koncového bodu služby Azure File.

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

Parametry

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se má použít k aktualizaci oddílu souboru. Rozsah může být až 4 MB.

length: int

Vyžadováno

Počet bajtů, které se mají použít k aktualizaci oddílu souboru. Rozsah může být až 4 MB.

source_url: str

Vyžadováno

Adresa URL o délce až 2 kB, která určuje soubor Nebo objekt blob Azure. Hodnota by měla být zakódovaná jako adresa URL, jak by se zobrazovala v identifikátoru URI požadavku. Pokud je zdroj v jiném účtu, musí být buď veřejný, nebo musí být ověřený prostřednictvím sdíleného přístupového podpisu. Pokud je zdroj veřejný, nevyžaduje se žádné ověřování. Příklady: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_offset: int

Vyžadováno

To označuje začátek rozsahu bajtů (včetně), který se má ze zdroje kopírování přebít. Služba načte stejný počet bajtů jako cílový rozsah (posun délky).

source_if_modified_since: datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že zdrojový objekt blob byl od zadaného data a času změněn.

source_if_unmodified_since: datetime

source_etag: str

Hodnota zdrojové značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

source_match_condition: MatchConditions

Podmínka shody zdroje, která se použije u značky eTag.

file_last_write_mode: Literal["preserve", "now"]

Novinka ve verzi 12.8.0: Tento parametr byl zaveden ve verzi rozhraní API z 8. 6. 2021.

lease: ShareLeaseClient nebo str

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

Novinka ve verzi 12.1.0.

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.

source_authorization: str

Ověřování jako instančního objektu pomocí tajného klíče klienta pro přístup ke zdrojovému objektu blob Ujistěte se, že "bearer" je předpona řetězce source_authorization.

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

Sdílet prostřednictvím

ShareFileClient Třída

Konstruktor

Parametry

Metody

abort_copy

Parametry

Návratový typ

acquire_lease

Parametry

Návraty

Návratový typ

Příklady

clear_range

Parametry

Návraty

Návratový typ

close

close_all_handles

Parametry

Návraty

Návratový typ

close_handle

Parametry

Návraty

Návratový typ

create_file

Parametry

Návraty

Návratový typ

Příklady

delete_file

Parametry

Návratový typ

Příklady

download_file

Parametry

Návraty

Návratový typ

Příklady

from_connection_string

Parametry

Návraty

Návratový typ

Příklady

from_file_url

Parametry

Návraty

Návratový typ

get_file_properties

Parametry

Návraty

Návratový typ

get_ranges

Parametry

Návraty

Návratový typ

get_ranges_diff

Parametry

Návraty

Návratový typ

list_handles

Parametry

Návraty

Návratový typ

rename_file

Parametry

Návraty

Návratový typ

resize_file

Parametry

Návraty

Návratový typ

set_file_metadata

Parametry

Návraty

Návratový typ

set_http_headers

Parametry

Návraty