ShareLeaseClient Klasse

Erstellt einen neuen ShareLeaseClient.

Dieser Client stellt Leasevorgänge für einen ShareClient oder ShareFileClient bereit.

Vererbung

builtins.object

ShareLeaseClient

Konstruktor

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

Parameter

client

ShareFileClient oder ShareClient

Erforderlich

Der Client der zu leasenden Datei oder Freigabe.

lease_id

str

Standardwert: None

Eine Zeichenfolge, die die Lease-ID einer vorhandenen Lease darstellt. Dieser Wert muss nicht angegeben werden, um eine neue Lease abzurufen oder eine zu unterbrechen.

Variablen

id

str

Die ID der derzeit verwalteten Lease. Dies ist Keine , wenn noch kein Leasing erworben wurde.

etag

str

Das ETag der derzeit verwalteten Lease. Dies ist None , wenn noch kein Lease erworben oder geändert wurde.

last_modified

datetime

Der zeitstempel der zuletzt geänderten Lease, die derzeit verwaltet wird. Dies ist None , wenn noch kein Lease erworben oder geändert wurde.

Methoden

acquire	Fordert eine neue Lease an. Mit diesem Vorgang wird eine Sperre für eine Datei oder Freigabe für Schreib- und Löschvorgänge eingerichtet und verwaltet. Wenn die Datei oder Freigabe keine aktive Lease aufweist, erstellt der Datei- oder Freigabedienst eine Lease für die Datei oder Freigabe. Wenn die Datei über eine aktive Lease verfügt, können Sie nur mithilfe der aktiven Lease-ID eine neue Lease anfordern. Wenn die Datei oder Freigabe keine aktive Lease aufweist, erstellt der Datei- oder Freigabedienst eine Lease für die Datei und gibt eine neue Lease-ID zurück.
break_lease	Erzwingen, dass die Lease unterbrochen wird, wenn die Datei oder Freigabe über eine aktive Lease verfügt. Die Lease kann von jeder autorisierten Anforderung unterbrochen werden. In der Anforderung muss keine übereinstimmende Lease-ID angegeben werden. Eine unendliche Lease bricht sofort ab. Sobald eine Lease unterbrochen wurde, kann sie nicht mehr geändert werden. Die Lease kann von jeder autorisierten Anforderung unterbrochen werden. In der Anforderung muss keine übereinstimmende Lease-ID angegeben werden. Wenn eine Lease erfolgreich unterbrochen wurde, gibt die Antwort das Intervall in Sekunden an, bis eine neue Lease abgerufen werden kann.
change	Ändert die Lease-ID einer aktiven Lease. Eine Änderung muss die aktuelle Lease-ID in x-ms-lease-id und eine neue Lease-ID in x-ms-proposed-lease-id enthalten.
release	Gibt die Lease frei. Die Lease kann freigegeben werden, wenn die in der Anforderung angegebene Lease-ID der Freigabe oder Datei entspricht. Durch das Freigeben der Lease kann ein anderer Client sofort die Lease für die Freigabe oder Datei erwerben, sobald die Veröffentlichung abgeschlossen ist.
renew	Erneuert die Freigabeleasing. Die Freigabeleasase kann verlängert werden, wenn die im Leaseclient angegebene Lease-ID mit der der Freigabe verknüpften übereinstimmt. Beachten Sie, dass der Leasingvertrag auch dann verlängert werden kann, wenn er abgelaufen ist, solange die Aktie seit Ablauf dieses Leasingverhältnisses nicht erneut geleast wurde. Beim Verlängern einer Lease wird die Leasedauer zurückgesetzt. Neu in Version 12.6.0.

acquire

Fordert eine neue Lease an. Mit diesem Vorgang wird eine Sperre für eine Datei oder Freigabe für Schreib- und Löschvorgänge eingerichtet und verwaltet. Wenn die Datei oder Freigabe keine aktive Lease aufweist, erstellt der Datei- oder Freigabedienst eine Lease für die Datei oder Freigabe. Wenn die Datei über eine aktive Lease verfügt, können Sie nur mithilfe der aktiven Lease-ID eine neue Lease anfordern.

Wenn die Datei oder Freigabe keine aktive Lease aufweist, erstellt der Datei- oder Freigabedienst eine Lease für die Datei und gibt eine neue Lease-ID zurück.

acquire(**kwargs: Any) -> None

Parameter

lease_duration

int

Gibt die Dauer der Lease in Sekunden oder als minus eins (-1) für eine nie ablaufende Lease an. Dateileases laufen nie ab. Eine nicht unendliche Freigabeleasase kann zwischen 15 und 60 Sekunden betragen. Die Dauer eines Freigabeleasings kann nicht per Verlängerung oder Änderung geändert werden. Der Standardwert ist -1 (unbegrenztes Freigabeleasing).

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

None

break_lease

Erzwingen, dass die Lease unterbrochen wird, wenn die Datei oder Freigabe über eine aktive Lease verfügt. Die Lease kann von jeder autorisierten Anforderung unterbrochen werden. In der Anforderung muss keine übereinstimmende Lease-ID angegeben werden. Eine unendliche Lease bricht sofort ab.

Sobald eine Lease unterbrochen wurde, kann sie nicht mehr geändert werden. Die Lease kann von jeder autorisierten Anforderung unterbrochen werden. In der Anforderung muss keine übereinstimmende Lease-ID angegeben werden. Wenn eine Lease erfolgreich unterbrochen wurde, gibt die Antwort das Intervall in Sekunden an, bis eine neue Lease abgerufen werden kann.

break_lease(**kwargs: Any) -> int

Parameter

lease_break_period

int

Dies ist die vorgeschlagene Dauer von Sekunden, für die die Freigabeleasing fortgesetzt werden soll, bevor sie unterbrochen wird, zwischen 0 und 60 Sekunden. Dieser Pausenzeitraum wird nur verwendet, wenn er kürzer als die verbleibende Zeit für die Freigabeleasing ist. Falls länger, wird die verbleibende Zeit für die Freigabeleasing verwendet. Ein neuer Aktienleasing ist nicht verfügbar, bevor der Pausenzeitraum abgelaufen ist, aber der Aktienleasing kann länger als der Pausenzeitraum gehalten werden. Wenn dieser Header nicht mit einem Unterbrechungsvorgang angezeigt wird, bricht eine Lease für eine Freigabe mit fester Dauer nach Ablauf des verbleibenden Zeitraums der Freigabeleasingzeit ab, und eine unendliche Freigabeleasase bricht sofort.

Neu in Version 12.6.0.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Die geschätzte verbleibende Zeit der Leasedauer in Sekunden.

Rückgabetyp

int

change

Ändert die Lease-ID einer aktiven Lease. Eine Änderung muss die aktuelle Lease-ID in x-ms-lease-id und eine neue Lease-ID in x-ms-proposed-lease-id enthalten.

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

Parameter

proposed_lease_id

str

Erforderlich

Vorgeschlagene Lease-ID in einem GUID-Zeichenfolgenformat. Der Datei- oder Freigabedienst löst einen Fehler (Ungültige Anforderung) aus, wenn die vorgeschlagene Lease-ID nicht das richtige Format aufweist.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Keine

release

Gibt die Lease frei. Die Lease kann freigegeben werden, wenn die in der Anforderung angegebene Lease-ID der Freigabe oder Datei entspricht. Durch das Freigeben der Lease kann ein anderer Client sofort die Lease für die Freigabe oder Datei erwerben, sobald die Veröffentlichung abgeschlossen ist.

release(**kwargs: Any) -> None

Parameter

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Keine

renew

Erneuert die Freigabeleasing.

Die Freigabeleasase kann verlängert werden, wenn die im Leaseclient angegebene Lease-ID mit der der Freigabe verknüpften übereinstimmt. Beachten Sie, dass der Leasingvertrag auch dann verlängert werden kann, wenn er abgelaufen ist, solange die Aktie seit Ablauf dieses Leasingverhältnisses nicht erneut geleast wurde. Beim Verlängern einer Lease wird die Leasedauer zurückgesetzt.

Neu in Version 12.6.0.

renew(**kwargs: Any) -> None

Parameter

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Keine