azure.storage.filedatalake.DataLakeFileClient class

Új bérletet kér. Ha a fájl vagy könyvtár nem rendelkezik aktív bérletekkel, a DataLake szolgáltatás létrehoz egy bérletet a fájlon/könyvtáron, és egy új bérletazonosítót ad vissza.

acquire_lease(lease_duration: int | None = -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ív (-1) egy olyan bérlet esetén, 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-et ad vissza (érvénytelen kérés), 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 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

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

Visszatérési típus

DataLakeLeaseClient

Adatok hozzáfűzése a fájlhoz.

append_data(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], offset: int, length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Paraméterek

data

Kötelező

A fájlhoz hozzáfűzendő tartalom

offset

Kötelező

a hozzáfűzendő adatok kezdőpozíciója.

length

Kötelező

Az adatok mérete bájtban.

flush: bool

Ha igaz, a hozzáfűzés után véglegesíti az adatokat.

validate_content: bool

Ha igaz, kiszámítja a blokktartalom MD5-kivonatát. A tárolási szolgáltatás ellenőrzi annak a tartalomnak a kivonatát, amely az elküldött kivonattal érkezett. Ez elsősorban akkor hasznos, ha bitflipeket észlel a vezetéken, ha a https helyett http-t használ, mivel a https (alapértelmezett) már érvényesíthető. Vegye figyelembe, hogy ez az MD5-kivonat nem a fájllal együtt van tárolva.

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

A bérletműveletek és az adatok hozzáfűzésére szolgál.

"acquire" – Bérlet beszerzése. "automatikus megújítás" – Meglévő bérlet újbóli létrehozása. "release" – A művelet befejezése után engedje fel a bérletet. Flush =True értéket igényel. "acquire-release" – Bérlet beszerzése és felszabadítása a műveletek befejezése után. Flush =True értéket igényel.

lease_duration: int

Akkor érvényes , ha lease_action "acquire" vagy "acquire-release" értékre van állítva.

Megadja a bérlet időtartamát másodpercben vagy negatív (-1) egy olyan bérlet esetén, 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: DataLakeLeaseClient vagy str

Kötelező, ha a fájl aktív bérlettel rendelkezik, vagy lease_action "acquire" vagy "acquire-release" értékre van állítva. Ha a fájl rendelkezik meglévő bérlettal, a rendszer ezt fogja használni a fájl eléréséhez. Ha új bérletet szerez be, a rendszer ezt fogja használni új bérletazonosítóként. Az érték lehet DataLakeLeaseClient objektum vagy sztringként megadott bérletazonosító.

cpk: CustomerProvidedEncryptionKey

A szolgáltatásoldali adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni.

Válaszok

a válaszfejléc diktálása

Példák

Adatok hozzáfűzése a fájlhoz.


   file_client.append_data(data=file_content[2048:3072], offset=2048, length=1024)

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

close() -> None

Hozzon létre egy új fájlt.

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

Paraméterek

content_settings: ContentSettings

Kötelező

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

metadata: Optional[Dict[str, str]]

Kötelező

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

lease: DataLakeLeaseClient vagy str

Kötelező, ha a fájl aktív bérletet kapott. Az érték lehet DataLakeLeaseClient objektum vagy sztringként megadott bérletazonosító.

umask: str

Nem kötelező, és csak akkor érvényes, ha a fiókhoz engedélyezve van a hierarchikus névtér. Amikor 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ényként kapott engedélyt a p & ^u adja meg, ahol 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 a 0777 egy könyvtárhoz és a 0666 egy fájlhoz. 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.

cpk: CustomerProvidedEncryptionKey

A szolgáltatás oldalán lévő adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni.

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.

encryption_context: str

Megadja a fájlon beállítani kívánt titkosítási környezetet.

Válaszok

response dict (Etag és utolsó módosítás).

Példák

Fájl létrehozása.


   file_client = filesystem_client.get_file_client(file_name)
   file_client.create_file()

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

delete_file(**kwargs) -> None

Paraméterek

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

None

Példák

Fájl törlése.


   new_client.delete_file()

Letölt egy fájlt a StorageStreamDownloaderbe. A readall() metódust kell használni az összes tartalom olvasásához, vagy a readinto() metódust kell használni a fájl streambe való letöltéséhez. Az adattömbök() használatával egy iterátort ad vissza, amely lehetővé teszi a felhasználó számára, hogy az adattömbök tartalma fölött iteráljon.

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

Paraméterek

offset: int

Kötelező

A fájl egy szakaszának letöltéséhez használandó bájttartomány kezdete. Meg kell adni, ha a hossz meg van adva.

length: int

Kötelező

A streamből beolvasandó bájtok száma. Ez nem kötelező, de az optimális teljesítmény érdekében kell megadni.

lease: DataLakeLeaseClient vagy str

Ha meg van adva, a letöltés csak akkor sikeres, ha a fájl bérlete aktív, és megfelel ennek az azonosítónak. Akkor szükséges, ha a fájl 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.

cpk: CustomerProvidedEncryptionKey

A szolgáltatásoldalon lévő adatok visszafejtése a megadott kulccsal. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni. Akkor szükséges, ha a fájlt egy Customer-Provided kulccsal hozták létre.

max_concurrency: int

Azoknak a párhuzamos kapcsolatoknak a száma, amelyekkel le kell tölteni.

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. Ez a metódus több hívást is indíthat a szolgáltatáshoz, és az időtúllépés minden hívásra külön-külön érvényes lesz.

Válaszok

Streamobjektum (StorageStreamDownloader)

Visszatérési típus

StorageStreamDownloader

Példák

Adja vissza a letöltött adatokat.


   download = file_client.download_file()
   downloaded_bytes = download.readall()

Igaz értéket ad vissza, ha egy fájl létezik, é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őkorlátok konfigurálását itt találja.

Válaszok

Igaz, ha létezik fájl, ellenkező esetben Hamis értéket ad vissza.

Visszatérési típus

bool

Véglegesítse az előző hozzáfűzött adatokat.

flush_data(offset: int, retain_uncommitted_data: bool | None = False, **kwargs) -> Dict[str, str | datetime]

Paraméterek

offset

Kötelező

az eltolás megegyezik a fájl hosszával az előző hozzáfűzött adatok véglegesítése után.

retain_uncommitted_data: bool

Kötelező

Csak kiürítési műveletekhez érvényes. Ha "igaz", a kiürítési művelet befejeződése után a nem véglegesített adatok megmaradnak; ellenkező esetben a kiürítési művelet után a nem véglegesített adatok törlődnek. Az alapértelmezett érték hamis. Ha a kiürítés sikeres, a megadott pozíciónál kisebb eltolású adatok kerülnek a fájlba, de ez az opcionális paraméter lehetővé teszi, hogy a kiürítési pozíció utáni adatok megmaradjanak egy későbbi kiürítési művelethez.

content_settings: ContentSettings

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

close: bool

Az Azure Storage-események lehetővé teszik, hogy az alkalmazások értesítéseket kapjanak a fájlok módosításakor. Ha az Azure Storage-események engedélyezve vannak, egy fájlmódosítási esemény jön létre. Ennek az eseménynek van egy tulajdonsága, amely azt jelzi, hogy ez-e az utolsó változás, amely megkülönbözteti a köztes kiürítés és a fájlstream végső bezárása közötti különbséget. A lekérdezés bezárása paraméter csak akkor érvényes, ha a művelet "kiürítés" és a változásértesítések engedélyezve vannak. Ha a bezárás értéke "igaz", és a kiürítési művelet sikeresen befejeződik, a szolgáltatás fájlmódosítási értesítést küld egy tulajdonsággal, amely jelzi, hogy ez a végleges frissítés (a fájlstream lezárult). Ha "false" (hamis) érték jelenik meg, a rendszer változásértesítést küld, amely jelzi, hogy a fájl megváltozott. Az alapértelmezett érték hamis. Ezt a lekérdezési paramétert a Hadoop ABFS-illesztő igaz értékre állítja, jelezve, hogy a fájlstream lezárult."

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.

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

A bérletműveletek és az adatok hozzáfűzésére szolgál.

"acquire" – Bérlet beszerzése. "automatikus megújítás" – Meglévő bérlet újbóli létrehozása. "release" – A művelet befejezése után engedje fel a bérletet. "acquire-release" – Bérlet beszerzése és felszabadítása a műveletek befejezése után.

lease_duration: int

Akkor érvényes , ha lease_action "acquire" vagy "acquire-release" értékre van állítva.

Megadja a bérlet időtartamát másodpercben vagy negatív (-1) egy olyan bérlet esetén, 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: DataLakeLeaseClient vagy str

Kötelező, ha a fájl aktív bérlettel rendelkezik, vagy lease_action "acquire" vagy "acquire-release" értékre van állítva. Ha a fájl rendelkezik meglévő bérlettal, a rendszer ezt fogja használni a fájl eléréséhez. Ha új bérletet szerez be, a rendszer ezt fogja használni új bérletazonosítóként. Az érték lehet DataLakeLeaseClient objektum vagy sztringként megadott bérletazonosító.

cpk: CustomerProvidedEncryptionKey

A szolgáltatásoldali adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni.

Válaszok

válaszfejléc a diktálásban

Példák

Véglegesítse az előző hozzáfűzött adatokat.


   with open(SOURCE_FILE, "rb") as data:
       file_client = file_system_client.get_file_client("myfile")
       file_client.create_file()
       file_client.append_data(data, 0)
       file_client.flush_data(data.tell())

DataLakeFileClient létrehozása kapcsolati sztringből.

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

from_connection_string(conn_str: str, file_system_name: str, file_path: 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ókra kapcsolati sztring.

file_system_name: str

Kötelező

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

file_path: str

Kötelező

A teljes fájl elérési útja, hogy egy adott fájllal kommunikáljon. például: "{directory}/{subdirectory}/{file}"

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, az AzureSasCredential vagy az 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 az AzureNamedKeyCredential egy példányát használja, a "name" legyen a tárfiók neve, a "kulcs" pedig a tárfiók kulcsa.

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

Paraméterek

upn: bool

Kötelező

Választható. Csak akkor érvényes, ha a fiókhoz engedélyezve van a hierarchikus névtér. 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ókbó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.

lease: DataLakeLeaseClient vagy str

Kötelező, ha a fájl/könyvtár 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 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.

response dict

válasz dict.

A felhasználó által definiált összes metaadatot, szabványos HTTP-tulajdonságot és rendszertulajdonságokat adja vissza a fájlhoz. Nem adja vissza a fájl tartalmát.

get_file_properties(**kwargs: Any) -> FileProperties

Paraméterek

lease

Akkor szükséges, ha a könyvtár vagy fájl rendelkezik aktív bérlettal. Az érték lehet DataLakeLeaseClient 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 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.

cpk: CustomerProvidedEncryptionKey

A szolgáltatás oldalán lévő adatok visszafejtése a megadott kulccsal. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni. Kötelező, ha a fájlt ügyfél által megadott kulccsal hozták létre.

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 fájlhoz tartozó összes felhasználó által definiált metaadat, szabványos HTTP-tulajdonság és rendszertulajdonság.

Visszatérési típus

FileProperties

Példák

Fájl tulajdonságainak lekérése.


   properties = file_client.get_file_properties()

Lehetővé teszi a felhasználók számára, hogy egyszerű lekérdezési kifejezések megadásával kiválasztják vagy kivetítik az adatlake-fájladatokat. Ez a művelet egy DataLakeFileQueryReadert ad vissza, a felhasználóknak a readall() vagy a readinto() parancsot kell használniuk a lekérdezési adatok lekéréséhez.

query_file(query_expression: str, **kwargs: Any) -> DataLakeFileQueryReader

Paraméterek

query_expression: str

Kötelező

Kötelező. egy lekérdezési utasítást. például: Válassza a * lehetőséget a DataLakeStorage-ból

on_error: Callable[DataLakeFileQueryError]

A szolgáltatás által visszaadott feldolgozási hibák esetén meghívandó függvény.

file_format: DelimitedTextDialect vagy DelimitedJsonDialect vagy QuickQueryDialect vagy str

Választható. Meghatározza a fájlban jelenleg tárolt adatok szerializálását. Az alapértelmezett beállítás a fájladatok csV-adatokként való kezelése, amely az alapértelmezett dialektusban van formázva. Ez felülbírálható egyéni DelimitedTextDialect, DelimitedJsonDialect vagy "ParquetDialect" (sztringként vagy számként átadva). Ezek a dialektusok átadhatók a megfelelő osztályokon, a QuickQueryDialect enumeráláson vagy sztringként.

output_format: DelimitedTextDialect vagy DelimitedJsonDialect vagy list[ArrowDialect] vagy QuickQueryDialect vagy str

Választható. Meghatározza az adatfolyam kimeneti szerializálását. Alapértelmezés szerint a rendszer visszaadja az adatokat, ahogy az a fájlban szerepel. A kimeneti formátum megadásával a fájladatok az adott profilnak megfelelően lesznek újraformálva. Ez az érték lehet DelimitedTextDialect, DelimitedJsonDialect vagy ArrowDialect. Ezek a dialektusok átadhatók a megfelelő osztályokon, a QuickQueryDialect enumeráláson vagy sztringként.

lease: DataLakeLeaseClient vagy str

Kötelező, ha a fájl aktív bérletet kapott. Az érték lehet DataLakeLeaseClient 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 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.

cpk: CustomerProvidedEncryptionKey

A szolgáltatás oldalán lévő adatok visszafejtése a megadott kulccsal. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni. Kötelező, ha a fájlt Customer-Provided kulccsal hozták létre.

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

Streamelési objektum (DataLakeFileQueryReader)

Visszatérési típus

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Példák

select/project on datalake file data by providing simple query expressions.


   errors = []
   def on_error(error):
       errors.append(error)

   # upload the csv file
   file_client = datalake_service_client.get_file_client(filesystem_name, "csvfile")
   file_client.upload_data(CSV_DATA, overwrite=True)

   # select the second column of the csv file
   query_expression = "SELECT _2 from DataLakeStorage"
   input_format = DelimitedTextDialect(delimiter=',', quotechar='"', lineterminator='\n', escapechar="", has_header=False)
   output_format = DelimitedJsonDialect(delimiter='\n')
   reader = file_client.query_file(query_expression, on_error=on_error, file_format=input_format, output_format=output_format)
   content = reader.readall()

Eltávolítja a Access Control egy elérési úton és az alútvonalakon.

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

Paraméterek

acl: str

Kötelező

Eltávolí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 és egy felhasználó- vagy csoportazonosítóból áll a következő formátumban: "[scope:][type]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

Visszahívás, ahol a hívó nyomon követheti a művelet előrehaladását, valamint összegyűjtheti azokat az elérési utakat, amelyek nem módosíthatók Access Control.

continuation_token: str

Nem kötelező folytatási jogkivonat, amely a korábban leállított művelet folytatásához használható.

batch_size: int

Választható. Ha az adathalmaz mérete meghaladja a köteg méretét, a művelet több kérelemre lesz felosztva, hogy nyomon lehessen követni az előrehaladást. A köteg méretének 1 és 2000 közé kell esnie. Ha nincs meghatározva, az alapértelmezett érték 2000.

max_batches: int

Választható. Meghatározza azoknak a kötegeknek a maximális számát, amelyeket egyetlen módosítás Access Control művelet hajthat végre. Ha az összes alútvonal feldolgozása előtt eléri a maximális értéket, akkor a folytatási jogkivonat használható a művelet folytatásához. Az üres érték azt jelzi, hogy a kötetlen kötegek maximális száma és a művelet a végéig folytatódik.

continue_on_failure: bool

Ha False (Hamis) értékre van állítva, a művelet gyorsan leáll, ha felhasználói hibákba ütközik (4XX). Ha igaz, a művelet figyelmen kívül hagyja a felhasználói hibákat, és folytatja a műveletet a címtár más alentitásainál. A folytatási jogkivonat csak akkor lesz visszaadva, ha continue_on_failure igaz felhasználói hibák esetén. Ha nincs beállítva, az alapértelmezett érték False (Hamis).

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 rekurzív műveletek összegzése, beleértve a sikeres és sikertelen műveletek számát, valamint egy folytatási jogkivonatot arra az esetre, ha a művelet idő előtt leállt.

Visszatérési típus

AccessControlChangeResult

Kivételek

AzureError

Ha a jogkivonat elérhető, a felhasználó újraindíthatja a műveletet az AzureError continuation_token mezőjével.

Nevezze át a forrásfájlt.

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

Paraméterek

new_name: str

Kötelező

az új fájlnév, ahová a felhasználó át szeretne nevezni. Az érték formátumának a következőnek kell lennie: "{filesystem}/{directory}/{subdirectory}/{file}".

content_settings: ContentSettings

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

source_lease: DataLakeLeaseClient vagy str

A forrásútvonal bérletazonosítója. Ha meg van adva, a forrásútvonalnak aktív bérletet kell tartalmaznia, és a bérletazonosítónak meg kell egyeznie.

lease

Kötelező, ha a fájl/könyvtár 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 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.

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

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

source_etag: str

A forrás ETag értéke vagy a 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.

source_match_condition: MatchConditions

Az etagen használni kívánt forrásegyeztetés feltétele.

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

az átnevezett fájlügyfél

Visszatérési típus

DataLakeFileClient

Példák

Nevezze át a forrásfájlt.


   new_client = file_client.rename_file(file_client.file_system_name + '/' + 'newname')

Állítsa be az elérési út tulajdonosát, csoportját, engedélyeit vagy hozzáférés-vezérlési listáját.

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

Paraméterek

owner: str

Kötelező

Választható. A fájl vagy könyvtár tulajdonosa.

group: str

Kötelező

Választható. A fájl vagy könyvtár tulajdonoscsoportja.

permissions: str

Kötelező

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. az engedélyek és az acl kölcsönösen kizárják egymást.

acl: str

Kötelező

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. az engedélyek és az acl kölcsönösen kizárják egymást.

lease: DataLakeLeaseClient vagy str

Kötelező, ha a fájl/könyvtár rendelkezik aktív bérletekkel. 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.

response dict

response dict (Etag és utolsó módosítás).

Beállítja a Access Control egy útvonalon és az alútvonalakon.

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

Paraméterek

acl: str

Kötelező

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.

progress_hook: <xref:func>(AccessControlChanges)

Visszahívás, ahol a hívó nyomon követheti a művelet előrehaladását, valamint olyan elérési utakat gyűjthet, amelyek nem módosíthatók Access Control.

continuation_token: str

Nem kötelező folytatási jogkivonat, amely a korábban leállított művelet folytatásához használható.

batch_size: int

Választható. Ha az adathalmaz mérete meghaladja a kötegméretet, a művelet több kérelemre lesz felosztva, hogy nyomon követhető legyen a folyamat. A kötegméretnek 1 és 2000 között kell lennie. A meg nem határozott alapértelmezett érték 2000.

max_batches: int

Választható. Meghatározza azoknak a kötegeknek a maximális számát, amelyek egyetlen módosítási Access Control műveletet hajthatnak végre. Ha az összes alútvonal feldolgozása előtt eléri a maximális értéket, akkor a folytatási jogkivonat használható a művelet folytatásához. Az üres érték azt jelzi, hogy a kötetlen kötegek maximális száma és a művelet a végéig folytatódik.

continue_on_failure: bool

Ha False (Hamis) értékre van állítva, a művelet gyorsan leáll a felhasználói hibák (4XX) észlelésekor. Ha igaz, a művelet figyelmen kívül hagyja a felhasználói hibákat, és folytatja a műveletet a címtár más alentitásainál. A folytatási jogkivonat csak akkor lesz visszaadva, ha continue_on_failure igaz felhasználói hibák esetén. Ha nem állítja be az alapértelmezett értéket, akkor a False (Hamis) érték jelenik meg.

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 rekurzív műveletek összegzése, beleértve a sikerek és hibák számát, valamint egy folytatási jogkivonatot, ha a művelet idő előtt leállt.

Visszatérési típus

AccessControlChangeResult

Kivételek

AzureError

A felhasználó újraindíthatja a műveletet az AzureError continuation_token mezőjével, ha a jogkivonat elérhető.

Beállítja a fájl lejáratának és törlésének időpontját.

set_file_expiry(expiry_options: str, expires_on: datetime | int | None = None, **kwargs) -> None

Paraméterek

expiry_options: str

Kötelező

Kötelező. A lejárati idő módját jelzi. Lehetséges értékek: "NeverExpire", "RelativeToCreation", "RelativeToNow", "Absolute"

expires_on: datetime vagy int

Kötelező

A fájl lejáratának ideje. Ha expiry_options RelativeTo*, expires_on ezredmásodpercben kell lennie. Ha a expires_on típusa dátum/idő, akkor utc-időpontban kell lennie.

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

Beállítja a rendszertulajdonságokat a fájlon vagy könyvtáron.

Ha az content_settings egy tulajdonság van beállítva, az összes tulajdonság felül lesz bírálva.

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

Paraméterek

content_settings: ContentSettings

Kötelező

ContentSettings objektum a fájl-/könyvtártulajdonságok beállításához.

lease: DataLakeLeaseClient vagy str

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

file/directory-updated property dict (Etag és utolsó módosítás)

Visszatérési típus

Dict[str, Any]

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_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: DataLakeLeaseClient vagy str

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.

cpk: CustomerProvidedEncryptionKey

A szolgáltatásoldali adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni.

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ájlrendszer által frissített tulajdonság dict (Etag és utolsó módosítás).

Módosítja a Access Control egy elérési úton és az alútvonalakon.

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

Paraméterek

acl: str

Kötelező

Módosí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.

progress_hook: <xref:func>(AccessControlChanges)

Visszahívás, ahol a hívó nyomon követheti a művelet előrehaladását, valamint összegyűjtheti azokat az elérési utakat, amelyek nem módosíthatók Access Control.

continuation_token: str

Nem kötelező folytatási jogkivonat, amely a korábban leállított művelet folytatásához használható.

batch_size: int

Választható. Ha az adathalmaz mérete meghaladja a köteg méretét, a művelet több kérelemre lesz felosztva, hogy nyomon lehessen követni az előrehaladást. A köteg méretének 1 és 2000 közé kell esnie. Ha nincs meghatározva, az alapértelmezett érték 2000.

max_batches: int

Választható. Meghatározza azoknak a kötegeknek a maximális számát, amelyeket egyetlen módosítás Access Control művelet hajthat végre. Ha az összes alútvonal feldolgozása előtt eléri a maximális értéket, akkor a folytatási jogkivonat használható a művelet folytatásához. Az üres érték azt jelzi, hogy a kötetlen kötegek maximális száma és a művelet a végéig folytatódik.

continue_on_failure: bool

Ha False (Hamis) értékre van állítva, a művelet gyorsan leáll, ha felhasználói hibákba ütközik (4XX). Ha igaz, a művelet figyelmen kívül hagyja a felhasználói hibákat, és folytatja a műveletet a címtár más alentitásainál. A folytatási jogkivonat csak akkor lesz visszaadva, ha continue_on_failure igaz felhasználói hibák esetén. Ha nincs beállítva, az alapértelmezett érték False (Hamis).

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 rekurzív műveletek összegzése, beleértve a sikeres és sikertelen műveletek számát, valamint egy folytatási jogkivonatot arra az esetre, ha a művelet idő előtt leállt.

Visszatérési típus

AccessControlChangeResult

Kivételek

AzureError

Ha a jogkivonat elérhető, a felhasználó újraindíthatja a műveletet az AzureError continuation_token mezőjével.

Adatok feltöltése fájlba.

upload_data(data: bytes | str | Iterable | IO, length: int | None = None, overwrite: bool | None = False, **kwargs) -> Dict[str, Any]

Paraméterek

data

Kötelező

A fájlba feltöltendő tartalom

length: int

Kötelező

Az adatok mérete bájtban.

overwrite: bool

Kötelező

egy meglévő fájl felülírásához vagy sem.

content_settings: ContentSettings

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

metadata: Optional[Dict[str, str]]

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

lease: DataLakeLeaseClient vagy str

Akkor szükséges, ha a blob rendelkezik aktív bérlettal. Az érték lehet DataLakeLeaseClient objektum vagy sztringként megadott bérletazonosító.

umask: str

Nem kötelező, és csak akkor érvényes, ha a fiókhoz engedélyezve van a hierarchikus névtér. Amikor 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ényként kapott engedélyt a p & ^u adja meg, ahol 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 a 0777 egy könyvtárhoz és a 0666 egy fájlhoz. Az alapértelmezett umask a 0027. Az umaskot négyjegyű oktális jelölésben kell megadni (pl. 0766).

permissions: str

Nem kötelező, és csak akkor érvényes, ha a fiókhoz engedélyezve van a hierarchikus névtér. BEÁLLÍTJA a POSIX hozzáférési engedélyeit a fájl tulajdonosának, a fájltulajdonosi 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. Mind a szimbolikus (rwxrw-rw-) és a négyjegyű oktális jelölés (pl. 0766) 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 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.

validate_content: bool

Ha igaz, kiszámít egy MD5-kivonatot a fájl minden egyes darabjára. A tárolási szolgáltatás ellenőrzi annak a tartalomnak a kivonatát, amely az elküldött kivonattal érkezett. Ez elsősorban akkor hasznos, ha bitflipeket észlel a vezetéken, ha https helyett HTTP-t használ, mivel a https (alapértelmezett) már érvényesíti. Vegye figyelembe, hogy ez az MD5-kivonat nem a blobban van tárolva. Azt is vegye figyelembe, hogy ha engedélyezve van, a memóriahatékony feltöltési algoritmus nem lesz használva, mert az MD5-kivonat kiszámításához teljes blokkok pufferelésére van szükség, és ez nem teszi lehetővé a memóriahatékony algoritmus használatát.

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.

cpk: CustomerProvidedEncryptionKey

A szolgáltatásoldali adatokat a megadott kulccsal titkosítja. Az ügyfél által megadott kulcsokat HTTPS-en keresztül kell használni.

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. Ez a metódus több hívást is indíthat a szolgáltatáshoz, és az időtúllépés minden hívásra külön-külön érvényes lesz.

chunk_size: int

A fájlok adattömbökben való feltöltésének maximális mérete. Alapértelmezés szerint 100*1024*1024 vagy 100 MB.

encryption_context: str

Megadja a fájlon beállítani kívánt titkosítási környezetet.

Válaszok

response dict (Etag és utolsó módosítás).

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

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

Alapértelmezés szerint ez az "elsődleges" lesz. A lehetőségek közé tartozik az "elsődleges" és a "másodlagos".

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

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

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

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

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

Ha nem érhető el, akkor a Nincs érték jelenik meg. Másodlagos állomásnév explicit megadásához használja az opcionális secondary_hostname kulcsszóargumentumot a példányosításkor.

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

acquire_lease	Új bérletet kér. Ha a fájl vagy könyvtár nem rendelkezik aktív bérletekkel, a DataLake szolgáltatás létrehoz egy bérletet a fájlon/könyvtáron, és egy új bérletazonosítót ad vissza.
append_data	Adatok hozzáfűzése a fájlhoz.
close	Ezzel a módszerrel zárja be az ügyfél által megnyitott szoftvercsatornákat. Környezetkezelővel való használathoz nem szükséges használni.
create_file	Hozzon létre egy új fájlt.
delete_file	Megjelöli a megadott fájlt törlésre.
download_file	Letölt egy fájlt a StorageStreamDownloaderbe. A readall() metódust kell használni az összes tartalom olvasásához, vagy a readinto() metódust kell használni a fájl streambe való letöltéséhez. Az adattömbök() használatával egy iterátort ad vissza, amely lehetővé teszi a felhasználó számára, hogy az adattömbök tartalma fölött iteráljon.
exists	Igaz értéket ad vissza, ha egy fájl létezik, és máskülönben Hamis értéket ad vissza.
flush_data	Véglegesítse az előző hozzáfűzött adatokat.
from_connection_string	DataLakeFileClient létrehozása kapcsolati sztringből. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	A felhasználó által definiált összes metaadatot, szabványos HTTP-tulajdonságot és rendszertulajdonságokat adja vissza a fájlhoz. Nem adja vissza a fájl tartalmát.
query_file	Lehetővé teszi a felhasználók számára, hogy egyszerű lekérdezési kifejezések megadásával kiválasztják vagy kivetítik az adatlake-fájladatokat. Ez a művelet egy DataLakeFileQueryReadert ad vissza, a felhasználóknak a readall() vagy a readinto() parancsot kell használniuk a lekérdezési adatok lekéréséhez.
remove_access_control_recursive	Eltávolítja a Access Control egy elérési úton és az alútvonalakon.
rename_file	Nevezze át a forrásfájlt.
set_access_control	Állítsa be az elérési út tulajdonosát, csoportját, engedélyeit vagy hozzáférés-vezérlési listáját.
set_access_control_recursive	Beállítja a Access Control egy útvonalon és az alútvonalakon.
set_file_expiry	Beállítja a fájl lejáratának és törlésének időpontját.
set_http_headers	Beállítja a rendszertulajdonságokat a fájlon vagy könyvtáron. Ha az content_settings egy tulajdonság van beállítva, az összes tulajdonság felül lesz bírálva.
set_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.
update_access_control_recursive	Módosítja a Access Control egy elérési úton és az alútvonalakon.
upload_data	Adatok feltöltése fájlba.

Megosztás a következőn keresztül:

DataLakeFileClient Osztály

Konstruktor

Paraméterek

Példák

Változók

Metódusok

acquire_lease

Paraméterek

Válaszok

Visszatérési típus

append_data

Paraméterek

Válaszok

Példák

close

create_file

Paraméterek

Válaszok

Példák

delete_file

Paraméterek

Válaszok

Példák

download_file

Paraméterek

Válaszok

Visszatérési típus

Példák

exists

Paraméterek

Válaszok

Visszatérési típus

flush_data

Paraméterek

Válaszok

Példák

from_connection_string

Paraméterek

get_access_control

Paraméterek

get_file_properties

Paraméterek

Válaszok

Visszatérési típus

Példák

query_file

Paraméterek

Válaszok

Visszatérési típus

Példák

remove_access_control_recursive

Paraméterek

Válaszok

Visszatérési típus

Kivételek

rename_file

Paraméterek

Válaszok

Visszatérési típus

Példák

set_access_control

Paraméterek

set_access_control_recursive

Paraméterek

Válaszok

Visszatérési típus

Kivételek

set_file_expiry

Paraméterek

Visszatérési típus

set_http_headers

Paraméterek

Válaszok

Visszatérési típus

set_metadata

Paraméterek

Válaszok

update_access_control_recursive

Paraméterek