azure.storage.blob.BlobClient class

Przerywanie 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.

abort_copy(copy_id: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> None

Parametry

copy_id: str lub BlobProperties

Wymagane

Operacja kopiowania do przerwania. Może to być ciąg identyfikatora lub wystąpienie obiektu BlobProperties.

Typ zwracany

None

Żą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ę.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> BlobLeaseClient

Parametry

lease_duration: int

Wymagane

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

lease_id: str

Wymagane

Proponowany identyfikator dzierżawy w formacie ciągu GUID. Usługa Blob Service zwraca wartość 400 (nieprawidłowe żądanie), jeśli proponowany identyfikator dzierżawy nie jest w poprawnym formacie.

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

Obiekt BlobLeaseClient.

Typ zwracany

BlobLeaseClient

Zatwierdza nowy blok danych na końcu istniejącego uzupełnialnych obiektów blob.

append_block(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parametry

data: bytes lub str lub Iterable

Wymagane

Zawartość bloku. Może to być bajty, tekst, iterowalny lub obiekt podobny do pliku.

length: int

Wymagane

Rozmiar bloku w bajtach.

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 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.

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).

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. 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.

cpk: CustomerProvidedEncryptionKey

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

dict(str, Any)

Tworzy nowy blok do zatwierdzenia w ramach obiektu blob, w którym zawartość jest odczytywana z źródłowego adresu URL.

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

Wymagane

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

Wymagane

Wskazuje to początek zakresu bajtów (włącznie), który musi zostać pobrany ze źródła kopii.

source_length: int

Wymagane

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.

cpk: CustomerProvidedEncryptionKey

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.

Czyści zakres stron.

clear_page(offset: int, length: int, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

offset: int

Wymagane

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

Wymagane

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. 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.

cpk: CustomerProvidedEncryptionKey

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 dykt właściwości obiektu blob (Etag i ostatnia modyfikacja).

Typ zwracany

dict(str, Any)

Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.

close()

Operacja Zatwierdź listę bloków zapisuje obiekt blob, określając listę identyfikatorów blokowych, które tworzą obiekt blob.

commit_block_list(block_list: List[BlobBlock], content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Parametry

block_list: list

Wymagane

Lista bloków.

content_settings: ContentSettings

Wymagane

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.

metadata: dict[str, str]

Wymagane

Pary nazwa-wartość skojarzone z obiektem blob jako metadane.

tags: dict(str, str)

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.

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".

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 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.

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 w docelowym obiekcie blob z pasującą wartością.

Nowość w wersji 12.4.0.

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.

cpk: CustomerProvidedEncryptionKey

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

dict(str, Any)

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_append_blob(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

content_settings: ContentSettings

Wymagane

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.

metadata: dict(str, str)

Wymagane

Pary nazwa-wartość skojarzone z obiektem blob jako metadane.

tags: dict(str, str)

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.

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.

cpk: CustomerProvidedEncryptionKey

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

dict[str, Any]

Tworzy nowy stronicowy obiekt blob o określonym rozmiarze.

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

Wymagane

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

Wymagane

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.

metadata: dict(str, str)

Wymagane

Pary nazwa-wartość skojarzone z obiektem blob jako metadane.

premium_page_blob_tier: PremiumPageBlobTier

Wymagane

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.

tags: dict(str, str)

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.

cpk: CustomerProvidedEncryptionKey

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

dict[str, Any]

Tworzy migawkę obiektu blob.

Migawka to wersja 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 momencie ich wyświetlania w czasie.

Migawka obiektu blob ma taką samą nazwę jak podstawowy obiekt blob, z którego wykonywana jest migawka, z dołączona wartość DateTime wskazująca czas wykonania migawki.

create_snapshot(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

metadata: dict(str, str)

Wymagane

Pary nazwa-wartość skojarzone z obiektem blob jako metadane.

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 w docelowym obiekcie blob z pasującą wartością.

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.

cpk: CustomerProvidedEncryptionKey

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 (identyfikator migawki, element Etag i ostatnia modyfikacja).

Typ zwracany

dict[str, Any]

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 te elementy 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 pośrednictwem list_blobs opcji include=['deleted']. Obiekt blob usunięty nietrwale można przywrócić przy użyciu <xref:azure.storage.blob.undelete> operacji .

delete_blob(delete_snapshots: str = None, **kwargs: Any) -> None

Parametry

delete_snapshots: str

Wymagane

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. 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.

Typ zwracany

None

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".

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 klucz-wartość tagów obiektów blob.

Typ zwracany

Dict[str, str]

Pobiera obiekt blob do obiektu StorageStreamDownloader. Metoda readall() musi służyć do odczytywania całej zawartości lub readinto() do pobrania obiektu blob do strumienia. Użycie fragmentów() zwraca iterator, który umożliwia użytkownikowi iterowanie zawartości we fragmentach.

download_blob(offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Parametry

offset: int

Wymagane

Początek zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. Należy ustawić, jeśli podano długość.

length: int

Wymagane

Liczba bajtów do odczytania ze strumienia. Jest to opcjonalne, ale powinno zostać dostarczone w celu uzyskania optymalnej wydajności.

version_id: str

Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa 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 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ę. 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. 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.

cpk: CustomerProvidedEncryptionKey

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, z którymi należy pobrać.

encoding: str

Kodowanie w celu dekodowania pobranych bajtów. Wartość domyślna to Brak, tj. brak dekodowania.

progress_hook: Callable[[int, int], None]

Wywołanie zwrotne do śledzenia postępu długotrwałego pobierania. Podpis to funkcja(current: int, total: int), gdzie bieżąca jest liczbą bajtów przesłanych 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 osobno. 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

StorageStreamDownloader

Zwraca wartość True, jeśli obiekt blob istnieje z zdefiniowanymi parametrami i zwraca wartość False w przeciwnym razie.

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

bool

Utwórz obiekt BlobClient na podstawie adresu URL obiektu blob. Nie obsługuje to niestandardowego adresu URL obiektu blob o nazwie "/".

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

Wymagane

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żącej location_mode.

credential: Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

wartość domyślna: None

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 elementu azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z klasy azure.identity. Jeśli identyfikator URI zasobu zawiera już token sygnatury dostępu współdzielonego, zostanie on zignorowany na rzecz jawnego poświadczenia

z wyjątkiem przypadków usługi AzureSasCredential, gdzie powodujące konflikty tokeny SYGNATURy dostępu współdzielonego spowodują podniesienie wartościError. Jeśli używasz wystąpienia elementu AzureNamedKeyCredential, wartość "name" powinna być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.

snapshot: str

wartość domyślna: None

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 obiektów blob.

Typ zwracany

BlobClient

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

conn_str: str

Wymagane

Parametry połączenia do konta usługi Azure Storage.

container_name: str

Wymagane

Nazwa kontenera dla obiektu blob.

blob_name: str

Wymagane

Nazwa obiektu blob, z którym można korzystać.

snapshot: str

wartość domyślna: None

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:./>

wartość domyślna: None

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 elementu azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z klasy 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 elementu AzureNamedKeyCredential, wartość "name" powinna 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 obiektów blob.

Typ zwracany

BlobClient

Pobiera informacje związane z kontem magazynu, w którym znajduje się obiekt blob.

Informacje można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob. Klucze w zwróconym słowniku obejmują "sku_name" i "account_kind".

get_account_information(**kwargs: Any) -> Dict[str, str]

Zwraca

Dykt informacji o koncie (jednostka SKU i typ konta).

Typ zwracany

dict(str, str)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob.

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 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.

cpk: CustomerProvidedEncryptionKey

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 obiektów blob

Typ zwracany

BlobProperties

Operacja Pobieranie tagów umożliwia użytkownikom pobieranie tagów w obiekcie blob lub określonej wersji obiektu blob lub migawki.

Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12".

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 do dodawania tagów.

if_tags_match_condition: str

Określ klauzulę SQL where dla tagów obiektów blob do działania tylko w docelowym obiekcie blob z zgodną 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 wartości klucza tagów obiektów blob.

Typ zwracany

Dict[str, str]

Operacja Pobierz listę bloków pobiera listę bloków, które zostały przekazane w ramach blokowego obiektu blob.

get_block_list(block_list_type: str | None = 'committed', **kwargs: Any) -> Tuple[List[BlobBlock], List[BlobBlock]]

Parametry

block_list_type: str

Wymagane

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 do działania tylko w docelowym obiekcie blob z zgodną wartością.

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

tuple(list(BlobBlock), list(BlobBlock))

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_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

Wymagane

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

Wymagane

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

Wymagane

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

tuple(list(dict(str, str), list(dict(str, str))

PRZESTARZAŁE: Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob.

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

Wymagane

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

Wymagane

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

Wymagane

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

tuple(list(dict(str, str), list(dict(str, str))

Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob. W przypadku określenia previous_snapshot 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) -> ItemPaged[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.

previous_snapshot: str lub Dict[str, Any]

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

ItemPaged[PageRange]

Umożliwia użytkownikom wybieranie/projekt na danych migawek obiektów blob/lub obiektów blob przez udostępnianie prostych wyrażeń zapytań. Te operacje zwracają obiekt BlobQueryReader, użytkownicy muszą używać funkcji readall() lub readinto(), aby uzyskać dane zapytania.

query_blob(query_expression: str, **kwargs: Any) -> BlobQueryReader

Parametry

query_expression: str

Wymagane

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 dla wszelkich błędów przetwarzania zwracanych 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 dialektze. Można to przesłonić za pomocą niestandardowego obiektu DelimitedTextDialect lub DelimitedJsonDialect lub "ParquetDialect" (przekazywanego 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 będą zwracane, ponieważ są reprezentowane w obiekcie blob (formaty Parquet domyślnie mają wartość DelimitedTextDialect). Po podaniu formatu wyjściowego dane obiektu blob zostaną ponownie 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. 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.

cpk: CustomerProvidedEncryptionKey

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

BlobQueryReader

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.

resize_blob(size: int, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

size: int

Wymagane

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-bajtowej.

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.

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.

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

dict(str, Any)

Operacja seal uszczelnia obiekt blob dołączania, aby był tylko do odczytu.

Nowość w wersji 12.4.0.

seal_append_blob(**kwargs) -> Dict[str, str | datetime | int]

Parametry

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.

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

dict(str, Any)

Ustawia metadane zdefiniowane przez użytkownika dla obiektu blob jako co najmniej jedną parę name-value.

set_blob_metadata(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

metadata: dict(str, str)

Wymagane

Dykt 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. 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.

cpk: CustomerProvidedEncryptionKey

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)

Operacja Ustawianie tagów 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_blob_tags(tags: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

Parametry

tags: dict(str, str)

Wymagane

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 (_)

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.

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 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.

if_tags_match_condition: str

Określ klauzulę SQL where dla tagów obiektów blob, która będzie działać tylko w docelowym 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 dykt właściwości obiektu blob (Etag i ostatnia modyfikacja)

Typ zwracany

Dict[str, Any]

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_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None

Parametry

content_settings: ContentSettings

Wymagane

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. 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

Dict[str, Any]

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_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]

Parametry

immutability_policy: ImmutabilityPolicy

Wymagane

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".

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

Dict[str, str]

Operacja Ustaw blokadę prawną ustawia blokadę prawną obiektu blob.

Nowość w wersji 12.10.0: Ta operacja została wprowadzona w interfejsie API w wersji "2020-10-02".

set_legal_hold(legal_hold: bool, **kwargs: Any) -> Dict[str, str | datetime | bool]

Parametry

legal_hold: bool

Wymagane

Określono, czy dla obiektu blob należy ustawić archiwizację prawną.

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

Dict[str, Union[str, datetime, bool]]

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_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None

Parametry

premium_page_blob_tier: PremiumPageBlobTier

Wymagane

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.

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.

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

None

Ustawia numer sekwencji obiektów blob.

set_sequence_number(sequence_number_action: str | SequenceNumberAction, sequence_number: str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

sequence_number_action: str

Wymagane

Ta właściwość wskazuje, jak usługa powinna zmodyfikować numer sekwencji obiektu blob. Aby uzyskać więcej informacji, zobacz SequenceNumberAction.

sequence_number: str

Wymagane

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 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

dict(str, Any)

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.

set_standard_blob_tier(standard_blob_tier: str | StandardBlobTier, **kwargs: Any) -> None

Parametry

standard_blob_tier: str lub StandardBlobTier

Wymagane

Wskazuje warstwę, która ma zostać ustawiona na 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 danych rzadko używanych i przechowywanych przez co najmniej sześć miesięcy z elastycznymi wymaganiami dotyczącymi opóźnień.

rehydrate_priority: RehydratePriority

Wskazuje priorytet, za pomocą którego należy ponownie uzupełnić zarchiwizowany obiekt blob

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".

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.

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

None

Tworzy nowy blok, który ma zostać zatwierdzony w ramach obiektu blob.

stage_block(block_id: str, data: Iterable | IO, length: int | None = None, **kwargs) -> Dict[str, Any]

Parametry

block_id: str

Wymagane

Wartość ciągu, która identyfikuje blok. Ciąg powinien być mniejszy lub równy 64 bajtom w rozmiarze. W przypadku danego obiektu blob block_id musi być taki sam rozmiar dla każdego bloku.

data

Wymagane

Dane obiektu blob.

length: int

Wymagane

Rozmiar bloku.

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ę. Wartość może być obiektem BlobLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

encoding: str

Wartość domyślna to UTF-8.

cpk: CustomerProvidedEncryptionKey

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

Właściwość obiektu blob dict.

Typ zwracany

dict[str, Any]

Tworzy nowy blok do zatwierdzenia w ramach obiektu blob, w którym zawartość jest odczytywana z adresu URL.

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) -> Dict[str, Any]

Parametry

block_id: str

Wymagane

Wartość ciągu, która identyfikuje blok. Ciąg powinien być mniejszy lub równy 64 bajtom w rozmiarze. W przypadku danego obiektu blob block_id musi być taki sam rozmiar dla każdego bloku.

source_url: str

Wymagane

Adres URL.

source_offset: int

Wymagane

Początek zakresu bajtów do użycia dla bloku. Należy ustawić, jeśli podano długość źródła.

source_length: int

Wymagane

Rozmiar bloku w bajtach.

source_content_md5: bytearray

Wymagane

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.

cpk: CustomerProvidedEncryptionKey

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.

Zwraca

Właściwość obiektu blob dict.

Typ zwracany

dict[str, Any]

Kopiuje obiekt blob z danego adresu URL.

Ta operacja zwraca słownik zawierający copy_status i copy_id, który może służyć do sprawdzania stanu lub przerwania operacji kopiowania. 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.

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

Wymagane

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

metadata: dict(str, str)

Wymagane

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

Wymagane

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.

tags: dict(str, str) lub Literal["COPY"]

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.

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

dict[str, Union[str, datetime]]

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.

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

None

Tworzy nowy obiekt blob ze źródła danych z automatycznym fragmentowaniem.

upload_blob(data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, Any]

Parametry

data

Wymagane

Dane obiektu blob do przekazania.

blob_type: BlobType

Wymagane

Typ obiektu blob. Może to być BlokBlob, PageBlob lub AppendBlob. Wartość domyślna to BlockBlob.

length: int

Wymagane

Liczba bajtów do odczytu ze strumienia. Jest to opcjonalne, ale powinno być dostarczane w celu uzyskania optymalnej wydajności.

metadata: dict(str, str)

Wymagane

Pary name-value skojarzone z obiektem blob jako metadanymi.

tags: dict(str, str)

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: BlobLeaseClient lub str

Wymagane, jeśli obiekt blob ma aktywną dzierżawę. Jeśli zostanie określony, upload_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.

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.

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.

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".

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.

cpk: CustomerProvidedEncryptionKey

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.

progress_hook: Callable[[int, Optional[int]], None]

Wywołanie zwrotne do ś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.

Zwraca

Zaktualizowany obiekt blob właściwość dict (Etag i ostatnia modyfikacja)

Typ zwracany

dict[str, Any]

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_blob_from_url(source_url: str, **kwargs: Any) -> Dict[str, Any]

Parametry

source_url: str

Wymagane

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.

tags: dict(str, str)

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.

cpk: CustomerProvidedEncryptionKey

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.

Operacja Przekazywanie stron zapisuje zakres stron w stronicowym obiekcie blob.

upload_page(page: bytes, offset: int, length: int, **kwargs) -> Dict[str, str | datetime]

Parametry

page: bytes

Wymagane

Zawartość strony.

offset: int

Wymagane

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

Wymagane

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.

cpk: CustomerProvidedEncryptionKey

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.

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

dict(str, Any)

Operacja Przekazywanie stron zapisuje zakres stron do stronicowego obiektu blob, w którym zawartość jest odczytywana z adresu URL.

upload_pages_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs) -> Dict[str, Any]

Parametry

source_url: str

Wymagane

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

Wymagane

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

Wymagane

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.

source_offset: int

Wymagane

Wskazuje to początek zakresu bajtów (włącznie), który musi zostać pobrany ze źródła kopiowania. 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 tę wartość.

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.

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

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.

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.

cpk: CustomerProvidedEncryptionKey

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.

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.

Wersja interfejsu API usługi Storage używana dla żądań.

Tryb lokalizacji używany przez klienta.

Domyślnie będzie to "podstawowe". Opcje obejmują "podstawowe" i "pomocnicze".

Pełny podstawowy adres URL punktu końcowego.

Nazwa hosta podstawowego punktu końcowego.

Pełny pomocniczy adres URL punktu końcowego, jeśli został skonfigurowany.

Jeśli parametr ValueError nie jest dostępny, zostanie zgłoszony. Aby jawnie określić pomocniczą nazwę hosta, użyj opcjonalnego argumentu słowa kluczowego secondary_hostname wystąpienia.

Wyjątki

ValueError

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 wystąpienia.

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_modeelementu . :zwraca: pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany. :rtype: str

abort_copy	Przerywanie 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 to wersja 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 momencie ich wyświetlania w czasie. Migawka obiektu blob ma taką samą nazwę jak podstawowy obiekt blob, z którego wykonywana jest migawka, z dołączona wartość DateTime wskazująca czas wykonania migawki.
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 te elementy 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 pośrednictwem list_blobs opcji include=['deleted']. Obiekt blob usunięty nietrwale można przywrócić przy użyciu <xref:azure.storage.blob.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 readinto() do pobrania obiektu blob do strumienia. Użycie fragmentów() zwraca iterator, który umożliwia użytkownikowi iterowanie zawartości we fragmentach.
exists	Zwraca wartość True, jeśli obiekt blob istnieje z 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 niestandardowego adresu URL obiektu blob o nazwie "/".
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 można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob. Klucze w zwróconym słowniku obejmują "sku_name" i "account_kind".
get_blob_properties	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob.
get_blob_tags	Operacja Pobieranie tagów umożliwia użytkownikom pobieranie tagów w obiekcie blob lub określonej wersji obiektu blob lub migawki. Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12".
get_block_list	Operacja Pobierz listę 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. W przypadku określenia previous_snapshot wynik będzie różnicą zmian między docelowym obiektem blob a poprzednią migawką.
query_blob	Umożliwia użytkownikom wybieranie/projekt na danych migawek obiektów blob/lub obiektów blob przez udostępnianie prostych wyrażeń zapytań. Te operacje zwracają obiekt BlobQueryReader, użytkownicy muszą używać funkcji readall() lub readinto(), aby uzyskać dane zapytania.
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 Ustawianie tagów 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 Ustaw blokadę prawną ustawia blokadę prawną 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, który ma zostać zatwierdzony 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óry może służyć do sprawdzania stanu lub przerwania operacji kopiowania. 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 Przekazywanie stron zapisuje zakres stron w stronicowym obiekcie blob.
upload_pages_from_url	Operacja Przekazywanie stron zapisuje zakres stron do stronicowego obiektu blob, w którym zawartość jest odczytywana z adresu URL.

BlobClient Klasa

Konstruktor

Parametry

Metody

abort_copy

Parametry

Typ zwracany

acquire_lease

Parametry

Zwraca

Typ zwracany

append_block

Parametry

Zwraca

Typ zwracany

append_block_from_url

Parametry

clear_page

Parametry

Zwraca

Typ zwracany

close

commit_block_list

Parametry

Zwraca

Typ zwracany

create_append_blob

Parametry

Zwraca

Typ zwracany

create_page_blob

Parametry

Zwraca

Typ zwracany

create_snapshot

Parametry

Zwraca

Typ zwracany

delete_blob

Parametry

Typ zwracany

delete_immutability_policy

Parametry

Zwraca

Typ zwracany

download_blob

Parametry

Zwraca

Typ zwracany

exists

Parametry

Zwraca

Typ zwracany

from_blob_url

Parametry

Zwraca

Typ zwracany

from_connection_string

Parametry

Zwraca

Typ zwracany

get_account_information

Zwraca

Typ zwracany

get_blob_properties

Parametry

Zwraca

Typ zwracany

get_blob_tags

Parametry

Zwraca

Typ zwracany

get_block_list

Parametry

Zwraca

Typ zwracany

get_page_range_diff_for_managed_disk

Parametry

Zwraca

Typ zwracany