ShareLeaseClient クラス

  • リファレンス

新しい ShareLeaseClient を作成します。

このクライアントは、ShareClient または ShareFileClient に対するリース操作を提供します。

継承
builtins.object
ShareLeaseClient

コンストラクター

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

パラメーター

client
ShareFileClient または ShareClient
必須

リースするファイルまたは共有のクライアント。

lease_id
str
既定値: None

既存のリースのリース ID を表す文字列。 新しいリースを取得したり、リースを解除したりするために、この値を指定する必要はありません。

変数

id
str

現在維持されているリースの ID。 リースがまだ取得されていない場合、これは None になります。

etag
str

現在維持されているリースの ETag。 リースがまだ取得または変更されていない場合、これは None になります。

last_modified
datetime

現在維持されているリースの最後に変更されたタイムスタンプ。 リースがまだ取得または変更されていない場合、これは None になります。

メソッド

acquire

新しいリースを要求します。 この操作により、書き込み操作と削除操作に対するファイルまたは共有のロックが確立および管理されます。 ファイルまたは共有にアクティブなリースがない場合、ファイルまたは共有サービスはファイルまたは共有にリースを作成します。 ファイルにアクティブなリースがある場合は、アクティブなリース ID を使用して新しいリースのみを要求できます。

ファイルまたは共有にアクティブなリースがない場合、ファイルまたは共有サービスはファイルにリースを作成し、新しいリース ID を返します。
break_lease

ファイルまたは共有にアクティブなリースがある場合、強制的にリースが解除されます。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 無限リースはすぐに中断します。

リースが解除されると、変更することはできません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。
change

アクティブなリースのリース ID を変更します。 変更には、現在のリース ID を x-ms-lease-id に、新しいリース ID を x-ms-proposed-lease-id に含める必要があります。
release

リースを解放します。 要求で指定されたリース ID が共有またはファイルに関連付けられているリース ID と一致する場合、リースが解放される可能性があります。 リースを解放すると、リリースが完了するとすぐに、別のクライアントが共有またはファイルのリースをすぐに取得できます。
renew

共有リースを更新します。

リース クライアントで指定されたリース ID が共有に関連付けられているリース ID と一致する場合は、共有リースを更新できます。 リースの有効期限が切れてから共有が再びリースされていない限り、リースが期限切れであっても、リースが更新される可能性があることに注意してください。 リースを更新すると、リース期間の時間がリセットされます。

バージョン 12.6.0 の新機能。

acquire

新しいリースを要求します。 この操作により、書き込み操作と削除操作に対するファイルまたは共有のロックが確立および管理されます。 ファイルまたは共有にアクティブなリースがない場合、ファイルまたは共有サービスはファイルまたは共有にリースを作成します。 ファイルにアクティブなリースがある場合は、アクティブなリース ID を使用して新しいリースのみを要求できます。

ファイルまたは共有にアクティブなリースがない場合、ファイルまたは共有サービスはファイルにリースを作成し、新しいリース ID を返します。

acquire(**kwargs: Any) -> None

パラメーター

lease_duration
int

リース期間 (秒単位) を指定します。無期限のリースには -1 を指定します。 ファイルリースの有効期限は切れません。 無限でない共有リースは、15 秒から 60 秒の間にすることができます。 更新または変更を使用して共有リース期間を変更することはできません。 既定値は -1 (無限共有リース) です。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

の戻り値の型 :

None

break_lease

ファイルまたは共有にアクティブなリースがある場合、強制的にリースが解除されます。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 無限リースはすぐに中断します。

リースが解除されると、変更することはできません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。

break_lease(**kwargs: Any) -> int

パラメーター

lease_break_period
int

これは、共有リースが中断されるまでに 0 秒から 60 秒の間に継続する必要がある、提案された秒数です。 この中断期間は、共有リースの残り時間よりも短い場合にのみ使用されます。 長い場合は、共有リースの残りの時間が使用されます。 新しい共有リースは、中断期間が切れる前には使用できませんが、共有リースは中断期間よりも長く保持される可能性があります。 このヘッダーが中断操作と共に表示されない場合は、残りの共有リース期間が経過した後に固定期間の共有リースが中断され、無限共有リースはすぐに中断されます。

バージョン 12.6.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

リース期間のおおよその残り時間 (秒単位)。

の戻り値の型 :

int

change

アクティブなリースのリース ID を変更します。 変更には、現在のリース ID を x-ms-lease-id に、新しいリース ID を x-ms-proposed-lease-id に含める必要があります。

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

パラメーター

proposed_lease_id
str
必須

GUID 文字列形式の推奨リース ID。 提案されたリース ID が正しい形式でない場合、File サービスまたは Share サービスはエラー (無効な要求) を発生させます。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

なし

release

リースを解放します。 要求で指定されたリース ID が共有またはファイルに関連付けられているリース ID と一致する場合、リースが解放される可能性があります。 リースを解放すると、リリースが完了するとすぐに、別のクライアントが共有またはファイルのリースをすぐに取得できます。

release(**kwargs: Any) -> None

パラメーター

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

なし

renew

共有リースを更新します。

リース クライアントで指定されたリース ID が共有に関連付けられているリース ID と一致する場合は、共有リースを更新できます。 リースの有効期限が切れてから共有が再びリースされていない限り、リースが期限切れであっても、リースが更新される可能性があることに注意してください。 リースを更新すると、リース期間の時間がリセットされます。

バージョン 12.6.0 の新機能。

renew(**kwargs: Any) -> None

パラメーター

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

なし