ShareLeaseClient Classe

Crea un nuovo ShareLeaseClient.

Questo client fornisce operazioni di lease su shareClient o ShareFileClient.

Ereditarietà

builtins.object

ShareLeaseClient

Costruttore

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

Parametri

client

ShareFileClient oppure ShareClient

Necessario

Client del file o della condivisione per il lease.

lease_id

str

valore predefinito: None

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. Questa operazione stabilisce e gestisce un blocco in un file o una condivisione per operazioni di scrittura ed eliminazione. Se il file o la condivisione non dispone di un lease attivo, il servizio File o Condivisione crea un lease nel file o nella condivisione. Se il file ha un lease attivo, è possibile richiedere solo un nuovo lease usando l'ID lease attivo. Se il file o la condivisione non dispone di un lease attivo, il servizio File o Condivisione crea un lease nel file e restituisce un nuovo ID lease.
break_lease	Forzare l'interruzione del lease se il file o la condivisione ha un lease attivo. Qualsiasi richiesta autorizzata può interrompere il lease; non è necessario che nella richiesta sia specificato un ID lease corrispondente. Un lease infinito si interrompe immediatamente. Una volta interrotto un lease, non può essere modificato. Qualsiasi richiesta autorizzata può interrompere il lease; non è necessario che nella richiesta sia specificato un ID lease corrispondente. 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	Modifica l'ID lease di un lease attivo. Una modifica deve includere l'ID lease corrente in x-ms-lease-id e un nuovo ID lease in x-ms-propose-lease-id.
release	Rilascia il lease. Il lease può essere rilasciato se l'ID lease specificato nella richiesta corrisponde a quello associato alla condivisione o al file. Il rilascio del lease consente a un altro client di acquisire immediatamente il lease per la condivisione o il file non appena viene completata la versione.
renew	Rinnova il lease di condivisione. Il lease di condivisione può essere rinnovato se l'ID lease specificato nel client lease corrisponde a quello associato alla condivisione. Si noti che il lease può essere rinnovato anche se è scaduto fino a quando la condivisione non è stata nuovamente lease dopo la scadenza del lease. Quando si rinnova un lease, la durata del lease viene reimpostata. Novità nella versione 12.6.0.

acquire

Richiede un nuovo lease. Questa operazione stabilisce e gestisce un blocco in un file o una condivisione per operazioni di scrittura ed eliminazione. Se il file o la condivisione non dispone di un lease attivo, il servizio File o Condivisione crea un lease nel file o nella condivisione. Se il file ha un lease attivo, è possibile richiedere solo un nuovo lease usando l'ID lease attivo.

Se il file o la condivisione non dispone di un lease attivo, il servizio File o Condivisione crea un lease nel file e restituisce un nuovo ID lease.

acquire(**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. I lease di file non scadono mai. Un lease di condivisione non infinito può essere compreso tra 15 e 60 secondi. Non è possibile modificare una durata del lease di condivisione usando il rinnovo o la modifica. Il valore predefinito è -1 (lease di condivisione infinita).

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-file-service-operations. Questo valore non viene monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Tipo restituito

None

break_lease

Forzare l'interruzione del lease se il file o la condivisione ha un lease attivo. Qualsiasi richiesta autorizzata può interrompere il lease; non è necessario che nella richiesta sia specificato un ID lease corrispondente. Un lease infinito si interrompe immediatamente.

Una volta interrotto un lease, non può essere modificato. Qualsiasi richiesta autorizzata può interrompere il lease; non è necessario che nella richiesta sia specificato un ID lease corrispondente. 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(**kwargs: Any) -> int

Parametri

lease_break_period

int

Si tratta della durata proposta di secondi che il lease di condivisione deve continuare prima che venga interrotto, tra 0 e 60 secondi. Questo periodo di interruzione viene usato solo se è più breve del tempo rimanente nel lease di condivisione. Se più lungo, viene usato il tempo rimanente nel lease di condivisione. Un nuovo lease di condivisione non sarà disponibile prima della scadenza del periodo di interruzione, ma il lease di condivisione può essere mantenuto per più tempo del periodo di interruzione. Se questa intestazione non viene visualizzata con un'operazione di interruzione, un lease di condivisione a durata fissa si interrompe immediatamente dopo il periodo di lease di condivisione rimanente e un lease di condivisione infinito si interrompe immediatamente.

Novità nella versione 12.6.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-file-service-operations. Questo valore non viene monitorato 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

int

change

Modifica l'ID lease di un lease attivo. Una modifica deve includere l'ID lease corrente in x-ms-lease-id e un nuovo ID lease in x-ms-propose-lease-id.

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

Parametri

proposed_lease_id

str

Necessario

ID lease proposto, in un formato di stringa GUID. Il servizio File o Condivisione genererà un errore (richiesta non valida) se l'ID lease proposto non è nel formato corretto.

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-file-service-operations. Questo valore non viene monitorato 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 specificato nella richiesta corrisponde a quello associato alla condivisione o al file. Il rilascio del lease consente a un altro client di acquisire immediatamente il lease per la condivisione o il file non appena viene completata la versione.

release(**kwargs: Any) -> None

Parametri

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-file-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 di condivisione.

Il lease di condivisione può essere rinnovato se l'ID lease specificato nel client lease corrisponde a quello associato alla condivisione. Si noti che il lease può essere rinnovato anche se è scaduto fino a quando la condivisione non è stata nuovamente lease dopo la scadenza del lease. Quando si rinnova un lease, la durata del lease viene reimpostata.

Novità nella versione 12.6.0.

renew(**kwargs: Any) -> None

Parametri

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-file-service-operations. Questo valore non viene monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Nessuno