ShareLeaseClient class
Ein Client, der Leases für einen ShareFileClient oder ShareClient verwaltet.
Anzeigen https://docs.microsoft.com/rest/api/storageservices/lease-file und Anzeigen https://docs.microsoft.com/rest/api/storageservices/lease-share
Konstruktoren
| Share |
Erstellt eine Instanz von ShareLeaseClient. |
Eigenschaften
| lease |
Ruft die Lease-ID ab. |
| url | Ruft die URL ab. |
Methoden
| acquire |
Richtet eine Sperre für eine Datei-, Freigabe- oder Freigabemomentaufnahme für Schreib- und Löschvorgänge ein und verwaltet diese. |
| break |
Um das Beenden der Lease zu erzwingen. |
| change |
So ändern Sie die ID einer vorhandenen Lease. |
| release |
Um die Lease freizugeben, wenn sie nicht mehr benötigt wird, damit ein anderer Client sofort eine Lease erwerben kann. |
| renew |
So verlängern Sie die Lease. Nur für lease on share oder share snapshot verfügbar. Beachten Sie, dass der Leasingvertrag auch dann verlängert werden kann, wenn er abgelaufen ist, solange die Aktie seit Ablauf dieses Leasingverhältnisses nicht erneut geleast wurde. Beim Verlängern einer Lease wird die Leasedauer zurückgesetzt. |
Details zum Konstruktor
ShareLeaseClient(ShareFileClient, string)
Erstellt eine Instanz von ShareLeaseClient.
new ShareLeaseClient(client: ShareFileClient, leaseId?: string)Parameter
- client
- ShareFileClient
Der Client, der den Leasevorgang anfordert.
- leaseId
-
string
Anfängliche vorgeschlagene Lease-ID.
Details zur Eigenschaft
leaseId
Ruft die Lease-ID ab.
string leaseIdEigenschaftswert
string
url
Ruft die URL ab.
string urlEigenschaftswert
string
Details zur Methode
acquireLease(number, LeaseOperationOptions)
Richtet eine Sperre für eine Datei-, Freigabe- oder Freigabemomentaufnahme für Schreib- und Löschvorgänge ein und verwaltet diese.
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameter
- duration
-
number
Gibt die Dauer der Lease in Sekunden an. Für datei ist der einzige zulässige Wert -1 für eine Lease, die nie abläuft. Für freigabe muss -1 oder zwischen 15 und 60 sein.
- options
- LeaseOperationOptions
Optionen für den Leaseverwaltungsvorgang.
Gibt zurück
Promise<LeaseOperationResponse>
Antwortdaten für den Leasevorgang abrufen.
breakLease(LeaseOperationOptions)
Um das Beenden der Lease zu erzwingen.
function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameter
- options
- LeaseOperationOptions
Optionen für den Leaseverwaltungsvorgang.
Gibt zurück
Promise<LeaseOperationResponse>
Antwortdaten für den Unterbrechungsleasingvorgang.
changeLease(string, LeaseOperationOptions)
So ändern Sie die ID einer vorhandenen Lease.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameter
- proposedLeaseId
-
string
die vorgeschlagene neue Lease-ID.
- options
- LeaseOperationOptions
Optionen für den Leaseverwaltungsvorgang.
Gibt zurück
Promise<LeaseOperationResponse>
Antwortdaten für den Änderungsleasingvorgang.
releaseLease(LeaseOperationOptions)
Um die Lease freizugeben, wenn sie nicht mehr benötigt wird, damit ein anderer Client sofort eine Lease erwerben kann.
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameter
- options
- LeaseOperationOptions
Optionen für den Leaseverwaltungsvorgang.
Gibt zurück
Promise<LeaseOperationResponse>
Antwortdaten für den Releaseleasingvorgang.
renewLease(LeaseOperationOptions)
So verlängern Sie die Lease. Nur für lease on share oder share snapshot verfügbar. Beachten Sie, dass der Leasingvertrag auch dann verlängert werden kann, wenn er abgelaufen ist, solange die Aktie seit Ablauf dieses Leasingverhältnisses nicht erneut geleast wurde. Beim Verlängern einer Lease wird die Leasedauer zurückgesetzt.
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parameter
- options
- LeaseOperationOptions
Optionen für den Leaseverwaltungsvorgang.
Gibt zurück
Promise<LeaseOperationResponse>
Antwortdaten für den Lease-Verlängerungsvorgang.