azure.storage.filedatalake.DataLakeFileClient class

Vraagt een nieuwe lease aan. Als het bestand of de map geen actieve lease heeft, maakt de DataLake-service een lease voor het bestand/de map en retourneert een nieuwe lease-id.

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

Parameters

lease_duration: int

Vereist

Hiermee geeft u de duur van de lease op, in seconden, of negatief (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige lease).

lease_id: str

Vereist

Voorgestelde lease-id, in een GUID-tekenreeksindeling. De DataLake-service retourneert 400 (ongeldige aanvraag) als de voorgestelde lease-id niet de juiste indeling heeft.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een DataLakeLeaseClient-object, dat kan worden uitgevoerd in een contextbeheer.

Retourtype

DataLakeLeaseClient

Voeg gegevens toe aan het bestand.

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

Parameters

data

Vereist

Inhoud die aan het bestand moet worden toegevoegd

offset

Vereist

beginpositie van de gegevens waaraan moet worden toegevoegd.

length

Vereist

Grootte van de gegevens in bytes.

flush: bool

Indien waar, worden de gegevens doorgevoerd nadat deze zijn toegevoegd.

validate_content: bool

Als dit waar is, wordt een MD5-hash van de blokinhoud berekend. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen bij het bestand.

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

Wordt gebruikt om leasebewerkingen uit te voeren, samen met het toevoegen van gegevens.

'acquire' - Een lease verkrijgen. 'automatisch verlengen': een bestaande lease opnieuw vernieuwen. 'release': laat de lease los zodra de bewerking is voltooid. Vereist flush=True. 'acquire-release': verkrijg een lease en geef deze vrij zodra de bewerkingen zijn voltooid. Vereist flush=True.

lease_duration: int

Geldig als lease_action is ingesteld op 'acquire' of 'acquire-release'.

Hiermee geeft u de duur van de lease op, in seconden, of negatief (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige lease).

lease: DataLakeLeaseClient of str

Vereist als het bestand een actieve lease heeft of als lease_action is ingesteld op 'acquire' of 'acquire-release'. Als het bestand een bestaande lease heeft, wordt deze gebruikt om toegang te krijgen tot het bestand. Als u een nieuwe lease verkrijgt, wordt deze gebruikt als de nieuwe lease-id. Waarde kan een DataLakeLeaseClient-object zijn of de lease-id als een tekenreeks.

cpk: CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS.

Retouren

dicteren van de antwoordheader

Voorbeelden

Voeg gegevens toe aan het bestand.


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

Deze methode is om de sockets te sluiten die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met contextbeheer.

close() -> None

Maak een nieuw bestand.

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

Parameters

content_settings: ContentSettings

Vereist

ContentSettings-object dat wordt gebruikt om padeigenschappen in te stellen.

metadata: Optional[Dict[str, str]]

Vereist

Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld.

lease: DataLakeLeaseClient of str

Vereist als het bestand een actieve lease heeft. Waarde kan een DataLakeLeaseClient-object zijn of de lease-id als een tekenreeks.

umask: str

Optioneel en alleen geldig als hiërarchische naamruimte is ingeschakeld voor het account. Wanneer u een bestand of map maakt en de bovenliggende map geen standaard-ACL heeft, beperkt de umask de machtigingen van het bestand of de map die moet worden gemaakt. De resulterende machtiging wordt gegeven door p & ^u, waarbij p de machtiging is en u de umask. Als p bijvoorbeeld 0777 is en u 0057, is de resulterende machtiging 0720. De standaardmachtiging is 0777 voor een map en 0666 voor een bestand. De standaard-umask is 0027. De umask moet worden opgegeven in een 4-cijferige octale notatie (bijvoorbeeld 0766).

owner: str

De eigenaar van het bestand of de map.

group: str

De groep die eigenaar is van het bestand of de map.

acl: str

Hiermee stelt u POSIX-toegangsrechten voor bestanden en mappen in. De waarde is een door komma's gescheiden lijst met vermeldingen van toegangsbeheer. Elke toegangsbeheervermelding (ACE) bestaat uit een bereik, een type, een gebruikers- of groeps-id en machtigingen in de indeling [bereik:][type]:[id]:[machtigingen]".

lease_id: str

Voorgestelde lease-id, in een GUID-tekenreeksindeling. De DataLake-service retourneert 400 (ongeldige aanvraag) als de voorgestelde lease-id niet de juiste indeling heeft.

lease_duration: int

Hiermee geeft u de duur van de lease op, in seconden, of negatief (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen.

expires_on: datetime of int

De tijd waarop het bestand moet verlopen. Als het type expires_on een int is, wordt de verlooptijd ingesteld als het aantal milliseconden dat is verstreken na de aanmaaktijd. Als het type expires_on datum/tijd is, wordt de vervaltijd absoluut ingesteld op de opgegeven tijd. Als er geen tijdzone-informatie wordt opgegeven, wordt dit geïnterpreteerd als UTC.

permissions: str

Optioneel en alleen geldig als hiërarchische naamruimte is ingeschakeld voor het account. Hiermee stelt u POSIX-toegangsmachtigingen in voor de bestandseigenaar, de groep die eigenaar is van het bestand en andere. Aan elke klasse kan de machtiging lezen, schrijven of uitvoeren worden verleend. De sticky bit wordt ook ondersteund. Zowel symbolische (rwxrw-rw-) als 4-cijferige octale notatie (bijvoorbeeld 0766) worden ondersteund.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

cpk: CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

encryption_context: str

Hiermee geeft u de versleutelingscontext op die voor het bestand moet worden ingesteld.

Retouren

antwoorddicteren (Etag en laatst gewijzigd).

Voorbeelden

Bestand maken.


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

Hiermee wordt het opgegeven bestand gemarkeerd voor verwijdering.

delete_file(**kwargs) -> None

Parameters

lease: DataLakeLeaseClient of str

Vereist als het bestand een actieve lease heeft. De waarde kan een LeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Geen

Voorbeelden

Bestand verwijderen.


   new_client.delete_file()

Hiermee downloadt u een bestand naar de StorageStreamDownloader. De methode readall() moet worden gebruikt om alle inhoud te lezen of readinto() moet worden gebruikt om het bestand in een stream te downloaden. Het gebruik van chunks() retourneert een iterator waarmee de gebruiker de inhoud in segmenten kan herhalen.

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

Parameters

offset: int

Vereist

Begin van het bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Moet worden ingesteld als de lengte is opgegeven.

length: int

Vereist

Het aantal bytes dat uit de stream moet worden gelezen. Dit is optioneel, maar moet worden opgegeven voor optimale prestaties.

lease: DataLakeLeaseClient of str

Als dit is opgegeven, slaagt de download alleen als de lease van het bestand actief is en overeenkomt met deze id. Vereist als het bestand een actieve lease heeft.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

cpk: CustomerProvidedEncryptionKey

Ontsleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS. Vereist als het bestand is gemaakt met een Customer-Provided-sleutel.

max_concurrency: int

Het aantal parallelle verbindingen waarmee moet worden gedownload.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier. Deze methode kan meerdere aanroepen naar de service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk.

Retouren

Een streamingobject (StorageStreamDownloader)

Retourtype

StorageStreamDownloader

Voorbeelden

Retourneer de gedownloade gegevens.


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

Retourneert True als een bestand bestaat en retourneert anders False.

exists(**kwargs: Any) -> bool

Parameters

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Waar als er een bestand bestaat, retourneert anders False.

Retourtype

bool

De vorige toegevoegde gegevens doorvoeren.

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

Parameters

offset

Vereist

offset is gelijk aan de lengte van het bestand nadat de vorige toegevoegde gegevens zijn doorgevoerd.

retain_uncommitted_data: bool

Vereist

Alleen geldig voor spoelbewerkingen. Indien "waar", worden niet-verzonden gegevens bewaard nadat de flush-bewerking is voltooid; Anders worden de niet-verzonden gegevens verwijderd na de flush-bewerking. De standaardwaarde is false. Gegevens met offsets kleiner dan de opgegeven positie worden naar het bestand geschreven wanneer het leegmaken is voltooid, maar met deze optionele parameter kunnen gegevens na de leegmaakpositie worden bewaard voor een toekomstige flush-bewerking.

content_settings: ContentSettings

ContentSettings-object dat wordt gebruikt om padeigenschappen in te stellen.

close: bool

Met Azure Storage-gebeurtenissen kunnen toepassingen meldingen ontvangen wanneer bestanden worden gewijzigd. Wanneer Azure Storage-gebeurtenissen zijn ingeschakeld, wordt er een gebeurtenis voor het wijzigen van bestanden gegenereerd. Deze gebeurtenis heeft een eigenschap die aangeeft of dit de laatste wijziging is om het verschil te onderscheiden tussen een tussenliggende flush naar een bestandsstroom en het laatste sluiten van een bestandsstroom. De queryparameter sluiten is alleen geldig wanneer de actie 'leegmaken' is en wijzigingsmeldingen zijn ingeschakeld. Als de waarde van sluiten 'true' is en de flush-bewerking is voltooid, ontvangt de service een melding voor bestandswijziging met een eigenschap die aangeeft dat dit de laatste update is (de bestandsstroom is gesloten). Als 'false' wordt weergegeven, wordt er een wijzigingsmelding gegenereerd die aangeeft dat het bestand is gewijzigd. De standaardwaarde is false. Deze queryparameter wordt ingesteld op true door het Hadoop ABFS-stuurprogramma om aan te geven dat de bestandsstroom is gesloten.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

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

Wordt gebruikt voor het uitvoeren van leasebewerkingen samen met het toevoegen van gegevens.

'acquire': een lease verkrijgen. 'automatisch verlengen': een bestaande lease opnieuw vernieuwen. 'release': de lease vrijgeven zodra de bewerking is voltooid. 'acquire-release': verkrijg een lease en geef deze vrij zodra de bewerkingen zijn voltooid.

lease_duration: int

Geldig als lease_action is ingesteld op 'acquire' of 'acquire-release'.

Hiermee geeft u de duur van de lease, in seconden, of een negatieve (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige lease).

lease: DataLakeLeaseClient of str

Vereist als het bestand een actieve lease heeft of als lease_action is ingesteld op 'acquire' of 'acquire-release'. Als het bestand een bestaande lease heeft, wordt deze gebruikt voor toegang tot het bestand. Als u een nieuwe lease aanschaft, wordt deze gebruikt als de nieuwe lease-id. De waarde kan een DataLakeLeaseClient-object zijn of de lease-id als een tekenreeks.

cpk: CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS.

Retouren

antwoordheader in dict

Voorbeelden

De vorige toegevoegde gegevens doorvoeren.


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

Maak DataLakeFileClient op basis van een verbindingsreeks.

: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

Parameters

conn_str: str

Vereist

Een connection string naar een Azure Storage-account.

file_system_name: str

Vereist

De naam van het bestandssysteem waarmee moet worden gecommuniceerd.

file_path: str

Vereist

Het hele bestandspad, zodat u met een specifiek bestand kunt werken. bijvoorbeeld "{directory}/{subdirectory}/{file}"

credential

standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft of als de connection string al gedeelde toegangssleutelwaarden heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor het account of een exemplaar van een TokenCredentials-klasse van azure.identity. Referenties die hier worden opgegeven, hebben voorrang op de referenties in de connection string. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'name' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

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

Parameters

upn: bool

Vereist

Optioneel. Alleen geldig wanneer hiërarchische naamruimte is ingeschakeld voor het account. Als 'waar' is, worden de waarden van de gebruikersidentiteit die worden geretourneerd in de antwoordheaders x-ms-owner, x-ms-group en x-ms-acl getransformeerd van Azure Active Directory-object-id's naar User Principal Names. Als 'false' wordt weergegeven, worden de waarden geretourneerd als Azure Active Directory-object-id's. De standaardwaarde is false. Houd er rekening mee dat groeps- en toepassingsobject-id's niet worden vertaald omdat ze geen unieke beschrijvende namen hebben.

lease: DataLakeLeaseClient of str

Vereist als het bestand/de map een actieve lease heeft. De waarde kan een LeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

response dict

antwoord-dict.

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het bestand. De inhoud van het bestand wordt niet geretourneerd.

get_file_properties(**kwargs: Any) -> FileProperties

Parameters

lease

Vereist als de map of het bestand een actieve lease heeft. De waarde kan een DataLakeLeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

cpk: CustomerProvidedEncryptionKey

Ontsleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS. Vereist als het bestand is gemaakt met een door de klant opgegeven sleutel.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het bestand.

Retourtype

FileProperties

Voorbeelden

De eigenschappen voor een bestand ophalen.


   properties = file_client.get_file_properties()

Hiermee kunnen gebruikers gegevens van datalake-bestanden selecteren/projecteren door eenvoudige query-expressies op te geven. Deze bewerking retourneert een DataLakeFileQueryReader. Gebruikers moeten readall() of readinto() gebruiken om querygegevens op te halen.

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

Parameters

query_expression: str

Vereist

Vereist. een query-instructie. bijvoorbeeld Selecteer * in DataLakeStorage

on_error: Callable[DataLakeFileQueryError]

Een functie die moet worden aangeroepen voor eventuele verwerkingsfouten die door de service worden geretourneerd.

file_format: DelimitedTextDialect of DelimitedJsonDialect of QuickQueryDialect of str

Optioneel. Definieert de serialisatie van de gegevens die momenteel in het bestand zijn opgeslagen. De standaardinstelling is om de bestandsgegevens te behandelen als CSV-gegevens die zijn opgemaakt in het standaarddialect. Dit kan worden overschreven met een aangepaste DelimitedTextDialect of DelimitedJsonDialect of ParquetDialect (doorgegeven als een tekenreeks of opsomming). Deze dialecten kunnen worden doorgegeven via hun respectieve klassen, de opsomming QuickQueryDialect of als een tekenreeks.

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

Optioneel. Definieert de uitvoerserialisatie voor de gegevensstroom. Standaard worden de gegevens geretourneerd zoals deze worden weergegeven in het bestand. Door een uitvoerindeling op te geven, worden de bestandsgegevens geformatteerd op basis van dat profiel. Deze waarde kan een DelimitedTextDialect of een DelimitedJsonDialect of ArrowDialect zijn. Deze dialecten kunnen worden doorgegeven via hun respectieve klassen, de opsomming QuickQueryDialect of als een tekenreeks.

lease: DataLakeLeaseClient of str

Vereist als het bestand een actieve lease heeft. Waarde kan een DataLakeLeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

cpk: CustomerProvidedEncryptionKey

Ontsleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS. Vereist als het bestand is gemaakt met een Customer-Provided-sleutel.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een streaming-object (DataLakeFileQueryReader)

Retourtype

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Voorbeelden

select/project on datalake-bestandsgegevens door eenvoudige query-expressies op te geven.


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

Hiermee verwijdert u de Access Control op een pad en subpaden.

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

Parameters

acl: str

Vereist

Hiermee verwijdert u POSIX-toegangsrechten voor bestanden en mappen. De waarde is een door komma's gescheiden lijst met vermeldingen van toegangsbeheer. Elke toegangsbeheervermelding (ACE) bestaat uit een bereik, een type en een gebruikers- of groeps-id in de indeling [bereik:][type]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

Callback waarbij de aanroeper de voortgang van de bewerking kan volgen en paden kan verzamelen die niet zijn gewijzigd Access Control.

continuation_token: str

Optioneel vervolgtoken dat kan worden gebruikt om de eerder gestopte bewerking te hervatten.

batch_size: int

Optioneel. Als de grootte van de gegevensset groter is dan de batchgrootte, wordt de bewerking gesplitst in meerdere aanvragen, zodat de voortgang kan worden bijgehouden. De batchgrootte moet tussen 1 en 2000 zijn. De standaardwaarde wanneer dit niet is opgegeven, is 2000.

max_batches: int

Optioneel. Hiermee definieert u het maximum aantal batches dat met één wijziging Access Control bewerking kan worden uitgevoerd. Als het maximum is bereikt voordat alle subpaden zijn verwerkt, kan het vervolgtoken worden gebruikt om de bewerking te hervatten. Lege waarde geeft aan dat het maximum aantal niet-afhankelijke batches en de bewerking wordt voortgezet tot het einde.

continue_on_failure: bool

Als deze optie is ingesteld op Onwaar, wordt de bewerking snel beëindigd wanneer gebruikersfouten (4XX) optreden. Als dit waar is, worden gebruikersfouten genegeerd en wordt de bewerking uitgevoerd op andere subentiteiten van de map. Vervolgtoken wordt alleen geretourneerd wanneer continue_on_failure Waar is in het geval van gebruikersfouten. Als dit niet is ingesteld, is de standaardwaarde Onwaar.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een samenvatting van de recursieve bewerkingen, inclusief het aantal geslaagde en mislukte bewerkingen, evenals een vervolgtoken voor het geval de bewerking voortijdig is beëindigd.

Retourtype

AccessControlChangeResult

Uitzonderingen

AzureError

De gebruiker kan de bewerking opnieuw starten met behulp van continuation_token veld van AzureError als het token beschikbaar is.

Wijzig de naam van het bronbestand.

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

Parameters

new_name: str

Vereist

de nieuwe bestandsnaam waarnaar de gebruiker de naam wil wijzigen. De waarde moet de volgende indeling hebben: {filesystem}/{directory}/{subdirectory}/{file}.

content_settings: ContentSettings

ContentSettings-object dat wordt gebruikt om padeigenschappen in te stellen.

source_lease: DataLakeLeaseClient of str

Een lease-id voor het bronpad. Indien opgegeven, moet het bronpad een actieve lease hebben en moet de lease-id overeenkomen.

lease

Vereist als het bestand/de map een actieve lease heeft. De waarde kan een LeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

source_if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

source_if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

source_etag: str

De bron-ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

source_match_condition: MatchConditions

De bronovereenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

de bestandsclient met de naam gewijzigd

Retourtype

DataLakeFileClient

Voorbeelden

Wijzig de naam van het bronbestand.


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

Stel de eigenaar, groep, machtigingen of toegangsbeheerlijst voor een pad in.

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

Parameters

owner: str

Vereist

Optioneel. De eigenaar van het bestand of de map.

group: str

Vereist

Optioneel. De groep die eigenaar is van het bestand of de map.

permissions: str

Vereist

Optioneel en alleen geldig als hiërarchische naamruimte is ingeschakeld voor het account. Hiermee stelt u POSIX-toegangsmachtigingen in voor de bestandseigenaar, de groep die eigenaar is van het bestand en anderen. Aan elke klasse kan lees-, schrijf- of uitvoeringsmachtigingen worden verleend. De sticky bit wordt ook ondersteund. Zowel symbolische (rwxrw-rw-) als 4-cijferige octale notatie (bijvoorbeeld 0766) worden ondersteund. machtigingen en ACL sluiten elkaar uit.

acl: str

Vereist

Hiermee stelt u POSIX-toegangsbeheerrechten in voor bestanden en mappen. De waarde is een door komma's gescheiden lijst met vermeldingen van toegangsbeheer. Elke toegangsbeheervermelding (ACE) bestaat uit een bereik, een type, een gebruikers- of groeps-id en machtigingen in de indeling [bereik:][type]:[id]:[machtigingen]". machtigingen en ACL sluiten elkaar uit.

lease: DataLakeLeaseClient of str

Vereist als het bestand/de map een actieve lease heeft. De waarde kan een LeaseClient-object zijn of de lease-id als een tekenreeks.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

response dict

antwoorddict (Etag en laatst gewijzigd).

Hiermee stelt u de Access Control op een pad en subpaden.

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

Parameters

acl: str

Vereist

Hiermee stelt u POSIX-toegangsbeheerrechten in voor bestanden en mappen. De waarde is een door komma's gescheiden lijst met vermeldingen van toegangsbeheer. Elke toegangsbeheervermelding (ACE) bestaat uit een bereik, een type, een gebruikers- of groeps-id en machtigingen in de indeling [bereik:][type]:[id]:[machtigingen]".

progress_hook: <xref:func>(AccessControlChanges)

Callback waarbij de beller de voortgang van de bewerking kan bijhouden en paden kan verzamelen die niet zijn gewijzigd Access Control.

continuation_token: str

Optioneel vervolgtoken dat kan worden gebruikt om de eerder gestopte bewerking te hervatten.

batch_size: int

Optioneel. Als de grootte van de gegevensset groter is dan de batchgrootte, wordt de bewerking gesplitst in meerdere aanvragen, zodat de voortgang kan worden bijgehouden. De batchgrootte moet tussen 1 en 2000 zijn. De standaardwaarde wanneer deze niet wordt opgegeven, is 2000.

max_batches: int

Optioneel. Definieert het maximum aantal batches dat één wijziging Access Control bewerking kan uitvoeren. Als het maximum is bereikt voordat alle subpaden zijn verwerkt, kan het vervolgtoken worden gebruikt om de bewerking te hervatten. Lege waarde geeft aan dat het maximum aantal batches in niet-afhankelijke en bewerking wordt voortgezet tot het einde.

continue_on_failure: bool

Als deze optie is ingesteld op Onwaar, wordt de bewerking snel beëindigd bij het optreden van gebruikersfouten (4XX). Als dit waar is, worden gebruikersfouten genegeerd en wordt de bewerking op andere subentiteiten van de map voortgezet. Vervolgtoken wordt alleen geretourneerd wanneer continue_on_failure Waar is in het geval van gebruikersfouten. Als dit niet is ingesteld, is de standaardwaarde Onwaar.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Een samenvatting van de recursieve bewerkingen, inclusief het aantal geslaagde en mislukte bewerkingen, evenals een vervolgtoken voor het geval de bewerking voortijdig is beëindigd.

Retourtype

AccessControlChangeResult

Uitzonderingen

AzureError

De gebruiker kan de bewerking opnieuw starten met behulp van continuation_token veld AzureError als het token beschikbaar is.

Hiermee stelt u de tijd in waarop een bestand verloopt en wordt verwijderd.

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

Parameters

expiry_options: str

Vereist

Vereist. Hiermee wordt de modus van de verlooptijd aangegeven. Mogelijke waarden zijn: 'NeverExpire', 'RelativeToCreation', 'RelativeToNow', 'Absolute'

expires_on: datetime of int

Vereist

De tijd die nodig is om het bestand te laten verlopen. Wanneer expiry_options RelativeTo* is, moet expires_on een int zijn in milliseconden. Als het type expires_on datum/tijd is, moet dit in UTC-tijd zijn.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retourtype

None

Hiermee stelt u systeemeigenschappen voor het bestand of de map in.

Als er één eigenschap is ingesteld voor de content_settings, worden alle eigenschappen overschreven.

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

Parameters

content_settings: ContentSettings

Vereist

ContentSettings-object dat wordt gebruikt voor het instellen van bestands-/mapeigenschappen.

lease: DataLakeLeaseClient of str

Indien opgegeven, slaagt set_file_system_metadata alleen als de lease van het bestandssysteem actief is en overeenkomt met deze id.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

eigenschapsdict bestand/map bijgewerkt (Etag en laatst gewijzigd)

Retourtype

Dict[str, Any]

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor het opgegeven bestandssysteem. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan het bestandssysteem zijn gekoppeld. Als u alle metagegevens uit het bestandssysteem wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteerfunctie.

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

Parameters

metadata: Dict[str, str]

Vereist

Een dict met naam-waardeparen die als metagegevens aan het bestandssysteem moeten worden gekoppeld. Voorbeeld: {'category':'test'}

lease: DataLakeLeaseClient of str

Indien opgegeven, slaagt set_file_system_metadata alleen als de lease van het bestandssysteem actief is en overeenkomt met deze id.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

cpk: CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

bestandssysteem bijgewerkt eigenschapsdict (Etag en laatst gewijzigd).

Hiermee wijzigt u de Access Control op een pad en subpaden.

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

Parameters

acl: str

Vereist

Hiermee wijzigt u POSIX-toegangsbeheerrechten voor bestanden en mappen. De waarde is een door komma's gescheiden lijst met vermeldingen van toegangsbeheer. Elke toegangsbeheervermelding (ACE) bestaat uit een bereik, een type, een gebruikers- of groeps-id en machtigingen in de indeling [bereik:][type]:[id]:[machtigingen]".

progress_hook: <xref:func>(AccessControlChanges)

Callback waarbij de beller de voortgang van de bewerking kan bijhouden en paden kan verzamelen die niet zijn gewijzigd Access Control.

continuation_token: str

Optioneel vervolgtoken dat kan worden gebruikt om de eerder gestopte bewerking te hervatten.

batch_size: int

Optioneel. Als de grootte van de gegevensset groter is dan de batchgrootte, wordt de bewerking gesplitst in meerdere aanvragen, zodat de voortgang kan worden bijgehouden. De batchgrootte moet tussen 1 en 2000 zijn. De standaardwaarde wanneer deze niet wordt opgegeven, is 2000.

max_batches: int

Optioneel. Definieert het maximum aantal batches dat één wijziging Access Control bewerking kan uitvoeren. Als het maximum is bereikt voordat alle subpaden zijn verwerkt, kan het vervolgtoken worden gebruikt om de bewerking te hervatten. Lege waarde geeft aan dat het maximum aantal batches in niet-afhankelijke en bewerking wordt voortgezet tot het einde.

continue_on_failure: bool

Als deze optie is ingesteld op Onwaar, wordt de bewerking snel beëindigd bij het optreden van gebruikersfouten (4XX). Als dit waar is, worden gebruikersfouten genegeerd en wordt de bewerking op andere subentiteiten van de map voortgezet. Vervolgtoken wordt alleen geretourneerd wanneer continue_on_failure Waar is in het geval van gebruikersfouten. Als dit niet is ingesteld, is de standaardwaarde Onwaar.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Een samenvatting van de recursieve bewerkingen, inclusief het aantal geslaagde en mislukte bewerkingen, evenals een vervolgtoken voor het geval de bewerking voortijdig is beëindigd.

Retourtype

AccessControlChangeResult

Uitzonderingen

AzureError

De gebruiker kan de bewerking opnieuw starten met behulp van continuation_token veld AzureError als het token beschikbaar is.

Gegevens uploaden naar een bestand.

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

Parameters

data

Vereist

Inhoud die naar bestand moet worden geüpload

length: int

Vereist

Grootte van de gegevens in bytes.

overwrite: bool

Vereist

om een bestaand bestand te overschrijven of niet.

content_settings: ContentSettings

ContentSettings-object dat wordt gebruikt om padeigenschappen in te stellen.

metadata: Optional[Dict[str, str]]

Naam-waardeparen die als metagegevens aan de blob zijn gekoppeld.

lease: DataLakeLeaseClient of str

Vereist als de blob een actieve lease heeft. De waarde kan een DataLakeLeaseClient-object zijn of de lease-id als een tekenreeks.

umask: str

Optioneel en alleen geldig als hiërarchische naamruimte is ingeschakeld voor het account. Wanneer u een bestand of map maakt en de bovenliggende map geen standaard-ACL heeft, beperkt de umask de machtigingen van het bestand of de map die moet worden gemaakt. De resulterende machtiging wordt gegeven door p & ^u, waarbij p de machtiging is en u de umask. Als p bijvoorbeeld 0777 is en u 0057, is de resulterende machtiging 0720. De standaardmachtiging is 0777 voor een map en 0666 voor een bestand. De standaard-umask is 0027. De umask moet worden opgegeven in een 4-cijferige octale notatie (bijvoorbeeld 0766).

permissions: str

Optioneel en alleen geldig als hiërarchische naamruimte is ingeschakeld voor het account. Hiermee stelt u POSIX-toegangsmachtigingen in voor de bestandseigenaar, de groep die eigenaar is van het bestand en anderen. Aan elke klasse kan lees-, schrijf- of uitvoeringsmachtigingen worden verleend. De sticky bit wordt ook ondersteund. Zowel symbolische (rwxrw-rw-) als 4-cijferige octale notatie (bijvoorbeeld 0766) worden ondersteund.

if_modified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since: datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

validate_content: bool

Als dit waar is, berekent u een MD5-hash voor elk segment van het bestand. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de kabel als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen met de blob. Houd er ook rekening mee dat als dit is ingeschakeld, het algoritme voor geheugenefficiënte upload niet wordt gebruikt, omdat voor het berekenen van de MD5-hash hele blokken moeten worden gebufferd, waardoor het doel van het geheugenefficiënte algoritme wordt genegeerd.

etag: str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition: MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

cpk: CustomerProvidedEncryptionKey

Versleutelt de gegevens aan de servicezijde met de opgegeven sleutel. Het gebruik van door de klant verstrekte sleutels moet worden uitgevoerd via HTTPS.

timeout: int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren. Met deze methode kunnen meerdere aanroepen naar de service worden uitgevoerd en de time-out is van toepassing op elke aanroep afzonderlijk.

chunk_size: int

De maximale segmentgrootte voor het uploaden van een bestand in segmenten. De standaardwaarde is 100*1024*1024 of 100 MB.

encryption_context: str

Hiermee geeft u de versleutelingscontext op die moet worden ingesteld voor het bestand.

Retouren

antwoorddict (Etag en laatst gewijzigd).

De versie van de Storage-API die wordt gebruikt voor aanvragen.

De locatiemodus die de client momenteel gebruikt.

Dit is standaard 'primair'. Opties zijn 'primair' en 'secundair'.

De volledige URL van het primaire eindpunt.

De hostnaam van het primaire eindpunt.

De volledige URL van het secundaire eindpunt, indien geconfigureerd.

Als dit niet beschikbaar is, wordt er een ValueError gegenereerd. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname sleutelwoordargument bij instantiëring.

Uitzonderingen

ValueError

De hostnaam van het secundaire eindpunt.

Als dit niet beschikbaar is, is dit Geen. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname sleutelwoordargument bij instantiëring.

De volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt.

Dit kan het primaire eindpunt of het secundaire eindpunt zijn, afhankelijk van de huidige location_mode. :retourneert: de volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt. :rtype: str

acquire_lease	Vraagt een nieuwe lease aan. Als het bestand of de map geen actieve lease heeft, maakt de DataLake-service een lease voor het bestand/de map en retourneert een nieuwe lease-id.
append_data	Voeg gegevens toe aan het bestand.
close	Deze methode is om de sockets te sluiten die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met contextbeheer.
create_file	Maak een nieuw bestand.
delete_file	Hiermee wordt het opgegeven bestand gemarkeerd voor verwijdering.
download_file	Hiermee downloadt u een bestand naar de StorageStreamDownloader. De methode readall() moet worden gebruikt om alle inhoud te lezen of readinto() moet worden gebruikt om het bestand in een stream te downloaden. Het gebruik van chunks() retourneert een iterator waarmee de gebruiker de inhoud in segmenten kan herhalen.
exists	Retourneert True als een bestand bestaat en retourneert anders False.
flush_data	De vorige toegevoegde gegevens doorvoeren.
from_connection_string	Maak DataLakeFileClient op basis van een verbindingsreeks. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het bestand. De inhoud van het bestand wordt niet geretourneerd.
query_file	Hiermee kunnen gebruikers gegevens van datalake-bestanden selecteren/projecteren door eenvoudige query-expressies op te geven. Deze bewerking retourneert een DataLakeFileQueryReader. Gebruikers moeten readall() of readinto() gebruiken om querygegevens op te halen.
remove_access_control_recursive	Hiermee verwijdert u de Access Control op een pad en subpaden.
rename_file	Wijzig de naam van het bronbestand.
set_access_control	Stel de eigenaar, groep, machtigingen of toegangsbeheerlijst voor een pad in.
set_access_control_recursive	Hiermee stelt u de Access Control op een pad en subpaden.
set_file_expiry	Hiermee stelt u de tijd in waarop een bestand verloopt en wordt verwijderd.
set_http_headers	Hiermee stelt u systeemeigenschappen voor het bestand of de map in. Als er één eigenschap is ingesteld voor de content_settings, worden alle eigenschappen overschreven.
set_metadata	Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor het opgegeven bestandssysteem. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan het bestandssysteem zijn gekoppeld. Als u alle metagegevens uit het bestandssysteem wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteerfunctie.
update_access_control_recursive	Hiermee wijzigt u de Access Control op een pad en subpaden.
upload_data	Gegevens uploaden naar een bestand.

Delen via

DataLakeFileClient Klas

Constructor

Parameters

Voorbeelden

Variabelen

Methoden

acquire_lease

Parameters

Retouren

Retourtype

append_data

Parameters

Retouren

Voorbeelden

close

create_file

Parameters

Retouren

Voorbeelden

delete_file

Parameters

Retouren

Voorbeelden

download_file

Parameters

Retouren

Retourtype

Voorbeelden

exists

Parameters

Retouren

Retourtype

flush_data

Parameters

Retouren

Voorbeelden

from_connection_string

Parameters

get_access_control

Parameters

get_file_properties

Parameters

Retouren

Retourtype

Voorbeelden

query_file

Parameters

Retouren

Retourtype

Voorbeelden

remove_access_control_recursive

Parameters

Retouren

Retourtype

Uitzonderingen

rename_file

Parameters

Retouren

Retourtype

Voorbeelden

set_access_control

Parameters

set_access_control_recursive

Parameters

Retouren

Retourtype

Uitzonderingen

set_file_expiry

Parameters

Retourtype

set_http_headers

Parameters

Retouren

Retourtype

set_metadata

Parameters

Retouren

update_access_control_recursive

Parameters