azure.storage.filedatalake.DataLakeFileClient class

Begär ett nytt lån. Om filen eller katalogen inte har något aktivt lån skapar DataLake-tjänsten ett lån för filen/katalogen och returnerar ett nytt låne-ID.

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

Parametrar

lease_duration: int

Obligatorisk

Anger varaktigheten för lånet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra lånetiden med förnyelse eller ändring. Standardvärdet är -1 (oändligt lån).

lease_id: str

Obligatorisk

Föreslaget låne-ID i ett GUID-strängformat. DataLake-tjänsten returnerar 400 (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett DataLakeLeaseClient-objekt som kan köras i en kontexthanterare.

Returtyp

DataLakeLeaseClient

Lägg till data i filen.

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

Parametrar

data

Obligatorisk

Innehåll som ska läggas till i filen

offset

Obligatorisk

startpositionen för de data som ska läggas till.

length

Obligatorisk

Storleken på data i byte.

flush: bool

Om det är sant checkar du in data när de har lagts till.

validate_content: bool

Om det är sant beräknas en MD5-hash för blockinnehållet. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med hashen som skickades. Detta är främst värdefullt för att identifiera bitflips på tråden om http i stället för https som https (standard) redan verifieras. Observera att denna MD5-hash inte lagras med filen.

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

Används för att utföra låneåtgärder tillsammans med väntande data.

"acquire" – Skaffa ett lån. "förnya automatiskt" – Förnya ett befintligt lån igen. "release" – Släpp lånet när åtgärden är klar. Kräver flush=True. "acquire-release" – Skaffa ett lån och släpp det när åtgärderna har slutförts. Kräver flush=True.

lease_duration: int

Giltigt om lease_action är inställt på "acquire" eller "acquire-release".

Anger varaktigheten för lånet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra lånetiden med förnyelse eller ändring. Standardvärdet är -1 (oändligt lån).

lease: DataLakeLeaseClient eller str

Krävs om filen har ett aktivt lån eller om lease_action är inställt på "hämta" eller "hämta-release". Om filen har ett befintligt lån används den för att komma åt filen. Om du hämtar ett nytt lån används detta som det nya låne-ID:t. Värdet kan vara ett DataLakeLeaseClient-objekt eller låne-ID:t som en sträng.

cpk: CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS.

Returer

diktamen för svarshuvudet

Exempel

Lägg till data i filen.


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

Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.

close() -> None

Skapa en ny fil.

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

Parametrar

content_settings: ContentSettings

Obligatorisk

ContentSettings-objekt som används för att ange sökvägsegenskaper.

metadata: Optional[Dict[str, str]]

Obligatorisk

Namn/värde-par som är associerade med filen som metadata.

lease: DataLakeLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett DataLakeLeaseClient-objekt eller låne-ID:t som en sträng.

umask: str

Valfritt och endast giltigt om hierarkiskt namnområde är aktiverat för kontot. När du skapar en fil eller katalog och den överordnade mappen inte har någon standard-ACL begränsar umask behörigheterna för filen eller katalogen som ska skapas. Den resulterande behörigheten ges av p & ^u, där p är behörigheten och du är umask. Om p till exempel är 0777 och du är 0057 är den resulterande behörigheten 0720. Standardbehörigheten är 0777 för en katalog och 0666 för en fil. Standard-umask är 0027. Umasken måste anges i en 4-siffrig oktal notation (t.ex. 0766).

owner: str

Ägaren till filen eller katalogen.

group: str

Den ägande gruppen av filen eller katalogen.

acl: str

Anger behörigheter för POSIX-åtkomstkontroll för filer och kataloger. Värdet är en kommaavgränsad lista över åtkomstkontrollposter. Varje åtkomstkontrollpost (ACE) består av ett omfång, en typ, en användare eller gruppidentifierare och behörigheter i formatet "[scope:][type]:[id]:[permissions]".

lease_id: str

Föreslaget låne-ID i ett GUID-strängformat. DataLake-tjänsten returnerar 400 (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.

lease_duration: int

Anger varaktigheten för lånet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra lånetiden med förnyelse eller ändring.

expires_on: datetime eller int

Tiden för att ange att filen ska upphöra att gälla. Om typen av expires_on är en int anges förfallotiden som antalet millisekunder som förflutit från skapandetiden. Om typen av expires_on är datetime anges förfallotiden absolut till den angivna tiden. Om ingen tidszonsinformation tillhandahålls tolkas detta som UTC.

permissions: str

Valfritt och endast giltigt om hierarkiskt namnområde är aktiverat för kontot. Anger POSIX-åtkomstbehörigheter för filägaren, filägargruppen och andra. Varje klass kan beviljas läs-, skriv- eller körningsbehörighet. Den klibbiga biten stöds också. Både symbolisk (rwxrw-rw-) och 4-siffrig oktal notation (t.ex. 0766) stöds.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

encryption_context: str

Anger krypteringskontexten som ska anges för filen.

Returer

svarsdikt (Etag och senast ändrad).

Exempel

Skapa fil.


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

Markerar den angivna filen för borttagning.

delete_file(**kwargs) -> None

Parametrar

lease: DataLakeLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett LeaseClient-objekt eller låne-ID som en sträng.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ingen

Exempel

Ta bort filen.


   new_client.delete_file()

Laddar ned en fil till StorageStreamDownloader. Metoden readall() måste användas för att läsa allt innehåll, eller readinto() måste användas för att ladda ned filen till en dataström. Med segment() returneras en iterator som gör att användaren kan iterera över innehållet i segment.

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

Parametrar

offset: int

Obligatorisk

Start av byteintervall som ska användas för att ladda ned ett avsnitt av filen. Måste anges om längden anges.

length: int

Obligatorisk

Antal byte som ska läsas från dataströmmen. Detta är valfritt, men bör tillhandahållas för optimala prestanda.

lease: DataLakeLeaseClient eller str

Om det anges lyckas nedladdningen endast om filens lån är aktivt och matchar det här ID:t. Krävs om filen har ett aktivt lån.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

Dekrypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS. Krävs om filen skapades med en Customer-Provided nyckel.

max_concurrency: int

Antalet parallella anslutningar som du kan ladda ned.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här. Den här metoden kan göra flera anrop till tjänsten och tidsgränsen gäller för varje anrop individuellt.

Returer

Ett strömmande objekt (StorageStreamDownloader)

Returtyp

StorageStreamDownloader

Exempel

Returnera nedladdade data.


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

Returnerar Sant om en fil finns och returnerar False annars.

exists(**kwargs: Any) -> bool

Parametrar

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Sant om det finns en fil, annars returneras False.

Returtyp

bool

Checka in tidigare bifogade data.

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

Parametrar

offset

Obligatorisk

offset är lika med längden på filen efter incheckning av tidigare bifogade data.

retain_uncommitted_data: bool

Obligatorisk

Gäller endast för tömningsåtgärder. Om "sant" behålls ogenomförda data när tömningsåtgärden har slutförts. Annars tas de ogenomförda data bort efter tömningsåtgärden. Standardvärdet är False. Data vid förskjutningar som är mindre än den angivna positionen skrivs till filen när tömningen lyckas, men den här valfria parametern tillåter att data efter tömningspositionen bevaras för en framtida tömningsåtgärd.

content_settings: ContentSettings

ContentSettings-objekt som används för att ange sökvägsegenskaper.

close: bool

Med Azure Storage-händelser kan program ta emot meddelanden när filer ändras. När Azure Storage-händelser är aktiverade aktiveras en filändringshändelse. Den här händelsen har en egenskap som anger om detta är den slutliga ändringen för att skilja skillnaden mellan en mellanliggande tömning till en filström och den sista stängningen av en filström. Parametern close query är endast giltig när åtgärden är "flush" och ändringsmeddelanden aktiveras. Om värdet för close är "true" och tömningsåtgärden har slutförts, genererar tjänsten ett filändringsmeddelande med en egenskap som anger att detta är den slutliga uppdateringen (filströmmen har stängts). Om "false" genereras ett ändringsmeddelande som anger att filen har ändrats. Standardvärdet är False. Den här frågeparametern anges till true av Hadoop ABFS-drivrutinen för att indikera att filströmmen har stängts."

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

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

Används för att utföra låneåtgärder tillsammans med väntande data.

"acquire" – Skaffa ett lån. "förnya automatiskt" – Förnya ett befintligt lån igen. "release" – Släpp lånet när åtgärden är klar. "acquire-release" – Skaffa ett lån och släpp det när åtgärderna har slutförts.

lease_duration: int

Giltigt om lease_action är inställt på "acquire" eller "acquire-release".

Anger varaktigheten för lånet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra lånetiden med förnyelse eller ändring. Standardvärdet är -1 (oändligt lån).

lease: DataLakeLeaseClient eller str

Krävs om filen har ett aktivt lån eller om lease_action är inställt på "hämta" eller "hämta-release". Om filen har ett befintligt lån används den för att komma åt filen. Om du hämtar ett nytt lån används detta som det nya låne-ID:t. Värdet kan vara ett DataLakeLeaseClient-objekt eller låne-ID:t som en sträng.

cpk: CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS.

Returer

svarsrubrik i diktamen

Exempel

Checka in tidigare bifogade data.


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

Skapa DataLakeFileClient från en anslutningssträng.

: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

Parametrar

conn_str: str

Obligatorisk

En anslutningssträng till ett Azure Storage-konto.

file_system_name: str

Obligatorisk

Namnet på filsystemet som ska interagera med.

file_path: str

Obligatorisk

Hela filsökvägen, så att du kan interagera med en specifik fil. t.ex. "{directory}/{subdirectory}/{file}"

credential

standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Det här är valfritt om konto-URL:en redan har en SAS-token, eller om anslutningssträngen redan har värden för delad åtkomstnyckel. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Autentiseringsuppgifterna som anges här har företräde framför dem i anslutningssträngen. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

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

Parametrar

upn: bool

Obligatorisk

Valfritt. Gäller endast när hierarkiskt namnområde är aktiverat för kontot. Om det är "sant" omvandlas användaridentitetsvärdena som returneras i x-ms-owner, x-ms-group och x-ms-acl-svarshuvuden från Azure Active Directory-objekt-ID:t till användarens huvudnamn. Om värdet är "falskt" returneras värdena som Azure Active Directory-objekt-ID:t. Standardvärdet är false. Observera att grupp- och programobjekt-ID:t inte översätts eftersom de inte har unika egna namn.

lease: DataLakeLeaseClient eller str

Krävs om filen/katalogen har ett aktivt lån. Värdet kan vara ett LeaseClient-objekt eller låne-ID som en sträng.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

response dict

svarsdikt.

Returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för filen. Den returnerar inte innehållet i filen.

get_file_properties(**kwargs: Any) -> FileProperties

Parametrar

lease

Krävs om katalogen eller filen har ett aktivt lån. Värdet kan vara ett DataLakeLeaseClient-objekt eller låne-ID:t som en sträng.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

Dekrypterar data på tjänstsidan med den angivna nyckeln. Användning av nycklar som tillhandahålls av kunden måste göras via HTTPS. Krävs om filen har skapats med en nyckel som tillhandahålls av kunden.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för filen.

Returtyp

FileProperties

Exempel

Hämta egenskaperna för en fil.


   properties = file_client.get_file_properties()

Gör det möjligt för användare att välja/projekt på datalake-fildata genom att tillhandahålla enkla frågeuttryck. De här åtgärderna returnerar en DataLakeFileQueryReader, användarna måste använda readall() eller readinto() för att hämta frågedata.

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

Parametrar

query_expression: str

Obligatorisk

Krävs. en frågeuttryck. t.ex. Välj * från DataLakeStorage

on_error: Callable[DataLakeFileQueryError]

En funktion som ska anropas för alla bearbetningsfel som returneras av tjänsten.

file_format: DelimitedTextDialect eller DelimitedJsonDialect eller QuickQueryDialect eller str

Valfritt. Definierar serialiseringen av de data som för närvarande lagras i filen. Standardvärdet är att behandla fildata som CSV-data formaterade på standarddialekten. Detta kan åsidosättas med en anpassad DelimitedTextDialect eller DelimitedJsonDialect eller "ParquetDialect" (skickas som en sträng eller uppräkning). Dessa dialekter kan skickas genom deras respektive klasser, QuickQueryDialect-uppräkningen eller som en sträng.

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

Valfritt. Definierar utdataserialiseringen för dataströmmen. Som standard returneras data som de representeras i filen. Genom att tillhandahålla ett utdataformat formateras fildata om enligt den profilen. Det här värdet kan vara en AvgränsadTextDialect eller en DelimitedJsonDialect eller ArrowDialect. Dessa dialekter kan skickas genom deras respektive klasser, QuickQueryDialect-uppräkningen eller som en sträng.

lease: DataLakeLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett DataLakeLeaseClient-objekt eller låne-ID:t som en sträng.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

Dekrypterar data på tjänstsidan med den angivna nyckeln. Användning av nycklar som tillhandahålls av kunden måste göras via HTTPS. Krävs om filen skapades med en Customer-Provided nyckel.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett strömmande objekt (DataLakeFileQueryReader)

Returtyp

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Exempel

select/project på datalake-fildata genom att tillhandahålla enkla frågeuttryck.


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

Tar bort Access Control på en sökväg och undersökvägar.

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

Parametrar

acl: str

Obligatorisk

Tar bort POSIX-åtkomstkontrollrättigheter för filer och kataloger. Värdet är en kommaavgränsad lista över åtkomstkontrollposter. Varje åtkomstkontrollpost (ACE) består av ett omfång, en typ och en användar- eller gruppidentifierare i formatet "[scope:][type]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

Återanrop där anroparen kan spåra förloppet för åtgärden samt samla in sökvägar som inte kunde ändras Access Control.

continuation_token: str

Valfri fortsättningstoken som kan användas för att återuppta en tidigare stoppad åtgärd.

batch_size: int

Valfritt. Om datauppsättningens storlek överskrider batchstorleken delas åtgärden upp i flera begäranden så att förloppet kan spåras. Batchstorleken ska vara mellan 1 och 2000. Standardvärdet när ospecificerat är 2000.

max_batches: int

Valfritt. Definierar maximalt antal batchar som en enskild ändring Access Control åtgärden kan köra. Om maxvärdet uppnås innan alla undersökvägar bearbetas kan fortsättningstoken användas för att återuppta åtgärden. Tomt värde anger att det maximala antalet batchar i obundna och åtgärden fortsätter till slutet.

continue_on_failure: bool

Om värdet är False avslutas åtgärden snabbt när användarfel (4XX) uppstår. Om värdet är Sant ignorerar åtgärden användarfel och fortsätter med åtgärden på andra underentiteter i katalogen. Fortsättningstoken returneras endast när continue_on_failure är Sant om det uppstår användarfel. Om det inte anges är standardvärdet Falskt för detta.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En sammanfattning av de rekursiva åtgärderna, inklusive antalet lyckade och misslyckade försök, samt en fortsättningstoken om åtgärden avslutades i förtid.

Returtyp

AccessControlChangeResult

Undantag

AzureError

Användaren kan starta om åtgärden med hjälp av continuation_token fältet i AzureError om token är tillgänglig.

Byt namn på källfilen.

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

Parametrar

new_name: str

Obligatorisk

det nya filnamnet som användaren vill byta namn till. Värdet måste ha följande format: "{filesystem}/{directory}/{subdirectory}/{file}".

content_settings: ContentSettings

ContentSettings-objekt som används för att ange sökvägsegenskaper.

source_lease: DataLakeLeaseClient eller str

Ett låne-ID för källsökvägen. Om det anges måste källsökvägen ha ett aktivt lån och låne-ID:t måste matcha.

lease

Krävs om filen/katalogen har ett aktivt lån. Värdet kan vara ett LeaseClient-objekt eller låne-ID som en sträng.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

source_if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

source_if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

source_etag: str

ETag-källans värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

source_match_condition: MatchConditions

Källmatchningsvillkoret som ska användas på etag.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

den omdöpta filklienten

Returtyp

DataLakeFileClient

Exempel

Byt namn på källfilen.


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

Ange ägare, grupp, behörigheter eller åtkomstkontrollistan för en sökväg.

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

Parametrar

owner: str

Obligatorisk

Valfritt. Ägaren till filen eller katalogen.

group: str

Obligatorisk

Valfritt. Den ägande gruppen för filen eller katalogen.

permissions: str

Obligatorisk

Valfritt och endast giltigt om hierarkisk namnrymd är aktiverat för kontot. Anger POSIX-åtkomstbehörigheter för filägaren, gruppen som äger filen och andra. Varje klass kan beviljas läs-, skriv- eller körningsbehörighet. Den klibbiga biten stöds också. Både symbolisk (rwxrw-rw-) och 4-siffrig oktal notation (t.ex. 0766) stöds. behörigheter och acl är ömsesidigt uteslutande.

acl: str

Obligatorisk

Anger POSIX-åtkomstkontrollbehörigheter för filer och kataloger. Värdet är en kommaavgränsad lista över åtkomstkontrollposter. Varje åtkomstkontrollpost (ACE) består av ett omfång, en typ, en användar- eller gruppidentifierare och behörigheter i formatet "[scope:][type]:[id]:[permissions]". behörigheter och acl är ömsesidigt uteslutande.

lease: DataLakeLeaseClient eller str

Krävs om filen/katalogen har ett aktivt lån. Värdet kan vara ett LeaseClient-objekt eller låne-ID som en sträng.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

response dict

svarsdikt (Etag och senast ändrad).

Anger Access Control på en sökväg och undersökvägar.

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

Parametrar

acl: str

Obligatorisk

Anger POSIX-åtkomstkontrollbehörigheter för filer och kataloger. Värdet är en kommaavgränsad lista över åtkomstkontrollposter. Varje åtkomstkontrollpost (ACE) består av ett omfång, en typ, en användar- eller gruppidentifierare och behörigheter i formatet "[scope:][type]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

Återanrop där anroparen kan spåra förloppet för åtgärden samt samla in sökvägar som inte kunde ändras Access Control.

continuation_token: str

Valfri fortsättningstoken som kan användas för att återuppta en tidigare stoppad åtgärd.

batch_size: int

Valfritt. Om datauppsättningens storlek överskrider batchstorleken delas åtgärden upp i flera begäranden så att förloppet kan spåras. Batchstorleken ska vara mellan 1 och 2000. Standardvärdet när ospecificerat är 2000.

max_batches: int

Valfritt. Definierar maximalt antal batchar som en enskild ändring Access Control åtgärden kan köra. Om maxvärdet uppnås innan alla undersökvägar bearbetas kan fortsättningstoken användas för att återuppta åtgärden. Tomt värde anger att det maximala antalet batchar i obundna och åtgärden fortsätter till slutet.

continue_on_failure: bool

Om värdet är False avslutas åtgärden snabbt när användarfel (4XX) uppstår. Om värdet är Sant ignorerar åtgärden användarfel och fortsätter med åtgärden på andra underentiteter i katalogen. Fortsättningstoken returneras endast när continue_on_failure är Sant om det uppstår användarfel. Om det inte anges är standardvärdet Falskt för detta.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En sammanfattning av de rekursiva åtgärderna, inklusive antalet lyckade och misslyckade försök, samt en fortsättningstoken om åtgärden avslutades i förtid.

Returtyp

AccessControlChangeResult

Undantag

AzureError

Användaren kan starta om åtgärden med hjälp av continuation_token fältet i AzureError om token är tillgänglig.

Anger den tid då en fil upphör att gälla och tas bort.

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

Parametrar

expiry_options: str

Obligatorisk

Krävs. Anger förfallotidens läge. Möjliga värden är: "NeverExpire", "RelativeToCreation", "RelativeToNow", "Absolute"

expires_on: datetime eller int

Obligatorisk

Tiden för att ange att filen ska upphöra att gälla. När expiry_options är RelativeTo* ska expires_on vara en int i millisekunder. Om typen av expires_on är datetime ska den vara i UTC-tid.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

None

Anger systemegenskaper för filen eller katalogen.

Om en egenskap anges för content_settings åsidosätts alla egenskaper.

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

Parametrar

content_settings: ContentSettings

Obligatorisk

ContentSettings-objekt som används för att ange fil-/katalogegenskaper.

lease: DataLakeLeaseClient eller str

Om detta anges lyckas set_file_system_metadata endast om filsystemets lån är aktivt och matchar detta ID.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

file/directory-updated property dict (Etag och senast ändrad)

Returtyp

Dict[str, Any]

Anger ett eller flera användardefinierade namn/värde-par för det angivna filsystemet. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filsystemet. Om du vill ta bort alla metadata från filsystemet anropar du den här åtgärden utan metadatadiktering.

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

Parametrar

metadata: Dict[str, str]

Obligatorisk

En diktamen som innehåller namn/värde-par som ska associeras med filsystemet som metadata. Exempel: {'category':'test'}

lease: DataLakeLeaseClient eller str

Om det anges lyckas set_file_system_metadata bara om filsystemets lån är aktivt och matchar det här ID:t.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

file system-updated property dict (Etag och senast ändrad).

Ändrar Access Control på en sökväg och undersökvägar.

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

Parametrar

acl: str

Obligatorisk

Ändrar POSIX-åtkomstkontrollrättigheter för filer och kataloger. Värdet är en kommaavgränsad lista över åtkomstkontrollposter. Varje åtkomstkontrollpost (ACE) består av ett omfång, en typ, en användare eller gruppidentifierare och behörigheter i formatet "[scope:][type]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

Återanrop där anroparen kan spåra förloppet för åtgärden samt samla in sökvägar som inte kunde ändras Access Control.

continuation_token: str

Valfri fortsättningstoken som kan användas för att återuppta tidigare stoppad åtgärd.

batch_size: int

Valfritt. Om datauppsättningens storlek överskrider batchstorleken delas åtgärden upp i flera begäranden så att förloppet kan spåras. Batchstorleken ska vara mellan 1 och 2 000. Standardvärdet när ospecificerat är 2000.

max_batches: int

Valfritt. Definierar maximalt antal batchar som en enda ändring Access Control åtgärden kan köra. Om maxvärdet nås innan alla undersökvägar bearbetas kan fortsättningstoken användas för att återuppta åtgärden. Tomt värde anger att det maximala antalet batchar i obundna och åtgärden fortsätter till slutet.

continue_on_failure: bool

Om värdet är Falskt avslutas åtgärden snabbt när användarfel uppstår (4XX). Om sant ignoreras användarfel och åtgärden fortsätter med andra underentiteter i katalogen. Fortsättningstoken returneras endast när continue_on_failure är Sant vid användarfel. Om du inte anger standardvärdet är Falskt för detta.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En sammanfattning av de rekursiva åtgärderna, inklusive antalet lyckade och misslyckade åtgärder, samt en fortsättningstoken om åtgärden avslutades i förtid.

Returtyp

AccessControlChangeResult

Undantag

AzureError

Användaren kan starta om åtgärden med hjälp av continuation_token fältet i AzureError om token är tillgänglig.

Ladda upp data till en fil.

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

Parametrar

data

Obligatorisk

Innehåll som ska laddas upp till filen

length: int

Obligatorisk

Storleken på data i byte.

overwrite: bool

Obligatorisk

för att skriva över en befintlig fil eller inte.

content_settings: ContentSettings

ContentSettings-objekt som används för att ange sökvägsegenskaper.

metadata: Optional[Dict[str, str]]

Namn/värde-par som är associerade med bloben som metadata.

lease: DataLakeLeaseClient eller str

Krävs om bloben har ett aktivt lån. Värdet kan vara ett DataLakeLeaseClient-objekt eller låne-ID:t som en sträng.

umask: str

Valfritt och endast giltigt om hierarkiskt namnområde är aktiverat för kontot. När du skapar en fil eller katalog och den överordnade mappen inte har någon standard-ACL begränsar umask behörigheterna för filen eller katalogen som ska skapas. Den resulterande behörigheten ges av p & ^u, där p är behörigheten och du är umask. Om p till exempel är 0777 och du är 0057 är den resulterande behörigheten 0720. Standardbehörigheten är 0777 för en katalog och 0666 för en fil. Standard-umask är 0027. Umasken måste anges i en 4-siffrig oktal notation (t.ex. 0766).

permissions: str

Valfritt och endast giltigt om hierarkiskt namnområde är aktiverat för kontot. Anger POSIX-åtkomstbehörigheter för filägaren, filägargruppen och andra. Varje klass kan beviljas läs-, skriv- eller körningsbehörighet. Den klibbiga biten stöds också. Både symbolisk (rwxrw-rw-) och 4-siffrig oktal notation (t.ex. 0766) stöds.

if_modified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since: datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

validate_content: bool

Om det är sant beräknas en MD5-hash för varje segment i filen. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med hashen som skickades. Detta är främst värdefullt för att identifiera bitflips på tråden om http i stället för https, som https (standard), redan verifieras. Observera att denna MD5-hash inte lagras med bloben. Observera också att om den är aktiverad används inte den minneseffektiva uppladdningsalgoritmen eftersom databehandling av MD5-hashen kräver buffring av hela block, och detta minskar syftet med den minneseffektiva algoritmen.

etag: str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

Krypterar data på tjänstsidan med den angivna nyckeln. Användning av kundspecifika nycklar måste göras via HTTPS.

timeout: int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här. Den här metoden kan göra flera anrop till tjänsten och tidsgränsen gäller för varje anrop individuellt.

chunk_size: int

Den maximala segmentstorleken för att ladda upp en fil i segment. Standardvärdet är 100*1024*1024 eller 100 MB.

encryption_context: str

Anger krypteringskontexten som ska anges för filen.

Returer

svarsdikt (Etag och senast ändrad).

Den version av lagrings-API:et som används för begäranden.

Det platsläge som klienten använder för närvarande.

Som standard är detta "primärt". Alternativen är "primär" och "sekundär".

Den fullständiga primära slutpunkts-URL:en.

Värdnamnet för den primära slutpunkten.

Den fullständiga sekundära slutpunkts-URL:en om den har konfigurerats.

Om den inte är tillgänglig utlöses en ValueError. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

Undantag

ValueError

Värdnamnet för den sekundära slutpunkten.

Om det inte är tillgängligt blir det Ingen. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används.

Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på aktuell location_mode. :returns: Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används. :rtype: str

acquire_lease	Begär ett nytt lån. Om filen eller katalogen inte har något aktivt lån skapar DataLake-tjänsten ett lån för filen/katalogen och returnerar ett nytt låne-ID.
append_data	Lägg till data i filen.
close	Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.
create_file	Skapa en ny fil.
delete_file	Markerar den angivna filen för borttagning.
download_file	Laddar ned en fil till StorageStreamDownloader. Metoden readall() måste användas för att läsa allt innehåll, eller readinto() måste användas för att ladda ned filen till en dataström. Med segment() returneras en iterator som gör att användaren kan iterera över innehållet i segment.
exists	Returnerar Sant om en fil finns och returnerar False annars.
flush_data	Checka in tidigare bifogade data.
from_connection_string	Skapa DataLakeFileClient från en anslutningssträng. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	Returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för filen. Den returnerar inte innehållet i filen.
query_file	Gör det möjligt för användare att välja/projekt på datalake-fildata genom att tillhandahålla enkla frågeuttryck. De här åtgärderna returnerar en DataLakeFileQueryReader, användarna måste använda readall() eller readinto() för att hämta frågedata.
remove_access_control_recursive	Tar bort Access Control på en sökväg och undersökvägar.
rename_file	Byt namn på källfilen.
set_access_control	Ange ägare, grupp, behörigheter eller åtkomstkontrollistan för en sökväg.
set_access_control_recursive	Anger Access Control på en sökväg och undersökvägar.
set_file_expiry	Anger den tid då en fil upphör att gälla och tas bort.
set_http_headers	Anger systemegenskaper för filen eller katalogen. Om en egenskap anges för content_settings åsidosätts alla egenskaper.
set_metadata	Anger ett eller flera användardefinierade namn/värde-par för det angivna filsystemet. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filsystemet. Om du vill ta bort alla metadata från filsystemet anropar du den här åtgärden utan metadatadiktering.
update_access_control_recursive	Ändrar Access Control på en sökväg och undersökvägar.
upload_data	Ladda upp data till en fil.

Dela via

DataLakeFileClient Klass

Konstruktor

Parametrar

Exempel

Variabler

Metoder

acquire_lease

Parametrar

Returer

Returtyp

append_data

Parametrar

Returer

Exempel

close

create_file

Parametrar

Returer

Exempel

delete_file

Parametrar

Returer

Exempel

download_file

Parametrar

Returer

Returtyp

Exempel

exists

Parametrar

Returer

Returtyp

flush_data

Parametrar

Returer

Exempel

from_connection_string

Parametrar

get_access_control

Parametrar

get_file_properties

Parametrar

Returer

Returtyp

Exempel

query_file

Parametrar

Returer

Returtyp

Exempel

remove_access_control_recursive

Parametrar

Returer

Returtyp

Undantag

rename_file

Parametrar

Returer

Returtyp

Exempel

set_access_control

Parametrar

set_access_control_recursive

Parametrar

Returer

Returtyp

Undantag

set_file_expiry

Parametrar

Returtyp

set_http_headers

Parametrar

Returer

Returtyp

set_metadata

Parametrar

Returer

update_access_control_recursive

Parametrar