azure.storage.filedatalake.DataLakeDirectoryClient 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, 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_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 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

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

Retourtype

DataLakeLeaseClient

Deze methode is het sluiten van de sockets die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met een contextbeheerder.

close() -> None

Maak een nieuwe map.

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

Parameters

metadata: dict(str, str)

Vereist

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

content_settings: ContentSettings

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

lease: DataLakeLeaseClient of str

Vereist als het bestand 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).

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

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

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.

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

Een woordenlijst met antwoordheaders.

Retourtype

Dict[str, Union[str, datetime]]

Voorbeelden

Map maken.


   directory_client.create_directory()

Maak een nieuw bestand en retourneer de bestandsclient waarmee interactie moet worden uitgevoerd.

create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Parameters

file: str of FileProperties

Vereist

Het bestand waarmee moet worden gecommuniceerd. Dit kan de naam van het bestand zijn of een exemplaar van FileProperties.

content_settings: ContentSettings

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

metadata

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

lease: DataLakeLeaseClient of str

Vereist als het bestand 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).

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

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

expires_on: datetime of int

De tijd die nodig is om het bestand te laten 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 tijdzonegegevens worden 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 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.

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

DataLakeFileClient

Maak een submap en retourneer de submapclient waarmee interactie moet worden uitgevoerd.

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

Parameters

sub_directory: str of DirectoryProperties

Vereist

De map waarmee moet worden gecommuniceerd. Dit kan de naam van de map zijn of een exemplaar van DirectoryProperties.

metadata: dict(str, str)

Vereist

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

content_settings: ContentSettings

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

lease: DataLakeLeaseClient of str

Vereist als het bestand 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).

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

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

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.

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.

Retouren

DataLakeDirectoryClient voor de submap.

Markeert de opgegeven map voor verwijdering.

delete_directory(**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

Verwijder de map.


   new_directory.delete_directory()

Hiermee wordt de opgegeven submap gemarkeerd voor verwijdering.

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

Parameters

sub_directory: str of DirectoryProperties

Vereist

De map waarmee u wilt communiceren. Dit kan de naam van de map zijn of een exemplaar van DirectoryProperties.

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

DataLakeDirectoryClient voor de submap

Retourneert Waar als er een map 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. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Waar als er een map bestaat, anders Onwaar.

Retourtype

bool

Maak DataLakeDirectoryClient op basis van een verbindingsreeks.

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

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.

credential

standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

directory_name: str

Vereist

De naam van de map waarmee u wilt werken. De map bevindt zich onder het bestandssysteem.

credential

Vereist

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft of als de connection string al waarden voor gedeelde toegangssleutels heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een 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 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

Retouren

een DataLakeDirectoryClient

Retourtype

DataLakeDirectoryClient

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. Indien 'waar', 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 'onwaar' is, 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 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. 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 de map. De inhoud van de map wordt niet geretourneerd.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Parameters

lease: DataLakeLeaseClient of str

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 de map 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. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retourtype

DirectoryProperties

Voorbeelden

De eigenschappen voor een bestand/map ophalen.


   props = new_directory.get_directory_properties()

Vraag een client om te communiceren met het opgegeven bestand.

Het bestand hoeft nog niet te bestaan.

get_file_client(file: FileProperties | str) -> DataLakeFileClient

Parameters

file: str of FileProperties

Vereist

Het bestand waarmee moet worden gecommuniceerd. Dit kan de naam van het bestand zijn of een exemplaar van FileProperties. bijvoorbeeld map/submap/bestand

Retouren

Een DataLakeFileClient.

Retourtype

DataLakeFileClient

Vraag een client om te communiceren met de opgegeven submap van de huidige map.

De submap hoeft nog niet te bestaan.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parameters

sub_directory: str of DirectoryProperties

Vereist

De map waarmee moet worden gecommuniceerd. Dit kan de naam van de map zijn of een exemplaar van DirectoryProperties.

Retouren

Een DataLakeDirectoryClient.

Retourtype

DataLakeDirectoryClient

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-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 en een gebruikers- of groeps-id in de indeling [bereik:][type]:[id]".

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.

Wijzig de naam van de bronmap.

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

Parameters

new_name: str

Vereist

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

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

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. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

DataLakeDirectoryClient

Voorbeelden

Wijzig de naam van de bronmap.


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

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 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. machtigingen en acl sluiten elkaar uit.

acl: str

Vereist

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

response dict

antwoorddicteren (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-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]".

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.

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

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

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

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 trefwoordargument 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 trefwoordargument 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.
close	Deze methode is het sluiten van de sockets die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met een contextbeheerder.
create_directory	Maak een nieuwe map.
create_file	Maak een nieuw bestand en retourneer de bestandsclient waarmee interactie moet worden uitgevoerd.
create_sub_directory	Maak een submap en retourneer de submapclient waarmee interactie moet worden uitgevoerd.
delete_directory	Markeert de opgegeven map voor verwijdering.
delete_sub_directory	Hiermee wordt de opgegeven submap gemarkeerd voor verwijdering.
exists	Retourneert Waar als er een map bestaat en retourneert anders False.
from_connection_string	Maak DataLakeDirectoryClient op basis van een verbindingsreeks.
get_access_control
get_directory_properties	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor de map. De inhoud van de map wordt niet geretourneerd.
get_file_client	Vraag een client om te communiceren met het opgegeven bestand. Het bestand hoeft nog niet te bestaan.
get_sub_directory_client	Vraag een client om te communiceren met de opgegeven submap van de huidige map. De submap hoeft nog niet te bestaan.
remove_access_control_recursive	Hiermee verwijdert u de Access Control op een pad en subpaden.
rename_directory	Wijzig de naam van de bronmap.
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_http_headers	Hiermee stelt u systeemeigenschappen in voor het bestand of de map. 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.

Share via

DataLakeDirectoryClient Klas

Constructor

Parameters

Voorbeelden

Variabelen

Methoden

acquire_lease

Parameters

Retouren

Retourtype

close

create_directory

Parameters

Retouren

Retourtype

Voorbeelden

create_file

Parameters

Retouren

create_sub_directory

Parameters

Retouren

delete_directory

Parameters

Retouren

Voorbeelden

delete_sub_directory

Parameters

Retouren

exists

Parameters

Retouren

Retourtype

from_connection_string

Parameters

Retouren

Retourtype

get_access_control

Parameters

get_directory_properties

Parameters

Retourtype

Voorbeelden

get_file_client

Parameters

Retouren

Retourtype

get_sub_directory_client

Parameters

Retouren

Retourtype

remove_access_control_recursive

Parameters

Retouren

Retourtype

Uitzonderingen

rename_directory

Parameters

Retouren

Voorbeelden

set_access_control

Parameters

set_access_control_recursive

Parameters

Retouren

Retourtype

Uitzonderingen

set_http_headers

Parameters

Retouren

Retourtype

set_metadata

Parameters

Retouren

update_access_control_recursive

Parameters

Retouren

Retourtype

Uitzonderingen