ShareLeaseClient Classe
Crée un ShareLeaseClient.
Ce client fournit des opérations de bail sur un ShareClient ou ShareFileClient.
- Héritage
-
builtins.objectShareLeaseClient
Constructeur
ShareLeaseClient(client: ShareFileClient | ShareClient, lease_id: str | None = None)
Paramètres
- lease_id
- str
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 d’entretien. Ce sera Aucun 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. Ce sera Aucun si aucun bail n’a encore été acquis ou modifié.
Méthodes
acquire |
Demande un nouveau bail. Cette opération établit et gère un verrou sur un fichier ou un partage pour les opérations d’écriture et de suppression. Si le fichier ou le partage n’a pas de bail actif, le service Fichier ou Partage crée un bail sur le fichier ou le partage. Si le fichier a un bail actif, vous pouvez uniquement demander un nouveau bail à l’aide de l’ID de bail actif. Si le fichier ou le partage n’a pas de bail actif, le service Fichier ou Partage crée un bail sur le fichier et retourne un nouvel ID de bail. |
break_lease |
Forcer l’interruption du bail si le fichier ou le partage a un bail actif. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Un bail infini s’arrête immédiatement. Une fois qu’un bail est rompu, il ne peut pas être modifié. 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 correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis. |
change |
Modifie l'ID du bail d'un bail actif. Une modification doit inclure l’ID de bail actuel dans x-ms-lease-id et un nouvel ID de bail dans x-ms-proposed-lease-id. |
release |
Libère le bail. Le bail peut être libéré si l’ID de bail spécifié dans la demande correspond à celui associé au partage ou au fichier. La libération du bail permet à un autre client d’acquérir immédiatement le bail pour l’action ou le fichier dès que la mise en production est terminée. |
renew |
Renouvelle le bail d’actions. Le bail de partage peut être renouvelé si l’ID de bail spécifié dans le client de bail correspond à celui associé au partage. Notez que le bail peut être renouvelé même s’il a expiré tant que la part n’a pas été à nouveau louée depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée. Nouveautés de la version 12.6.0. |
acquire
Demande un nouveau bail. Cette opération établit et gère un verrou sur un fichier ou un partage pour les opérations d’écriture et de suppression. Si le fichier ou le partage n’a pas de bail actif, le service Fichier ou Partage crée un bail sur le fichier ou le partage. Si le fichier a un bail actif, vous pouvez uniquement demander un nouveau bail à l’aide de l’ID de bail actif.
Si le fichier ou le partage n’a pas de bail actif, le service Fichier ou Partage crée un bail sur le fichier et retourne un nouvel ID de bail.
acquire(**kwargs: Any) -> None
Paramètres
- lease_duration
- int
Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Les baux de fichiers n’expirent jamais. Un bail de partage non infini peut être compris entre 15 et 60 secondes. La durée d’un bail de partage ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail de partage infini).
- 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-file-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
break_lease
Forcer l’interruption du bail si le fichier ou le partage a un bail actif. Toute demande autorisée peut résilier le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Un bail infini s’arrête immédiatement.
Une fois qu’un bail est rompu, il ne peut pas être modifié. 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 correctement résilié, la réponse indique l'intervalle en secondes avant qu'un nouveau bail puisse être acquis.
break_lease(**kwargs: Any) -> int
Paramètres
- lease_break_period
- int
Il s’agit de la durée proposée en secondes que le bail de partage doit continuer avant d’être rompu, entre 0 et 60 secondes. Cette période d’interruption n’est utilisée que si elle est inférieure à la durée restante sur le bail d’actions. S’il est plus long, le temps restant sur le bail d’actions est utilisé. Un nouveau bail d’actions ne sera pas disponible avant l’expiration de la période d’interruption, mais le bail d’actions peut être conservé pendant plus longtemps que la période d’interruption. Si cet en-tête n’apparaît pas avec une opération d’interruption, un bail de partage à durée fixe s’interrompt après l’expiration de la période de bail d’action restante, et un bail de partage infini s’interrompt immédiatement.
Nouveautés de la version 12.6.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-file-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
change
Modifie l'ID du bail d'un bail actif. Une modification doit inclure l’ID de bail actuel dans x-ms-lease-id et un nouvel ID de bail dans x-ms-proposed-lease-id.
change(proposed_lease_id: str, **kwargs: Any) -> None
Paramètres
- proposed_lease_id
- str
ID de bail proposé, dans un format de chaîne GUID. Le service Fichier ou Partage génère une erreur (requête non valide) si l’ID de bail proposé n’est pas au format correct.
- 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-file-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
Libère le bail. Le bail peut être libéré si l’ID de bail spécifié dans la demande correspond à celui associé au partage ou au fichier. La libération du bail permet à un autre client d’acquérir immédiatement le bail pour l’action ou le fichier dès que la mise en production est terminée.
release(**kwargs: Any) -> None
Paramètres
- 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-file-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 d’actions.
Le bail de partage peut être renouvelé si l’ID de bail spécifié dans le client de bail correspond à celui associé au partage. Notez que le bail peut être renouvelé même s’il a expiré tant que la part n’a pas été à nouveau louée depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail est réinitialisée.
Nouveautés de la version 12.6.0.
renew(**kwargs: Any) -> None
Paramètres
- 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-file-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
Azure SDK for Python