FileService Třída

Protokol SMB (Server Message Block) je upřednostňovaným protokolem sdílené složky, který se dnes používá místně. Služba Microsoft Azure File umožňuje zákazníkům využívat dostupnost a škálovatelnost protokolu SMB cloudové infrastruktury jako služby (IaaS) v Azure, aniž by museli přepisovat klientské aplikace SMB.

Služba Azure File také nabízí atraktivní alternativu k tradičním řešením direct attached storage (DAS) a sítí SAN (Storage Area Network), která jsou často složitá a náročná na instalaci, konfiguraci a provoz.

Dědičnost

StorageClient

FileService

Konstruktor

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

Parametry

Name	Description
account_name	str Název účtu úložiště. Používá se k ověřování požadavků podepsaných klíčem účtu a k vytvoření koncového bodu úložiště. Vyžaduje se, pokud není zadaný připojovací řetězec. výchozí hodnota: None
account_key	str Klíč účtu úložiště. Používá se pro ověřování pomocí sdíleného klíče. výchozí hodnota: None
sas_token	str Token sdíleného přístupového podpisu, který se použije k ověřování požadavků místo klíče účtu. Pokud je zadán klíč účtu i token SAS, použije se k podepsání klíč účtu. výchozí hodnota: None
protocol	str Protokol, který se má použít pro požadavky. Výchozí hodnota je https. výchozí hodnota: https
endpoint_suffix	str Základní komponenta hostitele adresy URL minus název účtu. Výchozí hodnota je Azure (core.windows.net). Přepište tuto možnost, pokud chcete používat čínský cloud (core.chinacloudapi.cn). výchozí hodnota: core.windows.net
request_session	<xref:requests.Session> Objekt relace, který se má použít pro požadavky HTTP. výchozí hodnota: None
connection_string	str Pokud je tato možnost zadána, přepíše se tím všechny ostatní parametry kromě relace požadavku. Viz http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ formát připojovací řetězec. výchozí hodnota: None
socket_timeout	int Pokud je zadaný, přepíše se tím výchozí časový limit soketu. Zadaný časový limit je v sekundách. Výchozí hodnotu najdete v DEFAULT_SOCKET_TIMEOUT v _constants.py. výchozí hodnota: None

Proměnné

Name	Description
MAX_SINGLE_GET_SIZE	int Velikost prvního rozsahu provádí metody get_file_to_*, pokud je max_connections větší než 1. Pokud je soubor menší, vrátí se méně dat.
MAX_CHUNK_GET_SIZE	int Velikost následného rozsahu provádí metody get_file_to_*, pokud je max_connections větší než 1 a soubor je větší než MAX_SINGLE_GET_SIZE. Pokud je zbytek souboru menší, vrátí se méně dat. Pokud je nastavená velikost větší než 4 MB, content_validation vyvolá chybu, pokud je povolená. Pokud ale content_validation není žádoucí, může být optimální velikost větší než 4 MB. Nastavení na nižší než 4 MB se nedoporučuje.
MAX_RANGE_SIZE	int Velikost rozsahů podle metod create_file_from_*. Pokud je k dispozici méně dat, je možné umístit menší rozsahy. Maximální velikost rozsahu, který služba podporuje, je 4 MB.

Metody

abort_copy_file	Přeruší operaci čekající copy_file a ponechá cílový soubor s nulovou délkou a úplnými metadaty.
clear_range	Vymaže zadaný rozsah a uvolní místo použité v úložišti pro daný rozsah.
close_handles	Vrátí generátor pro zavření otevřených popisovačů v adresáři nebo souboru v zadané sdílené složce. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, když jsou všechny popisovače uzavřeny. Zobrazené hodnoty představují počet popisovačů, které byly uzavřeny v každé transakci.
copy_file	Asynchronně zkopíruje soubor. Tato operace vrátí objekt vlastností operace kopírování, včetně ID kopírování, které můžete použít ke kontrole nebo přerušení operace kopírování. Souborová služba kopíruje soubory s maximálním úsilím. Pokud cílový soubor existuje, přepíše se. Cílový soubor nelze změnit, zatímco probíhá operace kopírování.
create_directory	Vytvoří nový adresář v zadané sdílené složce nebo nadřazené adresáři. Pokud adresář se stejným názvem již existuje, operace ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete zveřejnit výjimku, zadejte pro fail_on_exists hodnotu True.
create_file	Vytvoří nový soubor. V tématu create_file_from_* najdete funkce vysoké úrovně, které zpracovávají vytváření a nahrávání velkých souborů s automatickými bloky dat a oznámeními o průběhu.
create_file_from_bytes	Vytvoří nový soubor z pole bajtů nebo aktualizuje obsah existujícího souboru pomocí automatických oznámení bloků dat a průběhu.
create_file_from_path	Vytvoří nový soubor Azure z místní cesty k souboru nebo aktualizuje obsah existujícího souboru pomocí automatických oznámení o změnách dat a průběhu.
create_file_from_stream	Vytvoří nový soubor ze souboru nebo datového proudu nebo aktualizuje obsah existujícího souboru s automatickým zápisem bloků dat a oznámením o průběhu.
create_file_from_text	Vytvoří nový soubor ze souboru str/unicode nebo aktualizuje obsah existujícího souboru automatickým zápisem bloků dat a oznámením o průběhu.
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, musí vrátit jeho klíč, jinak vytvoří nové oprávnění na úrovni sdílené složky a vrátí jeho klíč. :vrátí klíč oprávnění k souboru:rtype str.
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 ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete zveřejnit výjimku, zadejte pro fail_on_exists hodnotu True.
delete_directory	Odstraní zadaný prázdný adresář. Upozorňujeme, že adresář musí být před odstraněním prázdný. Pokus o odstranění adresářů, které nejsou prázdné, se nezdaří. Pokud adresář neexistuje, operace ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete výjimku zveřejnit, zadejte pro fail_not_exist hodnotu True.
delete_file	Označí zadaný soubor k odstranění. Soubor se později odstraní během uvolňování paměti.
delete_share	Označí zadanou sdílenou složku k odstranění. Pokud sdílená složka neexistuje, operace ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete výjimku zveřejnit, zadejte pro fail_not_exist hodnotu True.
exists	Vrátí logickou hodnotu označující, zda sdílená složka existuje, pokud je zadaný pouze název sdílené složky. Pokud je directory_name konkrétní, vrátí se logická hodnota označující, jestli adresář existuje. Pokud je zadána také file_name, vrátí se logická hodnota označující, jestli soubor existuje.
extract_date_and_request_id
generate_account_shared_access_signature	Vygeneruje sdílený přístupový podpis pro souborovou službu. Použijte vrácený podpis s parametrem sas_token služby FileService.
generate_file_shared_access_signature	Vygeneruje sdílený přístupový podpis pro soubor. Použijte vrácený podpis s parametrem sas_token FileService.
generate_share_shared_access_signature	Vygeneruje sdílený přístupový podpis pro sdílenou složku. Použijte vrácený podpis s parametrem sas_token FileService.
get_directory_metadata	Vrátí všechna uživatelem definovaná metadata pro zadaný adresář.
get_directory_properties	Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadaný adresář. Vrácená data neobsahují seznam souborů adresáře.
get_file_metadata	Vrátí všechna uživatelem definovaná metadata pro zadaný soubor.
get_file_properties	Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru. Vrátí instanci diktu File metadat s FileProperties a.
get_file_service_properties	Získá vlastnosti služby File účtu úložiště, včetně azure Analýza úložiště.
get_file_to_bytes	Stáhne soubor jako pole bajtů s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s File vlastnostmi, metadaty a obsahem.
get_file_to_path	Stáhne soubor do cesty k souboru s oznámeními o automatickém vytváření bloků dat a průběhu. Vrátí instanci Souboru s vlastnostmi a metadaty.
get_file_to_stream	Stáhne soubor do datového proudu s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s File vlastnostmi a metadaty.
get_file_to_text	Stáhne soubor jako text unicode s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s File vlastnostmi, metadaty a obsahem.
get_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íč. :vrátí oprávnění k souboru (přenosný SDDL) :rtype str
get_share_acl	Získá oprávnění pro zadanou sdílenou složku.
get_share_metadata	Vrátí všechna uživatelem definovaná metadata pro zadanou sdílenou složku.
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 zaokrouhlené nahoru na nejbližší gigabajt. Všimněte si, že tato hodnota nemusí zahrnovat všechny nedávno vytvořené nebo nedávno přeustvované soubory.
get_share_stats_in_bytes	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é nebo nedávno přeustvované soubory.
list_directories_and_files	Vrátí generátor pro výpis adresářů a souborů v zadané sdílené složce. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, když se vrátí všechny adresáře a soubory nebo se dosáhne num_results. Pokud je zadána num_results a sdílená složka obsahuje více než tento počet souborů a adresářů, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
list_handles	Vrátí generátor pro výpis otevřených popisovačů v adresáři nebo souboru v zadané sdílené složce. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny popisovače nebo se dosáhne num_results. Pokud je zadána num_results a sdílená složka obsahuje více než tento počet souborů a adresářů, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
list_ranges	Načte platné rozsahy pro soubor.
list_shares	Vrátí generátor pro výpis sdílených složek v zadaném účtu. 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 nebo se dosáhne num_results. Pokud je zadána num_results a účet má více než tento počet sdílených složek, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
make_file_url	Vytvoří adresu URL pro přístup k souboru.
resize_file	Změní velikost souboru na zadanou velikost. Pokud je zadaná hodnota bajtu menší než aktuální velikost souboru, vymažou se všechny oblasti nad zadanou hodnotou bajtu.
set_directory_metadata	Nastaví jeden nebo více párů název-hodnota definované uživatelem pro zadaný adresář. Každé volání této operace nahradí všechna existující metadata připojená k adresáři. Pokud chcete z adresáře odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.
set_directory_properties
set_file_metadata	Nastaví uživatelem definovaná metadata pro zadaný soubor jako jeden nebo více dvojic název-hodnota.
set_file_properties	Nastaví systémové vlastnosti souboru. Pokud je pro content_settings nastavená jedna vlastnost, všechny vlastnosti se přepíšou.
set_file_service_properties	Nastaví vlastnosti služby File účtu úložiště, včetně azure Analýza úložiště. Pokud je prvek (ex HourMetrics) ponechán jako None, stávající nastavení služby pro danou funkci se zachovají.
set_proxy	Nastaví hostitele proxy serveru a port pro tunelování HTTP CONNECT.
set_share_acl	Nastaví oprávnění pro zadanou 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.
set_share_metadata	Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadanou sdílenou složku. 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 definované službou pro zadanou sdílenou složku.
snapshot_share	Vytvoří snímek existující sdílené složky pod zadaným účtem.
update_range	Zapíše bajty určené tělem požadavku do zadaného rozsahu.
update_range_from_file_url	Zapíše bajty z jednoho koncového bodu Azure File do zadaného rozsahu jiného koncového bodu Azure File.

abort_copy_file

Přeruší operaci čekající copy_file a ponechá cílový soubor s nulovou délkou a úplnými metadaty.

abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název cílové sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název cílového souboru.
copy_id Vyžadováno	str Identifikátor kopírování zadaný v copy.id původní operace copy_file.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

clear_range

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

clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
start_range Vyžadováno	int Začátek rozsahu bajtů, který se má použít k vymazání části souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
end_range Vyžadováno	int Konec rozsahu bajtů, který se má použít k vymazání části souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

close_handles

Vrátí generátor pro zavření otevřených popisovačů v adresáři nebo souboru v zadané sdílené složce. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, když jsou všechny popisovače uzavřeny. Zobrazené hodnoty představují počet popisovačů, které byly uzavřeny v každé transakci.

close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name	str Cesta k adresáři. výchozí hodnota: None
file_name	str Název existujícího souboru. výchozí hodnota: None
recursive	bool Logická hodnota určující, jestli se má operace použít pro adresář zadaný v identifikátoru URI, jeho soubory, podadresáře a jejich soubory. výchozí hodnota: None
handle_id	str Povinná hodnota. Určuje ID popisovače otevřeného v souboru nebo adresáři, který se má zavřít. Astrix (*) je zástupný znak, který určuje všechny popisovače. výchozí hodnota: None
marker	str Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud není dokončeno uzavírací úchyty. Pokud je tato funkce zadána, začne tento generátor zavírat popisovače od bodu, kde se předchozí generátor zastavil. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

copy_file

Asynchronně zkopíruje soubor. Tato operace vrátí objekt vlastností operace kopírování, včetně ID kopírování, které můžete použít ke kontrole nebo přerušení operace kopírování. Souborová služba kopíruje soubory s maximálním úsilím.

Pokud cílový soubor existuje, přepíše se. Cílový soubor nelze změnit, zatímco probíhá operace kopírování.

copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název cílové sdílené složky. Sdílená složka musí existovat.
directory_name Vyžadováno	str Název cílového adresáře. Adresář musí existovat.
file_name Vyžadováno	str Název cílového souboru. Pokud cílový soubor existuje, přepíše se. V opačném případě se vytvoří.
copy_source Vyžadováno	str Adresa URL o délce až 2 kB, která určuje soubor Azure nebo objekt blob. Hodnota by měla být zakódovaná jako 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 ověřování. Příklady: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> Páry název-hodnota přidružené k souboru jako metadata. Pokud nejsou zadány žádné páry název-hodnota, operace zkopíruje metadata ze zdrojového objektu blob nebo souboru do cílového souboru. Pokud je zadán jeden nebo více dvojic název-hodnota, cílový soubor se vytvoří se zadanými metadaty a metadata se nezkopírují ze zdrojového objektu blob nebo souboru. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
CopyProperties	Vlastnosti operace kopírování, jako je stav, zdroj a ID.

create_directory

Vytvoří nový adresář v zadané sdílené složce nebo nadřazené adresáři. Pokud adresář se stejným názvem již existuje, operace ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete zveřejnit výjimku, zadejte pro fail_on_exists hodnotu True.

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Název adresáře, který se má vytvořit, včetně cesty k nadřazeného adresáři.
metadata	dict(str, str)<xref::> Dikt s name_value páry, které se přidruží ke sdílené složce jako metadata. Příklad:{'Category':'test'} výchozí hodnota: None
fail_on_exist	bool určuje, zda má být vyvolání výjimky, pokud adresář existuje. Ve výchozím nastavení nepravda. výchozí hodnota: False
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
bool	True, pokud je adresář vytvořen, false, pokud adresář již existuje.

create_file

Vytvoří nový soubor.

V tématu create_file_from_* najdete funkce vysoké úrovně, které zpracovávají vytváření a nahrávání velkých souborů s automatickými bloky dat a oznámeními o průběhu.

create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název souboru, který chcete vytvořit nebo aktualizovat.
content_length Vyžadováno	int Délka souboru v bajtech
content_settings	ContentSettings ContentSettings objekt použitý k nastavení vlastností souboru. výchozí hodnota: None
metadata	dict(str, str) Dvojice název-hodnota přidružené k souboru jako metadata. výchozí hodnota: None
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu se vyjadřuje v sekundách. výchozí hodnota: None

create_file_from_bytes

Vytvoří nový soubor z pole bajtů nebo aktualizuje obsah existujícího souboru pomocí automatických oznámení bloků dat a průběhu.

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název souboru, který chcete vytvořit nebo aktualizovat.
file Vyžadováno	str Obsah souboru jako pole bajtů.
index	int Spusťte index v poli bajtů. výchozí hodnota: 0
count	int Počet bajtů k nahrání Pokud chcete nahrát všechny bajty počínaje indexem, nastavte možnost Žádné nebo záporná hodnota. výchozí hodnota: None
content_settings	ContentSettings ContentSettings objekt použitý k nastavení vlastností souboru. výchozí hodnota: None
metadata	dict(str, str) Dvojice název-hodnota přidružené k souboru jako metadata. výchozí hodnota: None
validate_content	bool Pokud je hodnota 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á. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a celkový počet je velikost souboru, nebo Žádná, pokud je celková velikost neznámá. výchozí hodnota: None
max_connections	int Maximální počet paralelních připojení, která se mají použít. výchozí hodnota: 2
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu se vyjadřuje v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se použije pro každé volání zvlášť. výchozí hodnota: None

create_file_from_path

Vytvoří nový soubor Azure z místní cesty k souboru nebo aktualizuje obsah existujícího souboru pomocí automatických oznámení o změnách dat a průběhu.

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název souboru, který chcete vytvořit nebo aktualizovat.
local_file_path Vyžadováno	str Cesta k místnímu souboru, který se má nahrát jako obsah souboru.
content_settings	ContentSettings ContentSettings objekt použitý k nastavení vlastností souboru. výchozí hodnota: None
metadata	dict(str, str) Dvojice název-hodnota přidružené k souboru jako metadata. výchozí hodnota: None
validate_content	bool Pokud je hodnota 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á. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a celkový počet je velikost souboru, nebo Žádná, pokud je celková velikost neznámá. výchozí hodnota: None
max_connections	int Maximální počet paralelních připojení, která se mají použít. výchozí hodnota: 2
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu se vyjadřuje v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se použije pro každé volání zvlášť. výchozí hodnota: None

create_file_from_stream

Vytvoří nový soubor ze souboru nebo datového proudu nebo aktualizuje obsah existujícího souboru s automatickým zápisem bloků dat a oznámením o průběhu.

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název souboru, který chcete vytvořit nebo aktualizovat.
stream Vyžadováno	IOBase Otevřený soubor nebo stream, který se má nahrát jako obsah souboru.
count Vyžadováno	int Počet bajtů, které se mají číst z datového proudu To je povinné. Soubor nelze vytvořit, pokud je počet neznámý.
content_settings	ContentSettings ContentSettings objekt použitý k nastavení vlastností souboru. výchozí hodnota: None
metadata	dict(str, str) Dvojice název-hodnota přidružené k souboru jako metadata. výchozí hodnota: None
validate_content	bool Pokud je hodnota 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á. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a celkový počet je velikost souboru, nebo Žádná, pokud je celková velikost neznámá. výchozí hodnota: None
max_connections	int Maximální počet paralelních připojení, která se mají použít. Mějte na paměti, že paralelní nahrávání vyžaduje, aby byl datový proud vyhledatelný. výchozí hodnota: 2
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu se vyjadřuje v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se použije pro každé volání zvlášť. výchozí hodnota: None

create_file_from_text

Vytvoří nový soubor ze souboru str/unicode nebo aktualizuje obsah existujícího souboru automatickým zápisem bloků dat a oznámením o průběhu.

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název souboru, který chcete vytvořit nebo aktualizovat.
text Vyžadováno	str Text, který se má nahrát do souboru
encoding	str Kódování Pythonu, které se má použít k převodu textu na bajty. výchozí hodnota: utf-8
content_settings	ContentSettings ContentSettings objekt použitý k nastavení vlastností souboru. výchozí hodnota: None
metadata	dict(str, str) Dvojice název-hodnota přidružené k souboru jako metadata. výchozí hodnota: None
validate_content	bool Pokud je hodnota 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á. výchozí hodnota: False
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu se vyjadřuje v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se použije pro každé volání zvlášť. výchozí hodnota: None

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, musí vrátit jeho klíč, jinak vytvoří nové oprávnění na úrovni sdílené složky a vrátí jeho klíč.

:vrátí klíč oprávnění k souboru:rtype str.

create_permission_for_share(share_name, file_permission, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	Název sdílené složky.
file_permission Vyžadováno	Oprávnění k souborům, Portable SDDL
timeout	Parametr časového limitu se vyjadřuje v sekundách. výchozí hodnota: None

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 ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete zveřejnit výjimku, zadejte pro fail_on_exists hodnotu True.

create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky, která se má vytvořit.
metadata	dict(str, str) Dikt s name_value spáruje, aby se ke sdílené složce přidružila jako metadata. Příklad:{'Category':'test'} výchozí hodnota: None
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 (5120). výchozí hodnota: None
fail_on_exist	bool Určete, zda má být vyvolání výjimky, pokud sdílená složka existuje. Ve výchozím nastavení je false. výchozí hodnota: False
timeout	int Parametr časového limitu se vyjadřuje v sekundách. výchozí hodnota: None

Návraty

Typ	Description
bool	True, pokud je vytvořená sdílená složka, false, pokud už sdílená složka existuje.

delete_directory

Odstraní zadaný prázdný adresář. Upozorňujeme, že adresář musí být před odstraněním prázdný. Pokus o odstranění adresářů, které nejsou prázdné, se nezdaří.

Pokud adresář neexistuje, operace ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete výjimku zveřejnit, zadejte pro fail_not_exist hodnotu True.

delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Název adresáře, který chcete odstranit, včetně cesty k nadřazené adresáři.
fail_not_exist	bool Určete, jestli se má vyvolat výjimka, když adresář neexistuje. výchozí hodnota: False
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
bool	True, pokud je adresář odstraněn, v opačném případě false.

delete_file

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

delete_file(share_name, directory_name, file_name, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

delete_share

Označí zadanou sdílenou složku k odstranění. Pokud sdílená složka neexistuje, operace ve službě selže. Ve výchozím nastavení je výjimka spolknuta klientem. Pokud chcete výjimku zveřejnit, zadejte pro fail_not_exist hodnotu True.

delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky, která se má odstranit.
fail_not_exist	bool Určete, jestli se má vyvolat výjimka, když sdílená složka neexistuje. Ve výchozím nastavení nepravda. výchozí hodnota: False
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. Zadáním tohoto argumentu odstraníte pouze konkrétní snímek. delete_snapshots musí být Žádná, pokud je tato možnost zadána. výchozí hodnota: None
delete_snapshots	DeleteSnapshot Pokud chcete odstranit sdílenou složku, která obsahuje snímky, musí být tato možnost zadána jako DeleteSnapshot.Include. výchozí hodnota: None

Návraty

Typ	Description
bool	True, pokud je sdílená složka odstraněná, sdílená složka False neexistuje.

exists

Vrátí logickou hodnotu označující, zda sdílená složka existuje, pokud je zadaný pouze název sdílené složky. Pokud je directory_name konkrétní, vrátí se logická hodnota označující, jestli adresář existuje. Pokud je zadána také file_name, vrátí se logická hodnota označující, jestli soubor existuje.

exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky.
directory_name	str Cesta k adresáři. výchozí hodnota: None
file_name	str Název souboru. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
bool	Logická hodnota označující, jestli prostředek existuje.

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parametry

Name	Description
retry_context Vyžadováno

generate_account_shared_access_signature

Vygeneruje sdílený přístupový podpis pro souborovou službu. Použijte vrácený podpis s parametrem sas_token služby FileService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Parametry

Name	Description
resource_types Vyžadováno	<xref:ResourceTypes> Určuje typy prostředků, které jsou přístupné pomocí SAS účtu.
permission Vyžadováno	<xref:AccountPermissions> Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.
expiry Vyžadováno	datetime nebo str Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
start	datetime nebo str Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. výchozí hodnota: None
ip	str Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy. výchozí hodnota: None
protocol	str Určuje protokol povolený pro zadaný požadavek. Možné hodnoty jsou HTTPS a HTTP (https,http) nebo pouze HTTPS (https). Výchozí hodnota je https,http. Všimněte si, že pouze HTTP není povolená hodnota. výchozí hodnota: None

Návraty

Typ	Description
str	Token sdíleného přístupového podpisu (SAS).

generate_file_shared_access_signature

Vygeneruje sdílený přístupový podpis pro soubor. Použijte vrácený podpis s parametrem sas_token FileService.

generate_file_shared_access_signature(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky.
directory_name	str Název adresáře. Tokeny SAS nelze vytvořit pro adresáře, takže tento parametr by měl být k dispozici pouze v případě, že je k dispozici file_name. výchozí hodnota: None
file_name	str Název souboru. výchozí hodnota: None
permission	FilePermissions Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Oprávnění musí být seřazená pro čtení, vytváření, zápis, odstranění a seznam. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. výchozí hodnota: None
expiry	datetime nebo str Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. výchozí hodnota: None
start	datetime nebo str Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. výchozí hodnota: None
id	str Jedinečná hodnota o délce až 64 znaků, která koreluje s uloženými zásadami přístupu. K vytvoření uložených zásad přístupu použijte set_file_service_properties. výchozí hodnota: None
ip	str Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy. výchozí hodnota: None
protocol	str Určuje protokol povolený pro zadaný požadavek. Možné hodnoty jsou HTTPS a HTTP (https,http) nebo pouze HTTPS (https). Výchozí hodnota je https,http. Všimněte si, že pouze HTTP není povolená hodnota. výchozí hodnota: None
cache_control	str Hodnota hlavičky odpovědi pro Cache-Control při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu. výchozí hodnota: None
content_disposition	str Hodnota hlavičky odpovědi pro Content-Disposition při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu výchozí hodnota: None
content_encoding	str Hodnota hlavičky odpovědi pro Content-Encoding při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu výchozí hodnota: None
content_language	str Hodnota hlavičky odpovědi pro Content-Language při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu výchozí hodnota: None
content_type	str Hodnota hlavičky odpovědi pro Content-Type při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu. výchozí hodnota: None

Návraty

Typ	Description
str	Token sdíleného přístupového podpisu (SAS).

generate_share_shared_access_signature

Vygeneruje sdílený přístupový podpis pro sdílenou složku. Použijte vrácený podpis s parametrem sas_token FileService.

generate_share_shared_access_signature(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky.
permission	SharePermissions Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Oprávnění musí být seřazená pro čtení, vytváření, zápis, odstranění a seznam. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. výchozí hodnota: None
expiry	datetime nebo str Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. výchozí hodnota: None
start	datetime nebo str Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. výchozí hodnota: None
id	str Jedinečná hodnota o délce až 64 znaků, která koreluje s uloženými zásadami přístupu. K vytvoření uložených zásad přístupu použijte set_share_acl. výchozí hodnota: None
ip	str Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy. výchozí hodnota: None
protocol	str Určuje protokol povolený pro zadaný požadavek. Možné hodnoty jsou HTTPS a HTTP (https,http) nebo pouze HTTPS (https). Výchozí hodnota je https,http. Všimněte si, že pouze HTTP není povolená hodnota. výchozí hodnota: None
cache_control	str Hodnota hlavičky odpovědi pro Cache-Control při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu. výchozí hodnota: None
content_disposition	str Hodnota hlavičky odpovědi pro Content-Disposition při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu výchozí hodnota: None
content_encoding	str Hodnota hlavičky odpovědi pro Content-Encoding při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu výchozí hodnota: None
content_language	str Hodnota hlavičky odpovědi pro Content-Language při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu výchozí hodnota: None
content_type	str Hodnota hlavičky odpovědi pro Content-Type při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu. výchozí hodnota: None

Návraty

Typ	Description
str	Token sdíleného přístupového podpisu (SAS).

get_directory_metadata

Vrátí všechna uživatelem definovaná metadata pro zadaný adresář.

get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
dict(str, str)	Slovník představující název metadat adresáře, páry hodnot.

get_directory_properties

Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadaný adresář. Vrácená data neobsahují seznam souborů adresáře.

get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k existujícímu adresáři.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
Directory	vlastnosti zadaného adresáře v objektu adresáře.

get_file_metadata

Vrátí všechna uživatelem definovaná metadata pro zadaný soubor.

get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
dict(str, str)	Slovník představující název metadat souboru, páry hodnot.

get_file_properties

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru. Vrátí instanci diktu File metadat s FileProperties a.

get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
File	objekt souboru včetně vlastností a metadat.

get_file_service_properties

Získá vlastnosti služby File účtu úložiště, včetně azure Analýza úložiště.

get_file_service_properties(timeout=None)

Parametry

Name	Description
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
ServiceProperties	Vlastnosti souborové služby.

get_file_to_bytes

Stáhne soubor jako pole bajtů s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s File vlastnostmi, metadaty a obsahem.

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
start_range	int Začátek rozsahu bajtů, který se má použít ke stažení části souboru. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
end_range	int Konec rozsahu bajtů, který se má použít ke stažení části souboru. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
validate_content	bool Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část souboru. 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 služba bude vracet pouze transakční md5 pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud já. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že výpočet md5 trvá zpracování a kvůli zmenšené velikosti bloků dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a součet je velikost souboru, pokud je znám. výchozí hodnota: None
max_connections	int Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první sebe. MAX_SINGLE_GET_SIZE bajtů souboru. Pokud se jedná o celý soubor, vrátí metoda v tomto okamžiku. Pokud tomu tak není, stáhne zbývající data paralelně s použitím počtu vláken rovnajících se max_connections. Každý blok dat bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhlednutelný datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se soubor současně upravuje tak, aby vynutil atomicitu, nebo pokud se očekává, že mnoho souborů bude prázdné, protože je vyžadován další požadavek na prázdné soubory, pokud je max_connections větší než 1. výchozí hodnota: 2
timeout	int Parametr časového limitu je vyjádřen v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
File	Soubor s vlastnostmi, obsahem a metadaty.

get_file_to_path

Stáhne soubor do cesty k souboru s oznámeními o automatickém vytváření bloků dat a průběhu. Vrátí instanci Souboru s vlastnostmi a metadaty.

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
file_path Vyžadováno	str Cesta k souboru, do který chcete zapisovat.
open_mode	str Režim, který se má použít při otevírání souboru. Všimněte si, že zadání pouze open_mode brání paralelnímu stahování. Pokud se tedy používá tato open_mode, musí být max_connections nastavená na hodnotu 1. výchozí hodnota: wb
start_range	int Začátek rozsahu bajtů, který se má použít ke stažení části souboru. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
end_range	int Konec rozsahu bajtů, který se má použít ke stažení části souboru. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
validate_content	bool Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část souboru. 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 služba bude vracet pouze transakční md5 pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud já. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že výpočet md5 trvá zpracování a kvůli zmenšené velikosti bloků dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a součet je velikost souboru, pokud je znám. výchozí hodnota: None
max_connections	int Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první sebe. MAX_SINGLE_GET_SIZE bajtů souboru. Pokud se jedná o celý soubor, vrátí metoda v tomto okamžiku. Pokud tomu tak není, stáhne zbývající data paralelně s použitím počtu vláken rovnajících se max_connections. Každý blok dat bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhlednutelný datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se soubor současně upravuje tak, aby vynutil atomicitu, nebo pokud se očekává, že mnoho souborů bude prázdné, protože je vyžadován další požadavek na prázdné soubory, pokud je max_connections větší než 1. výchozí hodnota: 2
timeout	int Parametr časového limitu je vyjádřen v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
File	Soubor s vlastnostmi a metadaty.

get_file_to_stream

Stáhne soubor do datového proudu s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s File vlastnostmi a metadaty.

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
stream Vyžadováno	IOBase Otevřený soubor nebo datový proud pro zápis.
start_range	int Začátek rozsahu bajtů, který se má použít ke stažení části souboru. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
end_range	int Konec rozsahu bajtů, který se má použít ke stažení části souboru. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
validate_content	bool Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část souboru. 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 služba bude vracet pouze transakční md5 pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud já. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že výpočet md5 trvá zpracování a kvůli zmenšené velikosti bloků dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a součet je velikost souboru, pokud je znám. výchozí hodnota: None
max_connections	int Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první sebe. MAX_SINGLE_GET_SIZE bajtů souboru. Pokud se jedná o celý soubor, vrátí metoda v tomto okamžiku. Pokud tomu tak není, stáhne zbývající data paralelně s použitím počtu vláken rovnajících se max_connections. Každý blok dat bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhlednutelný datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se soubor současně upravuje tak, aby vynutil atomicitu, nebo pokud se očekává, že mnoho souborů bude prázdné, protože je vyžadován další požadavek na prázdné soubory, pokud je max_connections větší než 1. výchozí hodnota: 2
timeout	int Parametr časového limitu je vyjádřen v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
File	Soubor s vlastnostmi a metadaty.

get_file_to_text

Stáhne soubor jako text unicode s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s File vlastnostmi, metadaty a obsahem.

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
encoding	str Kódování Pythonu, které se má použít při dekódování dat souboru. výchozí hodnota: utf-8
start_range	int Začátek rozsahu bajtů, který se má použít ke stažení části souboru. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
end_range	int Konec rozsahu bajtů, který se má použít ke stažení části souboru. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
validate_content	bool Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část souboru. 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 služba bude vracet pouze transakční md5 pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud já. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že výpočet md5 trvá zpracování a kvůli zmenšené velikosti bloků dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence. výchozí hodnota: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Zpětné volání pro průběh s funkcí signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a součet je velikost souboru, pokud je znám. výchozí hodnota: None
max_connections	int Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první sebe. MAX_SINGLE_GET_SIZE bajtů souboru. Pokud se jedná o celý soubor, vrátí metoda v tomto okamžiku. Pokud tomu tak není, stáhne zbývající data paralelně s použitím počtu vláken rovnajících se max_connections. Každý blok dat bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhlednutelný datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se soubor současně upravuje tak, aby vynutil atomicitu, nebo pokud se očekává, že mnoho souborů bude prázdné, protože je vyžadován další požadavek na prázdné soubory, pokud je max_connections větší než 1. výchozí hodnota: 2
timeout	int Parametr časového limitu je vyjádřen v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
File	Soubor s vlastnostmi, obsahem a metadaty.

get_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íč.

:vrátí oprávnění k souboru (přenosný SDDL) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	Název sdílené složky.
file_permission_key Vyžadováno	Klíč oprávnění k načtení souboru
timeout	Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

get_share_acl

Získá oprávnění pro zadanou sdílenou složku.

get_share_acl(share_name, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
dict(str, AccessPolicy)	Slovník zásad přístupu přidružených ke sdílené složce.

get_share_metadata

Vrátí všechna uživatelem definovaná metadata pro zadanou sdílenou složku.

get_share_metadata(share_name, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
dict(str, str)	Slovník představující název metadat sdílené složky, páry hodnot.

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(share_name, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
Share	Sdílená složka, která zveřejňuje vlastnosti a metadata.

get_share_stats

Získá přibližnou velikost dat uložených ve sdílené složce zaokrouhlené nahoru na nejbližší gigabajt.

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

get_share_stats(share_name, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
int	přibližnou velikost dat uložených ve sdílené složce.

get_share_stats_in_bytes

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é nebo nedávno přeustvované soubory.

get_share_stats_in_bytes(share_name, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
int	přibližnou velikost dat uložených ve sdílené složce.

list_directories_and_files

Vrátí generátor pro výpis adresářů a souborů v zadané sdílené složce. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, když se vrátí všechny adresáře a soubory nebo se dosáhne num_results.

Pokud je zadána num_results a sdílená složka obsahuje více než tento počet souborů a adresářů, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.

list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name	str Cesta k adresáři. výchozí hodnota: None
num_results	int Určuje maximální počet souborů, které se mají vrátit, včetně všech prvků adresáře. Pokud požadavek neurčuje num_results nebo určuje hodnotu větší než 5 000, server vrátí až 5 000 položek. Nastavení num_results na hodnotu menší nebo rovnou nule vede k chybě s kódem odpovědi na chybu 400 (chybný požadavek). výchozí hodnota: None
marker	str Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán num_results a tento generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
prefix	str Vypište pouze soubory nebo adresáře s danou předponou. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

list_handles

Vrátí generátor pro výpis otevřených popisovačů v adresáři nebo souboru v zadané sdílené složce. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny popisovače nebo se dosáhne num_results.

Pokud je zadána num_results a sdílená složka obsahuje více než tento počet souborů a adresářů, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.

list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name	str Cesta k adresáři. výchozí hodnota: None
file_name	str Název existujícího souboru. výchozí hodnota: None
recursive	bool Logická hodnota určující, jestli se má operace použít pro adresář zadaný v identifikátoru URI, jeho soubory, podadresáře a jejich soubory. výchozí hodnota: None
max_results	int Určuje maximální počet popisovačů souborů nebo adresářů, které se mají vrátit. Pokud požadavek neurčuje max_results nebo určuje hodnotu větší než 5 000, server vrátí až 5 000 položek. Nastavení max_results na hodnotu menší nebo rovnou nule vede k chybě s kódem odpovědi na chybu 400 (chybný požadavek). výchozí hodnota: None
marker	str Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán max_results a generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

list_ranges

Načte platné rozsahy pro soubor.

list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
start_range	int Určuje počáteční posun bajtů, nad kterými se mají vypsat oblasti. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
end_range	int Určuje koncový posun bajtů, nad kterými se mají vypsat oblasti. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
snapshot	str Řetězec, který představuje verzi snímku, pokud je k dispozici. výchozí hodnota: None

Návraty

Typ	Description
<xref:a> list <xref:of> FileRange	seznam platných oblastí

list_shares

Vrátí generátor pro výpis sdílených složek v zadaném účtu. 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 nebo se dosáhne num_results.

Pokud je zadána num_results a účet má více než tento počet sdílených složek, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.

list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

Parametry

Name	Description
prefix	str Filtruje výsledky tak, aby vracely pouze sdílené složky, jejichž názvy začínají určenou předponou. výchozí hodnota: None
num_results	int Určuje maximální počet sdílených složek, které se mají vrátit. výchozí hodnota: None
include_metadata	bool Určuje, že se v odpovědi vrátí metadata sdílené složky. výchozí hodnota: False
marker	str Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán num_results a tento generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None
include_snapshots	bool Určuje, že se v odpovědi vrátí snímky sdílených složek. výchozí hodnota: False

make_file_url

Vytvoří adresu URL pro přístup k souboru.

make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název souboru.
protocol	str Protokol, který se má použít: http nebo https. Pokud není zadaný, použije protokol zadaný při inicializaci služby FileService. výchozí hodnota: None
sas_token	str Token sdíleného přístupových podpisů vytvořený pomocí generate_shared_access_signature. výchozí hodnota: None

Návraty

Typ	Description
str	přístupová adresa URL souboru.

resize_file

Změní velikost souboru na zadanou velikost. Pokud je zadaná hodnota bajtu menší než aktuální velikost souboru, vymažou se všechny oblasti nad zadanou hodnotou bajtu.

resize_file(share_name, directory_name, file_name, content_length, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
content_length Vyžadováno	int Délka, na kterou chcete změnit velikost souboru.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_directory_metadata

Nastaví jeden nebo více párů název-hodnota definované uživatelem pro zadaný adresář. Každé volání této operace nahradí všechna existující metadata připojená k adresáři. Pokud chcete z adresáře odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.

set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
metadata	dict(str, str)<xref:./> Dikt obsahující páry název-hodnota, které se přidružují k adresáři jako metadata. Příklad: {'category':'test'} výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_directory_properties

set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	Název sdílené složky
directory_name Vyžadováno	Název adresáře
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_file_metadata

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

set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
metadata	dict(str, str) Dict obsahující páry název a 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 hlaviček metadat. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_file_properties

Nastaví systémové vlastnosti souboru. Pokud je pro content_settings nastavená jedna vlastnost, všechny vlastnosti se přepíšou.

set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
content_settings Vyžadováno	ContentSettings ContentSettings objekt použitý k nastavení vlastností souboru.
file_permission	str Oprávnění k souborům, přenosný SDDL výchozí hodnota: None
smb_properties	SMBProperties Nastaví vlastnosti souboru souvisejícího s protokolem SMB.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_file_service_properties

Nastaví vlastnosti služby File účtu úložiště, včetně azure Analýza úložiště. Pokud je prvek (ex HourMetrics) ponechán jako None, stávající nastavení služby pro danou funkci se zachovají.

set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Parametry

Name	Description
hour_metrics	<xref:Metrics> Nastavení hodinové metriky poskytuje souhrn statistik žádostí seskupených podle rozhraní API v agregovaných po hodinách pro soubory. výchozí hodnota: None
minute_metrics	<xref:Metrics> Nastavení minutových metrik poskytuje statistiky žádostí o každou minutu pro soubory. výchozí hodnota: None
cors	list(CorsRule) 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. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_proxy

Nastaví hostitele proxy serveru a port pro tunelování HTTP CONNECT.

set_proxy(host, port, user=None, password=None)

Parametry

Name	Description
host Vyžadováno	str Adresa proxy serveru. Příklad: "192.168.0.100"
port Vyžadováno	int Port proxy serveru. Příklad: 6000
user	str Uživatel pro autorizaci proxy serveru. výchozí hodnota: None
password	str Heslo pro autorizaci proxy serveru. výchozí hodnota: None

set_share_acl

Nastaví oprávnění pro zadanou 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.

set_share_acl(share_name, signed_identifiers=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
signed_identifiers	dict(str, AccessPolicy) Slovník zásad přístupu, které se mají 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é ve službě. výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_share_metadata

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadanou sdílenou složku. 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(share_name, metadata=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
metadata	dict(str, str) Dikt obsahující páry název-hodnota, které se přidružují ke sdílené složce jako metadata. Příklad: {'category':'test'} výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

set_share_properties

Nastaví vlastnosti definované službou pro zadanou sdílenou složku.

set_share_properties(share_name, quota, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
quota Vyžadováno	int Určuje maximální velikost sdílené složky v gigabajtech. Musí být větší než 0 a menší než nebo rovno 5 TB (5120 GB).
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

snapshot_share

Vytvoří snímek existující sdílené složky pod zadaným účtem.

snapshot_share(share_name, metadata=None, quota=None, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název sdílené složky, ze které chcete vytvořit snímek.
metadata	<xref:<xref:a dict> of <xref:str to str:>> Dikt s name_value páry, které se přidruží ke sdílené složce jako metadata. Příklad:{'Category':'test'} výchozí hodnota: None
quota	int Určuje maximální velikost sdílené složky v gigabajtech. Musí být větší než 0 a menší nebo rovno 5 TB (5120). výchozí hodnota: None
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Návraty

Typ	Description
Share	Vlastnosti snímku

update_range

Zapíše bajty určené tělem požadavku do zadaného rozsahu.

update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
data Vyžadováno	bytes Obsah rozsahu.
start_range Vyžadováno	int Začátek rozsahu bajtů, který se má použít pro aktualizaci oddílu souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
end_range Vyžadováno	int Konec rozsahu bajtů, který se má použít pro aktualizaci oddílu souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
validate_content	bool Pokud ano, vypočítá hodnotu hash MD5 obsahu stránky. Služba úložiště zkontroluje hodnotu hash obsahu, která přišla s hodnotou hash, která byla odeslána. 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 není uložena se souborem. výchozí hodnota: False
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

update_range_from_file_url

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

update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)

Parametry

Name	Description
share_name Vyžadováno	str Název existující sdílené složky.
directory_name Vyžadováno	str Cesta k adresáři.
file_name Vyžadováno	str Název existujícího souboru.
start_range Vyžadováno	int Začátek rozsahu bajtů, který se má použít pro aktualizaci oddílu souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
end_range Vyžadováno	int Konec rozsahu bajtů, který se má použít pro aktualizaci oddílu souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
source Vyžadováno	str Adresa URL o délce až 2 kB, která určuje soubor Azure nebo objekt blob. Hodnota by měla být zakódovaná jako 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 ověřování. Příklady: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range Vyžadováno	int Začátek rozsahu bajtů, který se má použít pro aktualizaci oddílu souboru. Rozsah může mít velikost až 4 MB. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů souboru.
timeout	int Parametr časového limitu je vyjádřen v sekundách. výchozí hodnota: None

Atributy

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432