Sdílet prostřednictvím


DataLakeDirectoryClient Třída

Klient pro interakci s adresářem DataLake, i když adresář ještě neexistuje.

Pro operace související s konkrétním podadresářem nebo souborem v adresáři je možné načíst klienta adresáře nebo souborového klienta pomocí get_sub_directory_client funkcí nebo get_file_client .

Dědičnost
azure.storage.filedatalake._path_client.PathClient
DataLakeDirectoryClient

Konstruktor

DataLakeDirectoryClient(account_url: str, file_system_name: str, directory_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parametry

account_url
str
Vyžadováno

Identifikátor URI účtu úložiště

file_system_name
str
Vyžadováno

Systém souborů pro adresář nebo soubory.

directory_name
str
Vyžadováno

Celá cesta k adresáři. např. {directory v systému souborů}/{adresář pro interakci}

credential
výchozí hodnota: None

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

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

Příklady

Vytvoření DataLakeServiceClient z připojovacího řetězce


   from azure.storage.filedatalake import DataLakeDirectoryClient
   DataLakeDirectoryClient.from_connection_string(connection_string, "myfilesystem", "mydirectory")

Proměnné

url
str

Úplná adresa URL koncového bodu systému souborů, včetně tokenu SAS, pokud je použit.

primary_endpoint
str

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

primary_hostname
str

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

Metody

acquire_lease

Požádá o nové zapůjčení. Pokud soubor nebo adresář nemá aktivní zapůjčení, služba DataLake vytvoří zapůjčení souboru nebo adresáře a vrátí nové ID zapůjčení.

close

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

create_directory

Vytvořte nový adresář.

create_file

Vytvořte nový soubor a vraťte klienta souboru, se kterým bude interagován.

create_sub_directory

Vytvořte podadresář a vraťte klienta podadresáře pro interakci.

delete_directory

Označí zadaný adresář k odstranění.

delete_sub_directory

Označí zadaný podadresář k odstranění.

exists

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

from_connection_string

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

get_access_control
get_directory_properties

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti adresáře. Nevrací obsah adresáře.

get_file_client

Získejte klienta pro interakci se zadaným souborem.

Soubor ještě nemusí existovat.

get_sub_directory_client

Získejte klienta pro interakci se zadaným podadresářem aktuálního adresáře.

Podadresář podadresář ještě nemusí existovat.

remove_access_control_recursive

Odebere Access Control na cestě a dílčích cestách.

rename_directory

Přejmenujte zdrojový adresář.

set_access_control

Nastavte vlastníka, skupinu, oprávnění nebo seznam řízení přístupu pro cestu.

set_access_control_recursive

Nastaví Access Control na cestu a dílčí cesty.

set_http_headers

Nastaví systémové vlastnosti souboru nebo adresáře.

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

set_metadata

Nastaví jednu nebo více uživatelsky definovaných dvojic název-hodnota pro zadaný systém souborů. Každé volání této operace nahradí všechna existující metadata připojená k systému souborů. Pokud chcete odebrat všechna metadata ze systému souborů, zavolejte tuto operaci bez diktování metadat.

update_access_control_recursive

Upraví Access Control na cestě a dílčích cestách.

acquire_lease

Požádá o nové zapůjčení. Pokud soubor nebo adresář nemá aktivní zapůjčení, služba DataLake vytvoří zapůjčení souboru nebo adresáře a vrátí nové ID zapůjčení.

acquire_lease(lease_duration: int | None = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient

Parametry

lease_duration
int
Vyžadováno

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

lease_id
str
Vyžadováno

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

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

Objekt DataLakeLeaseClient, který lze spustit ve správci kontextu.

Návratový typ

close

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

close() -> None

create_directory

Vytvořte nový adresář.

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

Parametry

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

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

content_settings
ContentSettings

Objekt ContentSettings použitý k nastavení vlastností cesty.

lease
DataLakeLeaseClient nebo str

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

umask
str

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Při vytváření souboru nebo adresáře a nadřazená složka nemá výchozí seznam ACL, umask omezí oprávnění k vytvoření souboru nebo adresáře. Výsledné oprávnění je dáno p & ^u, kde p je oprávnění a vy je umask. Pokud je například p 0777 a vy je 0057, výsledné oprávnění je 0720. Výchozí oprávnění je 0777 pro adresář a 0666 pro soubor. Výchozí umask je 0027. Umask musí být zadán v osmičkovém zápisu se 4 číslicemi (např. 0766).

owner
str

Vlastník souboru nebo adresáře.

group
str

Vlastnící skupina souboru nebo adresáře.

acl
str

Nastaví práva řízení přístupu k souborům a adresářům posix. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu, identifikátoru uživatele nebo skupiny a oprávnění ve formátu [obor:][typ]:[id]:[oprávnění].

lease_id
str

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

lease_duration
int

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

permissions
str

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Nastaví přístupová oprávnění POSIX pro vlastníka souboru, skupinu vlastníka souboru a další. Každé třídě může být uděleno oprávnění ke čtení, zápisu nebo spuštění. Podporuje se také bit sticky. Podporuje se symbolický (rwxrw-rw-) i 4místný osmičkový zápis (např. 0766).

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

cpk
CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes HTTPS.

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-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Slovník hlaviček odpovědi.

Návratový typ

Příklady

Vytvořit adresář.


   directory_client.create_directory()

create_file

Vytvořte nový soubor a vraťte klienta souboru, se kterým bude interagován.

create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Parametry

file
str nebo FileProperties
Vyžadováno

Soubor, se kterým chcete pracovat. Může to být buď název souboru, nebo instance FileVlastnosti.

content_settings
ContentSettings

Objekt ContentSettings použitý k nastavení vlastností cesty.

metadata

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

lease
DataLakeLeaseClient nebo str

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

umask
str

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Při vytváření souboru nebo adresáře a nadřazená složka nemá výchozí seznam ACL, umask omezí oprávnění k vytvoření souboru nebo adresáře. Výsledné oprávnění je dáno p & ^u, kde p je oprávnění a vy je umask. Pokud je například p 0777 a vy je 0057, výsledné oprávnění je 0720. Výchozí oprávnění je 0777 pro adresář a 0666 pro soubor. Výchozí umask je 0027. Umask musí být zadán v osmičkovém zápisu se 4 číslicemi (např. 0766).

owner
str

Vlastník souboru nebo adresáře.

group
str

Vlastnící skupina souboru nebo adresáře.

acl
str

Nastaví práva řízení přístupu k souborům a adresářům posix. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu, identifikátoru uživatele nebo skupiny a oprávnění ve formátu [obor:][typ]:[id]:[oprávnění].

lease_id
str

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

lease_duration
int

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

expires_on
datetime nebo int

Doba, po které se má soubor nastavit na vypršení platnosti. Pokud je typ expires_on int, nastaví se doba vypršení platnosti jako počet milisekund, které uplynuly od doby vytvoření. Pokud je typ expires_on datetime, nastaví se doba vypršení platnosti absolutní na zadaný čas. Pokud nejsou k dispozici žádné informace o časovém pásmu, budou tyto informace interpretovány jako UTC.

permissions
str

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Nastaví přístupová oprávnění POSIX pro vlastníka souboru, skupinu vlastníka souboru a další. Každé třídě může být uděleno oprávnění ke čtení, zápisu nebo spuštění. Podporuje se také bit sticky. Podporuje se symbolický (rwxrw-rw-) i 4místný osmičkový zápis (např. 0766).

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

cpk
CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes HTTPS.

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

DataLakeFileClient

create_sub_directory

Vytvořte podadresář a vraťte klienta podadresáře pro interakci.

create_sub_directory(sub_directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient

Parametry

sub_directory
str nebo DirectoryProperties
Vyžadováno

Adresář, se kterým chcete pracovat. Může to být buď název adresáře, nebo instance DirectoryProperties.

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

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

content_settings
ContentSettings

Objekt ContentSettings použitý k nastavení vlastností cesty.

lease
DataLakeLeaseClient nebo str

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

umask
str

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Při vytváření souboru nebo adresáře a nadřazená složka nemá výchozí seznam ACL, umask omezí oprávnění k vytvoření souboru nebo adresáře. Výsledné oprávnění je dáno p & ^u, kde p je oprávnění a vy je umask. Pokud je například p 0777 a vy je 0057, výsledné oprávnění je 0720. Výchozí oprávnění je 0777 pro adresář a 0666 pro soubor. Výchozí umask je 0027. Umask musí být zadán v osmičkovém zápisu se 4 číslicemi (např. 0766).

owner
str

Vlastník souboru nebo adresáře.

group
str

Vlastnící skupina souboru nebo adresáře.

acl
str

Nastaví práva řízení přístupu k souborům a adresářům posix. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu, identifikátoru uživatele nebo skupiny a oprávnění ve formátu [obor:][typ]:[id]:[oprávnění].

lease_id
str

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

lease_duration
int

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

permissions
str

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Nastaví přístupová oprávnění POSIX pro vlastníka souboru, skupinu vlastníka souboru a další. Každé třídě může být uděleno oprávnění ke čtení, zápisu nebo spuštění. Podporuje se také bit sticky. Podporuje se symbolický (rwxrw-rw-) i 4místný osmičkový zápis (např. 0766).

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

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

cpk
CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes protokol HTTPS.

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

DataLakeDirectoryClient pro podadresář.

delete_directory

Označí zadaný adresář k odstranění.

delete_directory(**kwargs) -> None

Parametry

lease
DataLakeLeaseClient nebo str

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

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

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

Žádné

Příklady

Odstranit adresář.


   new_directory.delete_directory()

delete_sub_directory

Označí zadaný podadresář k odstranění.

delete_sub_directory(sub_directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Parametry

sub_directory
str nebo DirectoryProperties
Vyžadováno

Adresář, se kterým chcete pracovat. Může to být buď název adresáře, nebo instance DirectoryVlastnosti.

lease
DataLakeLeaseClient nebo str

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

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

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

DataLakeDirectoryClient pro podadresář

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

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-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

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

Návratový typ

from_connection_string

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

from_connection_string(conn_str: str, file_system_name: str, directory_name: 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.

file_system_name
str
Vyžadováno

Název systému souborů, se kterým chcete pracovat.

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ě.
directory_name
str
Vyžadováno

Název adresáře, se kterým chcete pracovat. Adresář je v systému souborů.

credential
Vyžadováno

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už má token SAS nebo pokud připojovací řetězec už obsahuje hodnoty sdíleného přístupového klíče. 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. Přihlašovací údaje uvedené tady budou mít přednost před přihlašovacími údaji v připojovacím řetězci. Pokud používáte instanci AzureNamedKeyCredential, název by měl být název účtu úložiště a klíč by měl být klíč účtu úložiště.

Návraty

DataLakeDirectoryClient

Návratový typ

get_access_control

get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]

Parametry

upn
bool
Vyžadováno

Nepovinný parametr. Platí pouze v případě, že je pro účet povolený hierarchický obor názvů. Pokud je hodnota true, hodnoty identity uživatele vrácené v hlavičce odpovědí x-ms-owner, x-ms-group a x-ms-acl se transformují z ID objektů Azure Active Directory na hlavní názvy uživatelů. Pokud je hodnota false, vrátí se hodnoty jako ID objektů Azure Active Directory. Výchozí hodnota je False. Id objektů skupin a aplikací se nepřekládají, protože nemají jedinečné popisné názvy.

lease
DataLakeLeaseClient nebo str

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

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

response dict

dikt odpovědi.

get_directory_properties

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti adresáře. Nevrací obsah adresáře.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Parametry

lease
DataLakeLeaseClient nebo str

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

cpk
CustomerProvidedEncryptionKey

Dešifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes HTTPS. Vyžaduje se, pokud byl adresář vytvořen s klíčem poskytnutým zákazníkem.

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-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

Příklady

Získání vlastností souboru nebo adresáře


   props = new_directory.get_directory_properties()

get_file_client

Získejte klienta pro interakci se zadaným souborem.

Soubor ještě nemusí existovat.

get_file_client(file: FileProperties | str) -> DataLakeFileClient

Parametry

file
str nebo FileProperties
Vyžadováno

Soubor, se kterým chcete pracovat. Může to být buď název souboru, nebo instance FileVlastnosti. Např. adresář/podadresář/soubor

Návraty

A DataLakeFileClient.

Návratový typ

get_sub_directory_client

Získejte klienta pro interakci se zadaným podadresářem aktuálního adresáře.

Podadresář podadresář ještě nemusí existovat.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parametry

sub_directory
str nebo DirectoryProperties
Vyžadováno

Adresář, se kterým chcete pracovat. Může to být buď název adresáře, nebo instance DirectoryProperties.

Návraty

A DataLakeDirectoryClient.

Návratový typ

remove_access_control_recursive

Odebere Access Control na cestě a dílčích cestách.

remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parametry

acl
str
Vyžadováno

Odebere práva řízení přístupu poSIX k souborům a adresářům. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu a identifikátoru uživatele nebo skupiny ve formátu "[scope:][type]:[id]".

progress_hook
<xref:func>(AccessControlChanges)

Zpětné volání, kde volající může sledovat průběh operace a shromažďovat cesty, které se nepodařilo změnit Access Control.

continuation_token
str

Volitelný pokračovací token, který lze použít k obnovení dříve zastavené operace.

batch_size
int

Nepovinný parametr. Pokud velikost datové sady překročí velikost dávky, rozdělí se operace do několika požadavků, aby bylo možné sledovat průběh. Velikost dávky by měla být mezi 1 a 2000. Výchozí hodnota, pokud není zadána, je 2000.

max_batches
int

Nepovinný parametr. Definuje maximální počet dávek, které může provést jedna změna Access Control operace. Pokud je dosaženo maxima před zpracováním všech dílčích cest, můžete k obnovení operace použít pokračovací token. Prázdná hodnota označuje, že maximální počet dávek v nevázaných a operace pokračuje až do konce.

continue_on_failure
bool

Pokud je nastavená hodnota False, operace se při výskytu uživatelských chyb (4XX) rychle ukončí. Pokud je hodnota True, operace bude ignorovat chyby uživatele a pokračovat v operaci u jiných dílčích entit adresáře. Token pokračování se vrátí pouze v případě, že continue_on_failure má hodnotu True v případě chyb uživatele. Pokud není nastavená výchozí hodnota pro tuto hodnotu 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-blob-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

Souhrn rekurzivních operací, včetně počtu úspěšných a neúspěšných operací, a také token pokračování v případě předčasného ukončení operace.

Návratový typ

Výjimky

Uživatel může operaci restartovat pomocí continuation_token pole AzureError, pokud je token k dispozici.

rename_directory

Přejmenujte zdrojový adresář.

rename_directory(new_name: str, **kwargs: Any) -> DataLakeDirectoryClient

Parametry

new_name
str
Vyžadováno

název nového adresáře, na který chce uživatel přejmenovat. Hodnota musí mít následující formát: {filesystem}/{directory}/{podadresář}.

source_lease
DataLakeLeaseClient nebo str

ID zapůjčení zdrojové cesty. Pokud je zadáno, musí mít zdrojová cesta aktivní zapůjčení a ID zapůjčení se musí shodovat.

lease
DataLakeLeaseClient nebo str

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

source_if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

source_if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

source_etag
str

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

source_match_condition
MatchConditions

Podmínka shody zdroje, která se má použít u značky etag.

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

DataLakeDirectoryClient

Příklady

Přejmenujte zdrojový adresář.


   new_dir_name = "testdir2"
   print("Renaming the directory named '{}' to '{}'.".format(dir_name, new_dir_name))
   new_directory = directory_client\
       .rename_directory(new_name=directory_client.file_system_name + '/' + new_dir_name)

set_access_control

Nastavte vlastníka, skupinu, oprávnění nebo seznam řízení přístupu pro cestu.

set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]

Parametry

owner
str
Vyžadováno

Nepovinný parametr. Vlastník souboru nebo adresáře.

group
str
Vyžadováno

Nepovinný parametr. Vlastnící skupina souboru nebo adresáře.

permissions
str
Vyžadováno

Volitelné a platné pouze v případě, že je pro účet povolený hierarchický obor názvů. Nastaví přístupová oprávnění POSIX pro vlastníka souboru, skupinu, která soubor vlastní, a další. Každá třída může mít udělené oprávnění ke čtení, zápisu nebo spuštění. Podporuje se také bit sticky. Podporují se symbolické (rwxrw-rw-) i 4místné osmičkové notace (např. 0766). oprávnění a seznam ACL se vzájemně vylučují.

acl
str
Vyžadováno

Nastaví přístupová práva POSIX k souborům a adresářům. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu, identifikátoru uživatele nebo skupiny a oprávnění ve formátu "[obor:][typ]:[id]:[oprávnění]". oprávnění a seznam ACL se vzájemně vylučují.

lease
DataLakeLeaseClient nebo str

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

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

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

response dict

response dict (Etag a last modified).

set_access_control_recursive

Nastaví Access Control na cestu a dílčí cesty.

set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parametry

acl
str
Vyžadováno

Nastaví přístupová práva POSIX k souborům a adresářům. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu, identifikátoru uživatele nebo skupiny a oprávnění ve formátu "[obor:][typ]:[id]:[oprávnění]".

progress_hook
<xref:func>(AccessControlChanges)

Zpětné volání, kde volající může sledovat průběh operace a shromažďovat cesty, které se nepodařilo změnit Access Control.

continuation_token
str

Volitelný pokračovací token, který lze použít k obnovení dříve zastavené operace.

batch_size
int

Nepovinný parametr. Pokud velikost datové sady překročí velikost dávky, operace se rozdělí do několika požadavků, aby bylo možné sledovat průběh. Velikost dávky by měla být mezi 1 a 2000. Výchozí hodnota, pokud není zadána, je 2000.

max_batches
int

Nepovinný parametr. Definuje maximální počet dávek, které může provést jedna změna Access Control operaci. Pokud je před zpracováním všech dílčích cest dosaženo maxima, můžete k obnovení operace použít pokračovací token. Prázdná hodnota označuje, že maximální počet dávek v nevázaných a operace pokračuje až do konce.

continue_on_failure
bool

Pokud je nastavená hodnota False, operace se při výskytu uživatelských chyb (4XX) rychle ukončí. Pokud je hodnota True, operace bude ignorovat chyby uživatele a pokračovat v operaci v jiných dílčích entitách adresáře. Token pro pokračování se vrátí jenom v případě, že continue_on_failure má hodnotu True v případě chyb uživatele. Pokud není nastavená, výchozí hodnota je false.

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

Souhrn rekurzivních operací, včetně počtu úspěšných a neúspěšných operací, a také token pro pokračování v případě předčasného ukončení operace.

Návratový typ

Výjimky

Uživatel může operaci restartovat pomocí continuation_token pole AzureError, pokud je token k dispozici.

set_http_headers

Nastaví systémové vlastnosti souboru nebo adresáře.

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

set_http_headers(content_settings: ContentSettings | None = None, **kwargs) -> Dict[str, Any]

Parametry

content_settings
ContentSettings
Vyžadováno

ContentSettings Objekt použitý k nastavení vlastností souboru nebo adresáře.

lease
DataLakeLeaseClient nebo str

Pokud zadáte hodnotu, set_file_system_metadata bude úspěšná jenom v případě, že je aktivní zapůjčení systému souborů a odpovídá tomuto ID.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

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

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

file/directory-updated property dict (Etag a last modified)

Návratový typ

set_metadata

Nastaví jednu nebo více uživatelsky definovaných dvojic název-hodnota pro zadaný systém souborů. Každé volání této operace nahradí všechna existující metadata připojená k systému souborů. Pokud chcete odebrat všechna metadata ze systému souborů, zavolejte tuto operaci bez diktování metadat.

set_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]

Parametry

metadata
Dict[str, str]
Vyžadováno

Dict obsahující páry název-hodnota, které se přidruží k systému souborů jako metadata. Příklad: {'category':'test'}

lease
DataLakeLeaseClient nebo str

Pokud zadáte hodnotu, set_file_system_metadata bude úspěšná jenom v případě, že je aktivní zapůjčení systému souborů a odpovídá tomuto ID.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

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

match_condition
MatchConditions

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

cpk
CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes protokol HTTPS.

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

dict vlastnosti aktualizovaného systému souborů (značka Etag a naposledy změněno).

update_access_control_recursive

Upraví Access Control na cestě a dílčích cestách.

update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parametry

acl
str
Vyžadováno

Upraví práva řízení přístupu k souborům a adresářům posix. Hodnota je čárkami oddělený seznam položek řízení přístupu. Každá položka řízení přístupu (ACE) se skládá z oboru, typu, identifikátoru uživatele nebo skupiny a oprávnění ve formátu "[obor:][typ]:[id]:[oprávnění]".

progress_hook
<xref:func>(AccessControlChanges)

Zpětné volání, kde volající může sledovat průběh operace a shromažďovat cesty, které se nepodařilo změnit Access Control.

continuation_token
str

Volitelný pokračovací token, který lze použít k obnovení dříve zastavené operace.

batch_size
int

Nepovinný parametr. Pokud velikost datové sady překročí velikost dávky, operace se rozdělí do několika požadavků, aby bylo možné sledovat průběh. Velikost dávky by měla být mezi 1 a 2000. Výchozí hodnota, pokud není zadána, je 2000.

max_batches
int

Nepovinný parametr. Definuje maximální počet dávek, které může provést jedna změna Access Control operaci. Pokud je před zpracováním všech dílčích cest dosaženo maxima, můžete k obnovení operace použít pokračovací token. Prázdná hodnota označuje, že maximální počet dávek v nevázaných a operace pokračuje až do konce.

continue_on_failure
bool

Pokud je nastavená hodnota False, operace se při výskytu uživatelských chyb (4XX) rychle ukončí. Pokud je hodnota True, operace bude ignorovat chyby uživatele a pokračovat v operaci v jiných dílčích entitách adresáře. Token pro pokračování se vrátí jenom v případě, že continue_on_failure má hodnotu True v případě chyb uživatele. Pokud není nastavená, výchozí hodnota je false.

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

Souhrn rekurzivních operací, včetně počtu úspěšných a neúspěšných operací, a také token pro pokračování v případě předčasného ukončení operace.

Návratový typ

Výjimky

Uživatel může operaci restartovat pomocí continuation_token pole AzureError, pokud je token k dispozici.

Atributy

api_version

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

location_mode

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

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

primary_endpoint

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

primary_hostname

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

secondary_endpoint

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

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

Výjimky

secondary_hostname

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

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

url

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

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