ShareLeaseClient 類別

建立新的 ShareLeaseClient。

此用戶端會在 ShareClient 或 ShareFileClient 上提供租用作業。

繼承

builtins.object

ShareLeaseClient

建構函式

ShareLeaseClient(client: ShareFileClient | ShareClient, lease_id: str | None = None)

參數

client

ShareFileClient 或 ShareClient

必要

要租用之檔案或共用的用戶端。

lease_id

str

預設值: None

字串，表示現有租用的租用識別碼。 這個值不需要指定，才能取得新的租用，或中斷一個租用。

變數

id

str

目前正在維護之租用的識別碼。 如果尚未取得任何租用，這會是 None 。

etag

str

目前正在維護之租用的 ETag。 如果沒有取得或修改租用，這會是 None 。

last_modified

datetime

目前正在維護之租用的最後一個修改時間戳記。 如果沒有取得或修改租用，這會是 None 。

方法

acquire	要求新的租用。 此作業會建立和管理檔案或共用的鎖定，以進行寫入和刪除作業。 如果檔案或共用沒有使用中的租用，檔案或共用服務會在檔案或共用上建立租用。 如果檔案有作用中的租用，您只能使用使用中的租用識別碼要求新的租用。 如果檔案或共用沒有作用中的租用，檔案或共用服務會在檔案上建立租用，並傳回新的租用識別碼。
break_lease	如果檔案或共用有作用中的租用，強制中斷租用。 任何獲授權的要求都可以中斷租用，不需要求即可指定相符的租用識別碼。 無限租用會立即中斷。 一旦租用中斷，就無法變更。 任何獲授權的要求都可以中斷租用，不需要求即可指定相符的租用識別碼。 當租用成功中斷時，回應會指出可取得新租用之前的間隔秒數。
change	變更作用中租用的租用識別碼。 變更必須在 x-ms-lease-id 中包含目前的租用識別碼，以及 x-ms-proposed-lease-id 中的新租用識別碼。
release	釋放租用。 如果要求上指定的租用識別碼符合與共享或檔案相關聯的租用識別碼，可能會釋放租用。 釋放租用可讓另一個用戶端在發行完成後立即取得共用或檔案的租用。
renew	更新共用租用。 如果租用用戶端中指定的租用識別碼符合與共享相關聯的租用識別碼，則可以更新共用租用。 請注意，即使租用自該租用到期後尚未再次租用，仍可能會更新租用。 當您更新租用時，租用持續時間的時鐘會重設。 12.6.0 版的新功能。

acquire

要求新的租用。 此作業會建立和管理檔案或共用的鎖定，以進行寫入和刪除作業。 如果檔案或共用沒有使用中的租用，檔案或共用服務會在檔案或共用上建立租用。 如果檔案有作用中的租用，您只能使用使用中的租用識別碼要求新的租用。

如果檔案或共用沒有作用中的租用，檔案或共用服務會在檔案上建立租用，並傳回新的租用識別碼。

acquire(**kwargs: Any) -> None

參數

lease_duration

int

指定租用的持續時間 (秒數)，或指定負一 (-1)，代表租用永不到期。 檔案租用永遠不會過期。 非無限共用租用可以介於 15 到 60 秒之間。 共用租用持續時間無法使用更新或變更來變更。 預設值為 -1 (無限共用租用) 。

timeout

int

以秒為單位設定作業的伺服器端逾時。 如需詳細資訊，請參閱 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations 。 用戶端上不會追蹤或驗證此值。 若要設定用戶端網路逾時，請參閱 這裡。

傳回類型

None

break_lease

如果檔案或共用有作用中的租用，強制中斷租用。 任何獲授權的要求都可以中斷租用，不需要求即可指定相符的租用識別碼。 無限租用會立即中斷。

一旦租用中斷，就無法變更。 任何獲授權的要求都可以中斷租用，不需要求即可指定相符的租用識別碼。 當租用成功中斷時，回應會指出可取得新租用之前的間隔秒數。

break_lease(**kwargs: Any) -> int

參數

lease_break_period

int

這是共用租用在中斷前應該繼續的建議持續時間，介於 0 到 60 秒之間。 只有當此中斷期間比共用租用剩餘的時間短時，才會使用此中斷期間。 如果時間較長，則會使用共用租用的剩餘時間。 中斷期間過期之前，將無法使用新的共用租用，但共用租用可能會保留超過中斷期間。 如果此標頭未顯示中斷作業，固定持續時間的共用租用會在剩餘的共用租用期間過後中斷，而無限的共用租用會立即中斷。

12.6.0 版的新功能。

timeout

int

以秒為單位設定作業的伺服器端逾時。 如需詳細資訊，請參閱 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations 。 用戶端上不會追蹤或驗證此值。 若要設定用戶端網路逾時，請參閱 這裡。

傳回

在租用期間內保留的近似時間 (以秒計)。

傳回類型

int

change

變更作用中租用的租用識別碼。 變更必須在 x-ms-lease-id 中包含目前的租用識別碼，以及 x-ms-proposed-lease-id 中的新租用識別碼。

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

參數

proposed_lease_id

str

必要

建議的租用識別碼，使用 GUID 字串格式。 如果建議的租用識別碼格式不正確，檔案或共用服務將會引發錯誤 (不正確要求) 。

timeout

int

以秒為單位設定作業的伺服器端逾時。 如需詳細資訊，請參閱 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations 。 用戶端上不會追蹤或驗證此值。 若要設定用戶端網路逾時，請參閱 這裡。

傳回

無

release

釋放租用。 如果要求上指定的租用識別碼符合與共享或檔案相關聯的租用識別碼，可能會釋放租用。 釋放租用可讓另一個用戶端在發行完成後立即取得共用或檔案的租用。

release(**kwargs: Any) -> None

參數

timeout

int

以秒為單位設定作業的伺服器端逾時。 如需詳細資訊，請參閱 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations 。 用戶端上不會追蹤或驗證此值。 若要設定用戶端網路逾時，請參閱 這裡。

傳回

無

renew

更新共用租用。

如果租用用戶端中指定的租用識別碼符合與共享相關聯的租用識別碼，則可以更新共用租用。 請注意，即使租用自該租用到期後尚未再次租用，仍可能會更新租用。 當您更新租用時，租用持續時間的時鐘會重設。

12.6.0 版的新功能。

renew(**kwargs: Any) -> None

參數

timeout

int

以秒為單位設定作業的伺服器端逾時。 如需詳細資訊，請參閱 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations 。 用戶端上不會追蹤或驗證此值。 若要設定用戶端網路逾時，請參閱 這裡。

傳回

無