Delen via


BlobLeaseClient Klas

Hiermee maakt u een nieuwe BlobLeaseClient.

Deze client biedt leasebewerkingen op een BlobClient of ContainerClient.

Overname
azure.storage.blob._lease.BlobLeaseClient
BlobLeaseClient

Constructor

BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)

Parameters

client
BlobClient of ContainerClient
Vereist

De client van de blob of container die moet worden geleased.

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 er een 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 onderhouden. Dit is Geen als er nog geen lease is verkregen of gewijzigd.

last_modified
datetime

De laatste gewijzigde tijdstempel 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 de container geen actieve lease heeft, maakt de Blob-service een lease voor de container en retourneert een nieuwe lease-id.

break_lease

Verbreek de lease als de container of blob een actieve lease heeft.

Zodra een lease is verbroken, kan deze niet meer worden verlengd. 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 lease-onderbrekingsperiode verlopen, gedurende welke tijd geen leasebewerkingen kunnen worden uitgevoerd, met uitzondering van onderbreking en vrijgave op de container of blob. 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 de container of blob. Door de lease vrij te geven, kan een andere client onmiddellijk de lease voor de container of blob verkrijgen zodra de release is voltooid.

renew

Hiermee wordt de lease verlengd.

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

acquire

Vraagt een nieuwe lease aan.

Als de container geen actieve lease heeft, maakt de Blob-service een lease voor de container en retourneert een nieuwe lease-id.

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

Parameters

lease_duration
int
Vereist

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

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.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags die alleen moeten worden uitgevoerd op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

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

Retourtype

break_lease

Verbreek de lease als de container of blob een actieve lease heeft.

Zodra een lease is verbroken, kan deze niet meer worden verlengd. 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 lease-onderbrekingsperiode verlopen, gedurende welke tijd geen leasebewerkingen kunnen worden uitgevoerd, met uitzondering van onderbreking en vrijgave op de container of blob. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen.

async 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. Als het langer is, 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 header niet wordt weergegeven met een onderbrekingsbewerking, breekt een lease met een vaste duur na het verstrijken van de resterende leaseperiode en een oneindige lease onmiddellijk af.

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.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags die alleen moeten worden uitgevoerd op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

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

Retouren

Geschatte resterende tijd in de leaseperiode, in seconden.

Retourtype

int

change

Wijzig de lease-id van een actieve lease.

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

Parameters

proposed_lease_id
str
Vereist

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

if_modified_since
datetime

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

if_unmodified_since
datetime

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

etag
str

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

match_condition
MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags die alleen moeten worden uitgevoerd op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

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

Retouren

Geen

release

Laat de lease los.

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

async 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 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.

if_tags_match_condition
str

Geef een SQL where-component op voor blobtags die alleen moeten worden uitgevoerd op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

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

Retouren

Geen

renew

Hiermee wordt de lease verlengd.

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

async 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 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.

if_tags_match_condition
str

Geef een SQL Where-component op voor blobtags om alleen te werken op blob met een overeenkomende waarde. bijvoorbeeld "\"tagname\"='my tag'"

Nieuw in versie 12.4.0.

timeout
int

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

Retouren

Geen