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


DataLakeDirectoryClient Osztály

A DataLake-címtárral kommunikáló ügyfél, még akkor is, ha a címtár még nem létezik.

Egy adott alkönyvtárral vagy fájllal kapcsolatos műveletek esetén a címtárügyfél vagy a fájlügyfél lekérhető a vagy get_file_client a get_sub_directory_client függvény használatával.

Öröklődés
azure.storage.filedatalake._path_client.PathClient
DataLakeDirectoryClient

Konstruktor

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

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.

directory_name
str
Kötelező

A könyvtár teljes elérési útja. például: {directory under file system}/{directory to interact}

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

  • kivéve az AzureSasCredential esetében, ahol az ütköző SAS-jogkivonatok ValueError értéket fognak létrehozni. 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.
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

A DataLakeServiceClient létrehozása kapcsolati sztring.


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

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

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_directory

Hozzon létre egy új könyvtárat.

create_file

Hozzon létre egy új fájlt, és adja vissza a használni kívánt fájlügyfélt.

create_sub_directory

Hozzon létre egy alkönyvtárat, és adja vissza a használni kívánt alkönyvtár-ügyfelet.

delete_directory

Megjelöli a megadott könyvtárat törlésre.

delete_sub_directory

Megjelöli a megadott alkönyvtárat törlésre.

exists

Igaz értéket ad vissza, ha létezik könyvtár, és máskülönben Hamis értéket ad vissza.

from_connection_string

DataLakeDirectoryClient létrehozása kapcsolati sztringből.

get_access_control
get_directory_properties

A címtár összes felhasználó által definiált metaadatát, szabványos HTTP-tulajdonságát és rendszertulajdonságát adja vissza. Nem adja vissza a könyvtár tartalmát.

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_sub_directory_client

Kérje meg az ügyfelet, hogy használja az aktuális könyvtár megadott alkönyvtárát.

Az alkönyvtárnak még nem kell léteznie.

remove_access_control_recursive

Eltávolítja a Access Control egy útvonalon és az alútvonalakon.

rename_directory

Nevezze át a forráskönyvtárat.

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_http_headers

Beállítja a rendszertulajdonságokat a fájlban vagy könyvtárban.

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.

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.

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

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.

close() -> None

create_directory

Hozzon létre egy új könyvtárat.

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

Paraméterek

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

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 umaskot 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ájlokhoz és könyvtárakhoz. 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-et ad vissza (érvénytelen kérés), 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í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.

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

Válaszok

Válaszfejlécek szótára.

Visszatérési típus

Példák

Címtár létrehozása.


   directory_client.create_directory()

create_file

Hozzon létre egy új fájlt, és adja vissza a használni kívánt fájlügyfélt.

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

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

metadata

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.

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.

Válaszok

DataLakeFileClient

create_sub_directory

Hozzon létre egy alkönyvtárat, és adja vissza a használni kívánt alkönyvtár-ügyfelet.

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

Paraméterek

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

DataLakeDirectoryClient az alkönyvtárhoz.

delete_directory

Megjelöli a megadott könyvtárat törlésre.

delete_directory(**kwargs) -> None

Paraméterek

lease
DataLakeLeaseClient vagy str

Kötelező, 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 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

None

Példák

Könyvtár törlése.


   new_directory.delete_directory()

delete_sub_directory

Megjelöli a megadott alkönyvtárat törlésre.

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

Paraméterek

sub_directory
str vagy DirectoryProperties
Kötelező

Az a könyvtár, amellyel kommunikálni szeretne. Ez lehet a könyvtár neve vagy a DirectoryProperties egy példánya.

lease
DataLakeLeaseClient vagy str

Kötelező, 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 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

DataLakeDirectoryClient az alkönyvtárhoz

exists

Igaz értéket ad vissza, ha létezik könyvtár, é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 könyvtár, ellenkező esetben hamis.

Visszatérési típus

from_connection_string

DataLakeDirectoryClient létrehozása kapcsolati sztringből.

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

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.

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

  • kivéve az AzureSasCredential esetében, ahol az ütköző SAS-jogkivonatok ValueError értéket fognak létrehozni. 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.
directory_name
str
Kötelező

A használni kívánt könyvtár neve. A könyvtár a fájlrendszer alatt található.

credential
Kötelező

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.

Válaszok

a DataLakeDirectoryClient

Visszatérési típus

get_access_control

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

válasz diktál.

get_directory_properties

A címtár összes felhasználó által definiált metaadatát, szabványos HTTP-tulajdonságát és rendszertulajdonságát adja vissza. Nem adja vissza a könyvtár tartalmát.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Paraméterek

lease
DataLakeLeaseClient vagy str

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

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 címtár ügyfél által megadott kulccsal lett létrehozva.

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

Példák

Fájl/könyvtár tulajdonságainak lekérése.


   props = new_directory.get_directory_properties()

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: FileProperties | str) -> 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. Pl. könyvtár/alkönyvtár/fájl

Válaszok

Egy DataLakeFileClient.

Visszatérési típus

get_sub_directory_client

Kérje meg az ügyfelet, hogy használja az aktuális könyvtár megadott alkönyvtárát.

Az alkönyvtárnak még nem kell léteznie.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Paraméterek

sub_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

remove_access_control_recursive

Eltávolítja a Access Control egy útvonalon é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ágait 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 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

Kivételek

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

rename_directory

Nevezze át a forráskönyvtárat.

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

Paraméterek

new_name
str
Kötelező

az új könyvtár neve, ahová a felhasználót át szeretné nevezni. Az értéknek a következő formátummal kell rendelkeznie: "{filesystem}/{directory}/{subdirectory}".

source_lease
DataLakeLeaseClient vagy str

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

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.

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

DataLakeDirectoryClient

Példák

Nevezze át a forráskönyvtárat.


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

set_access_control

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

set_access_control_recursive

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

Kivételek

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

set_http_headers

Beállítja a rendszertulajdonságokat a fájlban vagy könyvtárban.

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

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

Visszatérési típus

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.

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

update_access_control_recursive

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

Kivételek

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

Attribútumok

api_version

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

location_mode

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

primary_endpoint

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

primary_hostname

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

secondary_endpoint

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

secondary_hostname

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.

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