DataLakeLeaseClient Klas

Hiermee maakt u een nieuwe DataLakeLeaseClient.

Deze client biedt leasebewerkingen op een FileSystemClient, DataLakeDirectoryClient of DataLakeFileClient.

Overname

builtins.object

DataLakeLeaseClient

Constructor

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

Parameters

client

FileSystemClient of DataLakeDirectoryClient of DataLakeFileClient

Vereist

De client van het bestandssysteem, de map of het te leasen bestand.

lease_id

str

standaardwaarde: None

Een tekenreeks die de lease-id van een bestaande lease vertegenwoordigt. Deze waarde hoeft niet te worden opgegeven om een nieuwe lease te verkrijgen of een lease te verbreken.

Variabelen

id

str

De id van de lease die momenteel wordt onderhouden. Dit is Geen als er nog geen lease is verkregen.

etag

str

De ETag van de lease die momenteel wordt gehandhaafd. Dit is Geen als er nog geen lease is verkregen of gewijzigd.

last_modified

datetime

De tijdstempel van de laatste wijziging van de lease die momenteel wordt onderhouden. Dit is Geen als er nog geen lease is verkregen of gewijzigd.

Methoden

acquire	Vraagt een nieuwe lease aan. Als het bestand/bestandssysteem geen actieve lease heeft, maakt de DataLake-service een lease op het bestand/bestandssysteem en retourneert een nieuwe lease-id.
break_lease	Verbreek de lease als het bestandssysteem of bestand een actieve lease heeft. Zodra een lease is verbroken, kan deze niet worden vernieuwd. Elke geautoriseerde aanvraag kan de lease verbreken; de aanvraag is niet vereist om een overeenkomende lease-id op te geven. Wanneer een lease wordt verbroken, mag de periode voor het einde van de lease verlopen. Gedurende deze periode kan er geen leasebewerking worden uitgevoerd, behalve onderbreking en release op het bestandssysteem of bestand. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen.
change	Wijzig de lease-id van een actieve lease.
release	Laat de lease los. De lease kan worden vrijgegeven als de opgegeven clientlease-id overeenkomt met de id die is gekoppeld aan het bestandssysteem of bestand. Door de lease vrij te geven, kan een andere client de lease voor het bestandssysteem of bestand onmiddellijk verkrijgen zodra de release is voltooid.
renew	Hiermee wordt de lease verlengd. De lease kan worden vernieuwd als de lease-id die is opgegeven in de leaseclient overeenkomt met de id die is gekoppeld aan het bestandssysteem of bestand. Houd er rekening mee dat de lease kan worden verlengd, zelfs als deze is verlopen zolang het bestandssysteem of bestand niet opnieuw is geleased sinds het verlopen van die lease. Wanneer u een lease verlengt, wordt de klok voor de leaseduur opnieuw ingesteld.

acquire

Vraagt een nieuwe lease aan.

Als het bestand/bestandssysteem geen actieve lease heeft, maakt de DataLake-service een lease op het bestand/bestandssysteem en retourneert een nieuwe lease-id.

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

Parameters

lease_duration

int

Vereist

Hiermee geeft u de duur van de lease op, in seconden, of negatief (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige lease).

if_modified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout

int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retourtype

None

break_lease

Verbreek de lease als het bestandssysteem of bestand een actieve lease heeft.

Zodra een lease is verbroken, kan deze niet worden vernieuwd. Elke geautoriseerde aanvraag kan de lease verbreken; de aanvraag is niet vereist om een overeenkomende lease-id op te geven. Wanneer een lease wordt verbroken, mag de periode voor het einde van de lease verlopen. Gedurende deze periode kan er geen leasebewerking worden uitgevoerd, behalve onderbreking en release op het bestandssysteem of bestand. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen.

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

Parameters

lease_break_period

int

Vereist

Dit is de voorgestelde duur van seconden die de lease moet voortzetten voordat deze wordt verbroken, tussen 0 en 60 seconden. Deze onderbrekingsperiode wordt alleen gebruikt als deze korter is dan de resterende tijd van de lease. Indien langer, wordt de resterende tijd van de lease gebruikt. Een nieuwe lease is niet beschikbaar voordat de onderbrekingsperiode is verstreken, maar de lease kan langer worden vastgehouden dan de onderbrekingsperiode. Als deze koptekst niet wordt weergegeven met een onderbrekingsbewerking, wordt een lease met een vaste duur beëindigd nadat de resterende leaseperiode is verstreken en wordt een oneindige lease onmiddellijk verbroken.

if_modified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

timeout

int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Geschatte resterende tijd in de leaseperiode, in seconden.

Retourtype

int

change

Wijzig de lease-id van een actieve lease.

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

Parameters

proposed_lease_id

str

Vereist

Voorgestelde lease-id, in een GUID-tekenreeksindeling. De DataLake-service retourneert 400 (ongeldige aanvraag) als de voorgestelde lease-id niet de juiste indeling heeft.

if_modified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout

int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Geen

release

Laat de lease los.

De lease kan worden vrijgegeven als de opgegeven clientlease-id overeenkomt met de id die is gekoppeld aan het bestandssysteem of bestand. Door de lease vrij te geven, kan een andere client de lease voor het bestandssysteem of bestand onmiddellijk verkrijgen zodra de release is voltooid.

release(**kwargs: Any) -> None

Parameters

if_modified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds het opgegeven tijdstip is gewijzigd.

if_unmodified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout

int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Geen

renew

Hiermee wordt de lease verlengd.

De lease kan worden vernieuwd als de lease-id die is opgegeven in de leaseclient overeenkomt met de id die is gekoppeld aan het bestandssysteem of bestand. Houd er rekening mee dat de lease kan worden verlengd, zelfs als deze is verlopen zolang het bestandssysteem of bestand niet opnieuw is geleased sinds het verlopen van die lease. Wanneer u een lease verlengt, wordt de klok voor de leaseduur opnieuw ingesteld.

renew(**kwargs: Any) -> None

Parameters

if_modified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.

if_unmodified_since

datetime

Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

timeout

int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.

Retouren

Geen