ShareDirectoryClient Třída

Reference

Klient pro interakci s konkrétním adresářem, i když ještě nemusí existovat.

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

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

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

ShareDirectoryClient

Konstruktor

ShareDirectoryClient(account_url: str, share_name: str, directory_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 adresáře, použijte metodu from_directory_url třídy .

share_name: str

Vyžadováno

Název sdílené složky pro adresář.

directory_path: str

Vyžadováno

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

snapshot: str

výchozí hodnota: None

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

credential

výchozí hodnota: None

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

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

token_intent: Literal['backup']

Vyžaduje se 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 se obejdou všechny seznamy ACL pro soubory nebo adresáře a udělí 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á úč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.

Metody

close	Tato metoda je zavřít sokety otevřené klientem. Při použití se správcem kontextu se nemusí používat.
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_directory	Vytvoří nový adresář v adresáři odkazovaném klientem.
create_subdirectory	Vytvoří nový podadresář a vrátí klienta pro interakci s podadresářem.
delete_directory	Označí adresář k odstranění. Adresář se později odstraní během uvolňování paměti.
delete_file	Označí zadaný soubor k odstranění. Soubor se později odstraní během uvolňování paměti.
delete_subdirectory	Odstraní podadresář.
exists	Vrátí hodnotu True, pokud adresář existuje, a v opačném případě vrátí hodnotu False.
from_connection_string	Vytvořte ShareDirectoryClient z připojovacího řetězce.
from_directory_url	Vytvořte ShareDirectoryClient z adresy URL adresáře.
get_directory_properties	Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadaný adresář. Vrácená data nezahrnují seznam souborů adresáře.
get_file_client	Získejte klienta pro interakci s konkrétním souborem. Soubor ještě nemusí existovat.
get_subdirectory_client	Získejte klienta pro interakci s konkrétním podadresářem. Podadresář ještě nemusí existovat.
list_directories_and_files	Zobrazí seznam všech adresářů a souborů v adresáři.
list_handles	Zobrazí seznam otevřených popisovačů v adresáři nebo souboru v adresáři.
rename_directory	Přejmenujte zdrojový adresář. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes nebo str :keyword file_creation_time: Čas vytvoření adresáře. :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 pro adresář. 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.
set_directory_metadata	Nastaví metadata pro 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 s prázdným diktem metadat.
set_http_headers	Nastaví hlavičky HTTP v adresáři.
upload_file	Vytvoří nový soubor v adresáři a vrátí ShareFileClient pro interakci se souborem.

close

Tato metoda je zavřít sokety otevřené klientem. Při použití se správcem kontextu se nemusí používat.

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(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

Parametry

recursive: bool

Vyžadováno

Logická hodnota určující, jestli se má operace použít pro adresář určený klientem, jeho soubory, jeho podadresáře a jeho soubory. Výchozí hodnotou je Nepravda.

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

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 diktování.

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 diktování.

Návratový typ

dict[str, int]

create_directory

Vytvoří nový adresář v adresáři odkazovaném klientem.

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

Parametry

file_attributes: NTFSAttributes

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

Čas vytvoření adresáře Výchozí hodnota: "now".

file_last_write_time: str nebo datetime

Čas posledního zápisu adresáře. Výchozí hodnota: "now".

file_permission: str

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 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ěl by být zadán pouze jeden z oprávnění k souboru nebo klíč oprávnění k souboru.

file_permission_key: str

Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Měl by být zadán pouze jeden z oprávnění k souboru nebo klíč oprávnění k souboru.

file_change_time: str nebo datetime

Změňte čas pro adresář. 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.

metadata: dict(str,str)

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

timeout: int

Návraty

Dikt vlastnosti aktualizovaného adresáře (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Příklady

Vytvoří adresář.


   my_directory.create_directory()

create_subdirectory

Vytvoří nový podadresář a vrátí klienta pro interakci s podadresářem.

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

Parametry

directory_name: str

Vyžadováno

Název podadresáře.

metadata: dict(str,str)

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

timeout: int

Návraty

ShareDirectoryClient

Návratový typ

ShareDirectoryClient

Příklady

Vytvořte podadresář.


   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

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

delete_directory(**kwargs: Any) -> None

Parametry

timeout: int

Návratový typ

None

Příklady

Odstraní adresář.


   my_directory.delete_directory()

delete_file

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

delete_file(file_name: str, **kwargs: Any | None) -> None

Parametry

file_name: str

Vyžadováno

Název souboru, který se má odstranit.

timeout: int

Návratový typ

None

Příklady

Odstranění souboru v adresáři


   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

Odstraní podadresář.

delete_subdirectory(directory_name: str, **kwargs) -> None

Parametry

directory_name: str

Vyžadováno

Název podadresáře.

timeout: int

Návratový typ

None

Příklady

Odstraňte podadresář.


   parent_dir.delete_subdirectory("subdir")

exists

Vrátí hodnotu True, pokud adresář existuje, a v opačném případě vrátí hodnotu False.

exists(**kwargs: Any) -> bool

Parametry

timeout: int

Návraty

True, pokud adresář existuje, false v opačném případě.

Návratový typ

bool

from_connection_string

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

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

Parametry

conn_str: str

Vyžadováno

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

share_name: str

Vyžadováno

Název sdílené složky.

directory_path: str

Vyžadováno

Cesta k adresáři.

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

Klient adresáře.

Návratový typ

ShareDirectoryClient

from_directory_url

Vytvořte ShareDirectoryClient z adresy URL adresáře.

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

Parametry

directory_url: str

Vyžadováno

Úplný identifikátor URI adresáře.

snapshot: str

výchozí hodnota: None

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

credential

výchozí hodnota: None

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

Klient adresáře.

Návratový typ

ShareDirectoryClient

get_directory_properties

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

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Parametry

timeout: int

Návraty

Vlastnosti adresáře

Návratový typ

DirectoryProperties

get_file_client

Získejte klienta pro interakci s konkrétním souborem.

Soubor ještě nemusí existovat.

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

Parametry

file_name: str

Vyžadováno

Název souboru.

Návraty

Souborový klient.

Návratový typ

ShareFileClient

get_subdirectory_client

Získejte klienta pro interakci s konkrétním podadresářem.

Podadresář ještě nemusí existovat.

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

Parametry

directory_name: str

Vyžadováno

Název podadresáře.

Návraty

Klient adresáře.

Návratový typ

ShareDirectoryClient

Příklady

Získá klienta podadresáře.


   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

Zobrazí seznam všech adresářů a souborů v adresáři.

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

Parametry

name_starts_with: str

Vyžadováno

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

include: list[str]

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

Novinka ve verzi 12.6.0.

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

include_extended_info: bool

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

Novinka ve verzi 12.6.0.

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

timeout: int

Návraty

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

Návratový typ

ItemPaged[DirectoryProperties <xref:and> FileProperties]

Příklady

Výpis adresářů a souborů.


   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

Zobrazí seznam otevřených popisovačů v adresáři nebo souboru v adresáři.

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

Parametry

recursive: bool

Vyžadováno

Logická hodnota určující, jestli se má operace použít pro adresář určený klientem, jeho soubory, jeho podadresáře a jeho soubory. Výchozí hodnotou je Nepravda.

timeout: int

Návraty

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

Návratový typ

ItemPaged[Handle]

rename_directory

Přejmenujte zdrojový adresář.

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

Čas vytvoření adresáře.

: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 pro adresář. 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_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

Parametry

metadata: Dict[str,str]

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

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 adresáře.

Návratový typ

ShareDirectoryClient

set_directory_metadata

Nastaví metadata pro 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 s prázdným diktem metadat.

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

Parametry

metadata: dict(str, str)

Vyžadováno

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

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného adresáře (značka Etag a poslední změna)

Návratový typ

dict(str, Any)

set_http_headers

Nastaví hlavičky HTTP v adresáři.

set_http_headers(file_attributes: str | NTFSAttributes = 'none', 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

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 pro adresář. 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.

timeout: int

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

Návraty

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

Návratový typ

dict(str, Any)

upload_file

Vytvoří nový soubor v adresáři a vrátí ShareFileClient pro interakci se souborem.

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

Parametry

file_name: str

Vyžadováno

Název souboru.

data

Vyžadováno

Obsah souboru.

length: int

Vyžadováno

Délka souboru v bajtech. Zadejte jeho maximální velikost, až 1 TiB.

metadata: dict(str,str)

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

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.

validate_content: bool

Pokud ano, vypočítá hodnotu hash MD5 pro každou oblast souboru. 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.

max_concurrency: int

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

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

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

timeout: int

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

encoding: str

Výchozí hodnota je UTF-8.

Návraty

ShareFileClient

Návratový typ

ShareFileClient

Příklady

Nahrajte soubor do adresáře.


   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

Atributy

api_version

Verze rozhraní API služby Storage používaná pro požadavky.

location_mode

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

Ve výchozím nastavení 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, vyvolá se chyba ValueError. Pokud chcete explicitně zadat sekundární název hostitele, při vytváření instance použijte volitelný argument secondary_hostname klíčového slova.

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 sekundární název hostitele, při vytváření instance použijte volitelný argument secondary_hostname klíčového slova.

url

Úplná adresa URL koncového bodu této entity, včetně tokenu SAS, pokud se používá.

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