BlobLeaseClient Classe

Crée un objet BlobLeaseClient.

Ce client fournit des opérations de bail sur un BlobClient ou ContainerClient.

Héritage

azure.storage.blob._lease.BlobLeaseClient

BlobLeaseClient

Constructeur

BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)

Paramètres

client

BlobClient ou ContainerClient

Obligatoire

Client de l’objet blob ou du conteneur à louer.

lease_id

str

valeur par défaut: None

Chaîne représentant l’ID de bail d’un bail existant. Cette valeur n’a pas besoin d’être spécifiée pour acquérir un nouveau bail ou en rompre un.

Variables

id

str

ID du bail en cours de maintenance. Ce sera Aucun si aucun bail n’a encore été acquis.

etag

str

ETag du bail en cours de maintenance. Il s’agit de None si aucun bail n’a encore été acquis ou modifié.

last_modified

datetime

Horodatage de la dernière modification du bail en cours de maintenance. Il s’agit de None si aucun bail n’a encore été acquis ou modifié.

Méthodes

acquire	Demande un nouveau bail. Si le conteneur n'a pas de bail actif, le service BLOB crée un bail dans le conteneur et retourne un nouvel ID de bail.
break_lease	Interrompez le bail si le conteneur ou l’objet blob a un bail actif. Une fois un bail résilié, il ne peut pas être renouvelé. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Lorsqu’un bail est rompu, la période d’interruption de bail est autorisée à s’écouler, pendant laquelle aucune opération de bail, à l’exception de l’interruption et de la libération, ne peut être effectuée sur le conteneur ou l’objet blob. Lorsqu'un bail est correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis.
change	Modifiez l’ID de bail d’un bail actif.
release	Permet de libérer le bail. Le bail peut être libéré si l’ID de bail client spécifié correspond à celui associé au conteneur ou à l’objet blob. La libération du bail permet à un autre client d’acquérir immédiatement le bail pour le conteneur ou l’objet blob dès que la publication est terminée.
renew	Renouvelle le bail. Le bail peut être renouvelé si l’ID de bail spécifié dans le client de bail correspond à celui associé au conteneur ou à l’objet blob. Notez que le bail peut être renouvelé même s’il a expiré tant que le conteneur ou l’objet blob n’a pas été à nouveau loué depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée.

acquire

Demande un nouveau bail.

Si le conteneur n'a pas de bail actif, le service BLOB crée un bail dans le conteneur et retourne un nouvel ID de bail.

async acquire(lease_duration: int = -1, **kwargs: Any) -> None

Paramètres

lease_duration

int

Obligatoire

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail infini).

if_modified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag

str

Spécifiez une valeur ETag ou le caractère générique *. Permet de vérifier si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition .

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition

str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout

int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Type de retour

None

break_lease

Interrompez le bail si le conteneur ou l’objet blob a un bail actif.

Une fois un bail résilié, il ne peut pas être renouvelé. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Lorsqu’un bail est rompu, la période d’interruption de bail est autorisée à s’écouler, pendant laquelle aucune opération de bail, à l’exception de l’interruption et de la libération, ne peut être effectuée sur le conteneur ou l’objet blob. Lorsqu'un bail est correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis.

async break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int

Paramètres

lease_break_period

int

Obligatoire

Il s’agit de la durée proposée en secondes que le bail doit continuer avant d’être rompu, entre 0 et 60 secondes. Cette période de résiliation n'est utilisée que si elle est plus courte que la durée du bail restante. Si elle est plus longue, la durée restante du bail est utilisée. Un nouveau bail ne sera pas disponible avant l'expiration de la période de résiliation, mais le bail peut être conservé au-delà de cette période. Si cet en-tête n’apparaît pas avec une opération d’arrêt, un bail à durée fixe s’interrompt après l’expiration de la période de bail restante et un bail infini s’interrompt immédiatement.

if_modified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

if_tags_match_condition

str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout

int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Durée approximative restante de la période du bail, en secondes.

Type de retour

int

change

Modifiez l’ID de bail d’un bail actif.

async change(proposed_lease_id: str, **kwargs: Any) -> None

Paramètres

proposed_lease_id

str

Obligatoire

ID de bail proposé, dans un format de chaîne GUID. Le service Blob retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

if_modified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag

str

Spécifiez une valeur ETag ou le caractère générique *. Permet de vérifier si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition .

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition

str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout

int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

None

release

Permet de libérer le bail.

Le bail peut être libéré si l’ID de bail client spécifié correspond à celui associé au conteneur ou à l’objet blob. La libération du bail permet à un autre client d’acquérir immédiatement le bail pour le conteneur ou l’objet blob dès que la publication est terminée.

async release(**kwargs: Any) -> None

Paramètres

if_modified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag

str

Spécifiez une valeur ETag ou le caractère générique *. Permet de vérifier si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition .

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition

str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur un objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout

int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

None

renew

Renouvelle le bail.

Le bail peut être renouvelé si l’ID de bail spécifié dans le client de bail correspond à celui associé au conteneur ou à l’objet blob. Notez que le bail peut être renouvelé même s’il a expiré tant que le conteneur ou l’objet blob n’a pas été à nouveau loué depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée.

async renew(**kwargs: Any) -> None

Paramètres

if_modified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since

datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag

str

Spécifiez une valeur ETag ou le caractère générique *. Permet de vérifier si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition .

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag.

if_tags_match_condition

str

Spécifiez une clause SQL where sur les balises d’objet blob pour fonctionner uniquement sur l’objet blob avec une valeur correspondante. par exemple "\"tagname\"='my tag'"

Nouveautés de la version 12.4.0.

timeout

int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

None