ShareLeaseClient class
Een client die leases beheert voor een ShareFileClient- of ShareClient-.
Zie https://learn.microsoft.com/rest/api/storageservices/lease-file en Zie https://learn.microsoft.com/rest/api/storageservices/lease-share
Constructors
| Share |
Hiermee maakt u een exemplaar van ShareLeaseClient. |
Methoden
| acquire |
Hiermee wordt een vergrendeling van een bestand, share of share-momentopname voor schrijf- en verwijderbewerkingen tot stand brengt en beheerd. |
| break |
Beëindigen van de lease afdwingen. |
| change |
De id van een bestaande lease wijzigen. |
| release |
Om de lease vrij te maken als deze niet meer nodig is, zodat een andere klant onmiddellijk een lease kan verkrijgen. |
| renew |
De lease verlengen. Alleen beschikbaar voor lease op momentopname van delen of delen. Houd er rekening mee dat de lease kan worden verlengd, zelfs als deze is verlopen zolang de share niet opnieuw is geleased sinds de vervaldatum van die lease. Wanneer u een lease verlengt, wordt de tijdsduur van de lease opnieuw ingesteld. |
Constructordetails
ShareLeaseClient(ShareClient | ShareFileClient, string)
Hiermee maakt u een exemplaar van ShareLeaseClient.
new ShareLeaseClient(client: ShareClient | ShareFileClient, leaseId?: string)Parameters
- client
De client voor het indienen van de leasebewerkingsaanvragen.
- leaseId
-
string
Oorspronkelijke voorgestelde lease-id.
Eigenschapdetails
leaseId
Hiermee haalt u de lease-id op.
string leaseIdWaarde van eigenschap
string
url
Haalt de URL op.
string urlWaarde van eigenschap
string
Methodedetails
acquireLease(number, LeaseOperationOptions)
Hiermee wordt een vergrendeling van een bestand, share of share-momentopname voor schrijf- en verwijderbewerkingen tot stand brengt en beheerd.
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameters
- duration
-
number
Hiermee geeft u de duur van de lease in seconden. Voor het bestand is de enige toegestane waarde -1 voor een lease die nooit verloopt. Voor delen moet -1 of tussen 15 en 60 zijn.
- options
- LeaseOperationOptions
Opties voor de leasebeheerbewerking.
Retouren
Promise<LeaseOperationResponse>
Antwoordgegevens voor het verkrijgen van leasebewerking.
breakLease(LeaseOperationOptions)
Beëindigen van de lease afdwingen.
function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameters
- options
- LeaseOperationOptions
Opties voor de leasebeheerbewerking.
Retouren
Promise<LeaseOperationResponse>
Antwoordgegevens voor onderbrekings leasebewerking.
changeLease(string, LeaseOperationOptions)
De id van een bestaande lease wijzigen.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameters
- proposedLeaseId
-
string
de voorgestelde nieuwe lease-id.
- options
- LeaseOperationOptions
Opties voor de leasebeheerbewerking.
Retouren
Promise<LeaseOperationResponse>
Antwoordgegevens voor het wijzigen van de leasebewerking.
releaseLease(LeaseOperationOptions)
Om de lease vrij te maken als deze niet meer nodig is, zodat een andere klant onmiddellijk een lease kan verkrijgen.
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameters
- options
- LeaseOperationOptions
Opties voor de leasebeheerbewerking.
Retouren
Promise<LeaseOperationResponse>
Antwoordgegevens voor de release-leasebewerking.
renewLease(LeaseOperationOptions)
De lease verlengen. Alleen beschikbaar voor lease op momentopname van delen of delen. Houd er rekening mee dat de lease kan worden verlengd, zelfs als deze is verlopen zolang de share niet opnieuw is geleased sinds de vervaldatum van die lease. Wanneer u een lease verlengt, wordt de tijdsduur van de lease opnieuw ingesteld.
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameters
- options
- LeaseOperationOptions
Opties voor de leasebeheerbewerking.
Retouren
Promise<LeaseOperationResponse>
Antwoordgegevens voor het verlengen van de leasebewerking.