BlobClient Klasa
Klient do interakcji z określonym obiektem blob, chociaż ten obiekt blob może jeszcze nie istnieć.
- Dziedziczenie
-
azure.storage.blob._shared.base_client_async.AsyncStorageAccountHostsMixinBlobClientazure.storage.blob._blob_client.BlobClientBlobClientazure.storage.blob._encryption.StorageEncryptionMixinBlobClient
Konstruktor
BlobClient(account_url: str, container_name: str, blob_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | AsyncTokenCredential | None = None, **kwargs: Any)
Parametry
- account_url
- str
Identyfikator URI konta magazynu. Aby utworzyć klienta z pełnym identyfikatorem URI obiektu blob, użyj from_blob_url klasymethod.
- blob_name
- str
Nazwa obiektu blob, z którym ma być używana interakcja. Jeśli ta wartość zostanie określona, zastąpi wartość obiektu blob określoną w adresie URL obiektu blob.
- snapshot
- str
Opcjonalna migawka obiektu blob, na której ma działać. Może to być ciąg identyfikatora migawki lub odpowiedź zwrócona z .create_snapshot
- credential
Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być ciągiem tokenu SYGNATURy dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z pliku azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z pliku azure.identity. Jeśli identyfikator URI zasobu zawiera już token SAS, zostanie on zignorowany na rzecz jawnego poświadczenia
- z wyjątkiem przypadku elementu AzureSasCredential, gdzie powodujące konflikt tokeny SYGNATURy dostępu współdzielonego spowodują wywołanie błędu ValueError. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.
- api_version
- str
Wersja interfejsu API usługi Storage do użycia dla żądań. Wartość domyślna to najnowsza wersja usługi zgodna z bieżącym zestawem SDK. Ustawienie starszej wersji może spowodować zmniejszenie zgodności funkcji.
Nowość w wersji 12.2.0.
- secondary_hostname
- str
Nazwa hosta pomocniczego punktu końcowego.
- max_block_size
- int
Maksymalny rozmiar fragmentu przekazywania blokowego obiektu blob we fragmentach. Domyślnie 41024 1024lub 4 MB.
- max_single_put_size
- int
Jeśli rozmiar obiektu blob jest mniejszy lub równy max_single_put_size, obiekt blob zostanie przekazany przy użyciu tylko jednego żądania HTTP PUT. Jeśli rozmiar obiektu blob jest większy niż max_single_put_size, obiekt blob zostanie przekazany we fragmentach. Wartość domyślna to 641024 1024lub 64 MB.
- min_large_block_upload_threshold
- int
Minimalny rozmiar fragmentu wymagany do korzystania z algorytmu wydajnego pamięci podczas przekazywania blokowego obiektu blob. Wartość domyślna to 41024 1024+1.
- use_byte_buffer
- bool
Użyj buforu bajtów na potrzeby przekazywania blokowych obiektów blob. Wartość domyślna to False.
- max_page_size
- int
Maksymalny rozmiar fragmentu do przekazywania stronicowego obiektu blob. Domyślnie 41024 1024lub 4 MB.
- max_single_get_size
- int
Maksymalny rozmiar obiektu blob, który ma zostać pobrany w jednym wywołaniu, przekroczona część zostanie pobrana we fragmentach (może być równoległa). Wartość domyślna to 321024 1024lub 32 MB.
- max_chunk_get_size
- int
Maksymalny rozmiar fragmentu używany do pobierania obiektu blob. Domyślnie 41024 1024lub 4 MB.
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob do działania.
Metody
abort_copy |
Przerwanie trwającej operacji kopiowania. Spowoduje to pozostawienie docelowego obiektu blob o zerowej długości i pełnych metadanych. Spowoduje to wystąpienie błędu, jeśli operacja kopiowania została już zakończona. |
acquire_lease |
Żąda nowej dzierżawy. Jeśli obiekt blob nie ma aktywnej dzierżawy, usługa Blob Service tworzy dzierżawę obiektu blob i zwraca nową dzierżawę. |
append_block |
Zatwierdza nowy blok danych na końcu istniejącego uzupełnialnych obiektów blob. |
append_block_from_url |
Tworzy nowy blok do zatwierdzenia w ramach obiektu blob, w którym zawartość jest odczytywana z źródłowego adresu URL. |
clear_page |
Czyści zakres stron. |
close |
Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu. |
commit_block_list |
Operacja Zatwierdź listę bloków zapisuje obiekt blob, określając listę identyfikatorów blokowych, które tworzą obiekt blob. |
create_append_blob |
Tworzy nowy obiekt blob dołączania. Ta operacja tworzy nowy obiekt blob dołączania o długości 0. Zawartość dowolnego istniejącego obiektu blob jest zastępowana nowo zainicjowanym uzupełnianym obiektem blob. Aby dodać zawartość do uzupełnialnych obiektów blob, wywołaj metodę append_block or append_block_from_url . |
create_page_blob |
Tworzy nowy stronicowy obiekt blob o określonym rozmiarze. |
create_snapshot |
Tworzy migawkę obiektu blob. Migawka jest wersją obiektu blob tylko do odczytu, która jest wykonywana w danym momencie. Można go odczytywać, kopiować lub usuwać, ale nie modyfikować. Migawki umożliwiają tworzenie kopii zapasowej obiektu blob w miarę pojawiania się w danym momencie. Migawka obiektu blob ma taką samą nazwę jak podstawowy obiekt blob, z którego jest wykonywana migawka, z dołączona wartość DateTime wskazująca czas, w którym migawka została wykonana. |
delete_blob |
Oznacza określony obiekt blob do usunięcia. Obiekt blob zostanie później usunięty podczas odzyskiwania pamięci. Należy pamiętać, że aby usunąć obiekt blob, należy usunąć wszystkie jego migawki. Oba można usunąć jednocześnie za pomocą operacji delete_blob(). Jeśli dla usługi włączono zasady przechowywania usuwania, ta operacja nietrwała usuwa obiekt blob i zachowuje obiekt blob przez określoną liczbę dni. Po określonej liczbie dni dane obiektu blob zostaną usunięte z usługi podczas odzyskiwania pamięci. Obiekt blob usunięty nietrwale jest dostępny za pomocą list_blobs opcji include=['deleted']. Obiekt blob usunięty nietrwale można przywrócić przy użyciu <xref:azure.storage.blob.aio.undelete> operacji. |
delete_immutability_policy |
Operacja Usuń zasady niezmienności usuwa zasady niezmienności w obiekcie blob. Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02". |
download_blob |
Pobiera obiekt blob do obiektu StorageStreamDownloader. Metoda readall() musi służyć do odczytywania całej zawartości lub funkcji readinto() w celu pobrania obiektu blob do strumienia. Użycie fragmentów() zwraca iterator asynchroniczny, który umożliwia użytkownikowi iterowanie zawartości we fragmentach. |
exists |
Zwraca wartość True, jeśli obiekt blob istnieje ze zdefiniowanymi parametrami i zwraca wartość False w przeciwnym razie. |
from_blob_url |
Utwórz obiekt BlobClient na podstawie adresu URL obiektu blob. Nie obsługuje to dostosowanego adresu URL obiektu blob z ciągiem "/" w nazwie obiektu blob. |
from_connection_string |
Utwórz obiekt BlobClient na podstawie parametrów połączenia. |
get_account_information |
Pobiera informacje związane z kontem magazynu, w którym znajduje się obiekt blob. Informacje te można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob. Klucze w zwracanym słowniku obejmują "sku_name" i "account_kind". |
get_blob_properties |
Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob. |
get_blob_tags |
Operacja Pobierz tagi umożliwia użytkownikom pobieranie tagów w obiekcie blob lub określonej wersji obiektu blob, ale nie migawki. Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12". |
get_block_list |
Operacja Pobierania listy bloków pobiera listę bloków, które zostały przekazane w ramach blokowego obiektu blob. |
get_page_range_diff_for_managed_disk |
Zwraca listę prawidłowych zakresów stron dla dysku zarządzanego lub migawki. Uwaga Ta operacja jest dostępna tylko dla kont dysków zarządzanych. Nowość w wersji 12.2.0: ta operacja została wprowadzona w wersji interfejsu API "2019-07-07". |
get_page_ranges |
PRZESTARZAŁE: Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob. |
list_page_ranges |
Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob. Jeśli previous_snapshot zostanie określony, wynik będzie różnicą zmian między docelowym obiektem blob a poprzednią migawką. |
query_blob |
Umożliwia użytkownikom wybieranie/projekt danych migawek obiektów blob/lub obiektów blob przez dostarczanie prostych wyrażeń zapytań. Te operacje zwracają element BlobQueryReader, użytkownicy muszą używać funkcji readall() lub readinto(), aby pobrać dane zapytań. |
resize_blob |
Zmienia rozmiar stronicowego obiektu blob na określony rozmiar. Jeśli określona wartość jest mniejsza niż bieżący rozmiar obiektu blob, wszystkie strony powyżej określonej wartości zostaną wyczyszczone. |
seal_append_blob |
Operacja Seal uszczelnia obiekt blob dołączania, aby był tylko do odczytu. Nowość w wersji 12.4.0. |
set_blob_metadata |
Ustawia metadane zdefiniowane przez użytkownika dla obiektu blob jako co najmniej jedną parę name-value. |
set_blob_tags |
Operacja Ustaw tagi umożliwia użytkownikom ustawianie tagów w obiekcie blob lub określonej wersji obiektu blob, ale nie migawki. Każde wywołanie tej operacji zastępuje wszystkie istniejące tagi dołączone do obiektu blob. Aby usunąć wszystkie tagi z obiektu blob, wywołaj tę operację bez ustawionych tagów. Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12". |
set_http_headers |
Ustawia właściwości systemowe obiektu blob. Jeśli dla content_settings ustawiono jedną właściwość, wszystkie właściwości zostaną zastąpione. |
set_immutability_policy |
Operacja Ustaw zasady niezmienności ustawia zasady niezmienności w obiekcie blob. Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02". |
set_legal_hold |
Operacja ustawiania archiwizacji ze względów prawnych ustawia archiwizację ze względów prawnych dla obiektu blob. Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02". |
set_premium_page_blob_tier |
Ustawia warstwy stronicowych obiektów blob w obiekcie blob. Ten interfejs API jest obsługiwany tylko w przypadku stronicowych obiektów blob na kontach w warstwie Premium. |
set_sequence_number |
Ustawia numer sekwencji obiektów blob. |
set_standard_blob_tier |
Ta operacja ustawia warstwę na blokowym obiekcie blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob. |
stage_block |
Tworzy nowy blok do zatwierdzenia w ramach obiektu blob. |
stage_block_from_url |
Tworzy nowy blok do zatwierdzenia w ramach obiektu blob, w którym zawartość jest odczytywana z adresu URL. |
start_copy_from_url |
Kopiuje obiekt blob z danego adresu URL. Ta operacja zwraca słownik zawierający copy_status i copy_id, którego można użyć do sprawdzenia stanu operacji kopiowania lub przerwania jej działania. copy_status będzie "powodzenie", jeśli kopia została ukończona synchronicznie lub "oczekująca", jeśli kopia została uruchomiona asynchronicznie. W przypadku kopii asynchronicznych stan można sprawdzić, sondując metodę get_blob_properties i sprawdzając stan kopiowania. Ustaw wartość requires_sync na wartość True, aby wymusić synchroniczną kopię. Usługa Blob service kopiuje obiekty blob w oparciu o najlepsze wysiłki. Źródłowy obiekt blob operacji kopiowania może być blokowym obiektem blob, uzupełnianym obiektem blob lub stronicowym obiektem blob. Jeśli docelowy obiekt blob już istnieje, musi mieć ten sam typ obiektu blob co źródłowy obiekt blob. Każdy istniejący docelowy obiekt blob zostanie zastąpiony. Nie można zmodyfikować docelowego obiektu blob, gdy operacja kopiowania jest w toku. Podczas kopiowania ze stronicowego obiektu blob usługa Blob tworzy docelowy obiekt blob stronicowy długości źródłowego obiektu blob, początkowo zawierające wszystkie zera. Następnie zakresy stron źródłowych są wyliczane, a zakresy niepuste są kopiowane. W przypadku blokowego obiektu blob lub uzupełnialnych obiektów blob usługa Blob tworzy zatwierdzony obiekt blob o zerowej długości przed powrotem z tej operacji. Podczas kopiowania z blokowego obiektu blob wszystkie zatwierdzone bloki i ich identyfikatory bloków są kopiowane. Niezatwierdzone bloki nie są kopiowane. Na końcu operacji kopiowania docelowy obiekt blob będzie miał taką samą zatwierdzoną liczbę bloków co źródło. Podczas kopiowania z uzupełnialnych obiektów blob wszystkie zatwierdzone bloki są kopiowane. Na końcu operacji kopiowania docelowy obiekt blob będzie miał taką samą zatwierdzoną liczbę bloków co źródło. |
undelete_blob |
Przywraca nietrwałe obiekty blob lub migawki. Operacja zakończy się powodzeniem tylko wtedy, gdy zostanie użyta w określonej liczbie dni ustawionej w zasadach przechowywania usuwania. Jeśli obsługa wersji obiektów blob jest włączona, nie można przywrócić podstawowego obiektu blob przy użyciu tej metody. Zamiast tego użyj adresu start_copy_from_url URL wersji obiektu blob, którą chcesz podwyższyć poziom do bieżącej wersji. |
upload_blob |
Tworzy nowy obiekt blob ze źródła danych z automatycznym fragmentowaniem. |
upload_blob_from_url |
Tworzy nowy blokowy obiekt blob, w którym zawartość obiektu blob jest odczytywana z danego adresu URL. Zawartość istniejącego obiektu blob jest zastępowana nowym obiektem blob. |
upload_page |
Operacja Przekazywania stron zapisuje zakres stron do stronicowego obiektu blob. |
upload_pages_from_url |
Operacja Przekazywania stron zapisuje zakres stron do stronicowego obiektu blob, w którym zawartość jest odczytywana z adresu URL. |
abort_copy
Przerwanie trwającej operacji kopiowania.
Spowoduje to pozostawienie docelowego obiektu blob o zerowej długości i pełnych metadanych. Spowoduje to wystąpienie błędu, jeśli operacja kopiowania została już zakończona.
async abort_copy(copy_id: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> None
Parametry
- copy_id
- str lub BlobProperties
Operacja kopiowania do przerwania. Może to być identyfikator lub wystąpienie obiektu BlobProperties.
Typ zwracany
acquire_lease
Żąda nowej dzierżawy.
Jeśli obiekt blob nie ma aktywnej dzierżawy, usługa Blob Service tworzy dzierżawę obiektu blob i zwraca nową dzierżawę.
async acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> BlobLeaseClient
Parametry
- lease_duration
- int
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).
- lease_id
- str
Proponowany identyfikator dzierżawy w formacie ciągu identyfikatora GUID. Usługa Blob Service 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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
Obiekt BlobLeaseClient.
Typ zwracany
append_block
Zatwierdza nowy blok danych na końcu istniejącego uzupełnialnych obiektów blob.
async append_block(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]
Parametry
- data
Zawartość bloku.
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 zawartości bloku. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne w przypadku wykrywania bitflipów w sieci, jeśli używasz protokołu HTTP zamiast https, ponieważ jest to protokół https (wartość domyślna), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob.
- maxsize_condition
- int
Opcjonalny nagłówek warunkowy. Maksymalna długość w bajtach dozwolona dla uzupełnialnych obiektów blob. Jeśli operacja bloku dołączania spowoduje przekroczenie tego limitu przez obiekt blob lub jeśli rozmiar obiektu blob jest już większy niż wartość określona w tym nagłówku, żądanie zakończy się niepowodzeniem z powodu błędu MaxBlobSizeConditionNotMet (kod stanu HTTP 412 — Niepowodzenie warunku wstępnego).
- appendpos_condition
- int
Opcjonalny nagłówek warunkowy używany tylko dla operacji dołączania bloku. Liczba wskazująca przesunięcie bajtów do porównania. Funkcja Append Block powiedzie się tylko wtedy, gdy pozycja dołączania jest równa tej liczbie. Jeśli tak nie jest, żądanie zakończy się niepowodzeniem z powodu błędu AppendPositionConditionNotMet (kod stanu HTTP 412 — Niepowodzenie warunku wstępnego).
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- encoding
- str
Wartość domyślna to UTF-8.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
Zaktualizowany dykt właściwości obiektu blob (Etag, ostatnia modyfikacja, przesunięcie dołączania, liczba zatwierdzonych bloków).
Typ zwracany
append_block_from_url
Tworzy nowy blok do zatwierdzenia w ramach obiektu blob, w którym zawartość jest odczytywana z źródłowego adresu URL.
async append_block_from_url(copy_source_url: str, source_offset: int | None = None, source_length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]
Parametry
- copy_source_url
- str
Adres URL danych źródłowych. Może wskazywać dowolny obiekt blob lub plik platformy Azure, który jest publiczny lub ma dołączony sygnaturę dostępu współdzielonego.
- source_offset
- int
Wskazuje to początek zakresu bajtów (włącznie), który musi zostać pobrany ze źródła kopii.
- source_length
- int
Wskazuje to koniec zakresu bajtów, które muszą zostać pobrane ze źródła kopii.
- source_content_md5
- bytearray
Jeśli zostanie podana, usługa obliczy skrót MD5 zawartości bloku i porówna je z tą wartością.
- maxsize_condition
- int
Opcjonalny nagłówek warunkowy. Maksymalna długość w bajtach dozwolona dla uzupełnialnych obiektów blob. Jeśli operacja bloku dołączania spowoduje przekroczenie tego limitu przez obiekt blob lub jeśli rozmiar obiektu blob jest już większy niż wartość określona w tym nagłówku, żądanie zakończy się niepowodzeniem z powodu błędu MaxBlobSizeConditionNotMet (kod stanu HTTP 412 — Niepowodzenie warunku wstępnego).
- appendpos_condition
- int
Opcjonalny nagłówek warunkowy używany tylko dla operacji dołączania bloku. Liczba wskazująca przesunięcie bajtów do porównania. Funkcja Append Block powiedzie się tylko wtedy, gdy pozycja dołączania jest równa tej liczbie. Jeśli tak nie jest, żądanie zakończy się niepowodzeniem z powodu błędu AppendPositionConditionNotMet (kod stanu HTTP 412 — Niepowodzenie warunku wstępnego).
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- 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
Docelowa 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 miejsca docelowego do użycia w tagu etag.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- source_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 źródłowy został zmodyfikowany od określonego czasu.
- source_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 źródłowy nie został zmodyfikowany od określonej daty/godziny.
- source_etag
- str
Wartość źródłowego 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 .
- source_match_condition
- MatchConditions
Warunek dopasowania źródła do użycia w tagu etag.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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.
- source_authorization
- str
Uwierzytelnianie jako jednostka usługi przy użyciu klucza tajnego klienta w celu uzyskania dostępu do źródłowego obiektu blob. Upewnij się, że element nośny jest prefiksem ciągu source_authorization.
clear_page
Czyści zakres stron.
async clear_page(offset: int, length: int, **kwargs: Any) -> Dict[str, str | datetime]
Parametry
- offset
- int
Początek zakresu bajtów używany do zapisywania w sekcji obiektu blob. Strony muszą być wyrównane do granic 512-bajtowych, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- length
- int
Liczba bajtów używanych do zapisywania w sekcji obiektu blob. Strony muszą być wyrównane do granic 512-bajtowych, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_sequence_number_lte
- int
Jeśli numer sekwencji obiektu blob jest mniejszy lub równy określonej wartości, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_sequence_number_lt
- int
Jeśli numer sekwencji obiektu blob jest mniejszy niż określona wartość, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_sequence_number_eq
- int
Jeśli numer sekwencji obiektu blob jest równy określonej wartości, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- 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
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja).
Typ zwracany
close
Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.
async close()
commit_block_list
Operacja Zatwierdź listę bloków zapisuje obiekt blob, określając listę identyfikatorów blokowych, które tworzą obiekt blob.
async commit_block_list(block_list: List[BlobBlock], content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]
Parametry
- content_settings
- ContentSettings
Obiekt ContentSettings używany do ustawiania właściwości obiektu blob. Służy do ustawiania typu zawartości, kodowania, języka, dyspozycji, md5 i kontrolki pamięci podręcznej.
Pary name-value skojarzone z obiektem blob jako tagiem. Tagi są uwzględniane w wielkości liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się od 0 do 256 znaków.
Prawidłowe znaki klucza tagu i wartości obejmują małe litery i wielkie litery, cyfry (0–9), spację ( >>
<<), plus (+), minus (-), kropkę (.), kropkę (.), solidus (/), dwukropek (:), równe (=), podkreślenie (_)
Nowość w wersji 12.4.0.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- immutability_policy
- ImmutabilityPolicy
Określa zasady niezmienności wersji obiektu blob, migawki obiektu blob lub obiektu blob.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- legal_hold
- bool
Określono, czy na obiekcie blob ma być ustawione archiwizacja ze względów prawnych.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 zawartości strony. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https, jak https (ustawienie domyślne), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- standard_blob_tier
- StandardBlobTier
Standardowa wartość warstwy obiektów blob w celu ustawienia obiektu blob na wartość. W przypadku tej wersji biblioteki ma to zastosowanie tylko do blokowych obiektów blob na kontach magazynu w warstwie Standardowa.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał tutaj nazwę. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zostanie zastąpiona, jeśli zakres na poziomie kontenera jest skonfigurowany tak, aby zezwalał na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja).
Typ zwracany
create_append_blob
Tworzy nowy obiekt blob dołączania. Ta operacja tworzy nowy obiekt blob dołączania o długości 0. Zawartość dowolnego istniejącego obiektu blob jest zastępowana nowo zainicjowanym uzupełnianym obiektem blob. Aby dodać zawartość do uzupełnialnych obiektów blob, wywołaj metodę append_block or append_block_from_url .
async create_append_blob(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]
Parametry
- content_settings
- ContentSettings
Obiekt ContentSettings używany do ustawiania właściwości obiektu blob. Służy do ustawiania typu zawartości, kodowania, języka, dyspozycji, md5 i kontrolki pamięci podręcznej.
Pary name-value skojarzone z obiektem blob jako tagiem. Tagi są uwzględniane w wielkości liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się od 0 do 256 znaków.
Prawidłowe znaki klucza tagu i wartości obejmują małe litery i wielkie litery, cyfry (0–9), spację ( >>
<<), plus (+), minus (-), kropkę (.), kropkę (.), solidus (/), dwukropek (:), równe (=), podkreślenie (_)
Nowość w wersji 12.4.0.
- immutability_policy
- ImmutabilityPolicy
Określa zasady niezmienności wersji obiektu blob, migawki obiektu blob lub obiektu blob.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- legal_hold
- bool
Określono, czy na obiekcie blob ma być ustawione archiwizacja ze względów prawnych.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość 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.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
Zaktualizowany dykt właściwości obiektu blob (Etag i ostatnia modyfikacja).
Typ zwracany
create_page_blob
Tworzy nowy stronicowy obiekt blob o określonym rozmiarze.
async create_page_blob(size: int, content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, premium_page_blob_tier: str | PremiumPageBlobTier | None = None, **kwargs) -> Dict[str, str | datetime]
Parametry
- size
- int
Określa maksymalny rozmiar stronicowego obiektu blob o rozmiarze do 1 TB. Rozmiar stronicowego obiektu blob musi być wyrównany do granicy 512-bajtowej.
- content_settings
- ContentSettings
Obiekt ContentSettings używany do ustawiania właściwości obiektu blob. Służy do ustawiania typu zawartości, kodowania, języka, dyspozycji, md5 i kontrolki pamięci podręcznej.
- premium_page_blob_tier
- PremiumPageBlobTier
Wartość warstwy stronicowego obiektu blob do ustawienia obiektu blob na . Warstwa jest skorelowana z rozmiarem obiektu blob i liczbą dozwolonych operacji we/wy na sekundę. Dotyczy to tylko stronicowych obiektów blob na kontach magazynu w warstwie Premium.
Pary name-value skojarzone z obiektem blob jako tagiem. W tagach jest rozróżniana wielkość liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się w zakresie od 0 do 256 znaków.
Prawidłowe znaki klucza i wartości tagu obejmują: małe i wielkie litery, cyfry (0–9), spacja ( >>
<<), plus (+), minus (-), kropka (.), znak (/), dwukropek (:), równa (=), podkreślenie (_)
Nowość w wersji 12.4.0.
- sequence_number
- int
Tylko dla stronicowych obiektów blob. Numer sekwencji jest wartością kontrolowaną przez użytkownika, której można użyć do śledzenia żądań. Wartość numeru sekwencji musi należeć do przedziału od 0 do 2^63–1.Wartość domyślna to 0.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- immutability_policy
- ImmutabilityPolicy
Określa zasady niezmienności dla obiektu blob, migawki obiektu blob lub wersji obiektu blob.
Nowość w wersji 12.10.0: wprowadzono to w interfejsie API w wersji "2020-10-02".
- legal_hold
- bool
Określono, czy dla obiektu blob należy ustawić archiwizację prawną.
Nowość w wersji 12.10.0: wprowadzono to w interfejsie API w wersji "2020-10-02".
- 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.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
Zaktualizowany dykt właściwości obiektu blob (Etag i ostatnia modyfikacja).
Typ zwracany
create_snapshot
Tworzy migawkę obiektu blob.
Migawka jest wersją obiektu blob tylko do odczytu, która jest wykonywana w danym momencie. Można go odczytywać, kopiować lub usuwać, ale nie modyfikować. Migawki umożliwiają tworzenie kopii zapasowej obiektu blob w miarę pojawiania się w danym momencie.
Migawka obiektu blob ma taką samą nazwę jak podstawowy obiekt blob, z którego jest wykonywana migawka, z dołączona wartość DateTime wskazująca czas, w którym migawka została wykonana.
async create_snapshot(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]
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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
Zaktualizowano właściwość obiektu blob (identyfikator migawki, element Etag i ostatnia modyfikacja).
Typ zwracany
delete_blob
Oznacza określony obiekt blob do usunięcia.
Obiekt blob zostanie później usunięty podczas odzyskiwania pamięci. Należy pamiętać, że aby usunąć obiekt blob, należy usunąć wszystkie jego migawki. Oba można usunąć jednocześnie za pomocą operacji delete_blob().
Jeśli dla usługi włączono zasady przechowywania usuwania, ta operacja nietrwała usuwa obiekt blob i zachowuje obiekt blob przez określoną liczbę dni. Po określonej liczbie dni dane obiektu blob zostaną usunięte z usługi podczas odzyskiwania pamięci. Obiekt blob usunięty nietrwale jest dostępny za pomocą list_blobs opcji include=['deleted']. Obiekt blob usunięty nietrwale można przywrócić przy użyciu <xref:azure.storage.blob.aio.undelete> operacji.
async delete_blob(delete_snapshots: str = None, **kwargs: Any) -> None
Parametry
- delete_snapshots
- str
Wymagane, jeśli obiekt blob ma skojarzone migawki. Wartości są następujące:
"only": Usuwa tylko migawki obiektów blob.
"include": Usuwa obiekt blob wraz ze wszystkimi migawkami.
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob do usunięcia.
Nowość w wersji 12.4.0.
Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2019-12-12".
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Jeśli zostanie określony, delete_blob powiedzie się tylko wtedy, gdy dzierżawa obiektu blob jest aktywna i jest zgodna z tym identyfikatorem. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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
delete_immutability_policy
Operacja Usuń zasady niezmienności usuwa zasady niezmienności w obiekcie blob.
Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02".
async delete_immutability_policy(**kwargs: Any) -> None
Parametry
- 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
Pary wartości klucza tagów obiektów blob.
Typ zwracany
download_blob
Pobiera obiekt blob do obiektu StorageStreamDownloader. Metoda readall() musi służyć do odczytywania całej zawartości lub funkcji readinto() w celu pobrania obiektu blob do strumienia. Użycie fragmentów() zwraca iterator asynchroniczny, który umożliwia użytkownikowi iterowanie zawartości we fragmentach.
async download_blob(offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]
Parametry
- offset
- int
Początek zakresu bajtów do użycia podczas pobierania sekcji obiektu blob. Należy ustawić, jeśli jest podana długość.
- length
- int
Liczba bajtów do odczytu ze strumienia. Jest to opcjonalne, ale powinno być dostarczane w celu uzyskania optymalnej wydajności.
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime określającą wersję obiektu blob do pobrania.
Nowość w wersji 12.4.0.
Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2019-12-12".
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 dla każdego fragmentu obiektu blob. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https, jak https (ustawienie domyślne), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob. Należy również pamiętać, że w przypadku włączenia algorytmu przekazywania wydajnego w pamięci nie będzie używany, ponieważ przetwarzanie skrótu MD5 wymaga buforowania całych bloków i w ten sposób pokonuje cel algorytmu wydajnego w pamięci.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Jeśli zostanie określony, download_blob powiedzie się tylko wtedy, gdy dzierżawa obiektu blob jest aktywna i jest zgodna z tym identyfikatorem. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- max_concurrency
- int
Liczba połączeń równoległych do pobrania.
- encoding
- str
Kodowanie w celu dekodowania pobranych bajtów. Wartość domyślna to Brak, tj. brak dekodowania.
Asynchroniczne wywołanie zwrotne w celu śledzenia postępu długotrwałego pobierania. Podpis to funkcja (bieżąca: int, total: int), gdzie bieżąca jest liczbą bajtów przetransferowanych do tej pory, a łączny rozmiar pobierania jest całkowity.
- 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. Ta metoda może wykonywać wiele wywołań usługi, a limit czasu będzie stosowany do każdego wywołania indywidualnie. wiele wywołań do usługi platformy Azure i limit czasu będzie stosowany do każdego wywołania indywidualnie.
Zwraca
Obiekt przesyłania strumieniowego (StorageStreamDownloader)
Typ zwracany
exists
Zwraca wartość True, jeśli obiekt blob istnieje ze zdefiniowanymi parametrami i zwraca wartość False w przeciwnym razie.
async exists(**kwargs: Any) -> bool
Parametry
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob, aby sprawdzić, czy istnieje.
- 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
boolean
Typ zwracany
from_blob_url
Utwórz obiekt BlobClient na podstawie adresu URL obiektu blob. Nie obsługuje to dostosowanego adresu URL obiektu blob z ciągiem "/" w nazwie obiektu blob.
from_blob_url(blob_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> Self
Parametry
- blob_url
- str
Pełny adres URL punktu końcowego do obiektu blob, w tym token SAS i migawka, jeśli jest używana. Może to być podstawowy punkt końcowy lub pomocniczy punkt końcowy w zależności od bieżącego location_mode.
- credential
- Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>
Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS lub parametry połączenia ma już wartości klucza dostępu współdzielonego. Wartość może być ciągiem tokenu SYGNATURy dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z pliku azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z pliku azure.identity. Jeśli identyfikator URI zasobu zawiera już token SAS, zostanie on zignorowany na rzecz jawnego poświadczenia
- z wyjątkiem przypadku elementu AzureSasCredential, gdzie powodujące konflikt tokeny SYGNATURy dostępu współdzielonego spowodują wywołanie błędu ValueError. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.
- snapshot
- str
Opcjonalna migawka obiektu blob, na której ma działać. Może to być ciąg identyfikatora migawki lub odpowiedź zwrócona z .create_snapshot Jeśli zostanie określony, spowoduje to zastąpienie migawki w adresie URL.
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob do działania.
Zwraca
Klient obiektu blob.
Typ zwracany
from_connection_string
Utwórz obiekt BlobClient na podstawie parametrów połączenia.
from_connection_string(conn_str: str, container_name: str, blob_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parametry
- snapshot
- str
Opcjonalna migawka obiektu blob, na której ma działać. Może to być ciąg identyfikatora migawki lub odpowiedź zwrócona z .create_snapshot
- credential
- Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>
Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS lub parametry połączenia ma już wartości klucza dostępu współdzielonego. Wartość może być ciągiem tokenu SYGNATURy dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z pliku azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z pliku azure.identity. Poświadczenia podane w tym miejscu będą miały pierwszeństwo przed tymi w parametry połączenia. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob do działania.
Zwraca
Klient obiektu blob.
Typ zwracany
get_account_information
Pobiera informacje związane z kontem magazynu, w którym znajduje się obiekt blob.
Informacje te można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob. Klucze w zwracanym słowniku obejmują "sku_name" i "account_kind".
async get_account_information(**kwargs: int | None) -> Dict[str, str]
Zwraca
Dykt informacji o koncie (jednostka SKU i typ konta).
Typ zwracany
get_blob_properties
Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob.
async get_blob_properties(**kwargs: Any) -> BlobProperties
Parametry
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob w celu pobrania właściwości.
Nowość w wersji 12.4.0.
Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2019-12-12".
- 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- 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
Właściwości obiektu blob
Typ zwracany
get_blob_tags
Operacja Pobierz tagi umożliwia użytkownikom pobieranie tagów w obiekcie blob lub określonej wersji obiektu blob, ale nie migawki.
Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12".
async get_blob_tags(**kwargs: Any) -> Dict[str, str]
Parametry
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob w celu dodania tagów.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- 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
Pary klucz-wartość tagów obiektów blob.
Typ zwracany
get_block_list
Operacja Pobierania listy bloków pobiera listę bloków, które zostały przekazane w ramach blokowego obiektu blob.
async get_block_list(block_list_type: str | None = 'committed', **kwargs: Any) -> Tuple[List[BlobBlock], List[BlobBlock]]
Parametry
- block_list_type
- str
Określa, czy należy zwrócić listę zatwierdzonych bloków, listę niezatwierdzonych bloków, czy obie listy razem. Możliwe wartości to: "zatwierdzone", "niezatwierdzone", "wszystkie"
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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
Krotka dwóch list — zatwierdzone i niezatwierdzone bloki
Typ zwracany
get_page_range_diff_for_managed_disk
Zwraca listę prawidłowych zakresów stron dla dysku zarządzanego lub migawki.
Uwaga
Ta operacja jest dostępna tylko dla kont dysków zarządzanych.
Nowość w wersji 12.2.0: ta operacja została wprowadzona w wersji interfejsu API "2019-07-07".
async get_page_range_diff_for_managed_disk(previous_snapshot_url: str, offset: int | None = None, length: int | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]
Parametry
- previous_snapshot_url
Określa adres URL poprzedniej migawki dysku zarządzanego. Odpowiedź będzie zawierać tylko strony, które zostały zmienione między docelowym obiektem blob a poprzednią migawką.
- offset
- int
Początek zakresu bajtów do użycia na potrzeby pobierania prawidłowych zakresów stron. Jeśli nie podano długości, wszystkie bajty po przesunięcie zostaną przeszukane. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- length
- int
Liczba bajtów używanych do pobierania prawidłowych zakresów stron. W przypadku podania długości należy podać przesunięcie. Ten zakres zwróci prawidłowe zakresy stron od uruchomienia przesunięcia do określonej długości. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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
Krotka dwóch list zakresów stron jako słowników z kluczami "start" i "end". Pierwszy element jest wypełniony zakresami stron, drugi element jest czyszczone zakresy stron.
Typ zwracany
get_page_ranges
PRZESTARZAŁE: Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob.
async get_page_ranges(offset: int | None = None, length: int | None = None, previous_snapshot_diff: str | Dict[str, Any] | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]
Parametry
- offset
- int
Początek zakresu bajtów do użycia na potrzeby pobierania prawidłowych zakresów stron. Jeśli nie podano długości, wszystkie bajty po przesunięcie zostaną przeszukane. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- length
- int
Liczba bajtów używanych do pobierania prawidłowych zakresów stron. W przypadku podania długości należy podać przesunięcie. Ten zakres zwróci prawidłowe zakresy stron od uruchomienia przesunięcia do określonej długości. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- previous_snapshot_diff
- str
Parametr różnicowania migawki zawierający nieprzezroczystą wartość typu DateTime, która określa poprzednią migawkę obiektu blob do porównania z nowszą migawką lub bieżącym obiektem blob.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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
Krotka dwóch list zakresów stron jako słowników z kluczami "start" i "end". Pierwszy element jest wypełniony zakresami stron, drugi element jest czyszczone zakresy stron.
Typ zwracany
list_page_ranges
Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob. Jeśli previous_snapshot zostanie określony, wynik będzie różnicą zmian między docelowym obiektem blob a poprzednią migawką.
list_page_ranges(*, offset: int | None = None, length: int | None = None, previous_snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> AsyncItemPaged[PageRange]
Parametry
- offset
- int
Początek zakresu bajtów do użycia na potrzeby pobierania prawidłowych zakresów stron. Jeśli nie podano długości, wszystkie bajty po przesunięcie zostaną przeszukane. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- length
- int
Liczba bajtów używanych do pobierania prawidłowych zakresów stron. W przypadku podania długości należy podać przesunięcie. Ten zakres zwróci prawidłowe zakresy stron od uruchomienia przesunięcia do określonej długości. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
Wartość migawki określająca, że odpowiedź będzie zawierać tylko strony, które zostały zmienione między docelowym obiektem blob a poprzednią migawką. Zmienione strony obejmują zarówno zaktualizowane, jak i wyczyszczone strony. Docelowy obiekt blob może być migawką, o ile migawka określona przez previous_snapshot jest starsza od tych dwóch.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- results_per_page
- int
Maksymalna liczba zakresów stron do pobrania na wywołanie interfejsu API.
- 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
Iterowalne (automatyczne stronicowanie) elementu PageRange.
Typ zwracany
query_blob
Umożliwia użytkownikom wybieranie/projekt danych migawek obiektów blob/lub obiektów blob przez dostarczanie prostych wyrażeń zapytań. Te operacje zwracają element BlobQueryReader, użytkownicy muszą używać funkcji readall() lub readinto(), aby pobrać dane zapytań.
query_blob(query_expression: str, **kwargs: Any) -> BlobQueryReader
Parametry
- query_expression
- str
Wymagane. instrukcja zapytania. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.
- on_error
- Callable[BlobQueryError]
Funkcja, która ma być wywoływana w przypadku błędów przetwarzania zwróconych przez usługę.
- blob_format
- DelimitedTextDialect lub DelimitedJsonDialect lub QuickQueryDialect lub str
Opcjonalny. Definiuje serializacji danych przechowywanych obecnie w obiekcie blob. Wartością domyślną jest traktowanie danych obiektu blob jako danych CSV sformatowanych w domyślnym dialektzie. Można to zastąpić za pomocą niestandardowego obiektu DelimitedTextDialect lub DelimitedJsonDialect lub "ParquetDialect" (przekazanego jako ciąg lub wyliczenie). Te dialekty mogą być przekazywane przez odpowiednie klasy, wyliczenie QuickQueryDialect lub jako ciąg
- output_format
- DelimitedTextDialect lub DelimitedJsonDialect lub list[ArrowDialect] lub QuickQueryDialect lub str
Opcjonalny. Definiuje serializacji danych wyjściowych dla strumienia danych. Domyślnie dane zostaną zwrócone, ponieważ są reprezentowane w obiekcie blob (formaty Parquet są domyślnie formatami DelimitedTextDialect). Po podaniu formatu wyjściowego dane obiektu blob zostaną sformatowane zgodnie z tym profilem. Ta wartość może być delimitedTextDialect lub DelimitedJsonDialect lub ArrowDialect. Te dialekty mogą być przekazywane przez odpowiednie klasy, wyliczenie QuickQueryDialect lub jako ciąg
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- 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
Obiekt przesyłania strumieniowego (BlobQueryReader)
Typ zwracany
resize_blob
Zmienia rozmiar stronicowego obiektu blob na określony rozmiar.
Jeśli określona wartość jest mniejsza niż bieżący rozmiar obiektu blob, wszystkie strony powyżej określonej wartości zostaną wyczyszczone.
async resize_blob(size: int, **kwargs: Any) -> Dict[str, str | datetime]
Parametry
- size
- int
Rozmiar używany do zmiany rozmiaru obiektu blob. Maksymalny rozmiar stronicowego obiektu blob wynosi do 1 TB. Rozmiar stronicowego obiektu blob musi być wyrównany do granicy 512 bajtów.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- premium_page_blob_tier
- PremiumPageBlobTier
Wartość warstwy stronicowego obiektu blob w celu ustawienia obiektu blob na wartość. Warstwa jest skorelowana z rozmiarem obiektu blob i liczbą dozwolonych operacji we/wy na sekundę. Dotyczy to tylko stronicowych obiektów blob na kontach magazynu w warstwie Premium.
- 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
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja).
Typ zwracany
seal_append_blob
Operacja Seal uszczelnia obiekt blob dołączania, aby był tylko do odczytu.
Nowość w wersji 12.4.0.
async seal_append_blob(**kwargs) -> Dict[str, str | datetime | int]
Parametry
- appendpos_condition
- int
Opcjonalny nagłówek warunkowy, używany tylko dla operacji Dołączanie bloku. Liczba wskazująca przesunięcie bajtów do porównania. Blok dołączania powiedzie się tylko wtedy, gdy pozycja dołączania jest równa tej liczbie. Jeśli tak nie jest, żądanie zakończy się niepowodzeniem z powodu błędu AppendPositionConditionNotMet (kod stanu HTTP 412 — Niepowodzenie warunku wstępnego).
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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
Zaktualizowany obiekt blob właściwość dict (Etag, ostatnia modyfikacja, przesunięcie dołączania, liczba zatwierdzonych bloków).
Typ zwracany
set_blob_metadata
Ustawia metadane zdefiniowane przez użytkownika dla obiektu blob jako co najmniej jedną parę name-value.
async set_blob_metadata(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]
Parametry
Dict zawierający pary nazw i wartości. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do obiektu blob. Aby usunąć wszystkie metadane z obiektu blob, wywołaj tę operację bez nagłówków metadanych.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał tutaj nazwę. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zostanie zastąpiona, jeśli zakres na poziomie kontenera jest skonfigurowany tak, aby zezwalał na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja)
set_blob_tags
Operacja Ustaw tagi umożliwia użytkownikom ustawianie tagów w obiekcie blob lub określonej wersji obiektu blob, ale nie migawki. Każde wywołanie tej operacji zastępuje wszystkie istniejące tagi dołączone do obiektu blob. Aby usunąć wszystkie tagi z obiektu blob, wywołaj tę operację bez ustawionych tagów.
Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12".
async set_blob_tags(tags: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]
Parametry
Pary name-value skojarzone z obiektem blob jako tagiem. Tagi są uwzględniane w wielkości liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się od 0 do 256 znaków.
Prawidłowe znaki klucza tagu i wartości obejmują małe litery i wielkie litery, cyfry (0–9), spację ( >>
<<), plus (+), minus (-), kropkę (.), kropkę (.), solidus (/), dwukropek (:), równe (=), podkreślenie (_)
- version_id
- str
Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob do usunięcia.
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 zawartości tagów. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https, jak https (ustawienie domyślne), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- 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
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja)
Typ zwracany
set_http_headers
Ustawia właściwości systemowe obiektu blob.
Jeśli dla content_settings ustawiono jedną właściwość, wszystkie właściwości zostaną zastąpione.
async set_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None
Parametry
- content_settings
- ContentSettings
Obiekt ContentSettings używany do ustawiania właściwości obiektu blob. Służy do ustawiania typu zawartości, kodowania, języka, dyspozycji, md5 i kontrolki pamięci podręcznej.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja)
Typ zwracany
set_immutability_policy
Operacja Ustaw zasady niezmienności ustawia zasady niezmienności w obiekcie blob.
Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02".
async set_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]
Parametry
- immutability_policy
- ImmutabilityPolicy
Określa zasady niezmienności wersji obiektu blob, migawki obiektu blob lub obiektu blob.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- 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
Pary wartości klucza tagów obiektów blob.
Typ zwracany
set_legal_hold
Operacja ustawiania archiwizacji ze względów prawnych ustawia archiwizację ze względów prawnych dla obiektu blob.
Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02".
async set_legal_hold(legal_hold: bool, **kwargs: Any) -> Dict[str, str | datetime | bool]
Parametry
- legal_hold
- bool
Określono, czy na obiekcie blob ma być ustawione archiwizacja ze względów prawnych.
- 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
Pary klucz-wartość tagów obiektów blob.
Typ zwracany
set_premium_page_blob_tier
Ustawia warstwy stronicowych obiektów blob w obiekcie blob. Ten interfejs API jest obsługiwany tylko w przypadku stronicowych obiektów blob na kontach w warstwie Premium.
async set_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None
Parametry
- premium_page_blob_tier
- PremiumPageBlobTier
Wartość warstwy stronicowego obiektu blob do ustawienia obiektu blob na . Warstwa jest skorelowana z rozmiarem obiektu blob i liczbą dozwolonych operacji we/wy na sekundę. Dotyczy to tylko stronicowych obiektów blob na kontach magazynu w warstwie Premium.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
Typ zwracany
set_sequence_number
Ustawia numer sekwencji obiektów blob.
async set_sequence_number(sequence_number_action: str | SequenceNumberAction, sequence_number: str | None = None, **kwargs) -> Dict[str, str | datetime]
Parametry
- sequence_number_action
- str
Ta właściwość wskazuje, jak usługa powinna modyfikować numer sekwencji obiektu blob. Aby uzyskać więcej informacji, zobacz SequenceNumberAction.
- sequence_number
- str
Ta właściwość ustawia numer sekwencji obiektu blob. Numer sekwencji to właściwość kontrolowana przez użytkownika, której można użyć do śledzenia żądań i zarządzania problemami współbieżności.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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
Zaktualizowany dykt właściwości obiektu blob (Etag i ostatnia modyfikacja).
Typ zwracany
set_standard_blob_tier
Ta operacja ustawia warstwę na blokowym obiekcie blob.
Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob.
async set_standard_blob_tier(standard_blob_tier: str | StandardBlobTier, **kwargs: Any) -> None
Parametry
- standard_blob_tier
- str lub StandardBlobTier
Wskazuje warstwę, która ma zostać ustawiona w obiekcie blob. Opcje obejmują "Gorąca", "Chłodna", "Archiwum". Warstwa Gorąca jest zoptymalizowana pod kątem przechowywania często używanych danych. Warstwa magazynowania Chłodna jest zoptymalizowana pod kątem przechowywania danych, które są rzadko używane i przechowywane przez co najmniej miesiąc. Warstwa Archiwum jest zoptymalizowana pod kątem przechowywania rzadko używanych danych i przechowywanych przez co najmniej sześć miesięcy z elastycznymi wymaganiami dotyczącymi opóźnień.
- rehydrate_priority
- RehydratePriority
Wskazuje priorytet ponownego wypełniania zarchiwizowanego obiektu blob
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- 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.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
Typ zwracany
stage_block
Tworzy nowy blok do zatwierdzenia w ramach obiektu blob.
async stage_block(block_id: str, data: Iterable | IO, length: int | None = None, **kwargs) -> None
Parametry
- block_id
- str
Wartość ciągu identyfikującą blok. Ciąg powinien być mniejszy lub równy 64 bajtom w rozmiarze. W przypadku danego obiektu blob block_id musi mieć ten sam rozmiar dla każdego bloku.
- data
Dane obiektu blob.
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 dla każdego fragmentu obiektu blob. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne w przypadku wykrywania bitflipów w sieci, jeśli używasz protokołu HTTP zamiast https, ponieważ jest to protokół https (wartość domyślna), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob. Należy również pamiętać, że w przypadku włączenia algorytmu przekazywania wydajnego w pamięci nie będzie używany, ponieważ obliczanie skrótu MD5 wymaga buforowania całych bloków i w ten sposób pozwala pokonać cel algorytmu wydajnego pod względem pamięci.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- encoding
- str
Wartość domyślna to UTF-8.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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
stage_block_from_url
Tworzy nowy blok do zatwierdzenia w ramach obiektu blob, w którym zawartość jest odczytywana z adresu URL.
async stage_block_from_url(block_id: str | int, source_url: str, source_offset: int | None = None, source_length: int | None = None, source_content_md5: bytes | bytearray | None = None, **kwargs) -> None
Parametry
- block_id
- str
Wartość ciągu identyfikującą blok. Ciąg powinien być mniejszy lub równy 64 bajtom w rozmiarze. W przypadku danego obiektu blob block_id musi mieć ten sam rozmiar dla każdego bloku.
- source_offset
- int
Początek zakresu bajtów do użycia dla bloku. Należy ustawić, jeśli podano długość źródła.
- source_content_md5
- bytearray
Określ wartość md5 obliczaną dla zakresu bajtów, które muszą być odczytywane ze źródła kopii.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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.
- source_authorization
- str
Uwierzytelnianie jako jednostka usługi przy użyciu klucza tajnego klienta w celu uzyskania dostępu do źródłowego obiektu blob. Upewnij się, że element nośny jest prefiksem ciągu source_authorization.
Typ zwracany
start_copy_from_url
Kopiuje obiekt blob z danego adresu URL.
Ta operacja zwraca słownik zawierający copy_status i copy_id, którego można użyć do sprawdzenia stanu operacji kopiowania lub przerwania jej działania. copy_status będzie "powodzenie", jeśli kopia została ukończona synchronicznie lub "oczekująca", jeśli kopia została uruchomiona asynchronicznie. W przypadku kopii asynchronicznych stan można sprawdzić, sondując metodę get_blob_properties i sprawdzając stan kopiowania. Ustaw wartość requires_sync na wartość True, aby wymusić synchroniczną kopię. Usługa Blob service kopiuje obiekty blob w oparciu o najlepsze wysiłki.
Źródłowy obiekt blob operacji kopiowania może być blokowym obiektem blob, uzupełnianym obiektem blob lub stronicowym obiektem blob. Jeśli docelowy obiekt blob już istnieje, musi mieć ten sam typ obiektu blob co źródłowy obiekt blob. Każdy istniejący docelowy obiekt blob zostanie zastąpiony. Nie można zmodyfikować docelowego obiektu blob, gdy operacja kopiowania jest w toku.
Podczas kopiowania ze stronicowego obiektu blob usługa Blob tworzy docelowy obiekt blob stronicowy długości źródłowego obiektu blob, początkowo zawierające wszystkie zera. Następnie zakresy stron źródłowych są wyliczane, a zakresy niepuste są kopiowane.
W przypadku blokowego obiektu blob lub uzupełnialnych obiektów blob usługa Blob tworzy zatwierdzony obiekt blob o zerowej długości przed powrotem z tej operacji. Podczas kopiowania z blokowego obiektu blob wszystkie zatwierdzone bloki i ich identyfikatory bloków są kopiowane. Niezatwierdzone bloki nie są kopiowane. Na końcu operacji kopiowania docelowy obiekt blob będzie miał taką samą zatwierdzoną liczbę bloków co źródło.
Podczas kopiowania z uzupełnialnych obiektów blob wszystkie zatwierdzone bloki są kopiowane. Na końcu operacji kopiowania docelowy obiekt blob będzie miał taką samą zatwierdzoną liczbę bloków co źródło.
async start_copy_from_url(source_url: str, metadata: Dict[str, str] | None = None, incremental_copy: bool = False, **kwargs: Any) -> Dict[str, str | datetime]
Parametry
- source_url
- str
Adres URL o długości do 2 KB, który określa plik lub obiekt blob. Wartość powinna być zakodowana w adresie URL, tak jak byłaby wyświetlana w identyfikatorze URI żądania. Jeśli źródło znajduje się na innym koncie, źródło musi być publiczne lub musi być uwierzytelnione za pośrednictwem sygnatury dostępu współdzielonego. Jeśli źródło jest publiczne, nie jest wymagane uwierzytelnianie. Przykłady: https://myaccount.blob.core.windows.net/mycontainer/myblob
https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken
Pary nazwa-wartość skojarzone z obiektem blob jako metadane. Jeśli nie określono żadnych par nazwa-wartość, operacja skopiuje metadane ze źródłowego obiektu blob lub pliku do docelowego obiektu blob. Jeśli określono co najmniej jedną parę nazwa-wartość, docelowy obiekt blob jest tworzony z określonymi metadanymi, a metadane nie są kopiowane ze źródłowego obiektu blob lub pliku.
- incremental_copy
- bool
Kopiuje migawkę źródłowego stronicowego obiektu blob do docelowego stronicowego obiektu blob. Migawka jest kopiowana w taki sposób, że tylko zmiany różnicowe między wcześniej skopiowaną migawką są przenoszone do miejsca docelowego. Skopiowane migawki są kompletnymi kopiami oryginalnej migawki i można je odczytywać lub kopiować ze zwykłych. Wartość domyślna to False.
Pary name-value skojarzone z obiektem blob jako tagiem. W tagach jest rozróżniana wielkość liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się w zakresie od 0 do 256 znaków.
Prawidłowe znaki klucza i wartości tagu to: małe i wielkie litery, cyfry (0–9), spacja ( >>
<<), plus (+), minus (-), kropka (.), kropka (/), dwukropek (:), równa (=), podkreślenie (_).
Zamiast tego można przekazać literał "COPY" (z uwzględnieniem wielkości liter) w celu skopiowania tagów ze źródłowego obiektu blob. Ta opcja jest dostępna tylko wtedy, gdy incremental_copy=False i requires_sync=True.
Nowość w wersji 12.4.0.
- immutability_policy
- ImmutabilityPolicy
Określa zasady niezmienności dla obiektu blob, migawki obiektu blob lub wersji obiektu blob.
Nowość w wersji 12.10.0: wprowadzono to w interfejsie API w wersji "2020-10-02".
- legal_hold
- bool
Określono, czy dla obiektu blob należy ustawić archiwizację prawną.
Nowość w wersji 12.10.0: wprowadzono to w interfejsie API w wersji "2020-10-02".
- source_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 warunkowy, aby skopiować obiekt blob tylko wtedy, gdy źródłowy obiekt blob został zmodyfikowany od określonej daty/godziny.
- source_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 warunkowy, aby skopiować obiekt blob tylko wtedy, gdy źródłowy obiekt blob nie został zmodyfikowany od określonej daty/godziny.
- source_etag
- str
Wartość źródłowego 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 .
- source_match_condition
- MatchConditions
Warunek dopasowania źródła do użycia w tagu etag.
- 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 warunkowy, aby skopiować obiekt blob tylko wtedy, gdy docelowy obiekt blob został zmodyfikowany od określonej daty/godziny. Jeśli docelowy obiekt blob nie został zmodyfikowany, usługa Blob zwraca kod stanu 412 (Niepowodzenie warunku wstępnego).
- 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 warunkowy, aby skopiować obiekt blob tylko wtedy, gdy docelowy obiekt blob nie został zmodyfikowany od określonej daty/godziny. Jeśli docelowy obiekt blob został zmodyfikowany, usługa Blob zwraca kod stanu 412 (Niepowodzenie warunku wstępnego).
- etag
- str
Docelowa 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 miejsca docelowego do użycia w tagu etag.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- destination_lease
- BlobLeaseClient lub str
Identyfikator dzierżawy określony dla tego nagłówka musi być zgodny z identyfikatorem dzierżawy docelowego obiektu blob. Jeśli żądanie nie zawiera identyfikatora dzierżawy lub jest nieprawidłowe, operacja kończy się niepowodzeniem z kodem stanu 412 (Niepowodzenie warunku wstępnego).
- source_lease
- BlobLeaseClient lub str
Określ tę opcję, aby wykonać operację kopiowania obiektu blob tylko wtedy, gdy podany identyfikator dzierżawy jest zgodny z aktywnym identyfikatorem dzierżawy źródłowego obiektu blob.
- 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.
- premium_page_blob_tier
- PremiumPageBlobTier
Wartość warstwy stronicowego obiektu blob do ustawienia obiektu blob na . Warstwa jest skorelowana z rozmiarem obiektu blob i liczbą dozwolonych operacji we/wy na sekundę. Dotyczy to tylko stronicowych obiektów blob na kontach magazynu w warstwie Premium.
- standard_blob_tier
- StandardBlobTier
Wartość warstwy standardowego obiektu blob do ustawienia obiektu blob na . W przypadku tej wersji biblioteki ma to zastosowanie tylko do blokowych obiektów blob na kontach magazynu w warstwie Standardowa.
- rehydrate_priority
- RehydratePriority
Wskazuje priorytet ponownego wypełniania zarchiwizowanego obiektu blob
- seal_destination_blob
- bool
Uszczelnij docelowy obiekt blob dołączania. Ta operacja dotyczy tylko uzupełnialnych obiektów blob.
Nowość w wersji 12.4.0.
- requires_sync
- bool
Wymusza, że usługa nie zwróci odpowiedzi, dopóki kopia nie zostanie ukończona.
- source_authorization
- str
Uwierzytelnianie jako jednostka usługi przy użyciu klucza tajnego klienta w celu uzyskania dostępu do źródłowego obiektu blob. Upewnij się, że element nośny jest prefiksem ciągu source_authorization. Ta opcja jest dostępna tylko wtedy, gdy incremental_copy jest ustawiona na wartość Fałsz, a requires_sync jest ustawiona na wartość True.
Nowość w wersji 12.9.0.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w skopiowanym obiekcie blob synchronizacji. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.10.0.
Zwraca
Słownik właściwości kopiowania (etag, last_modified, copy_id, copy_status).
Typ zwracany
undelete_blob
Przywraca nietrwałe obiekty blob lub migawki.
Operacja zakończy się powodzeniem tylko wtedy, gdy zostanie użyta w określonej liczbie dni ustawionej w zasadach przechowywania usuwania.
Jeśli obsługa wersji obiektów blob jest włączona, nie można przywrócić podstawowego obiektu blob przy użyciu tej metody. Zamiast tego użyj adresu start_copy_from_url URL wersji obiektu blob, którą chcesz podwyższyć poziom do bieżącej wersji.
async undelete_blob(**kwargs: Any) -> None
Parametry
- 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
upload_blob
Tworzy nowy obiekt blob ze źródła danych z automatycznym fragmentowaniem.
async upload_blob(data: bytes | str | Iterable | AsyncIterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, Any]
Parametry
- data
Dane obiektu blob do przekazania.
- blob_type
- BlobType
Typ obiektu blob. Może to być BlokBlob, PageBlob lub AppendBlob. Wartość domyślna to BlockBlob.
- length
- int
Liczba bajtów do odczytu ze strumienia. Jest to opcjonalne, ale powinno być dostarczane w celu uzyskania optymalnej wydajności.
Pary name-value skojarzone z obiektem blob jako tagiem. Tagi są uwzględniane w wielkości liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się od 0 do 256 znaków.
Prawidłowe znaki klucza tagu i wartości obejmują małe litery i wielkie litery, cyfry (0–9), spację ( >>
<<), plus (+), minus (-), kropkę (.), kropkę (.), solidus (/), dwukropek (:), równe (=), podkreślenie (_)
Nowość w wersji 12.4.0.
- overwrite
- bool
Czy obiekt blob, który ma zostać przekazany, powinien zastąpić bieżące dane. Jeśli prawda, upload_blob zastąpi istniejące dane. W przypadku ustawienia wartości False operacja zakończy się niepowodzeniem z błędem ResourceExistsError. Wyjątek powyższy dotyczy typów uzupełnialnych obiektów blob: jeśli ustawiono wartość False i dane już istnieją, błąd nie zostanie zgłoszony, a dane zostaną dołączone do istniejącego obiektu blob. Jeśli ustawisz wartość overwrite=True, istniejący uzupełniony obiekt blob zostanie usunięty i zostanie utworzony nowy. Wartość domyślna to False.
- content_settings
- ContentSettings
Obiekt ContentSettings używany do ustawiania właściwości obiektu blob. Służy do ustawiania typu zawartości, kodowania, języka, dyspozycji, md5 i kontrolki pamięci podręcznej.
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 dla każdego fragmentu obiektu blob. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https, jak https (ustawienie domyślne), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob. Należy również pamiętać, że w przypadku włączenia algorytmu przekazywania wydajnego w pamięci nie będzie używany, ponieważ przetwarzanie skrótu MD5 wymaga buforowania całych bloków i w ten sposób pokonuje cel algorytmu wydajnego w pamięci.
- lease
Jeśli zostanie określony, upload_blob powiedzie się tylko wtedy, gdy dzierżawa obiektu blob jest aktywna i jest zgodna z tym identyfikatorem. Wymagane, jeśli obiekt blob ma aktywną dzierżawę.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
- premium_page_blob_tier
- PremiumPageBlobTier
Wartość warstwy stronicowego obiektu blob w celu ustawienia obiektu blob na wartość. Warstwa jest skorelowana z rozmiarem obiektu blob i liczbą dozwolonych operacji we/wy na sekundę. Dotyczy to tylko stronicowych obiektów blob na kontach magazynu w warstwie Premium.
- immutability_policy
- ImmutabilityPolicy
Określa zasady niezmienności wersji obiektu blob, migawki obiektu blob lub obiektu blob. Obecnie ten parametr interfejsu API upload_blob() jest przeznaczony tylko dla obiektu BlockBlob.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- legal_hold
- bool
Określono, czy na obiekcie blob ma być ustawione archiwizacja ze względów prawnych. Obecnie ten parametr interfejsu API upload_blob() jest przeznaczony tylko dla obiektu BlockBlob.
Nowość w wersji 12.10.0: została wprowadzona w interfejsie API w wersji "2020-10-02".
- standard_blob_tier
- StandardBlobTier
Standardowa wartość warstwy obiektów blob w celu ustawienia obiektu blob na wartość. W przypadku tej wersji biblioteki ma to zastosowanie tylko do blokowych obiektów blob na kontach magazynu w warstwie Standardowa.
- maxsize_condition
- int
Opcjonalny nagłówek warunkowy. Maksymalna długość bajtów dozwolona dla uzupełnialnych obiektów blob. Jeśli operacja bloku dołączania spowoduje przekroczenie tego limitu przez obiekt blob lub jeśli rozmiar obiektu blob jest już większy niż wartość określona w tym nagłówku, żądanie zakończy się niepowodzeniem z powodu błędu MaxBlobSizeConditionNotMet (kod stanu HTTP 412 — Niepowodzenie warunku wstępnego).
- max_concurrency
- int
Maksymalna liczba połączeń równoległych do użycia, gdy rozmiar obiektu blob przekracza 64 MB.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał tutaj nazwę. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zostanie zastąpiona, jeśli zakres na poziomie kontenera jest skonfigurowany tak, aby zezwalał na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- encoding
- str
Wartość domyślna to UTF-8.
Asynchroniczne wywołanie zwrotne w celu śledzenia postępu długotrwałego przekazywania. Podpis jest funkcją (bieżąca: int, total: Optional[int]), gdzie bieżąca jest liczbą bajtów przeniesionych do tej pory, a łączna wartość to rozmiar obiektu blob lub Brak, jeśli rozmiar jest nieznany.
- 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. Ta metoda może wykonywać wiele wywołań usługi, a limit czasu będzie stosowany do każdego wywołania indywidualnie. wiele wywołań do usługi platformy Azure i limit czasu będzie stosowany do każdego wywołania indywidualnie.
Zwraca
Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja)
Typ zwracany
upload_blob_from_url
Tworzy nowy blokowy obiekt blob, w którym zawartość obiektu blob jest odczytywana z danego adresu URL. Zawartość istniejącego obiektu blob jest zastępowana nowym obiektem blob.
async upload_blob_from_url(source_url: str, **kwargs: Any) -> Dict[str, Any]
Parametry
- source_url
- str
Adres URL o długości do 2 KB, który określa plik lub obiekt blob. Wartość powinna być zakodowana w adresie URL, ponieważ jest wyświetlana w identyfikatorze URI żądania. Jeśli źródło znajduje się na innym koncie, źródło musi być publiczne lub musi być uwierzytelnione za pośrednictwem sygnatury dostępu współdzielonego. Jeśli źródło jest publiczne, nie jest wymagane uwierzytelnianie. Przykłady: https://myaccount.blob.core.windows.net/mycontainer/myblob
https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken
- overwrite
- bool
Czy obiekt blob, który ma zostać przekazany, powinien zastąpić bieżące dane. Jeśli prawda, upload_blob zastąpi istniejące dane. W przypadku ustawienia wartości False operacja zakończy się niepowodzeniem z błędem ResourceExistsError.
- include_source_blob_properties
- bool
Wskazuje, czy należy skopiować właściwości źródłowego obiektu blob. Wartość domyślna to True.
Pary name-value skojarzone z obiektem blob jako tagiem. Tagi są uwzględniane w wielkości liter.
Zestaw tagów może zawierać co najwyżej 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków, a wartości tagów muszą zawierać się od 0 do 256 znaków.
Prawidłowe znaki klucza tagu i wartości obejmują małe litery i wielkie litery, cyfry (0–9), spację ( >>
<<), plus (+), minus (-), kropkę (.), kropkę (.), solidus (/), dwukropek (:), równe (=), podkreślenie (_)
- source_content_md5
- bytearray
Określ md5, który jest używany do weryfikowania integralności bajtów źródłowych.
- source_if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 źródłowy został zmodyfikowany od określonego czasu.
- source_if_unmodified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 źródłowy nie został zmodyfikowany od określonej daty/godziny.
- source_etag
- str
Źródłowa wartość 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 .
- source_match_condition
- MatchConditions
Warunek dopasowania źródła do użycia w tagu etag.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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
Docelowa wartość 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 miejsca docelowego do użycia w tagu etag.
- destination_lease
- BlobLeaseClient lub str
Identyfikator dzierżawy określony dla tego nagłówka musi być zgodny z identyfikatorem dzierżawy docelowego obiektu blob. Jeśli żądanie nie zawiera identyfikatora dzierżawy lub jest nieprawidłowe, operacja kończy się niepowodzeniem z kodem stanu 412 (Warunek wstępny nie powiodło się).
- 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.
- content_settings
- ContentSettings
Obiekt ContentSettings używany do ustawiania właściwości obiektu blob. Służy do ustawiania typu zawartości, kodowania, języka, dyspozycji, md5 i kontrolki pamięci podręcznej.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał tutaj nazwę. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zostanie zastąpiona, jeśli zakres na poziomie kontenera jest skonfigurowany tak, aby zezwalał na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
- standard_blob_tier
- StandardBlobTier
Standardowa wartość warstwy obiektów blob w celu ustawienia obiektu blob na wartość. W przypadku tej wersji biblioteki ma to zastosowanie tylko do blokowych obiektów blob na kontach magazynu w warstwie Standardowa.
- source_authorization
- str
Uwierzytelnianie jako jednostka usługi przy użyciu klucza tajnego klienta w celu uzyskania dostępu do źródłowego obiektu blob. Upewnij się, że element nośny jest prefiksem ciągu source_authorization.
upload_page
Operacja Przekazywania stron zapisuje zakres stron do stronicowego obiektu blob.
async upload_page(page: bytes, offset: int, length: int, **kwargs) -> Dict[str, str | datetime]
Parametry
- offset
- int
Początek zakresu bajtów do użycia do zapisywania w sekcji obiektu blob. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- length
- int
Liczba bajtów używanych do zapisywania w sekcji obiektu blob. Strony muszą być wyrównane do granic 512 bajtów, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- validate_content
- bool
Jeśli wartość true, oblicza skrót MD5 zawartości strony. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https, jak https (ustawienie domyślne), będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w obiekcie blob.
- if_sequence_number_lte
- int
Jeśli numer sekwencji obiektu blob jest mniejszy lub równy określonej wartości, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_sequence_number_lt
- int
Jeśli numer sekwencji obiektu blob jest mniejszy niż określona wartość, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_sequence_number_eq
- int
Jeśli numer sekwencji obiektu blob jest równy określonej wartości, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_modified_since
- datetime
Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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 będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na 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ść 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.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w obiekcie blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- encoding
- str
Wartość domyślna to UTF-8.
- 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
Zaktualizowany dykt właściwości obiektu blob (Etag i ostatnia modyfikacja).
Typ zwracany
upload_pages_from_url
Operacja Przekazywania stron zapisuje zakres stron do stronicowego obiektu blob, w którym zawartość jest odczytywana z adresu URL.
async upload_pages_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs) -> Dict[str, Any]
Parametry
- source_url
- str
Adres URL danych źródłowych. Może wskazywać dowolny obiekt blob lub plik platformy Azure, który jest publiczny lub ma dołączony sygnaturę dostępu współdzielonego.
- offset
- int
Początek zakresu bajtów używany do zapisywania w sekcji obiektu blob. Strony muszą być wyrównane do granic 512-bajtowych, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- length
- int
Liczba bajtów używanych do zapisywania w sekcji obiektu blob. Strony muszą być wyrównane do granic 512-bajtowych, przesunięcie początkowe musi być modulem 512, a długość musi być modulem 512.
- source_offset
- int
Wskazuje to początek zakresu bajtów (włącznie), który musi zostać pobrany ze źródła kopii. Usługa odczytuje tę samą liczbę bajtów co zakres docelowy (przesunięcie długości).
- source_content_md5
- bytes
Jeśli zostanie podana, usługa obliczy skrót MD5 zawartości bloku i porówna je z tą wartością.
- source_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 źródłowy został zmodyfikowany od określonego czasu.
- source_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 źródłowy nie został zmodyfikowany od określonej daty/godziny.
- source_etag
- str
Wartość źródłowego 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 .
- source_match_condition
- MatchConditions
Warunek dopasowania źródła do użycia w tagu etag.
- lease
- BlobLeaseClient lub str
Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.
- if_sequence_number_lte
- int
Jeśli numer sekwencji obiektu blob jest mniejszy lub równy określonej wartości, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_sequence_number_lt
- int
Jeśli numer sekwencji obiektu blob jest mniejszy niż określona wartość, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- if_sequence_number_eq
- int
Jeśli numer sekwencji obiektu blob jest równy określonej wartości, żądanie będzie kontynuowane; w przeciwnym razie kończy się niepowodzeniem.
- 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
Docelowa 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 miejsca docelowego do użycia w tagu etag.
- if_tags_match_condition
- str
Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko na obiektach blob z pasującą wartością.
np. "\"tagname\"='my tag'"
Nowość w wersji 12.4.0.
Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Ponieważ sam klucz szyfrowania jest udostępniany w żądaniu, należy ustanowić bezpieczne połączenie w celu przeniesienia klucza.
- encryption_scope
- str
Wstępnie zdefiniowany zakres szyfrowania używany do szyfrowania danych w usłudze. Zakres szyfrowania można utworzyć przy użyciu interfejsu API zarządzania i przywoływał go tutaj według nazwy. Jeśli domyślny zakres szyfrowania został zdefiniowany w kontenerze, ta wartość zastąpi go, jeśli zakres na poziomie kontenera jest skonfigurowany do zezwalania na przesłonięcia. W przeciwnym razie zostanie zgłoszony błąd.
Nowość w wersji 12.2.0.
- 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.
- source_authorization
- str
Uwierzytelnianie jako jednostka usługi przy użyciu klucza tajnego klienta w celu uzyskania dostępu do źródłowego obiektu blob. Upewnij się, że element nośny jest prefiksem ciągu source_authorization.
Atrybuty
api_version
Wersja interfejsu API usługi Storage używana na potrzeby żądań.
location_mode
Tryb lokalizacji, z którego obecnie korzysta klient.
Domyślnie będzie to "podstawowe". Opcje obejmują "podstawowe" i "pomocnicze".
primary_endpoint
Pełny podstawowy adres URL punktu końcowego.
primary_hostname
Nazwa hosta podstawowego punktu końcowego.
secondary_endpoint
Pełny adres URL pomocniczego punktu końcowego, jeśli został skonfigurowany.
Jeśli parametr ValueError nie będzie dostępny, zostanie zgłoszony błąd. Aby jawnie określić pomocniczą nazwę hosta, użyj opcjonalnego argumentu słowa kluczowego secondary_hostname podczas tworzenia wystąpienia.
Wyjątki
secondary_hostname
Nazwa hosta pomocniczego punktu końcowego.
Jeśli ta opcja nie będzie dostępna, będzie to brak. Aby jawnie określić pomocniczą nazwę hosta, użyj opcjonalnego argumentu słowa kluczowego secondary_hostname podczas tworzenia wystąpienia.
url
Pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany.
Może to być podstawowy punkt końcowy lub pomocniczy punkt końcowy w zależności od bieżącego location_mode. :returns: pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany. :rtype: str
Azure SDK for Python
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla