ShareLeaseClient Klas
Hiermee maakt u een nieuwe ShareLeaseClient.
Deze client biedt leasebewerkingen voor een ShareClient of ShareFileClient.
- Overname
-
builtins.objectShareLeaseClient
Constructor
ShareLeaseClient(client: ShareFileClient | ShareClient, lease_id: str | None = None)
Parameters
- client
- ShareFileClient of ShareClient
De client van het bestand of de share die u wilt leasen.
- lease_id
- str
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 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. Met deze bewerking wordt een vergrendeling van een bestand of share voor schrijf- en verwijderbewerkingen tot stand en beheerd. Als het bestand of de share geen actieve lease heeft, maakt de file- of share-service een lease voor het bestand of de share. Als het bestand een actieve lease heeft, kunt u alleen een nieuwe lease aanvragen met behulp van de actieve lease-id. Als het bestand of de share geen actieve lease heeft, maakt de service Bestand of Delen een lease voor het bestand en retourneert een nieuwe lease-id. |
break_lease |
Forceert de lease als het bestand of de share een actieve lease heeft. Elke geautoriseerde aanvraag kan de lease verbreken; de aanvraag is niet vereist om een overeenkomende lease-id op te geven. Een oneindige lease wordt onmiddellijk verbroken. Zodra een lease is verbroken, kan deze niet meer worden gewijzigd. Elke geautoriseerde aanvraag kan de lease verbreken; de aanvraag is niet vereist om een overeenkomende lease-id op te geven. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen. |
change |
Hiermee wijzigt u de lease-id van een actieve lease. Een wijziging moet de huidige lease-id in x-ms-lease-id bevatten en een nieuwe lease-id in x-ms-proposed-lease-id. |
release |
Hiermee wordt de lease vrijgegeven. De lease kan worden vrijgegeven als de lease-id die is opgegeven in de aanvraag overeenkomt met de lease-id die is gekoppeld aan de share of het bestand. Door de lease vrij te geven, kan een andere client onmiddellijk de lease voor de share of het bestand verkrijgen zodra de release is voltooid. |
renew |
Hiermee wordt de lease van het aandeel verlengd. De share-lease kan worden vernieuwd als de lease-id die is opgegeven in de leaseclient overeenkomt met de id die is gekoppeld aan de share. Houd er rekening mee dat de lease kan worden verlengd, zelfs als deze is verlopen zolang het aandeel niet opnieuw is geleased sinds het verstrijken van die lease. Wanneer u een lease verlengt, wordt de klok voor de leaseduur opnieuw ingesteld. Nieuw in versie 12.6.0. |
acquire
Vraagt een nieuwe lease aan. Met deze bewerking wordt een vergrendeling van een bestand of share voor schrijf- en verwijderbewerkingen tot stand en beheerd. Als het bestand of de share geen actieve lease heeft, maakt de file- of share-service een lease voor het bestand of de share. Als het bestand een actieve lease heeft, kunt u alleen een nieuwe lease aanvragen met behulp van de actieve lease-id.
Als het bestand of de share geen actieve lease heeft, maakt de service Bestand of Delen een lease voor het bestand en retourneert een nieuwe lease-id.
acquire(**kwargs: Any) -> None
Parameters
- lease_duration
- int
Hiermee geeft u de duur van de lease, in seconden, of een negatieve (-1) voor een lease die nooit verloopt. Bestandsleases verlopen nooit. Een niet-oneindige share-lease kan tussen 15 en 60 seconden duren. De duur van een share-lease kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige share-lease).
- 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-file-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
Forceert de lease als het bestand of de share een actieve lease heeft. Elke geautoriseerde aanvraag kan de lease verbreken; de aanvraag is niet vereist om een overeenkomende lease-id op te geven. Een oneindige lease wordt onmiddellijk verbroken.
Zodra een lease is verbroken, kan deze niet meer worden gewijzigd. Elke geautoriseerde aanvraag kan de lease verbreken; de aanvraag is niet vereist om een overeenkomende lease-id op te geven. Wanneer een lease is verbroken, geeft het antwoord het interval in seconden aan totdat een nieuwe lease kan worden verkregen.
break_lease(**kwargs: Any) -> int
Parameters
- lease_break_period
- int
Dit is de voorgestelde duur van seconden die de share-lease moet voortzetten voordat deze wordt onderbroken, tussen 0 en 60 seconden. Deze onderbrekingsperiode wordt alleen gebruikt als deze korter is dan de resterende tijd van de share-lease. Als dit langer is, wordt de resterende tijd van de lease van het aandeel gebruikt. Een nieuwe share-lease is niet beschikbaar voordat de onderbrekingsperiode is verstreken, maar de lease van het aandeel kan langer worden vastgehouden dan de onderbrekingsperiode. Als deze header niet wordt weergegeven met een onderbrekingsbewerking, wordt de lease van een aandeel met een vaste duur beƫindigd nadat de resterende leaseperiode van het aandeel is verstreken en een oneindige share-lease onmiddellijk beƫindigd.
Nieuw in versie 12.6.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-file-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
change
Hiermee wijzigt u de lease-id van een actieve lease. Een wijziging moet de huidige lease-id in x-ms-lease-id bevatten en een nieuwe lease-id in x-ms-proposed-lease-id.
change(proposed_lease_id: str, **kwargs: Any) -> None
Parameters
- proposed_lease_id
- str
Voorgestelde lease-id, in een GUID-tekenreeksindeling. De bestands- of shareservice genereert een fout (ongeldige aanvraag) als de voorgestelde lease-id niet de juiste indeling heeft.
- 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-file-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
Hiermee wordt de lease vrijgegeven. De lease kan worden vrijgegeven als de lease-id die is opgegeven in de aanvraag overeenkomt met de lease-id die is gekoppeld aan de share of het bestand. Door de lease vrij te geven, kan een andere client onmiddellijk de lease voor de share of het bestand verkrijgen zodra de release is voltooid.
release(**kwargs: Any) -> None
Parameters
- 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-file-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
renew
Hiermee wordt de lease van het aandeel verlengd.
De share-lease kan worden vernieuwd als de lease-id die is opgegeven in de leaseclient overeenkomt met de id die is gekoppeld aan de share. Houd er rekening mee dat de lease kan worden verlengd, zelfs als deze is verlopen zolang het aandeel niet opnieuw is geleased sinds het verstrijken van die lease. Wanneer u een lease verlengt, wordt de klok voor de leaseduur opnieuw ingesteld.
Nieuw in versie 12.6.0.
renew(**kwargs: Any) -> None
Parameters
- 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-file-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
Azure SDK for Python