DataLakeLeaseClient Klasa

Tworzy nowy element DataLakeLeaseClient.

Ten klient udostępnia operacje dzierżawy na elementach FileSystemClient, DataLakeDirectoryClient lub DataLakeFileClient.

Dziedziczenie

builtins.object

DataLakeLeaseClient

Konstruktor

DataLakeLeaseClient(client: FileSystemClient | DataLakeDirectoryClient | DataLakeFileClient, lease_id: str | None = None)

Parametry

client

FileSystemClient lub DataLakeDirectoryClient lub DataLakeFileClient

Wymagane

Klient systemu plików, katalogu lub pliku do dzierżawy.

lease_id

str

wartość domyślna: None

Ciąg reprezentujący identyfikator dzierżawy istniejącej dzierżawy. Ta wartość nie musi być określona, aby uzyskać nową dzierżawę lub przerwać tę wartość.

Zmienne

id

str

Identyfikator dzierżawy, która jest obecnie utrzymywana. Będzie to wartość Brak , jeśli dzierżawa nie została jeszcze przejęta.

etag

str

ETag dzierżawy, która jest obecnie utrzymywana. Będzie to wartość Brak , jeśli dzierżawa nie została jeszcze przejęta lub zmodyfikowana.

last_modified

datetime

Ostatni zmodyfikowany znacznik czasu dzierżawy, który jest obecnie utrzymywany. Będzie to wartość Brak , jeśli dzierżawa nie została jeszcze przejęta lub zmodyfikowana.

Metody

acquire	Żąda nowej dzierżawy. Jeśli system plików/plików nie ma aktywnej dzierżawy, usługa DataLake tworzy dzierżawę w systemie plików/plików i zwraca nowy identyfikator dzierżawy.
break_lease	Przerwij dzierżawę, jeśli system plików lub plik ma aktywną dzierżawę. Po przerwaniu dzierżawy nie można jej odnowić. Każde autoryzowane żądanie może przerwać dzierżawę; żądanie nie jest wymagane do określenia zgodnego identyfikatora dzierżawy. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w tym czasie nie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w systemie plików lub pliku. Po pomyślnym przerwaniu dzierżawy odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy.
change	Zmień identyfikator dzierżawy aktywnej dzierżawy.
release	Zwolnij dzierżawę. Dzierżawa może zostać zwolniona, jeśli określony identyfikator dzierżawy klienta jest zgodny z systemem plików lub plikiem. Zwolnienie dzierżawy umożliwia innemu klientowi natychmiastowe uzyskanie dzierżawy dla systemu plików lub pliku zaraz po zakończeniu wydania.
renew	Odnawia dzierżawę. Dzierżawę można odnowić, jeśli identyfikator dzierżawy określony w kliencie dzierżawy jest zgodny z tym, który jest skojarzony z systemem plików lub plikiem. Należy pamiętać, że dzierżawa może zostać odnowiona nawet wtedy, gdy system plików lub plik nie został ponownie dzierżawiony od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy jest resetowany.

acquire

Żąda nowej dzierżawy.

Jeśli system plików/plików nie ma aktywnej dzierżawy, usługa DataLake tworzy dzierżawę w systemie plików/plików i zwraca nowy identyfikator dzierżawy.

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

Parametry

lease_duration

int

Wymagane

Określa czas trwania dzierżawy, w sekundach lub ujemny (-1) dla dzierżawy, która nigdy nie wygasa. Dzierżawa nieskończenie nieskończona może należeć do zakresu od 15 do 60 sekund. Nie można zmienić czasu trwania dzierżawy przy użyciu odnowienia lub zmiany. Wartość domyślna to -1 (nieskończona dzierżawa).

if_modified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag

str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu.

timeout

int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Typ zwracany

None

break_lease

Przerwij dzierżawę, jeśli system plików lub plik ma aktywną dzierżawę.

Po przerwaniu dzierżawy nie można jej odnowić. Każde autoryzowane żądanie może przerwać dzierżawę; żądanie nie jest wymagane do określenia zgodnego identyfikatora dzierżawy. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w tym czasie nie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w systemie plików lub pliku. Po pomyślnym przerwaniu dzierżawy odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy.

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

Parametry

lease_break_period

int

Wymagane

Jest to proponowany czas trwania sekund, przez który dzierżawa powinna być kontynuowana, zanim zostanie przerwana( od 0 do 60 sekund). Ten okres przerwania jest używany tylko wtedy, gdy jest krótszy niż czas pozostały w dzierżawie. Jeśli czas pozostały do dzierżawy jest dłuższy. Nowa dzierżawa nie będzie dostępna przed wygaśnięciem okresu przerwania, ale dzierżawa może być przechowywana przez dłuższy niż okres przerwania. Jeśli ten nagłówek nie jest wyświetlany z operacją przerwania, przerwy dzierżawy o stałym czasie trwania po upływie pozostałego okresu dzierżawy i nieskończone przerwy dzierżawy natychmiast.

if_modified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

timeout

int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Przybliżony czas pozostały w okresie dzierżawy w sekundach.

Typ zwracany

int

change

Zmień identyfikator dzierżawy aktywnej dzierżawy.

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

Parametry

proposed_lease_id

str

Wymagane

Proponowany identyfikator dzierżawy w formacie ciągu identyfikatora GUID. Usługa DataLake zwraca wartość 400 (nieprawidłowe żądanie), jeśli proponowany identyfikator dzierżawy nie ma poprawnego formatu.

if_modified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag

str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu.

timeout

int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Brak

release

Zwolnij dzierżawę.

Dzierżawa może zostać zwolniona, jeśli określony identyfikator dzierżawy klienta jest zgodny z systemem plików lub plikiem. Zwolnienie dzierżawy umożliwia innemu klientowi natychmiastowe uzyskanie dzierżawy dla systemu plików lub pliku zaraz po zakończeniu wydania.

release(**kwargs: Any) -> None

Parametry

if_modified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag

str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu.

timeout

int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Brak

renew

Odnawia dzierżawę.

Dzierżawę można odnowić, jeśli identyfikator dzierżawy określony w kliencie dzierżawy jest zgodny z tym, który jest skojarzony z systemem plików lub plikiem. Należy pamiętać, że dzierżawa może zostać odnowiona nawet wtedy, gdy system plików lub plik nie został ponownie dzierżawiony od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy jest resetowany.

renew(**kwargs: Any) -> None

Parametry

if_modified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since

datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag

str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu.

timeout

int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Brak