ShareLeaseClient class
Klient zarządzający dzierżawami elementu ShareFileClient lub ShareClient.
Zobacz https://docs.microsoft.com/rest/api/storageservices/lease-file i zobacz https://docs.microsoft.com/rest/api/storageservices/lease-share
Konstruktory
| Share |
Tworzy wystąpienie klasy ShareLeaseClient. |
Właściwości
| lease |
Pobiera identyfikator dzierżawy. |
| url | Pobiera adres URL. |
Metody
| acquire |
Ustanawia blokadę pliku, udziału lub migawki udziału na potrzeby operacji zapisu i usuwania oraz zarządza nią. |
| break |
Aby wymusić zakończenie dzierżawy. |
| change |
Aby zmienić identyfikator istniejącej dzierżawy. |
| release |
Aby zwolnić dzierżawę, jeśli nie jest już potrzebna, aby inny klient mógł natychmiast uzyskać dzierżawę. |
| renew |
Aby odnowić dzierżawę. Dostępne tylko dla dzierżawy dla udziału lub migawki udziału. Należy pamiętać, że dzierżawa może zostać odnowiona, nawet jeśli wygasła, o ile udział nie został ponownie dzierżawiony od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy jest resetowany. |
Szczegóły konstruktora
ShareLeaseClient(ShareFileClient, string)
Tworzy wystąpienie klasy ShareLeaseClient.
new ShareLeaseClient(client: ShareFileClient, leaseId?: string)Parametry
- client
- ShareFileClient
Klient, który wysyła żądania operacji dzierżawy.
- leaseId
-
string
Początkowy identyfikator proponowanej dzierżawy.
Szczegóły właściwości
leaseId
Pobiera identyfikator dzierżawy.
string leaseIdWartość właściwości
string
url
Pobiera adres URL.
string urlWartość właściwości
string
Szczegóły metody
acquireLease(number, LeaseOperationOptions)
Ustanawia blokadę pliku, udziału lub migawki udziału na potrzeby operacji zapisu i usuwania oraz zarządza nią.
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parametry
- duration
-
number
Określa czas trwania dzierżawy w sekundach. W przypadku pliku jedyną dozwoloną wartością jest -1 dzierżawa, która nigdy nie wygasa. W przypadku udziału musi mieć wartość -1 lub od 15 do 60.
- options
- LeaseOperationOptions
Opcje operacji zarządzania dzierżawą.
Zwraca
Promise<LeaseOperationResponse>
Dane odpowiedzi dotyczące operacji pozyskiwania dzierżawy.
breakLease(LeaseOperationOptions)
Aby wymusić zakończenie dzierżawy.
function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parametry
- options
- LeaseOperationOptions
Opcje operacji zarządzania dzierżawą.
Zwraca
Promise<LeaseOperationResponse>
Dane odpowiedzi dotyczące operacji przerwania dzierżawy.
changeLease(string, LeaseOperationOptions)
Aby zmienić identyfikator istniejącej dzierżawy.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parametry
- proposedLeaseId
-
string
proponowany nowy identyfikator dzierżawy.
- options
- LeaseOperationOptions
Opcje operacji zarządzania dzierżawą.
Zwraca
Promise<LeaseOperationResponse>
Dane odpowiedzi dotyczące operacji zmiany dzierżawy.
releaseLease(LeaseOperationOptions)
Aby zwolnić dzierżawę, jeśli nie jest już potrzebna, aby inny klient mógł natychmiast uzyskać dzierżawę.
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parametry
- options
- LeaseOperationOptions
Opcje operacji zarządzania dzierżawą.
Zwraca
Promise<LeaseOperationResponse>
Dane odpowiedzi dla operacji dzierżawy wydania.
renewLease(LeaseOperationOptions)
Aby odnowić dzierżawę. Dostępne tylko dla dzierżawy dla udziału lub migawki udziału. Należy pamiętać, że dzierżawa może zostać odnowiona, nawet jeśli wygasła, o ile udział nie został ponownie dzierżawiony od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy jest resetowany.
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parametry
- options
- LeaseOperationOptions
Opcje operacji zarządzania dzierżawą.
Zwraca
Promise<LeaseOperationResponse>
Dane odpowiedzi dotyczące operacji odnawiania dzierżawy.