azure.storage.filedatalake.FileSystemClient class

Begär ett nytt lån. Om filsystemet inte har något aktivt lån skapar DataLake-tjänsten ett lån i filsystemet och returnerar ett nytt låne-ID.

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

Parametrar

lease_duration: int

Obligatorisk

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

lease_id: str

Obligatorisk

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

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

Returtyp

DataLakeLeaseClient

Exempel

Hämtar ett lån för filsystemet.


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

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

close() -> None

Skapa katalog

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

Parametrar

directory: str eller DirectoryProperties

Obligatorisk

Katalogen som du vill interagera med. Detta kan antingen vara namnet på katalogen eller en instans av DirectoryProperties.

metadata: dict(str, str)

Obligatorisk

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

content_settings: ContentSettings

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

lease: DataLakeLeaseClient eller str

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

umask: str

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

owner: str

Ägaren till filen eller katalogen.

group: str

Den ägande gruppen av filen eller katalogen.

acl: str

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

lease_id: str

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

lease_duration: int

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

permissions: str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

DataLakeDirectoryClient

Exempel

Skapa katalog i filsystemet.


   directory_client = file_system_client.create_directory("mydirectory")

Skapa fil

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

Parametrar

file: str eller FileProperties

Obligatorisk

Filen som du vill interagera med. Detta kan antingen vara namnet på filen eller en instans av FileProperties.

content_settings: ContentSettings

Obligatorisk

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

metadata: dict(str, str)

Obligatorisk

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

lease: DataLakeLeaseClient eller str

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

umask: str

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

owner: str

Ägaren till filen eller katalogen.

group: str

Den ägande gruppen av filen eller katalogen.

acl: str

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

lease_id: str

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

lease_duration: int

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

expires_on: datetime eller int

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

permissions: str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

DataLakeFileClient

Exempel

Skapa en fil i filsystemet.


   file_client = file_system_client.create_file("myfile")

Skapar ett nytt filsystem under det angivna kontot.

Om filsystemet med samma namn redan finns utlöses en ResourceExistsError. Den här metoden returnerar en klient som du kan interagera med det nyligen skapade filsystemet med.

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

Parametrar

metadata: dict(str, str)

Obligatorisk

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

public_access: PublicAccess

Obligatorisk

Ange om data i filsystemet ska kunna nås offentligt och åtkomstnivån.

encryption_scope_options: dict eller EncryptionScopeOptions

Anger standardkrypteringsomfånget som ska anges i filsystemet och används för alla framtida skrivningar.

Nytt i version 12.9.0.

timeout: int

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

Returer

En ordlista med svarshuvuden.

Returtyp

Dict[str, Union[str, datetime]]

Exempel

Skapa ett filsystem i datalake-tjänsten.


   file_system_client.create_file_system()

Markerar den angivna sökvägen för borttagning.

delete_directory(directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Parametrar

directory: str eller DirectoryProperties

Obligatorisk

Katalogen som du vill interagera med. Detta kan antingen vara namnet på katalogen eller en instans av DirectoryProperties.

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

DataLakeDirectoryClient

Exempel

Ta bort katalogen i filsystemet.


   file_system_client.delete_directory("mydirectory")

Markerar den angivna filen för borttagning.

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

Parametrar

file: str eller FileProperties

Obligatorisk

Filen som du vill interagera med. Detta kan antingen vara namnet på filen eller en instans av FileProperties.

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

DataLakeFileClient

Exempel

Ta bort filen i filsystemet.


   file_system_client.delete_file("myfile")

Markerar det angivna filsystemet för borttagning.

Filsystemet och alla filer som ingår i det tas senare bort under skräpinsamlingen. Om filsystemet inte hittas utlöses en ResourceNotFoundError.

delete_file_system(**kwargs: Any) -> None

Parametrar

lease: str eller DataLakeLeaseClient

Om det anges lyckas delete_file_system endast om filsystemets lån är aktivt och matchar det här ID:t. Krävs om filsystemet har ett aktivt lån.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returtyp

None

Exempel

Ta bort ett filsystem i datalake-tjänsten.


   file_system_client.delete_file_system()

Returnerar Sant om det finns ett filsystem och returnerar False annars.

exists(**kwargs: Any) -> bool

Parametrar

timeout: int

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

Returer

Sant om det finns ett filsystem, annars Falskt.

Returtyp

bool

Skapa FileSystemClient från en anslutningssträng.

: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

Parametrar

conn_str: str

Obligatorisk

En anslutningssträng till ett Azure Storage-konto.

file_system_name: str

Obligatorisk

Namnet på filsystemet som ska interagera med.

credential

standardvärde: None

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

Exempel

Skapa FileSystemClient från anslutningssträng


   from azure.storage.filedatalake import FileSystemClient
   file_system_client = FileSystemClient.from_connection_string(self.connection_string, "filesystem")

Få en klient att interagera med den angivna katalogen.

Katalogen behöver inte redan finnas.

get_directory_client(directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parametrar

directory: str eller DirectoryProperties

Obligatorisk

Katalogen som du vill interagera med. Detta kan antingen vara namnet på katalogen eller en instans av DirectoryProperties.

Returer

En DataLakeDirectoryClient.

Returtyp

DataLakeDirectoryClient

Exempel

Hämta katalogklienten för att interagera med en specifik katalog.


   # Get the DataLakeDirectoryClient from the FileSystemClient to interact with a specific file
   directory_client = file_system_client.get_directory_client("mynewdirectory")

Hämta en klient för att interagera med den angivna filen.

Filen behöver inte redan finnas.

get_file_client(file_path: FileProperties | str) -> DataLakeFileClient

Parametrar

file_path: str eller FileProperties

Obligatorisk

Filen som du vill interagera med. Detta kan antingen vara sökvägen till filen (från rotkatalogen) eller en instans av FileProperties. T.ex. katalog/underkatalog/fil

Returer

En DataLakeFileClient.

Returtyp

DataLakeFileClient

Exempel

Hämta filklienten för att interagera med en specifik fil.


   # Get the FileClient from the FileSystemClient to interact with a specific file
   file_client = file_system_client.get_file_client("mynewfile")

Hämtar behörigheterna för det angivna filsystemet. Behörigheterna anger om filsystemdata kan nås offentligt.

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

Parametrar

lease: DataLakeLeaseClient eller str

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

timeout: int

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

Returer

Få åtkomst till principinformation i en dikta.

Returtyp

dict[str, Any]

Returnerar alla användardefinierade metadata och systemegenskaper för det angivna filsystemet. De data som returneras innehåller inte filsystemets lista över sökvägar.

get_file_system_properties(**kwargs: Any) -> FileSystemProperties

Parametrar

lease: str eller DataLakeLeaseClient

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

timeout: int

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

Returer

Egenskaper för det angivna filsystemet i ett filsystemobjekt.

Returtyp

FileSystemProperties

Exempel

Hämta egenskaper i filsystemet.


   properties = file_system_client.get_file_system_properties()

Returnerar en generator för att lista sökvägarna (kan vara filer eller kataloger) under det angivna filsystemet. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

get_paths(path: str | None = None, recursive: bool | None = True, max_results: int | None = None, **kwargs) -> ItemPaged[PathProperties]

Parametrar

path: str

Obligatorisk

Filtrerar resultatet för att endast returnera sökvägar under den angivna sökvägen.

recursive: Optional[bool]

Obligatorisk

Valfritt. Ange True som rekursiv, False för iterativ.

max_results: int

Obligatorisk

Ett valfritt värde som anger det maximala antalet objekt som ska returneras per sida. Om svaret utelämnas eller är större än 5 000 innehåller det upp till 5 000 objekt per sida.

upn

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

timeout: int

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

Returer

Ett iterabelt svar (automatisk sidindelning) för PathProperties.

Returtyp

ItemPaged[PathProperties]

Exempel

Lista sökvägarna i filsystemet.


   path_list = file_system_client.get_paths()
   for path in path_list:
       print(path.name + '\n')

Returnerar en generator för att visa en lista över de borttagna sökvägarna (filen eller katalogen) under det angivna filsystemet. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.

Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2020-06-12".

list_deleted_paths(**kwargs: Any) -> ItemPaged[DeletedPathProperties]

Parametrar

path_prefix: str

Filtrerar resultatet så att endast sökvägar under den angivna sökvägen returneras.

results_per_page: int

Ett valfritt värde som anger det maximala antalet objekt som ska returneras per sida. Om det utelämnas eller är större än 5 000 innehåller svaret upp till 5 000 objekt per sida.

timeout: int

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

Returer

Ett iterabelt svar (automatisk sidindelning) för DeletedPathProperties.

Returtyp

ItemPaged[DeletedPathProperties]

Anger behörigheter för det angivna filsystemet eller lagrade åtkomstprinciper som kan användas med signaturer för delad åtkomst. Behörigheterna anger om filer i ett filsystem kan kommas åt offentligt.

set_file_system_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Parametrar

signed_identifiers: dict[str, AccessPolicy]

Obligatorisk

En ordlista med åtkomstprinciper som ska associeras med filsystemet. Ordlistan kan innehålla upp till 5 element. En tom ordlista rensar de åtkomstprinciper som angetts för tjänsten.

public_access: PublicAccess

Obligatorisk

Ange om data i filsystemet ska kunna nås offentligt och åtkomstnivån.

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

timeout: int

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

Returer

File System-updated property dict (Etag och senast ändrad).

Returtyp

dict[str, str,

datetime]

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

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

Parametrar

metadata: dict[str, str]

Obligatorisk

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

lease: str eller DataLakeLeaseClient

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

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

Returtyp

Dict[str, str]

Exempel

Ange metadata i filsystemet.


   # Create key, value pairs for metadata
   metadata = {'type': 'test'}

   # Set metadata on the file system
   file_system_client.set_file_system_metadata(metadata=metadata)

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

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

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

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

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

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

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

Undantag

ValueError

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

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

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

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

acquire_lease	Begär ett nytt lån. Om filsystemet inte har något aktivt lån skapar DataLake-tjänsten ett lån i filsystemet och returnerar ett nytt låne-ID.
close	Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.
create_directory	Skapa katalog
create_file	Skapa fil
create_file_system	Skapar ett nytt filsystem under det angivna kontot. Om filsystemet med samma namn redan finns utlöses en ResourceExistsError. Den här metoden returnerar en klient som du kan interagera med det nyligen skapade filsystemet med.
delete_directory	Markerar den angivna sökvägen för borttagning.
delete_file	Markerar den angivna filen för borttagning.
delete_file_system	Markerar det angivna filsystemet för borttagning. Filsystemet och alla filer som ingår i det tas senare bort under skräpinsamlingen. Om filsystemet inte hittas utlöses en ResourceNotFoundError.
exists	Returnerar Sant om det finns ett filsystem och returnerar False annars.
from_connection_string	Skapa FileSystemClient från en anslutningssträng. :return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient
get_directory_client	Få en klient att interagera med den angivna katalogen. Katalogen behöver inte redan finnas.
get_file_client	Hämta en klient för att interagera med den angivna filen. Filen behöver inte redan finnas.
get_file_system_access_policy	Hämtar behörigheterna för det angivna filsystemet. Behörigheterna anger om filsystemdata kan nås offentligt.
get_file_system_properties	Returnerar alla användardefinierade metadata och systemegenskaper för det angivna filsystemet. De data som returneras innehåller inte filsystemets lista över sökvägar.
get_paths	Returnerar en generator för att lista sökvägarna (kan vara filer eller kataloger) under det angivna filsystemet. Generatorn följer lazily fortsättningstoken som returneras av tjänsten.
list_deleted_paths	Returnerar en generator för att visa en lista över de borttagna sökvägarna (filen eller katalogen) under det angivna filsystemet. Generatorn följer lazily fortsättningstoken som returneras av tjänsten. Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2020-06-12".
set_file_system_access_policy	Anger behörigheter för det angivna filsystemet eller lagrade åtkomstprinciper som kan användas med signaturer för delad åtkomst. Behörigheterna anger om filer i ett filsystem kan kommas åt offentligt.
set_file_system_metadata	Anger ett eller flera användardefinierade namn/värde-par för det angivna filsystemet. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filsystemet. Om du vill ta bort alla metadata från filsystemet anropar du den här åtgärden utan metadatadikt.

Dela via

FileSystemClient Klass

Konstruktor

Parametrar

Exempel

Variabler

Metoder

acquire_lease

Parametrar

Returer

Returtyp

Exempel

close

create_directory

Parametrar

Returer

Exempel

create_file

Parametrar

Returer

Exempel

create_file_system

Parametrar

Returer

Returtyp

Exempel

delete_directory

Parametrar

Returer

Exempel

delete_file

Parametrar

Returer

Exempel

delete_file_system

Parametrar

Returtyp

Exempel

exists

Parametrar

Returer

Returtyp

from_connection_string

Parametrar

Exempel

get_directory_client

Parametrar

Returer

Returtyp

Exempel

get_file_client

Parametrar

Returer

Returtyp

Exempel

get_file_system_access_policy

Parametrar

Returer

Returtyp

get_file_system_properties

Parametrar

Returer

Returtyp

Exempel

get_paths

Parametrar

Returer

Returtyp

Exempel

list_deleted_paths

Parametrar

Returer

Returtyp

set_file_system_access_policy

Parametrar

Returer

Returtyp

set_file_system_metadata

Parametrar

Returer