BlobLeaseClient class
Client qui gère les baux d’un ContainerClient ou d’un BlobClient.
Constructeurs
Blob |
Crée une instance de BlobLeaseClient. |
Propriétés
lease |
Obtient l’ID de bail. |
url | Obtient l’URL. |
Méthodes
Détails du constructeur
BlobLeaseClient(BlobClient | ContainerClient, string)
Crée une instance de BlobLeaseClient.
new BlobLeaseClient(client: BlobClient | ContainerClient, leaseId?: string)
Paramètres
- client
Le client à effectuer l’opération de bail demande.
- 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.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container et voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function acquireLease(duration: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>
Paramètres
- duration
-
number
Doit être compris entre 15 et 60 secondes, ou infini (-1)
- options
- LeaseOperationOptions
pour 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)
Mettre fin au bail, mais s’assurer qu’un autre client ne peut pas acquérir un nouveau bail tant que la période de bail actuelle n’a pas expiré.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container et voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>
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 d’interruption de bail.
changeLease(string, LeaseOperationOptions)
Pour modifier l’ID du bail.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container et voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>
Paramètres
- proposedLeaseId
-
string
l’ID du nouveau bail proposé.
- options
- LeaseOperationOptions
pour 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)
Libérer le bail s’il n’est plus nécessaire pour qu’un autre client puisse immédiatement acquérir un bail contre le conteneur ou l’objet blob.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container et voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>
Paramètres
- options
- LeaseOperationOptions
pour 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.
Voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container et voir https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function renewLease(options?: LeaseOperationOptions): Promise<Lease>
Paramètres
- options
- LeaseOperationOptions
Option facultative pour configurer les opérations de gestion des baux.
Retours
Promise<Lease>
Données de réponse pour l’opération de renouvellement de bail.