ShareLeaseClient class
Client qui gère les baux d’un ShareFileClient ou ShareClient.
Voir https://learn.microsoft.com/rest/api/storageservices/lease-file et voir https://learn.microsoft.com/rest/api/storageservices/lease-share
Constructeurs
| Share |
Crée une instance de ShareLeaseClient. |
Méthodes
| acquire |
Établit et gère un verrou sur un fichier, un partage ou un instantané de partage pour les opérations d’écriture et de suppression. |
| break |
Pour forcer la fin du bail. |
| change |
Pour modifier l’ID d’un bail existant. |
| release |
Pour libérer le bail s’il n’est plus nécessaire afin qu’un autre client puisse immédiatement acquérir un bail. |
| renew |
Pour renouveler le bail. Disponible uniquement pour le bail sur un partage ou un instantané de partage. Notez que le bail peut être renouvelé même s’il a expiré tant que le partage n’a pas été loué à nouveau depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, l’horloge de durée du bail est réinitialisée. |
Détails du constructeur
ShareLeaseClient(ShareClient | ShareFileClient, string)
Crée une instance de ShareLeaseClient.
new ShareLeaseClient(client: ShareClient | ShareFileClient, leaseId?: string)Paramètres
- client
Client pour effectuer les demandes d’opération de bail.
- leaseId
-
string
ID de bail initial proposé.
Détails de la propriété
leaseId
Obtient l’ID de bail.
string leaseIdValeur de propriété
string
url
Obtient l’URL.
string urlValeur de propriété
string
Détails de la méthode
acquireLease(number, LeaseOperationOptions)
Établit et gère un verrou sur un fichier, un partage ou un instantané de partage pour les opérations d’écriture et de suppression.
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Paramètres
- duration
-
number
Spécifie la durée du bail en secondes. Pour le fichier, la seule valeur autorisée est -1 pour un bail qui n’expire jamais. Pour le partage, doit être -1 ou entre 15 et 60.
- options
- LeaseOperationOptions
Options pour l’opération de gestion des baux.
Retours
Promise<LeaseOperationResponse>
Données de réponse pour l’opération d’acquisition de bail.
breakLease(LeaseOperationOptions)
Pour forcer la fin du bail.
function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Paramètres
- options
- LeaseOperationOptions
Options pour l’opération de gestion des baux.
Retours
Promise<LeaseOperationResponse>
Données de réponse pour l’opération de bail d’arrêt.
changeLease(string, LeaseOperationOptions)
Pour modifier l’ID d’un bail existant.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Paramètres
- proposedLeaseId
-
string
l’ID de bail proposé.
- options
- LeaseOperationOptions
Options pour l’opération de gestion des baux.
Retours
Promise<LeaseOperationResponse>
Données de réponse pour l’opération de bail de modification.
releaseLease(LeaseOperationOptions)
Pour libérer le bail s’il n’est plus nécessaire afin qu’un autre client puisse immédiatement acquérir un bail.
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Paramètres
- options
- LeaseOperationOptions
Options pour l’opération de gestion des baux.
Retours
Promise<LeaseOperationResponse>
Données de réponse pour l’opération de bail de mise en production.
renewLease(LeaseOperationOptions)
Pour renouveler le bail. Disponible uniquement pour le bail sur un partage ou un instantané de partage. Notez que le bail peut être renouvelé même s’il a expiré tant que le partage n’a pas été loué à nouveau depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, l’horloge de durée du bail est réinitialisée.
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Paramètres
- options
- LeaseOperationOptions
Options pour l’opération de gestion des baux.
Retours
Promise<LeaseOperationResponse>
Données de réponse pour renouveler l’opération de bail.