DataLakeLeaseClient Klass

Skapar en ny DataLakeLeaseClient.

Den här klienten tillhandahåller låneåtgärder på en FileSystemClient, DataLakeDirectoryClient eller DataLakeFileClient.

Arv

azure.storage.filedatalake._data_lake_lease.DataLakeLeaseClient

DataLakeLeaseClient

Konstruktor

DataLakeLeaseClient(client: FileSystemClient | DataLakeDirectoryClient | DataLakeFileClient, lease_id: str | None = None)

Parametrar

client

FileSystemClient eller DataLakeDirectoryClient eller DataLakeFileClient

Obligatorisk

Klienten för filsystemet, katalogen eller filen som ska leasas.

lease_id

str

standardvärde: None

En sträng som representerar låne-ID:t för ett befintligt lån. Det här värdet behöver inte anges för att kunna skaffa ett nytt lån eller bryta ett.

Variabler

id

str

ID:t för lånet som för närvarande underhålls. Detta kommer att vara Ingen om inget lån ännu har förvärvats.

etag

str

ETag av lånet håller för närvarande på att underhållas. Detta blir Ingen om inget lån ännu har förvärvats eller ändrats.

last_modified

datetime

Den senast ändrade tidsstämpeln för lånet som för närvarande underhålls. Detta blir Ingen om inget lån ännu har förvärvats eller ändrats.

Metoder

acquire	Begär ett nytt lån. Om fil-/filsystemet inte har ett aktivt lån skapar DataLake-tjänsten ett lån för fil-/filsystemet och returnerar ett nytt låne-ID.
break_lease	Avbryt lånet om filsystemet eller filen har ett aktivt lån. När ett lån har brutits kan det inte förnyas. Alla auktoriserade begäranden kan bryta lånet. begäran krävs inte för att ange ett matchande låne-ID. När ett lån bryts kan låneperioden förflutit, under vilken tid ingen låneåtgärd förutom avbrott och lansering kan utföras på filsystemet eller filen. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas.
change	Ändra låne-ID för ett aktivt lån.
release	Frigör lånet. Lånet kan frisläppas om det angivna klientlåne-ID:t matchar det som är associerat med filsystemet eller filen. När lånet släpps kan en annan klient omedelbart hämta lånet för filsystemet eller filen så snart versionen är klar.
renew	Förnyar lånet. Lånet kan förnyas om det låne-ID som anges i låneklienten matchar det som är associerat med filsystemet eller filen. Observera att lånet kan förnyas även om det har upphört att gälla så länge filsystemet eller filen inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetidsklockan.

acquire

Begär ett nytt lån.

Om fil-/filsystemet inte har ett aktivt lån skapar DataLake-tjänsten ett lån för fil-/filsystemet och returnerar ett nytt låne-ID.

async acquire(lease_duration: int = -1, **kwargs: int | None) -> None

Parametrar

lease_duration

int

Obligatorisk

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. Standardvärdet är -1 (oändligt lån).

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.

Returtyp

None

break_lease

Avbryt lånet om filsystemet eller filen har ett aktivt lån.

När ett lån har brutits kan det inte förnyas. Alla auktoriserade begäranden kan bryta lånet. begäran krävs inte för att ange ett matchande låne-ID. När ett lån bryts kan låneperioden förflutit, under vilken tid ingen låneåtgärd förutom avbrott och lansering kan utföras på filsystemet eller filen. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas.

async break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int

Parametrar

lease_break_period

int

Obligatorisk

Det här är den föreslagna varaktigheten på sekunder som lånet ska fortsätta innan det bryts, mellan 0 och 60 sekunder. Den här brytperioden används bara om den är kortare än den tid som återstår för lånet. Om den är längre används den återstående tiden för lånet. Ett nytt lån kommer inte att vara tillgängligt innan avbrottsperioden har löpt ut, men lånet kan hållas längre än avbrottsperioden. Om den här rubriken inte visas med en avbrottsåtgärd bryts ett lån med fast varaktighet efter att den återstående låneperioden har förflutit och ett oändligt lån bryts omedelbart.

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.

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

Ungefärlig tid kvar i låneperioden, i sekunder.

Returtyp

int

change

Ändra låne-ID för ett aktivt lån.

async change(proposed_lease_id: str, **kwargs: Any) -> None

Parametrar

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

Ingen

release

Frigör lånet.

Lånet kan frisläppas om det angivna klientlåne-ID:t matchar det som är associerat med filsystemet eller filen. När lånet släpps kan en annan klient omedelbart hämta lånet för filsystemet eller filen så snart versionen är klar.

async release(**kwargs: Any) -> None

Parametrar

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

Ingen

renew

Förnyar lånet.

Lånet kan förnyas om det låne-ID som anges i låneklienten matchar det som är associerat med filsystemet eller filen. Observera att lånet kan förnyas även om det har upphört att gälla så länge filsystemet eller filen inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetidsklockan.

async renew(**kwargs: Any) -> None

Parametrar

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

Ingen