BlobLeaseClient Klasse

Erstellt einen neuen BlobLeaseClient.

Dieser Client stellt Leasevorgänge für einen BlobClient oder ContainerClient bereit.

Vererbung

builtins.object

BlobLeaseClient

Konstruktor

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

Parameter

client

BlobClient oder ContainerClient

Erforderlich

Der Client des zu leasenden Blobs oder Containers.

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 Lease, die derzeit verwaltet wird. Dies ist Keine , wenn noch kein Lease erworben wurde.

etag

str

Das ETag der Lease, die derzeit verwaltet wird. Dies ist Keine , wenn noch keine Lease erworben oder geändert wurde.

last_modified

datetime

Der Zeitstempel der letzten Änderung der Lease, die derzeit verwaltet wird. Dies ist Keine , wenn noch keine Lease erworben oder geändert wurde.

Methoden

acquire	Fordert eine neue Lease an. Wenn der Container über keine aktive Lease verfügt, erstellt der Blob-Dienst eine Lease für den Container und gibt eine neue Lease-ID zurück.
break_lease	Unterbrechen Sie die Lease, wenn der Container oder Blob über eine aktive Lease verfügt. Nachdem eine Lease unterbrochen wurde, kann sie nicht verlängert werden. Die Lease kann von jeder autorisierten Anforderung unterbrochen werden. In der Anforderung muss keine übereinstimmende Lease-ID angegeben werden. Wenn eine Lease unterbrochen wird, darf der Leaseunterbrechungszeitraum verstreichen, in dem für den Container oder Blob kein Leasevorgang mit Ausnahme von Unterbrechung und Freigabe ausgeführt werden kann. Wenn eine Lease erfolgreich unterbrochen wurde, gibt die Antwort das Intervall in Sekunden an, bis eine neue Lease abgerufen werden kann.
change	Ändern Sie die Lease-ID einer aktiven Lease.
release	Geben Sie die Lease frei. Die Lease kann freigegeben werden, wenn die angegebene Clientlease-ID der dem Container oder Blob zugeordneten entspricht. Das Freigeben der Lease ermöglicht es einem anderen Client, sofort die Lease für den Container oder Blob zu erwerben, sobald die Veröffentlichung abgeschlossen ist.
renew	Verlängert die Lease. Die Lease kann verlängert werden, wenn die im Leaseclient angegebene Lease-ID mit der des Containers oder Blobs übereinstimmt. Beachten Sie, dass die Lease auch dann verlängert werden kann, wenn sie abgelaufen ist, solange der Container oder Blob seit Ablauf dieser Lease nicht erneut geleast wurde. Beim Verlängern einer Lease wird die Leasedauer zurückgesetzt.

acquire

Fordert eine neue Lease an.

Wenn der Container über keine aktive Lease verfügt, erstellt der Blob-Dienst eine Lease für den Container und gibt eine neue Lease-ID zurück.

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

Parameter

lease_duration

int

Erforderlich

Gibt die Dauer der Lease in Sekunden oder als minus eins (-1) für eine nie ablaufende Lease an. Die Dauer einer nicht unendlichen Lease kann zwischen 15 und 60 Sekunden liegen. Eine Leasedauer kann nicht mit Verlängerung oder Änderung geändert werden. Der Standardwert ist -1 (unendliche Lease).

if_modified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag

str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition

str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.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-blob-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

Unterbrechen Sie die Lease, wenn der Container oder Blob über eine aktive Lease verfügt.

Nachdem eine Lease unterbrochen wurde, kann sie nicht verlängert werden. Die Lease kann von jeder autorisierten Anforderung unterbrochen werden. In der Anforderung muss keine übereinstimmende Lease-ID angegeben werden. Wenn eine Lease unterbrochen wird, darf der Leaseunterbrechungszeitraum verstreichen, in dem für den Container oder Blob kein Leasevorgang mit Ausnahme von Unterbrechung und Freigabe ausgeführt werden kann. Wenn eine Lease erfolgreich unterbrochen wurde, gibt die Antwort das Intervall in Sekunden an, bis eine neue Lease abgerufen werden kann.

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

Parameter

lease_break_period

int

Erforderlich

Dies ist die vorgeschlagene Dauer von Sekunden, die die Lease fortsetzen soll, bevor sie unterbrochen wird, zwischen 0 und 60 Sekunden. Dieser Unterbrechungszeitraum wird nur verwendet, wenn er kürzer als die verbleibende Zeit für die Lease ist. Ist er länger, wird die verbleibende Zeit für die Lease verwendet. Eine neue Lease ist erst verfügbar, wenn der Unterbrechungszeitraum abgelaufen ist. Allerdings ist es möglich, dass die Lease länger als der Unterbrechungszeitraum beibehalten wird. Wenn dieser Header nicht mit einem Unterbrechungsvorgang angezeigt wird, wird eine Lease mit fester Dauer nach Ablauf des verbleibenden Leasezeitraums unterbrochen, und eine unendliche Lease bricht sofort.

if_modified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

if_tags_match_condition

str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.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-blob-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

Ändern Sie die Lease-ID einer aktiven Lease.

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

Parameter

proposed_lease_id

str

Erforderlich

Vorgeschlagene Lease-ID in einem GUID-Zeichenfolgenformat. Der Blobdienst gibt 400 (Ungültige Anforderung) zurück, wenn die vorgeschlagene Lease-ID nicht im richtigen Format vorliegt.

if_modified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag

str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition

str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.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-blob-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

Geben Sie die Lease frei.

Die Lease kann freigegeben werden, wenn die angegebene Clientlease-ID der dem Container oder Blob zugeordneten entspricht. Das Freigeben der Lease ermöglicht es einem anderen Client, sofort die Lease für den Container oder Blob zu erwerben, sobald die Veröffentlichung abgeschlossen ist.

release(**kwargs: Any) -> None

Parameter

if_modified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag

str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition

str

Geben Sie eine SQL-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert ausgeführt werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Keine

renew

Verlängert die Lease.

Die Lease kann verlängert werden, wenn die im Leaseclient angegebene Lease-ID mit der des Containers oder Blobs übereinstimmt. Beachten Sie, dass die Lease auch dann verlängert werden kann, wenn sie abgelaufen ist, solange der Container oder Blob seit Ablauf dieser Lease nicht erneut geleast wurde. Beim Verlängern einer Lease wird die Leasedauer zurückgesetzt.

renew(**kwargs: Any) -> None

Parameter

if_modified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn die Zeitzone enthalten ist, werden alle datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag

str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

if_tags_match_condition

str

Geben Sie eine SQL Where-Klausel für Blobtags an, die nur für Blobs mit einem übereinstimmenden Wert verwendet werden soll. Beispiel: "\"tagname\"='my tag'"

Neu in Version 12.4.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-blob-service-operations. Dieser Wert wird auf dem Client nicht nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Keine