FileSystemClient Osztály

Egy ügyfél, amely egy adott fájlrendszerrel kommunikál, még akkor is, ha ez a fájlrendszer még nem létezik.

A fájlrendszer egy adott könyvtárával vagy fájlával kapcsolatos műveletek esetén a vagy a függvény használatával lekérhető egy get_directory_client címtárügyfél vagy get_file_client fájlügyfél.

Öröklődés

azure.storage.filedatalake._shared.base_client.StorageAccountHostsMixin

FileSystemClient

Konstruktor

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

Paraméterek

account_url

str

Kötelező

A tárfiók URI-ja.

file_system_name

str

Kötelező

A könyvtár vagy fájlok fájlrendszere.

credential

alapértelmezett érték: None

A hitelesítéshez használt hitelesítő adatok. Ez nem kötelező, ha a fiók URL-címe már rendelkezik SAS-jogkivonattal. Az érték lehet SAS-jogkivonat-sztring, egy AzureSasCredential vagy AzureNamedKeyCredential példánya az azure.core.credentials-ből, egy fiók megosztott hozzáférési kulcsa vagy az azure.identity tokencredentials osztályának egy példánya. Ha az erőforrás URI-ja már tartalmaz SAS-jogkivonatot, a rendszer ezt figyelmen kívül hagyja egy explicit hitelesítő adat javára.

• kivéve az AzureSasCredential esetében, ahol az ütköző SAS-jogkivonatok ValueError értéket fognak létrehozni. Ha azureNamedKeyCredential-példányt használ, a "név" a tárfiók neve, a "kulcs" pedig a tárfiók kulcsa.

api_version

str

A kérésekhez használandó Storage API-verzió. Az alapértelmezett érték az aktuális SDK-val kompatibilis legújabb szolgáltatásverzió. A régebbi verzióra való beállítás csökkentett funkciókompatibilitást eredményezhet.

Példák

FileSystemClient lekérése meglévő DataLakeServiceClientből.

   # Instantiate a DataLakeServiceClient using a connection string
   from azure.storage.filedatalake import DataLakeServiceClient
   datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)

   # Instantiate a FileSystemClient
   file_system_client = datalake_service_client.get_file_system_client("mynewfilesystem")

Változók

url

str

A fájlrendszer teljes végponti URL-címe, beleértve az SAS-jogkivonatot is, ha használják.

primary_endpoint

str

A teljes elsődleges végpont URL-címe.

primary_hostname

str

Az elsődleges végpont állomásneve.

Metódusok

acquire_lease	Új bérletet kér. Ha a fájlrendszer nem rendelkezik aktív bérletekkel, a DataLake szolgáltatás létrehoz egy bérletet a fájlrendszerben, és egy új bérletazonosítót ad vissza.
close	Ezzel a módszerrel zárja be az ügyfél által megnyitott szoftvercsatornákat. A környezetkezelővel való használathoz nem szükséges használni.
create_directory	Könyvtár létrehozása
create_file	Fájl létrehozása
create_file_system	Létrehoz egy új fájlrendszert a megadott fiók alatt. Ha az azonos nevű fájlrendszer már létezik, létrejön egy ResourceExistsError. Ez a metódus egy ügyfelet ad vissza, amellyel az újonnan létrehozott fájlrendszerrel kommunikálhat.
delete_directory	A megadott törlési útvonalat jelöli meg.
delete_file	Megjelöli a megadott fájlt törlésre.
delete_file_system	Megjelöli a megadott fájlrendszert törlésre. A fájlrendszer és a benne található fájlok később törlődnek a szemétgyűjtés során. Ha a fájlrendszer nem található, létrejön egy ResourceNotFoundError.
exists	Igaz értéket ad vissza, ha létezik fájlrendszer, és máskülönben Hamis értéket ad vissza.
from_connection_string	Hozza létre a FileSystemClientet kapcsolati sztringből. :return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient
get_directory_client	Kérje le az ügyfelet, hogy kommunikáljon a megadott címtárral. A könyvtárnak még nem kell léteznie.
get_file_client	Kérje le az ügyfelet, hogy kommunikáljon a megadott fájllal. A fájlnak még nem kell léteznie.
get_file_system_access_policy	Lekéri a megadott fájlrendszer engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszer adatai nyilvánosan elérhetők-e.
get_file_system_properties	A megadott fájlrendszer összes felhasználó által definiált metaadatát és rendszertulajdonságát adja vissza. A visszaadott adatok nem tartalmazzák a fájlrendszer elérési útjait.
get_paths	Egy generátort ad vissza a megadott fájlrendszerben lévő elérési utak (fájlok vagy könyvtárak) listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.
list_deleted_paths	Egy generátort ad vissza a törölt (fájl- vagy könyvtár-) elérési utak listázásához a megadott fájlrendszerben. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat. Újdonság a 12.4.0-s verzióban: Ez a művelet a "2020-06-12" API-verzióban jelent meg.
set_file_system_access_policy	Beállítja a megosztott hozzáférésű jogosultságkódokkal használható megadott fájlrendszer vagy tárolt hozzáférési szabályzatok engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszerben lévő fájlok nyilvánosan elérhetők-e.
set_file_system_metadata	Beállít egy vagy több felhasználó által definiált név-érték párt a megadott fájlrendszerhez. A művelet minden hívása lecseréli a fájlrendszerhez csatolt összes meglévő metaadatot. Ha az összes metaadatot el szeretné távolítani a fájlrendszerből, hívja meg ezt a műveletet metaadat-diktálás nélkül.

acquire_lease

Új bérletet kér. Ha a fájlrendszer nem rendelkezik aktív bérletekkel, a DataLake szolgáltatás létrehoz egy bérletet a fájlrendszerben, és egy új bérletazonosítót ad vissza.

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

Paraméterek

lease_duration

int

Kötelező

Megadja a bérlet időtartamát másodpercben, vagy negatívat (-1) egy olyan bérlethez, amely soha nem jár le. A nem végtelen bérlet 15 és 60 másodperc között lehet. A bérlet időtartama nem módosítható megújítással vagy módosítással. Az alapértelmezett érték -1 (végtelen bérlet).

lease_id

str

Kötelező

Javasolt bérletazonosító GUID sztringformátumban. A DataLake szolgáltatás 400(Érvénytelen kérelem) értéket ad vissza, ha a javasolt bérletazonosító nem a megfelelő formátumú.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Egy DataLakeLeaseClient objektum, amely egy környezetkezelőben futtatható.

Visszatérési típus

DataLakeLeaseClient

Példák

Bérlet beszerzése a fájlrendszerben.

   # Acquire a lease on the file system
   lease = file_system_client.acquire_lease()

   # Delete file system by passing in the lease
   file_system_client.delete_file_system(lease=lease)

close

Ezzel a módszerrel zárja be az ügyfél által megnyitott szoftvercsatornákat. A környezetkezelővel való használathoz nem szükséges használni.

close() -> None

create_directory

Könyvtár létrehozása

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

Paraméterek

directory

str vagy DirectoryProperties

Kötelező

Az a könyvtár, amellyel interakciót kell létesíteni. Ez lehet a könyvtár neve vagy a DirectoryProperties példánya.

metadata

dict(str, str)

Kötelező

A fájlhoz metaadatként társított név-érték párok.

content_settings

ContentSettings

Az elérésiút-tulajdonságok beállításához használt ContentSettings objektum.

lease

DataLakeLeaseClient vagy str

Akkor szükséges, ha a fájl aktív bérletet kapott. Az érték lehet DataLakeLeaseClient objektum vagy sztringként a bérletazonosító.

umask

str

Nem kötelező és csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz. Ha fájlt vagy könyvtárat hoz létre, és a szülőmappa nem rendelkezik alapértelmezett ACL-sel, az umask korlátozza a létrehozandó fájl vagy könyvtár engedélyeit. Az eredményül kapott engedélyt a p & ^u adja meg, ahol a p az engedély, ön pedig az umask. Ha például p 0777, és Ön 0057, akkor az eredményként kapott engedély 0720. Az alapértelmezett engedély egy könyvtárhoz a 0777, a fájlhoz pedig a 0666. Az alapértelmezett umask a 0027. Az umaszkot négyjegyű oktális jelölésben kell megadni (pl. 0766).

owner

str

A fájl vagy könyvtár tulajdonosa.

group

str

A fájl vagy könyvtár tulajdonoscsoportja.

acl

str

Beállítja a POSIX hozzáférés-vezérlési jogosultságokat a fájlokon és könyvtárakon. Az érték a hozzáférés-vezérlési bejegyzések vesszővel tagolt listája. Minden hozzáférés-vezérlési bejegyzés (ACE) egy hatókörből, egy típusból, egy felhasználó- vagy csoportazonosítóból és "[scope:][type]:[id]:[permissions]" formátumú engedélyekből áll.

lease_id

str

Javasolt bérletazonosító GUID sztringformátumban. A DataLake szolgáltatás 400(Érvénytelen kérelem) értéket ad vissza, ha a javasolt bérletazonosító nem a megfelelő formátumú.

lease_duration

int

Megadja a bérlet időtartamát másodpercben, vagy negatívat (-1) egy olyan bérlethez, amely soha nem jár le. A nem végtelen bérlet 15 és 60 másodperc között lehet. A bérlet időtartama nem módosítható megújítással vagy módosítással.

permissions

str

Nem kötelező és csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz. BEÁLLÍTJA a POSIX hozzáférési engedélyeit a fájl tulajdonosának, a fájltulajdonos csoportnak és másoknak. Minden osztály kaphat olvasási, írási vagy végrehajtási engedélyt. A ragadós bit is támogatott. A szimbolikus (rwxrw-rw-) és a négyjegyű oktális jelölés (pl. 0766) egyaránt támogatott.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

DataLakeDirectoryClient

Példák

Hozzon létre könyvtárat a fájlrendszerben.

   directory_client = file_system_client.create_directory("mydirectory")

create_file

Fájl létrehozása

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

Paraméterek

file

str vagy FileProperties

Kötelező

Az a fájl, amellyel interakciót kell létesíteni. Ez lehet a fájl neve vagy a FileProperties egy példánya.

content_settings

ContentSettings

Kötelező

Az elérésiút-tulajdonságok beállításához használt ContentSettings objektum.

metadata

dict(str, str)

Kötelező

A fájlhoz metaadatként társított név-érték párok.

lease

DataLakeLeaseClient vagy str

Akkor szükséges, ha a fájl aktív bérletet kapott. Az érték lehet DataLakeLeaseClient objektum vagy sztringként a bérletazonosító.

umask

str

Nem kötelező és csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz. Ha fájlt vagy könyvtárat hoz létre, és a szülőmappa nem rendelkezik alapértelmezett ACL-sel, az umask korlátozza a létrehozandó fájl vagy könyvtár engedélyeit. Az eredményül kapott engedélyt a p & ^u adja meg, ahol a p az engedély, ön pedig az umask. Ha például p 0777, és Ön 0057, akkor az eredményként kapott engedély 0720. Az alapértelmezett engedély egy könyvtárhoz a 0777, a fájlhoz pedig a 0666. Az alapértelmezett umask a 0027. Az umaszkot négyjegyű oktális jelölésben kell megadni (pl. 0766).

owner

str

A fájl vagy könyvtár tulajdonosa.

group

str

A fájl vagy könyvtár tulajdonoscsoportja.

acl

str

Beállítja a POSIX hozzáférés-vezérlési jogosultságokat a fájlokon és könyvtárakon. Az érték a hozzáférés-vezérlési bejegyzések vesszővel tagolt listája. Minden hozzáférés-vezérlési bejegyzés (ACE) egy hatókörből, egy típusból, egy felhasználó- vagy csoportazonosítóból és "[scope:][type]:[id]:[permissions]" formátumú engedélyekből áll.

lease_id

str

Javasolt bérletazonosító GUID sztringformátumban. A DataLake szolgáltatás 400(Érvénytelen kérelem) értéket ad vissza, ha a javasolt bérletazonosító nem a megfelelő formátumú.

lease_duration

int

Megadja a bérlet időtartamát másodpercben, vagy negatívat (-1) egy olyan bérlethez, amely soha nem jár le. A nem végtelen bérlet 15 és 60 másodperc között lehet. A bérlet időtartama nem módosítható megújítással vagy módosítással.

expires_on

datetime vagy int

A fájl lejáratának ideje. Ha a expires_on típusa int, a lejárati idő a létrehozási időtől eltelt ezredmásodpercként lesz beállítva. Ha a expires_on típusa datetime, a lejárati idő abszolút értékre lesz állítva. Ha nincs megadva időzóna-információ, akkor a rendszer UTC-ként értelmezi.

permissions

str

Nem kötelező és csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz. BEÁLLÍTJA a POSIX hozzáférési engedélyeit a fájl tulajdonosának, a fájltulajdonos csoportnak és másoknak. Minden osztály kaphat olvasási, írási vagy végrehajtási engedélyt. A ragadós bit is támogatott. A szimbolikus (rwxrw-rw-) és a négyjegyű oktális jelölés (pl. 0766) egyaránt támogatott.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

DataLakeFileClient

Példák

Hozzon létre egy fájlt a fájlrendszerben.

   file_client = file_system_client.create_file("myfile")

create_file_system

Létrehoz egy új fájlrendszert a megadott fiók alatt.

Ha az azonos nevű fájlrendszer már létezik, létrejön egy ResourceExistsError. Ez a metódus egy ügyfelet ad vissza, amellyel az újonnan létrehozott fájlrendszerrel kommunikálhat.

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

Paraméterek

metadata

dict(str, str)

Kötelező

Név-érték párokkal rendelkező diktálás, amely metaadatokként társítja a fájlrendszert. Példa: {'Category':'test'}

public_access

PublicAccess

Kötelező

Annak megadása, hogy a fájlrendszerben lévő adatok nyilvánosan elérhetők-e, valamint a hozzáférési szint.

encryption_scope_options

dict vagy EncryptionScopeOptions

Megadja az alapértelmezett titkosítási hatókört, amelyet a fájlrendszeren kell beállítani, és az összes jövőbeli íráshoz használni.

Új a 12.9.0-s verzióban.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Válaszfejlécek szótára.

Visszatérési típus

Dict[str, Union[str, datetime]]

Példák

Fájlrendszer létrehozása a datalake szolgáltatásban.

   file_system_client.create_file_system()

delete_directory

A megadott törlési útvonalat jelöli meg.

delete_directory(directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Paraméterek

directory

str vagy DirectoryProperties

Kötelező

Az a könyvtár, amellyel interakciót kell létesíteni. Ez lehet a könyvtár neve vagy a DirectoryProperties példánya.

lease

DataLakeLeaseClient vagy str

Akkor szükséges, ha a fájl aktív bérletet kapott. Az érték lehet LeaseClient objektum vagy sztringként megadott bérletazonosító.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

DataLakeDirectoryClient

Példák

Könyvtár törlése a fájlrendszerben.

   file_system_client.delete_directory("mydirectory")

delete_file

Megjelöli a megadott fájlt törlésre.

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

Paraméterek

file

str vagy FileProperties

Kötelező

Az a fájl, amellyel interakciót kell létesíteni. Ez lehet a fájl neve vagy a FileProperties egy példánya.

lease

DataLakeLeaseClient vagy str

Akkor szükséges, ha a fájl aktív bérletet kapott. Az érték lehet LeaseClient objektum vagy sztringként megadott bérletazonosító.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

DataLakeFileClient

Példák

Fájl törlése a fájlrendszerben.

   file_system_client.delete_file("myfile")

delete_file_system

Megjelöli a megadott fájlrendszert törlésre.

A fájlrendszer és a benne található fájlok később törlődnek a szemétgyűjtés során. Ha a fájlrendszer nem található, létrejön egy ResourceNotFoundError.

delete_file_system(**kwargs: Any) -> None

Paraméterek

lease

str vagy DataLakeLeaseClient

Ha meg van adva, delete_file_system csak akkor sikerül, ha a fájlrendszer bérlete aktív, és megfelel ennek az azonosítónak. Akkor szükséges, ha a fájlrendszer aktív bérletet kapott.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC dátumidőket a rendszer UTC-vé alakítja. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Visszatérési típus

None

Példák

Fájlrendszer törlése az adatlake szolgáltatásban.

   file_system_client.delete_file_system()

exists

Igaz értéket ad vissza, ha létezik fájlrendszer, és máskülönben Hamis értéket ad vissza.

exists(**kwargs: Any) -> bool

Paraméterek

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Igaz, ha létezik fájlrendszer, máskülönben hamis.

Visszatérési típus

bool

from_connection_string

Hozza létre a FileSystemClientet kapcsolati sztringből.

:return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient

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

Paraméterek

conn_str

str

Kötelező

Egy Azure Storage-fiókhoz kapcsolati sztring.

file_system_name

str

Kötelező

A használni kívánt fájlrendszer neve.

credential

alapértelmezett érték: None

A hitelesítéshez használt hitelesítő adatok. Ez nem kötelező, ha a fiók URL-címe már rendelkezik SAS-jogkivonattal, vagy a kapcsolati sztring már rendelkezik közös hozzáférési kulcsértékekkel. Az érték lehet SAS-jogkivonat-sztring, egy AzureSasCredential vagy AzureNamedKeyCredential példánya az azure.core.credentials-ből, egy fiók megosztott hozzáférési kulcsa vagy az azure.identity tokencredentials osztályának egy példánya. Az itt megadott hitelesítő adatok elsőbbséget élveznek a kapcsolati sztring. Ha azureNamedKeyCredential-példányt használ, a "név" a tárfiók neve, a "kulcs" pedig a tárfiók kulcsa.

Példák

FileSystemClient létrehozása kapcsolati sztring

   from azure.storage.filedatalake import FileSystemClient
   file_system_client = FileSystemClient.from_connection_string(self.connection_string, "filesystem")

get_directory_client

Kérje le az ügyfelet, hogy kommunikáljon a megadott címtárral.

A könyvtárnak még nem kell léteznie.

get_directory_client(directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Paraméterek

directory

str vagy DirectoryProperties

Kötelező

Az a könyvtár, amellyel interakciót kell létesíteni. Ez lehet a könyvtár neve vagy a DirectoryProperties példánya.

Válaszok

Egy DataLakeDirectoryClient.

Visszatérési típus

DataLakeDirectoryClient

Példák

A címtárügyfél lekérése egy adott címtárral való interakcióra.

   # Get the DataLakeDirectoryClient from the FileSystemClient to interact with a specific file
   directory_client = file_system_client.get_directory_client("mynewdirectory")

get_file_client

Kérje le az ügyfelet, hogy kommunikáljon a megadott fájllal.

A fájlnak még nem kell léteznie.

get_file_client(file_path: FileProperties | str) -> DataLakeFileClient

Paraméterek

file_path

str vagy FileProperties

Kötelező

Az a fájl, amellyel interakciót kell létesíteni. Ez lehet a fájl elérési útja (a gyökérkönyvtárból), vagy a FileProperties egy példánya. Pl. könyvtár/alkönyvtár/fájl

Válaszok

Egy DataLakeFileClient.

Visszatérési típus

DataLakeFileClient

Példák

A fájlügyfél lekérése egy adott fájllal való interakcióra.

   # Get the FileClient from the FileSystemClient to interact with a specific file
   file_client = file_system_client.get_file_client("mynewfile")

get_file_system_access_policy

Lekéri a megadott fájlrendszer engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszer adatai nyilvánosan elérhetők-e.

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

Paraméterek

lease

DataLakeLeaseClient vagy str

Ha meg van adva, a művelet csak akkor sikeres, ha a fájlrendszer bérlete aktív, és megfelel ennek az azonosítónak.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

Hozzáférési szabályzat adatai a diktálásban.

Visszatérési típus

dict[str, Any]

get_file_system_properties

A megadott fájlrendszer összes felhasználó által definiált metaadatát és rendszertulajdonságát adja vissza. A visszaadott adatok nem tartalmazzák a fájlrendszer elérési útjait.

get_file_system_properties(**kwargs: Any) -> FileSystemProperties

Paraméterek

lease

str vagy DataLakeLeaseClient

Ha meg van adva, get_file_system_properties csak akkor sikerül, ha a fájlrendszer bérlete aktív, és megfelel ennek az azonosítónak.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időtúllépések konfigurálásához lásd itt.

Válaszok

A megadott fájlrendszer tulajdonságai egy fájlrendszer-objektumon belül.

Visszatérési típus

FileSystemProperties

Példák

Tulajdonságok lekérése a fájlrendszerben.

   properties = file_system_client.get_file_system_properties()

get_paths

Egy generátort ad vissza a megadott fájlrendszerben lévő elérési utak (fájlok vagy könyvtárak) listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

get_paths(path: str | None = None, recursive: bool | None = True, max_results: int | None = None, **kwargs) -> ItemPaged[PathProperties]

Paraméterek

path

str

Kötelező

Az eredményeket úgy szűri, hogy csak a megadott elérési út alatti elérési utakat adja vissza.

recursive

Optional[bool]

Kötelező

Választható. Állítsa az Igaz értéket a rekurzív értékhez, a Hamis értéket az iteratív értékhez.

max_results

int

Kötelező

Nem kötelező érték, amely megadja az oldalonként visszaadandó elemek maximális számát. Ha nem adja meg vagy meghaladja az 5000-et, a válasz oldalanként legfeljebb 5000 elemet tartalmaz.

upn

Választható. Csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz. Ha "igaz", az x-ms-owner, az x-ms-group és az x-ms-acl válaszfejlécekben visszaadott felhasználói identitásértékek az Azure Active Directory-objektumazonosítókról egyszerű felhasználónevekké alakulnak át. Ha "false" (hamis) értékeket ad vissza, a rendszer Azure Active Directory-objektumazonosítóként adja vissza az értékeket. Az alapértelmezett érték a hamis. Vegye figyelembe, hogy a csoport- és alkalmazásobjektum-azonosítók nincsenek lefordítva, mert nem rendelkeznek egyedi felhasználóbarát névvel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időkorlátok konfigurálását itt találja.

Válaszok

A PathProperties iterable (automatikus lapozás) válasza.

Visszatérési típus

ItemPaged[PathProperties]

Példák

Sorolja fel a fájlrendszerben található elérési utakat.

   path_list = file_system_client.get_paths()
   for path in path_list:
       print(path.name + '\n')

list_deleted_paths

Egy generátort ad vissza a törölt (fájl- vagy könyvtár-) elérési utak listázásához a megadott fájlrendszerben. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat.

Újdonság a 12.4.0-s verzióban: Ez a művelet a "2020-06-12" API-verzióban jelent meg.

list_deleted_paths(**kwargs: Any) -> ItemPaged[DeletedPathProperties]

Paraméterek

path_prefix

str

Az eredményeket úgy szűri, hogy csak a megadott elérési út alatti elérési utakat adja vissza.

results_per_page

int

Nem kötelező érték, amely az egy oldalonként visszaadandó elemek maximális számát adja meg. Ha nincs megadva vagy nagyobb, mint 5000, a válasz oldalanként legfeljebb 5000 elemet tartalmaz.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időkorlátok konfigurálását itt találja.

Válaszok

A DeletedPathProperties ismétlődő (automatikus lapozási) válasza.

Visszatérési típus

ItemPaged[DeletedPathProperties]

set_file_system_access_policy

Beállítja a megosztott hozzáférésű jogosultságkódokkal használható megadott fájlrendszer vagy tárolt hozzáférési szabályzatok engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszerben lévő fájlok nyilvánosan elérhetők-e.

set_file_system_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Paraméterek

signed_identifiers

dict[str, AccessPolicy]

Kötelező

A fájlrendszerhez társítandó hozzáférési szabályzatok szótára. A szótár legfeljebb 5 elemet tartalmazhat. Egy üres szótár törli a szolgáltatásban beállított hozzáférési szabályzatokat.

public_access

PublicAccess

Kötelező

Annak megadása, hogy a fájlrendszerben lévő adatok nyilvánosan elérhetők-e, valamint a hozzáférési szint.

lease

DataLakeLeaseClient vagy str

Akkor szükséges, ha a fájlrendszer aktív bérletet kapott. Az érték lehet DataLakeLeaseClient objektum vagy sztringként megadott bérletazonosító.

if_modified_since

datetime

Egy datetime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott dátum/idő óta módosult.

if_unmodified_since

datetime

Egy datetime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Adja meg ezt a fejlécet a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időkorlátok konfigurálását itt találja.

Válaszok

Fájlrendszerben frissített tulajdonság dict (Etag és utolsó módosítás).

Visszatérési típus

dict[str, str,

datetime]

set_file_system_metadata

Beállít egy vagy több felhasználó által definiált név-érték párt a megadott fájlrendszerhez. A művelet minden hívása lecseréli a fájlrendszerhez csatolt összes meglévő metaadatot. Ha az összes metaadatot el szeretné távolítani a fájlrendszerből, hívja meg ezt a műveletet metaadat-diktálás nélkül.

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

Paraméterek

metadata

dict[str, str]

Kötelező

A fájlrendszerhez metaadatként társítandó név-érték párokat tartalmazó diktálás. Példa: {'category':'test'}

lease

str vagy DataLakeLeaseClient

Ha meg van adva, set_file_system_metadata csak akkor sikerül, ha a fájlrendszer bérlete aktív, és megfelel ennek az azonosítónak.

if_modified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Ezt a fejlécet csak akkor adja meg a művelet végrehajtásához, ha az erőforrás a megadott időpont óta módosult.

if_unmodified_since

datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC típusú dátum/idő időpontok UTC-vé lesznek konvertálva. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti. Adja meg ezt a fejlécet a művelet végrehajtásához, ha az erőforrás nem lett módosítva a megadott dátum/idő óta.

etag

str

ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően működik-e.

match_condition

MatchConditions

Az etagen használandó egyezési feltétel.

timeout

int

Beállítja a művelet kiszolgálóoldali időtúllépését másodpercben. További információ: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ez az érték nincs nyomon követve vagy érvényesítve az ügyfélen. Az ügyféloldali hálózati időkorlátok konfigurálását itt találja.

Válaszok

filesystem-updated property dict (Etag és utolsó módosítás).

Visszatérési típus

Dict[str, str]

Példák

Metaadatok beállítása a fájlrendszerben.

   # Create key, value pairs for metadata
   metadata = {'type': 'test'}

   # Set metadata on the file system
   file_system_client.set_file_system_metadata(metadata=metadata)

Attribútumok

api_version

A kérésekhez használt Storage API verziója.

location_mode

Az ügyfél által jelenleg használt hely mód.

Alapértelmezés szerint ez lesz az "elsődleges". A beállítások közé tartozik az "elsődleges" és a "másodlagos".

primary_endpoint

A teljes elsődleges végpont URL-címe.

primary_hostname

Az elsődleges végpont állomásneve.

secondary_endpoint

A teljes másodlagos végpont URL-címe, ha konfigurálva van.

Ha nem érhető el, a rendszer létrehoz egy ValueError értéket. Másodlagos állomásnév explicit megadásához használja az opcionális secondary_hostname kulcsszóargumentumot a példányosításkor.

Kivételek

ValueError

secondary_hostname

A másodlagos végpont állomásneve.

Ha nem érhető el, ez Nem lesz. Másodlagos állomásnév explicit megadásához használja az opcionális secondary_hostname kulcsszóargumentumot a példányosításkor.

url

Az entitás teljes végponti URL-címe, beleértve az SAS-jogkivonatot is, ha használják.

Ez lehet az elsődleges végpont vagy a másodlagos végpont az aktuálistól location_modefüggően. :returns: Az entitás teljes végponti URL-címe, beleértve az SAS-jogkivonatot is, ha használják. :rtype: str