ShareLeaseClient class

Pakket:

@azure/storage-file-share

Een client die leases beheert voor een ShareFileClient of ShareClient.

Zien https://docs.microsoft.com/rest/api/storageservices/lease-file en zien https://docs.microsoft.com/rest/api/storageservices/lease-share

Constructors

ShareLeaseClient(ShareFileClient, string)

Hiermee maakt u een exemplaar van ShareLeaseClient.

Eigenschappen

leaseId	Hiermee haalt u de lease-id op.
url	Hiermee haalt u de URL op.

Methoden

acquireLease(number, LeaseOperationOptions)	Hiermee wordt een vergrendeling van een bestand, share of momentopname van een share gemaakt en beheerd voor schrijf- en verwijderbewerkingen.
breakLease(LeaseOperationOptions)	De lease geforceerd beëindigen.
changeLease(string, LeaseOperationOptions)	De id van een bestaande lease wijzigen.
releaseLease(LeaseOperationOptions)	Om de lease vrij te maken als deze niet meer nodig is, zodat een andere klant onmiddellijk een lease kan verkrijgen.
renewLease(LeaseOperationOptions)	Om de lease te verlengen. Alleen beschikbaar voor lease op share of momentopname van 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 van de leaseduur opnieuw ingesteld.

Constructordetails

ShareLeaseClient(ShareFileClient, string)

Hiermee maakt u een exemplaar van ShareLeaseClient.

new ShareLeaseClient(client: ShareFileClient, leaseId?: string)

Parameters

client

ShareFileClient

De client die de leasebewerking aanvraagt.

leaseId

string

Initiële voorgestelde lease-id.

Eigenschapdetails

leaseId

Hiermee haalt u de lease-id op.

string leaseId

Waarde van eigenschap

string

url

Hiermee haalt u de URL op.

string url

Waarde van eigenschap

string

Methodedetails

acquireLease(number, LeaseOperationOptions)

Hiermee wordt een vergrendeling van een bestand, share of momentopname van een share gemaakt en beheerd voor schrijf- en verwijderbewerkingen.

function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Parameters

duration

number

Hiermee geeft u de duur van de lease in seconden. Voor bestand is de enige toegestane waarde -1 voor een lease die nooit verloopt. Voor share moet -1 of tussen 15 en 60 zijn.

options

LeaseOperationOptions

Opties voor de leasebeheerbewerking.

Retouren

Promise<LeaseOperationResponse>

Antwoordgegevens voor het verkrijgen van leasebewerkingen.

breakLease(LeaseOperationOptions)

De lease geforceerd beëindigen.

function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Parameters

options

LeaseOperationOptions

Opties voor de leasebeheerbewerking.

Retouren

Promise<LeaseOperationResponse>

Antwoordgegevens voor break-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 wijzigings-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 release-leasebewerking.

renewLease(LeaseOperationOptions)

Om de lease te verlengen. Alleen beschikbaar voor lease op share of momentopname van 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 van de leaseduur 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.