FileSystemClient Klas
Een client voor interactie met een specifiek bestandssysteem, zelfs als dat bestandssysteem mogelijk nog niet bestaat.
Voor bewerkingen die betrekking hebben op een specifieke map of bestand in dit bestandssysteem, kan een mapclient of bestandsclient worden opgehaald met behulp van de get_directory_client functies of get_file_client .
- Overname
-
azure.storage.filedatalake._shared.base_client.StorageAccountHostsMixinFileSystemClient
Constructor
FileSystemClient(account_url: str, file_system_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)
Parameters
- credential
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 het 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 'name' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.
- api_version
- str
De storage-API-versie die moet worden gebruikt voor aanvragen. De standaardwaarde is de meest recente serviceversie die compatibel is met de huidige SDK. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies.
Voorbeelden
Haal een FileSystemClient op uit een bestaande DataLakeServiceClient.
# Instantiate a DataLakeServiceClient using a connection string
from azure.storage.filedatalake import DataLakeServiceClient
datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)
# Instantiate a FileSystemClient
file_system_client = datalake_service_client.get_file_system_client("mynewfilesystem")
Variabelen
- url
- str
De volledige eindpunt-URL naar het bestandssysteem, inclusief SAS-token indien gebruikt.
- primary_endpoint
- str
De volledige URL van het primaire eindpunt.
- primary_hostname
- str
De hostnaam van het primaire eindpunt.
Methoden
acquire_lease |
Vraagt een nieuwe lease aan. Als het bestandssysteem geen actieve lease heeft, maakt de DataLake-service een lease op het bestandssysteem 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 |
Map maken |
create_file |
Bestand maken |
create_file_system |
Hiermee maakt u een nieuw bestandssysteem onder het opgegeven account. Als het bestandssysteem met dezelfde naam al bestaat, wordt er een ResourceExistsError gegenereerd. Deze methode retourneert een client waarmee kan worden gecommuniceerd met het zojuist gemaakte bestandssysteem. |
delete_directory |
Markeert het opgegeven pad voor verwijdering. |
delete_file |
Hiermee wordt het opgegeven bestand gemarkeerd voor verwijdering. |
delete_file_system |
Hiermee wordt het opgegeven bestandssysteem gemarkeerd voor verwijdering. Het bestandssysteem en alle bestanden in het bestandssysteem worden later verwijderd tijdens de garbagecollection. Als het bestandssysteem niet wordt gevonden, wordt er een ResourceNotFoundError gegenereerd. |
exists |
Retourneert Waar als er een bestandssysteem bestaat en retourneert anders False. |
from_connection_string |
Maak FileSystemClient op basis van een verbindingsreeks. :return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient |
get_directory_client |
Vraag een client om te communiceren met de opgegeven map. De map hoeft nog niet te bestaan. |
get_file_client |
Vraag een client om te communiceren met het opgegeven bestand. Het bestand hoeft nog niet te bestaan. |
get_file_system_access_policy |
Hiermee haalt u de machtigingen voor het opgegeven bestandssysteem op. De machtigingen geven aan of bestandssysteemgegevens openbaar kunnen worden geopend. |
get_file_system_properties |
Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor het opgegeven bestandssysteem. De geretourneerde gegevens bevatten niet de lijst met paden van het bestandssysteem. |
get_paths |
Retourneert een generator om de paden (kunnen bestanden of mappen zijn) onder het opgegeven bestandssysteem weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd. |
list_deleted_paths |
Retourneert een generator om de verwijderde paden (bestand of map) onder het opgegeven bestandssysteem weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd. Nieuw in versie 12.4.0: deze bewerking is geïntroduceerd in API-versie 2020-06-12. |
set_file_system_access_policy |
Hiermee stelt u de machtigingen voor het opgegeven bestandssysteem of opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures. De machtigingen geven aan of bestanden in een bestandssysteem openbaar toegankelijk zijn. |
set_file_system_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. |
acquire_lease
Vraagt een nieuwe lease aan. Als het bestandssysteem geen actieve lease heeft, maakt de DataLake-service een lease op het bestandssysteem en retourneert een nieuwe lease-id.
acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient
Parameters
- 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. De standaardwaarde is -1 (oneindige lease).
- 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.
- 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
Voorbeelden
Het verkrijgen van een lease op het bestandssysteem.
# Acquire a lease on the file system
lease = file_system_client.acquire_lease()
# Delete file system by passing in the lease
file_system_client.delete_file_system(lease=lease)
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.
close() -> None
create_directory
Map maken
create_directory(directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient
Parameters
- directory
- str of DirectoryProperties
De map waarmee moet worden gecommuniceerd. Dit kan de naam van de map zijn of een exemplaar van DirectoryProperties.
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.
- 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
DataLakeDirectoryClient
Voorbeelden
Maak een map in het bestandssysteem.
directory_client = file_system_client.create_directory("mydirectory")
create_file
Bestand maken
create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient
Parameters
- file
- str of FileProperties
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.
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.
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.
- 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
Voorbeelden
Maak een bestand in het bestandssysteem.
file_client = file_system_client.create_file("myfile")
create_file_system
Hiermee maakt u een nieuw bestandssysteem onder het opgegeven account.
Als het bestandssysteem met dezelfde naam al bestaat, wordt er een ResourceExistsError gegenereerd. Deze methode retourneert een client waarmee kan worden gecommuniceerd met het zojuist gemaakte bestandssysteem.
create_file_system(metadata: Dict[str, str] | None = None, public_access: PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]
Parameters
Een dict met naam-waardeparen om als metagegevens aan het bestandssysteem te koppelen. Voorbeeld: {'Category':'test'}
- public_access
- PublicAccess
Opgeven of gegevens in het bestandssysteem openbaar toegankelijk zijn en het toegangsniveau.
- encryption_scope_options
- dict of EncryptionScopeOptions
Hiermee geeft u het standaardversleutelingsbereik op dat moet worden ingesteld in het bestandssysteem en moet worden gebruikt voor alle toekomstige schrijfbewerkingen.
Nieuw in versie 12.9.0.
- 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
Voorbeelden
Een bestandssysteem maken in de datalake-service.
file_system_client.create_file_system()
delete_directory
Markeert het opgegeven pad voor verwijdering.
delete_directory(directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient
Parameters
- directory
- str of DirectoryProperties
De map waarmee moet worden gecommuniceerd. 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 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
DataLakeDirectoryClient
Voorbeelden
Verwijder de map in het bestandssysteem.
file_system_client.delete_directory("mydirectory")
delete_file
Hiermee wordt het opgegeven bestand gemarkeerd voor verwijdering.
delete_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient
Parameters
- file
- str of FileProperties
Het bestand waarmee u wilt communiceren. Dit kan de naam van het bestand zijn of een exemplaar van FileProperties.
- 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
DataLakeFileClient
Voorbeelden
Verwijder het bestand in het bestandssysteem.
file_system_client.delete_file("myfile")
delete_file_system
Hiermee wordt het opgegeven bestandssysteem gemarkeerd voor verwijdering.
Het bestandssysteem en alle bestanden in het bestandssysteem worden later verwijderd tijdens de garbagecollection. Als het bestandssysteem niet wordt gevonden, wordt er een ResourceNotFoundError gegenereerd.
delete_file_system(**kwargs: Any) -> None
Parameters
- lease
- str of DataLakeLeaseClient
Indien opgegeven, slaagt delete_file_system alleen als de lease van het bestandssysteem actief is en overeenkomt met deze id. Vereist als het bestandssysteem 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.
- 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.
Retourtype
Voorbeelden
Een bestandssysteem verwijderen in de datalake-service.
file_system_client.delete_file_system()
exists
Retourneert Waar als er een bestandssysteem 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 bestandssysteem bestaat, anders Onwaar.
Retourtype
from_connection_string
Maak FileSystemClient op basis van een verbindingsreeks.
:return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient
from_connection_string(conn_str: str, file_system_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parameters
- credential
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.
Voorbeelden
FileSystemClient maken op connection string
from azure.storage.filedatalake import FileSystemClient
file_system_client = FileSystemClient.from_connection_string(self.connection_string, "filesystem")
get_directory_client
Vraag een client om te communiceren met de opgegeven map.
De map hoeft nog niet te bestaan.
get_directory_client(directory: DirectoryProperties | str) -> DataLakeDirectoryClient
Parameters
- directory
- str of DirectoryProperties
De map waarmee u wilt communiceren. Dit kan de naam van de map zijn of een exemplaar van DirectoryProperties.
Retouren
Een DataLakeDirectoryClient.
Retourtype
Voorbeelden
De directoryclient laten communiceren met een specifieke map.
# Get the DataLakeDirectoryClient from the FileSystemClient to interact with a specific file
directory_client = file_system_client.get_directory_client("mynewdirectory")
get_file_client
Vraag een client om te communiceren met het opgegeven bestand.
Het bestand hoeft nog niet te bestaan.
get_file_client(file_path: FileProperties | str) -> DataLakeFileClient
Parameters
- file_path
- str of FileProperties
Het bestand waarmee u wilt communiceren. Dit kan het pad van het bestand (uit de hoofdmap) of een exemplaar van FileProperties zijn. bijvoorbeeld map/submap/bestand
Retouren
Een DataLakeFileClient.
Retourtype
Voorbeelden
De bestandsclient laten communiceren met een specifiek bestand.
# Get the FileClient from the FileSystemClient to interact with a specific file
file_client = file_system_client.get_file_client("mynewfile")
get_file_system_access_policy
Hiermee haalt u de machtigingen voor het opgegeven bestandssysteem op. De machtigingen geven aan of bestandssysteemgegevens openbaar kunnen worden geopend.
get_file_system_access_policy(**kwargs: Any) -> Dict[str, Any]
Parameters
- lease
- DataLakeLeaseClient of str
Indien opgegeven, slaagt de bewerking alleen als de lease van het bestandssysteem actief is en overeenkomt met deze id.
- 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
Toegang tot beleidsinformatie in een dict.
Retourtype
get_file_system_properties
Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor het opgegeven bestandssysteem. De geretourneerde gegevens bevatten niet de lijst met paden van het bestandssysteem.
get_file_system_properties(**kwargs: Any) -> FileSystemProperties
Parameters
- lease
- str of DataLakeLeaseClient
Indien opgegeven, slaagt get_file_system_properties alleen als de lease van het bestandssysteem actief is en overeenkomt met deze id.
- 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
Eigenschappen voor het opgegeven bestandssysteem in een bestandssysteemobject.
Retourtype
Voorbeelden
Eigenschappen ophalen in het bestandssysteem.
properties = file_system_client.get_file_system_properties()
get_paths
Retourneert een generator om de paden (kunnen bestanden of mappen zijn) onder het opgegeven bestandssysteem weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.
get_paths(path: str | None = None, recursive: bool | None = True, max_results: int | None = None, **kwargs) -> ItemPaged[PathProperties]
Parameters
- max_results
- int
Een optionele waarde die het maximum aantal items aangeeft dat per pagina moet worden geretourneerd. Als u dit weglaat of groter is dan 5.000, bevat het antwoord maximaal 5000 items per pagina.
- upn
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 '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.
- 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 iterable (automatisch paging) antwoord van PathProperties.
Retourtype
Voorbeelden
De paden in het bestandssysteem weergeven.
path_list = file_system_client.get_paths()
for path in path_list:
print(path.name + '\n')
list_deleted_paths
Retourneert een generator om de verwijderde paden (bestand of map) onder het opgegeven bestandssysteem weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd.
Nieuw in versie 12.4.0: deze bewerking is geïntroduceerd in API-versie 2020-06-12.
list_deleted_paths(**kwargs: Any) -> ItemPaged[DeletedPathProperties]
Parameters
- path_prefix
- str
Filtert de resultaten om alleen paden onder het opgegeven pad te retourneren.
- results_per_page
- int
Een optionele waarde die het maximum aantal items aangeeft dat per pagina moet worden geretourneerd. Als u dit weglaat of groter is dan 5.000, bevat het antwoord maximaal 5000 items per pagina.
- 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 iterable (automatisch paging) antwoord van DeletedPathProperties.
Retourtype
set_file_system_access_policy
Hiermee stelt u de machtigingen voor het opgegeven bestandssysteem of opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures. De machtigingen geven aan of bestanden in een bestandssysteem openbaar toegankelijk zijn.
set_file_system_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]
Parameters
- signed_identifiers
- dict[str, AccessPolicy]
Een woordenlijst met toegangsbeleidsregels die aan het bestandssysteem moeten worden gekoppeld. De woordenlijst kan maximaal 5 elementen bevatten. Met een lege woordenlijst wordt het toegangsbeleid dat voor de service is ingesteld, gewist.
- public_access
- PublicAccess
Opgeven of gegevens in het bestandssysteem openbaar toegankelijk zijn en het toegangsniveau.
- lease
- DataLakeLeaseClient of str
Vereist als het bestandssysteem 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 is gewijzigd sinds de opgegeven datum/tijd.
- 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.
- 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).
Retourtype
set_file_system_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.
set_file_system_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]
Parameters
Een dict met naam-waardeparen die als metagegevens aan het bestandssysteem moeten worden gekoppeld. Voorbeeld: {'category':'test'}
- lease
- str of DataLakeLeaseClient
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
bestandssysteem bijgewerkt eigenschapsdict (Etag en laatst gewijzigd).
Retourtype
Voorbeelden
Metagegevens instellen op het bestandssysteem.
# Create key, value pairs for metadata
metadata = {'type': 'test'}
# Set metadata on the file system
file_system_client.set_file_system_metadata(metadata=metadata)
Kenmerken
api_version
De versie van de Storage-API die wordt gebruikt voor aanvragen.
location_mode
De locatiemodus die de client momenteel gebruikt.
Dit is standaard 'primair'. Opties zijn 'primair' en 'secundair'.
primary_endpoint
De volledige URL van het primaire eindpunt.
primary_hostname
De hostnaam van het primaire eindpunt.
secondary_endpoint
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
secondary_hostname
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.
url
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
Azure SDK for Python