Share via

DataLakeServiceClient Osztály

  • Referencia

Ügyfél, amely a DataLake szolgáltatással kommunikál a fiók szintjén.

Ez az ügyfél műveleteket biztosít a fióktulajdonságok lekéréséhez és konfigurálásához, valamint a fiókon belüli fájlrendszerek listázásához, létrehozásához és törléséhez. Egy adott fájlrendszerhez, könyvtárhoz vagy fájlhoz kapcsolódó műveletek esetén az entitások ügyfelei a get_client függvényekkel is lekérhetők.

Öröklődés
azure.storage.filedatalake._shared.base_client.StorageAccountHostsMixin
DataLakeServiceClient

Konstruktor

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

Paraméterek

account_url
str
Kötelező

A DataLake-tárfiók URL-címe. Az URL-címben szereplő egyéb entitások (például fájlrendszer vagy fájl) elvesznek. Ez az URL-cím opcionálisan hitelesíthető SAS-jogkivonattal.

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 DataLakeServiceClient
   datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)

A DataLakeServiceClient létrehozása Azure Identity hitelesítő adatokkal.


   from azure.identity import ClientSecretCredential
   token_credential = ClientSecretCredential(
       self.active_directory_tenant_id,
       self.active_directory_application_id,
       self.active_directory_application_secret,
   )
   datalake_service_client = DataLakeServiceClient("https://{}.dfs.core.windows.net".format(self.account_name),
                                                   credential=token_credential)

Változók

url
str

A datalake szolgáltatásvégpont teljes végponti URL-címe.

primary_endpoint
str

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

primary_hostname
str

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

Metódusok

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_system

Új fájlrendszert hoz létre a megadott fiók alatt.

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

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

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

DataLakeServiceClient létrehozása kapcsolati sztringből.

:return a DataLakeServiceClient :rtype ~azure.storage.filedatalake.DataLakeServiceClient
get_directory_client

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

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

Kérje le az ügyfelet, hogy használja a megadott fájlt.

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

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

A fájlrendszernek még nem kell léteznie.
get_service_properties

Lekéri egy tárfiók adatlake szolgáltatásának tulajdonságait, beleértve az Azure Storage Analytics.

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

Szerezzen be egy felhasználódelegálási kulcsot SAS-jogkivonatok aláírása céljából. A kérés sikeres végrehajtásához jelen kell lennie egy jogkivonat hitelesítő adatainak a szolgáltatásobjektumon.
list_file_systems

Egy generátort ad vissza a megadott fiókban lévő fájlrendszerek listázásához.

A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat, és leáll az összes fájlrendszer visszaadásakor.
set_service_properties

Beállítja egy tárfiók Datalake szolgáltatásának tulajdonságait, beleértve az Azure Storage Analytics.

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

Ha egy elem (például analytics_logging) Nincs értéken marad, a szolgáltatás meglévő beállításai megmaradnak a funkcióhoz.
undelete_file_system

Helyreállíthatóan törölt fájlrendszer visszaállítása.

A művelet csak akkor lesz sikeres, ha a törlési adatmegőrzési szabályzatban megadott számú napon belül használják.

A 12.3.0-s verzió újdonságai: Ez a művelet a "2019-12-12" API-verzióban jelent meg.

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_file_system

Új fájlrendszert hoz létre a megadott fiók alatt.

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

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

Paraméterek

file_system
str
Kötelező

A létrehozandó fájlrendszer neve.

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

public_access
PublicAccess
Kötelező

Lehetséges értékek: fájlrendszer, fájl.

encryption_scope_options
dict vagy EncryptionScopeOptions

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

A 12.9.0-s verzió újdonságai.

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.

Visszatérési típus

FileSystemClient

Példák

Fájlrendszer létrehozása az adatlake szolgáltatásban.


   datalake_service_client.create_file_system("filesystem")

delete_file_system

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

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

delete_file_system(file_system: FileSystemProperties | str, **kwargs) -> FileSystemClient

Paraméterek

file_system
str vagy FileSystemProperties
Kötelező

A törölni kívánt fájlrendszer. Ez lehet a fájlrendszer neve vagy a FileSystemProperties egy példánya.

lease
DataLakeLeaseClient vagy str

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

if_modified_since
datetime

DateTime érték. Az Azure azt várja, hogy a megadott dátumérték UTC legyen. Ha az időzónát is tartalmazza, a nem UTC 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.

Visszatérési típus

None

Példák

Fájlrendszer törlése a datalake szolgáltatásban.


   datalake_service_client.delete_file_system("filesystem")

from_connection_string

DataLakeServiceClient létrehozása kapcsolati sztringből.

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

from_connection_string(conn_str: 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.

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 egy SAS-jogkivonat-sztring, egy AzureSasCredential 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.

Példák

A DataLakeServiceClient létrehozása egy kapcsolati sztring.


   from azure.storage.filedatalake import DataLakeServiceClient
   datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)

get_directory_client

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

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

get_directory_client(file_system: FileSystemProperties | str, directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Paraméterek

file_system
str vagy FileSystemProperties
Kötelező

A fájlrendszer, amelyben a könyvtár található. Ez lehet a fájlrendszer neve vagy a FileSystemProperties egy példánya.

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.

Válaszok

A DataLakeDirectoryClient.

Visszatérési típus

DataLakeDirectoryClient

Példák

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


   directory_client = datalake_service_client.get_directory_client(file_system_client.file_system_name,
                                                                   "mydirectory")

get_file_client

Kérje le az ügyfelet, hogy használja a megadott fájlt.

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

get_file_client(file_system: FileSystemProperties | str, file_path: FileProperties | str) -> DataLakeFileClient

Paraméterek

file_system
str vagy FileSystemProperties
Kötelező

A fájl fájlrendszere. Ez lehet a fájlrendszer neve vagy a FileSystemProperties egy példánya.

file_path
str vagy FileProperties
Kötelező

Az a fájl, amellyel kommunikálni szeretne. Ez lehet a fájl teljes elérési útja (a gyökérkönyvtárból), vagy a FileProperties egy példánya. Pl. könyvtár/alkönyvtár/fájl

Válaszok

Egy DataLakeFileClient.

Visszatérési típus

DataLakeFileClient

Példák

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


   file_client = datalake_service_client.get_file_client(file_system_client.file_system_name, "myfile")

get_file_system_client

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

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

get_file_system_client(file_system: FileSystemProperties | str) -> FileSystemClient

Paraméterek

file_system
str vagy FileSystemProperties
Kötelező

A fájlrendszer. Ez lehet a fájlrendszer neve vagy a FileSystemProperties egy példánya.

Válaszok

A FileSystemClient.

Visszatérési típus

FileSystemClient

Példák

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


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

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

get_service_properties

Lekéri egy tárfiók adatlake szolgáltatásának tulajdonságait, beleértve az Azure Storage Analytics.

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

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

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

Adatlake-szolgáltatástulajdonságokat, például elemzési naplózást, óra/perc metrikákat, cors-szabályokat stb. tartalmazó objektum.

Visszatérési típus

Dict[str, Any]

get_user_delegation_key

Szerezzen be egy felhasználódelegálási kulcsot SAS-jogkivonatok aláírása céljából. A kérés sikeres végrehajtásához jelen kell lennie egy jogkivonat hitelesítő adatainak a szolgáltatásobjektumon.

get_user_delegation_key(key_start_time: datetime, key_expiry_time: datetime, **kwargs: Any) -> UserDelegationKey

Paraméterek

key_start_time
datetime
Kötelező

DateTime érték. Azt jelzi, hogy mikor válik érvényessé a kulcs.

key_expiry_time
datetime
Kötelező

DateTime érték. Azt jelzi, hogy a kulcs mikor áll le.

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 felhasználódelegálási kulcs.

Visszatérési típus

UserDelegationKey

Példák

Felhasználódelegálási kulcs lekérése a datalake szolgáltatásügyfélről.


   from datetime import datetime, timedelta
   user_delegation_key = datalake_service_client.get_user_delegation_key(datetime.utcnow(),
                                                                         datetime.utcnow() + timedelta(hours=1))

list_file_systems

Egy generátort ad vissza a megadott fiókban lévő fájlrendszerek listázásához.

A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat, és leáll az összes fájlrendszer visszaadásakor.

list_file_systems(name_starts_with: str | None = None, include_metadata: bool | None = None, **kwargs) -> ItemPaged[FileSystemProperties]

Paraméterek

name_starts_with
str
Kötelező

Az eredményeket úgy szűri, hogy csak azokat a fájlrendszereket adja vissza, amelyeknek a neve a megadott előtaggal kezdődik.

include_metadata
bool
Kötelező

Megadja, hogy a fájlrendszer metaadatai a válaszban legyenek visszaadva. Az alapértelmezett érték a Hamis.

results_per_page
int

Az API-hívásonként lekérhető fájlrendszernevek maximális száma. Ha a kérés nem adja meg, a kiszolgáló oldalanként legfeljebb 5000 elemet ad vissza.

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.

include_deleted
bool

Megadja, hogy a válaszban visszaadandó törölt fájlrendszerek. Ez a fájlrendszer-visszaállítást engedélyező fiókhoz tartozik. Az alapértelmezett érték a Hamis. .. versionadded:: 12.3.0

include_system
bool

Jelölő, amely megadja, hogy a rendszer fájlrendszereit is bele kell foglalni. .. versionadded:: 12.6.0

Válaszok

A FileSystemProperties iterable (automatikus lapozás) eleme.

Visszatérési típus

ItemPaged[FileSystemProperties]

Példák

A datalake szolgáltatás fájlrendszereinek listázása.


   file_systems = datalake_service_client.list_file_systems()
   for file_system in file_systems:
       print(file_system.name)

set_service_properties

Beállítja egy tárfiók Datalake szolgáltatásának tulajdonságait, beleértve az Azure Storage Analytics.

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

Ha egy elem (például analytics_logging) Nincs értéken marad, a szolgáltatás meglévő beállításai megmaradnak a funkcióhoz.

set_service_properties(**kwargs: Any) -> None

Paraméterek

analytics_logging

Az Azure Analytics naplózási beállításainak csoportosítása.

hour_metrics

Az órametrikák beállításai az API-k szerint csoportosított kérelemstatisztikák óránkénti összesítéseit adják meg.

minute_metrics

A percmetrikák beállításai minden egyes percre vonatkozóan kérésstatisztikát biztosítanak.

cors

A listában legfeljebb öt CorsRule-elem szerepelhet. Ha egy üres lista van megadva, az összes CORS-szabály törlődik, és a CORS le lesz tiltva a szolgáltatáshoz.

target_version
str

Azt az alapértelmezett verziót jelzi, amelyet a kérelmekhez használni kell, ha a bejövő kérés verziója nincs megadva.

delete_retention_policy

A törlési adatmegőrzési szabályzat határozza meg, hogy meg kívánja-e őrizni a törölt fájlokat/könyvtárakat. Meghatározza a megtartandó fájl/könyvtár napok számát és verzióit is.

static_website

Megadja, hogy a statikus webhely szolgáltatás engedélyezve van-e, és ha igen, akkor az indexdokumentumot és a 404-et használó hibadokumentumot jelzi.

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.

Visszatérési típus

None

undelete_file_system

Helyreállíthatóan törölt fájlrendszer visszaállítása.

A művelet csak akkor lesz sikeres, ha a törlési adatmegőrzési szabályzatban megadott számú napon belül használják.

A 12.3.0-s verzió újdonságai: Ez a művelet a "2019-12-12" API-verzióban jelent meg.

undelete_file_system(name: str, deleted_version: str, **kwargs: Any) -> FileSystemClient

Paraméterek

name
str
Kötelező

Megadja a visszaállítandó törölt fájlrendszer nevét.

deleted_version
str
Kötelező

A visszaállítandó törölt fájlrendszer verzióját adja 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őkorlátok konfigurálását itt találja.

Válaszok

A visszaállított, solft által törölt FileSystemClient.

Visszatérési típus

FileSystemClient

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

ValueError

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