azure.storage.filedatalake.DataLakeDirectoryClient class

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

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

Parametrar

lease_duration: int

Obligatorisk

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

lease_id: str

Obligatorisk

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

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

Returtyp

DataLakeLeaseClient

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

close() -> None

Skapa en ny katalog.

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

Parametrar

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.

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

Returer

En ordlista med svarshuvuden.

Returtyp

Dict[str, Union[str, datetime]]

Exempel

Skapa katalog.


   directory_client.create_directory()

Skapa en ny fil och returnera den filklient som ska interageras med.

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

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

metadata

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 hierarkisk namnrymd är aktiverat för kontot. När du skapar en fil eller katalog och den överordnade mappen inte har en 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 för filen eller katalogen.

acl: str

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

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 lånets varaktighet, 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 en lånetid med hjälp av 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 anges tolkas detta som UTC.

permissions: str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

Returer

DataLakeFileClient

Skapa en underkatalog och returnera den underkatalogklient som ska interageras med.

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

Parametrar

sub_directory: str eller DirectoryProperties

Obligatorisk

Den katalog 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 hierarkisk namnrymd är aktiverat för kontot. När du skapar en fil eller katalog och den överordnade mappen inte har en 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 för filen eller katalogen.

acl: str

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

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 lånets varaktighet, 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 en lånetid med hjälp av förnyelse eller ändring.

permissions: str

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

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 utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

Returer

DataLakeDirectoryClient för underkatalogen.

Markerar den angivna katalogen för borttagning.

delete_directory(**kwargs) -> None

Parametrar

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

Ingen

Exempel

Ta bort katalog.


   new_directory.delete_directory()

Markerar den angivna underkatalogen för borttagning.

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

Parametrar

sub_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 för underkatalogen

Returnerar Sant om det finns en katalog och returnerar False annars.

exists(**kwargs: Any) -> bool

Parametrar

timeout: int

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

Returer

Sant om det finns en katalog, annars Falskt.

Returtyp

bool

Skapa DataLakeDirectoryClient från en anslutningssträng.

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

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. Detta är valfritt om konto-URL:en redan har en SAS-token. 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. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

directory_name: str

Obligatorisk

Namnet på katalogen som du vill interagera med. Katalogen finns under filsystemet.

credential

Obligatorisk

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.

Returer

en DataLakeDirectoryClient

Returtyp

DataLakeDirectoryClient

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

Parametrar

upn: bool

Obligatorisk

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

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

response dict

svarsdikt.

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

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Parametrar

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

Returtyp

DirectoryProperties

Exempel

Hämta egenskaperna för en fil/katalog.


   props = new_directory.get_directory_properties()

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

Filen behöver inte redan finnas.

get_file_client(file: FileProperties | str) -> 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. T.ex. directory/subdirectory/file

Returer

En DataLakeFileClient.

Returtyp

DataLakeFileClient

Hämta en klient för att interagera med den angivna underkatalogen för den aktuella katalogen.

Underkatalogen behöver inte redan finnas.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parametrar

sub_directory: str eller DirectoryProperties

Obligatorisk

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

Returer

En DataLakeDirectoryClient.

Returtyp

DataLakeDirectoryClient

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

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

Parametrar

acl: str

Obligatorisk

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

progress_hook: <xref:func>(AccessControlChanges)

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

continuation_token: str

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

batch_size: int

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

max_batches: int

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

continue_on_failure: bool

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

timeout: int

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

Returer

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

Returtyp

AccessControlChangeResult

Undantag

AzureError

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

Byt namn på källkatalogen.

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

Parametrar

new_name: str

Obligatorisk

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

source_lease: DataLakeLeaseClient eller str

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

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

source_if_modified_since: datetime

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

source_if_unmodified_since: datetime

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

source_etag: str

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

source_match_condition: MatchConditions

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

timeout: int

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

Returer

DataLakeDirectoryClient

Exempel

Byt namn på källkatalogen.


   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)

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

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

Parametrar

owner: str

Obligatorisk

Valfritt. Ägaren till filen eller katalogen.

group: str

Obligatorisk

Valfritt. Den ägande gruppen av filen eller katalogen.

permissions: str

Obligatorisk

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. behörigheter och acl är ömsesidigt uteslutande.

acl: str

Obligatorisk

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]". behörigheter och acl är ömsesidigt uteslutande.

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

response dict

svarsdikt (Etag och senast ändrad).

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

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

Parametrar

acl: str

Obligatorisk

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

progress_hook: <xref:func>(AccessControlChanges)

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

continuation_token: str

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

batch_size: int

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

max_batches: int

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

continue_on_failure: bool

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

timeout: int

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

Returer

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

Returtyp

AccessControlChangeResult

Undantag

AzureError

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

Anger systemegenskaper för filen eller katalogen.

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

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

Parametrar

content_settings: ContentSettings

Obligatorisk

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

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout: int

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

Returer

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

Returtyp

Dict[str, Any]

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

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

Parametrar

metadata: Dict[str, str]

Obligatorisk

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

lease: DataLakeLeaseClient eller str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

Matchningsvillkoret som ska användas på etag.

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

Returer

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

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

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

Parametrar

acl: str

Obligatorisk

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

progress_hook: <xref:func>(AccessControlChanges)

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

continuation_token: str

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

batch_size: int

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

max_batches: int

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

continue_on_failure: bool

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

timeout: int

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

Returer

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

Returtyp

AccessControlChangeResult

Undantag

AzureError

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

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

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

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

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

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

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

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

Undantag

ValueError

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

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

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

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

acquire_lease	Begär ett nytt lån. Om filen eller katalogen inte har något aktivt lån skapar DataLake-tjänsten ett lån för filen/katalogen och returnerar ett nytt låne-ID.
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 en ny katalog.
create_file	Skapa en ny fil och returnera den filklient som ska interageras med.
create_sub_directory	Skapa en underkatalog och returnera den underkatalogklient som ska interageras med.
delete_directory	Markerar den angivna katalogen för borttagning.
delete_sub_directory	Markerar den angivna underkatalogen för borttagning.
exists	Returnerar Sant om det finns en katalog och returnerar False annars.
from_connection_string	Skapa DataLakeDirectoryClient från en anslutningssträng.
get_access_control
get_directory_properties	Returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för katalogen. Den returnerar inte innehållet i katalogen.
get_file_client	Hämta en klient för att interagera med den angivna filen. Filen behöver inte redan finnas.
get_sub_directory_client	Hämta en klient för att interagera med den angivna underkatalogen för den aktuella katalogen. Underkatalogen behöver inte redan finnas.
remove_access_control_recursive	Tar bort Access Control på en sökväg och undersökvägar.
rename_directory	Byt namn på källkatalogen.
set_access_control	Ange listan ägare, grupp, behörigheter eller åtkomstkontroll för en sökväg.
set_access_control_recursive	Anger Access Control på en sökväg och undersökvägar.
set_http_headers	Anger systemegenskaper för filen eller katalogen. Om en egenskap anges för content_settings åsidosätts alla egenskaper.
set_metadata	Anger ett eller flera användardefinierade namn/värde-par för det angivna filsystemet. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filsystemet. Om du vill ta bort alla metadata från filsystemet anropar du den här åtgärden utan metadatadikt.
update_access_control_recursive	Ändrar Access Control på en sökväg och undersökvägar.

Dela via

DataLakeDirectoryClient Klass

Konstruktor

Parametrar

Exempel

Variabler

Metoder

acquire_lease

Parametrar

Returer

Returtyp

close

create_directory

Parametrar

Returer

Returtyp

Exempel

create_file

Parametrar

Returer

create_sub_directory

Parametrar

Returer

delete_directory

Parametrar

Returer

Exempel

delete_sub_directory

Parametrar

Returer

exists

Parametrar

Returer

Returtyp

from_connection_string

Parametrar

Returer

Returtyp

get_access_control

Parametrar

get_directory_properties

Parametrar

Returtyp

Exempel

get_file_client

Parametrar

Returer

Returtyp

get_sub_directory_client

Parametrar

Returer

Returtyp

remove_access_control_recursive

Parametrar

Returer

Returtyp

Undantag

rename_directory

Parametrar

Returer

Exempel

set_access_control

Parametrar

set_access_control_recursive

Parametrar

Returer

Returtyp

Undantag

set_http_headers

Parametrar

Returer

Returtyp

set_metadata

Parametrar

Returer

update_access_control_recursive

Parametrar

Returer

Returtyp

Undantag