BlobLeaseClient class
Un client qui gère les baux d’un <xref:ContainerClient> ou d’un <xref:BlobClient>.
Constructeurs
| Blob |
Crée une instance de BlobLeaseClient. |
Méthodes
| acquire |
Établit et gère un verrou sur un conteneur pour les opérations de suppression ou sur un objet blob pour les opérations d’écriture et de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie. |
| break |
Pour mettre fin au bail, mais assurez-vous qu’un autre client ne peut pas acquérir un nouveau bail tant que la période de bail en cours n’a pas expiré. |
| change |
Pour modifier l’ID du bail. |
| 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 sur le conteneur ou l’objet blob. |
| renew |
Pour renouveler le bail. |
Détails du constructeur
BlobLeaseClient(ContainerClient | BlobClient, string)
Crée une instance de BlobLeaseClient.
new BlobLeaseClient(client: ContainerClient | BlobClient, 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 leaseId
Valeur de propriété
string
url
Obtient l’URL.
string url
Valeur de propriété
string
Détails de la méthode
acquireLease(number, LeaseOperationOptions)
Établit et gère un verrou sur un conteneur pour les opérations de suppression ou sur un objet blob pour les opérations d’écriture et de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie.
function acquireLease(duration: number, options?: LeaseOperationOptions)
Paramètres
- duration
-
number
Doit être compris entre 15 et 60 secondes, ou infini (-1)
- options
- LeaseOperationOptions
option permettant de configurer les opérations de gestion des baux.
Retours
Promise<LeaseOperationResponse>
Données de réponse pour l’opération d’acquisition de bail.
breakLease(number, LeaseOperationOptions)
Pour mettre fin au bail, mais assurez-vous qu’un autre client ne peut pas acquérir un nouveau bail tant que la période de bail en cours n’a pas expiré.
function breakLease(breakPeriod: number, options?: LeaseOperationOptions)
Paramètres
- breakPeriod
-
number
Période d’arrêt
- options
- LeaseOperationOptions
Options facultatives pour configurer les opérations 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 du bail.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions)
Paramètres
- proposedLeaseId
-
string
l’ID de bail proposé.
- options
- LeaseOperationOptions
option permettant de configurer les opérations 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 sur le conteneur ou l’objet blob.
function releaseLease(options?: LeaseOperationOptions)
Paramètres
- options
- LeaseOperationOptions
option permettant de configurer les opérations 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.
function renewLease(options?: LeaseOperationOptions)
Paramètres
- options
- LeaseOperationOptions
Option facultative pour configurer les opérations de gestion des baux.
Retours
Promise<Lease>
Données de réponse pour renouveler l’opération de bail.