BlobLeaseClient Classe
Crea un nuovo BLOBLeaseClient.
Questo client fornisce operazioni di lease su un BLOBClient o containerClient.
- Ereditarietà
-
builtins.objectBlobLeaseClient
Costruttore
BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)
Parametri
- client
- BlobClient oppure ContainerClient
Client del BLOB o del contenitore da creare in lease.
- lease_id
- str
Stringa che rappresenta l'ID lease di un lease esistente. Questo valore non deve essere specificato per acquisire un nuovo lease o interromperne uno.
Variabili
- id
- str
ID del lease attualmente gestito. Questo sarà Nessuno se non è ancora stato acquisito alcun lease.
- etag
- str
ETag del lease attualmente gestito. Questo sarà Nessuno se non è ancora stato acquisito o modificato alcun lease.
- last_modified
- datetime
L'ultimo timestamp modificato del lease attualmente gestito. Questo sarà Nessuno se non è ancora stato acquisito o modificato alcun lease.
Metodi
acquire |
Richiede un nuovo lease. Se il contenitore non dispone di un lease attivo, il servizio Blob crea un lease sul contenitore e restituisce un nuovo ID lease. |
break_lease |
Interrompere il lease, se il contenitore o il BLOB ha un lease attivo. I lease interrotti non possono essere rinnovati. Qualsiasi richiesta autorizzata può interrompere il lease; non è necessario che nella richiesta sia specificato un ID lease corrispondente. Quando un lease viene interrotto, il periodo di interruzione del lease può trascorrere, durante il quale non è possibile eseguire alcuna operazione di lease ad eccezione di interruzione e rilascio nel contenitore o nel BLOB. Quando un lease viene interrotto correttamente, la risposta indica l'intervallo in secondi che deve trascorrere prima che possa essere acquisito un nuovo lease. |
change |
Modificare l'ID lease di un lease attivo. |
release |
Rilascia il lease. Il lease può essere rilasciato se l'ID lease client specificato corrisponde a quello associato al contenitore o al BLOB. Il rilascio del lease consente a un altro client di acquisire immediatamente il lease per il contenitore o il BLOB non appena viene completata la versione. |
renew |
Rinnova il lease. Il lease può essere rinnovato se l'ID lease specificato nel client lease corrisponde a quello associato al contenitore o al BLOB. Si noti che il lease può essere rinnovato anche se è scaduto fino a quando il contenitore o il BLOB non è stato nuovamente eseguito il lease dopo la scadenza del lease. Quando si rinnova un lease, la durata del lease viene reimpostata. |
acquire
Richiede un nuovo lease.
Se il contenitore non dispone di un lease attivo, il servizio Blob crea un lease sul contenitore e restituisce un nuovo ID lease.
acquire(lease_duration: int = -1, **kwargs: Any) -> None
Parametri
- lease_duration
- int
Specifica la durata del lease, in secondi, o un uno negativo (-1) per un lease che non scade mai. Un lease non infinito può essere compreso tra 15 e 60 secondi. Non è possibile modificare una durata del lease usando il rinnovo o la modifica. Il valore predefinito è -1 (lease infinito).
- if_modified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa è stata modificata dopo l'ora specificata.
- if_unmodified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa non è stata modificata dopo l'ora e la data specificate.
- etag
- str
Valore ETag o il carattere jolly (*). Usato per verificare se la risorsa è stata modificata e agire in base alla condizione specificata dal parametro match_condition .
- match_condition
- MatchConditions
Condizione di corrispondenza da utilizzare sull'etag.
- if_tags_match_condition
- str
Specificare una clausola SQL where nei tag BLOB da usare solo nel BLOB con un valore corrispondente.
Ad esempio: "\"tagname\"='my tag'"
Novità nella versione 12.4.0.
- timeout
- int
Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.
Tipo restituito
break_lease
Interrompere il lease, se il contenitore o il BLOB ha un lease attivo.
I lease interrotti non possono essere rinnovati. Qualsiasi richiesta autorizzata può interrompere il lease; non è necessario che nella richiesta sia specificato un ID lease corrispondente. Quando un lease viene interrotto, il periodo di interruzione del lease può trascorrere, durante il quale non è possibile eseguire alcuna operazione di lease ad eccezione di interruzione e rilascio nel contenitore o nel BLOB. Quando un lease viene interrotto correttamente, la risposta indica l'intervallo in secondi che deve trascorrere prima che possa essere acquisito un nuovo lease.
break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int
Parametri
- lease_break_period
- int
Si tratta della durata proposta di secondi che il lease deve continuare prima che venga interrotto, tra 0 e 60 secondi. Questo periodo di interruzione viene utilizzato solo se è più breve del tempo rimanente sul lease. Se più lungo, viene utilizzato il tempo rimanente sul lease. Un nuovo lease sarà disponibile solo dopo la scadenza del periodo di interruzione, è tuttavia possibile che il lease venga mantenuto anche oltre il periodo di interruzione. Se questa intestazione non viene visualizzata con un'operazione di interruzione, un lease a durata fissa si interrompe dopo il periodo di lease rimanente e un lease infinito si interrompe immediatamente.
- if_modified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa è stata modificata dopo l'ora specificata.
- if_unmodified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa non è stata modificata dopo l'ora e la data specificate.
- if_tags_match_condition
- str
Specificare una clausola SQL where nei tag BLOB da usare solo nel BLOB con un valore corrispondente.
Ad esempio: "\"tagname\"='my tag'"
Novità nella versione 12.4.0.
- timeout
- int
Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.
Restituisce
Tempo approssimativo rimanente nel periodo di lease, in secondi.
Tipo restituito
change
Modificare l'ID lease di un lease attivo.
change(proposed_lease_id: str, **kwargs: Any) -> None
Parametri
- proposed_lease_id
- str
ID lease proposto, in un formato di stringa GUID. Il servizio BLOB restituisce 400 (richiesta non valida) se l'ID lease proposto non è nel formato corretto.
- if_modified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa è stata modificata dopo l'ora specificata.
- if_unmodified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa non è stata modificata dopo l'ora e la data specificate.
- etag
- str
Valore ETag o il carattere jolly (*). Usato per verificare se la risorsa è stata modificata e agire in base alla condizione specificata dal parametro match_condition .
- match_condition
- MatchConditions
Condizione di corrispondenza da utilizzare sull'etag.
- if_tags_match_condition
- str
Specificare una clausola SQL where nei tag BLOB da usare solo nel BLOB con un valore corrispondente.
Ad esempio: "\"tagname\"='my tag'"
Novità nella versione 12.4.0.
- timeout
- int
Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.
Restituisce
Nessuno
release
Rilascia il lease.
Il lease può essere rilasciato se l'ID lease client specificato corrisponde a quello associato al contenitore o al BLOB. Il rilascio del lease consente a un altro client di acquisire immediatamente il lease per il contenitore o il BLOB non appena viene completata la versione.
release(**kwargs: Any) -> None
Parametri
- if_modified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa è stata modificata dopo l'ora specificata.
- if_unmodified_since
- datetime
Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa non è stata modificata dopo l'ora e la data specificate.
- etag
- str
Valore ETag o il carattere jolly (*). Usato per verificare se la risorsa è stata modificata e agire in base alla condizione specificata dal parametro match_condition .
- match_condition
- MatchConditions
Condizione di corrispondenza da utilizzare sull'etag.
- if_tags_match_condition
- str
Specificare una clausola SQL where nei tag BLOB da usare solo nel BLOB con un valore corrispondente.
Ad esempio: "\"tagname\"='my tag'"
Novità nella versione 12.4.0.
- timeout
- int
Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Questo valore non viene monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.
Restituisce
Nessuno
renew
Rinnova il lease.
Il lease può essere rinnovato se l'ID lease specificato nel client lease corrisponde a quello associato al contenitore o al BLOB. Si noti che il lease può essere rinnovato anche se è scaduto fino a quando il contenitore o il BLOB non è stato nuovamente eseguito il lease dopo la scadenza del lease. Quando si rinnova un lease, la durata del lease viene reimpostata.
renew(**kwargs: Any) -> None
Parametri
- if_modified_since
- datetime
Valore DateTime. Azure prevede che il valore di data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa è stata modificata dopo l'ora specificata.
- if_unmodified_since
- datetime
Valore DateTime. Azure prevede che il valore di data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione per eseguire l'operazione solo se la risorsa non è stata modificata dopo l'ora e la data specificate.
- etag
- str
Valore ETag o il carattere jolly (*). Usato per verificare se la risorsa è cambiata e agire in base alla condizione specificata dal parametro match_condition .
- match_condition
- MatchConditions
Condizione di corrispondenza da utilizzare sul etag.
- if_tags_match_condition
- str
Specificare una clausola SQL in cui le clausole sui tag BLOB vengono usate solo nel BLOB con un valore corrispondente.
Ad esempio: "\"tagname\"='my tag'"
Novità nella versione 12.4.0.
- timeout
- int
Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Questo valore non viene monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.
Restituisce
Nessuno
Azure SDK for Python