BaseBlobService Klasa

Jest to główna klasa zarządzania zasobami obiektów blob.

Usługa Blob przechowuje dane tekstowe i binarne jako obiekty blob w chmurze. Usługa Blob Service oferuje następujące trzy zasoby: konto magazynu, kontenery i obiekty blob. Na koncie magazynu kontenery umożliwiają organizowanie zestawów obiektów blob. Aby uzyskać więcej informacji, zobacz: https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx

:type ~azure.storage.common.TokenCredential

Dziedziczenie

StorageClient

BaseBlobService

Konstruktor

BaseBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, connection_string=None, socket_timeout=None, token_credential=None)

Parametry

account_name

str

wartość domyślna: None

Nazwa konta magazynu. Służy do uwierzytelniania żądań podpisanych przy użyciu klucza konta i konstruowania punktu końcowego magazynu. Jest to wymagane, chyba że podano parametry połączenia lub jeśli domena niestandardowa jest używana z uwierzytelnianiem anonimowym.

account_key

str

wartość domyślna: None

Klucz konta magazynu. Jest to używane do uwierzytelniania klucza współdzielonego. Jeśli nie określono żadnego klucza konta ani tokenu sygnatury dostępu współdzielonego, zostanie użyty dostęp anonimowy.

sas_token

str

wartość domyślna: None

Token sygnatury dostępu współdzielonego używany do uwierzytelniania żądań zamiast klucza konta. Jeśli określono zarówno klucz konta, jak i token sas, klucz konta zostanie użyty do podpisania. Jeśli żadna z nich nie zostanie określona, zostanie użyty dostęp anonimowy.

is_emulated

bool

wartość domyślna: False

Czy używać emulatora. Wartość domyślna to False. Jeśli zostanie określony, zastąpi wszystkie inne parametry oprócz parametry połączenia i sesji żądania.

protocol

str

wartość domyślna: https

Protokół do użycia dla żądań. Wartość domyślna to https.

endpoint_suffix

str

wartość domyślna: core.windows.net

Składnik podstawowy hosta adresu URL, minus nazwa konta. Domyślnie do platformy Azure (core.windows.net). Zastąp to użyciem chmury Chiny (core.chinacloudapi.cn).

custom_domain

str

wartość domyślna: None

Domena niestandardowa do użycia. Można to ustawić w witrynie Azure Portal. Na przykład "www.mydomain.com".

request_session

<xref:requests.Session>

wartość domyślna: None

Obiekt sesji do użycia dla żądań http.

connection_string

str

wartość domyślna: None

Jeśli zostanie określony, spowoduje to zastąpienie wszystkich innych parametrów oprócz sesji żądania. Zobacz http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ format parametry połączenia

socket_timeout

int

wartość domyślna: None

Jeśli zostanie określony, spowoduje to zastąpienie domyślnego limitu czasu gniazda. Określony limit czasu wynosi w sekundach. Aby uzyskać wartość domyślną, zobacz DEFAULT_SOCKET_TIMEOUT w pliku _constants.py.

token_credential

wartość domyślna: None

Poświadczenia tokenu używane do uwierzytelniania żądań HTTPS. Wartość tokenu powinna zostać zaktualizowana przed jego wygaśnięciem.

Zmienne

MAX_SINGLE_GET_SIZE

int

Rozmiar pierwszego zakresu wykonywanego przez metody get_blob_to_*, jeśli max_connections jest większy niż 1. Mniej danych zostanie zwróconych, jeśli obiekt blob jest mniejszy niż ten.

MAX_CHUNK_GET_SIZE

int

Rozmiar kolejnego zakresu jest wykonywany przez metody get_blob_to_*, jeśli max_connections jest większy niż 1, a obiekt blob jest większy niż MAX_SINGLE_GET_SIZE. Mniejsze dane zostaną zwrócone, jeśli pozostała część obiektu blob jest mniejsza niż ta. Jeśli ta wartość jest ustawiona na większą niż 4 MB, content_validation zgłosi błąd, jeśli jest włączona. Jeśli jednak content_validation nie jest pożądane, rozmiar większy niż 4 MB może być optymalny. Ustawienie tego poniżej 4 MB nie jest zalecane.

key_encryption_key

object

Klucz-encryption-key opcjonalnie dostarczony przez użytkownika. Jeśli zostanie podana wartość , zostanie użyta do szyfrowania/odszyfrowywania w obsługiwanych metodach. W przypadku metod wymagających odszyfrowywania należy podać key_encryption_key LUB rozpoznawania nazw. Jeśli podano oba te elementy, program rozpoznawania będzie mieć pierwszeństwo. Należy zaimplementować następujące metody dla interfejsów API wymagających szyfrowania: wrap_key(klucz) — opakowuje określony klucz (bajty) przy użyciu wybranego algorytmu użytkownika. Zwraca zaszyfrowany klucz jako bajty. get_key_wrap_algorithm()— zwraca algorytm używany do opakowania określonego klucza symetrycznego. get_kid()— zwraca identyfikator klucza ciągu dla tego klucza szyfrowania klucza. Należy zaimplementować następujące metody dla interfejsów API wymagających odszyfrowywania: unwrap_key(klucz, algorytm) — zwraca niezapisaną formę określonego klucza symetrycznego przy użyciu algorytmu określonego w ciągu. get_kid()— zwraca identyfikator klucza ciągu dla tego klucza szyfrowania klucza.

key_resolver_function

kid) (<xref:function>

Funkcja umożliwiająca rozpoznawanie kluczy opcjonalnie dostarczonych przez użytkownika. Jeśli zostanie podany, zostanie użyty do odszyfrowywania w obsługiwanych metodach. W przypadku metod wymagających odszyfrowywania należy podać key_encryption_key LUB rozpoznawania nazw. Jeśli podano oba te elementy, program rozpoznawania będzie mieć pierwszeństwo. Używa ciągu dla dzieci, aby zwrócić klucz-encryption-key implementujący interfejs zdefiniowany powyżej.

require_encryption

bool

Flaga, którą można ustawić, aby upewnić się, że wszystkie komunikaty zostały pomyślnie przekazane do kolejki i wszystkie pobrane i pomyślnie odczytane z kolejki są/zostały zaszyfrowane na serwerze. Jeśli ta flaga jest ustawiona, należy podać wszystkie wymagane parametry szyfrowania/odszyfrowywania. Zobacz powyższe komentarze dotyczące key_encryption_key i programu rozpoznawania.

Metody

abort_copy_blob	Przerywa oczekującą operację copy_blob i pozostawia docelowy obiekt blob o zerowej długości i pełnych metadanych.
acquire_blob_lease	Żąda nowej dzierżawy. Jeśli obiekt blob nie ma aktywnej dzierżawy, usługa Blob tworzy dzierżawę obiektu blob i zwraca nowy identyfikator dzierżawy.
acquire_container_lease	Żąda nowej dzierżawy. Jeśli kontener nie ma aktywnej dzierżawy, usługa Blob tworzy dzierżawę kontenera i zwraca nowy identyfikator dzierżawy.
batch_delete_blobs	Wysyła partię wielu żądań usuwania obiektów blob. Metoda delete obiektu blob usuwa określony obiekt blob lub migawkę. Należy pamiętać, że usunięcie obiektu blob powoduje również usunięcie wszystkich jego migawek. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/rest/api/storageservices/delete-blob.
break_blob_lease	Przerywa dzierżawę, jeśli obiekt blob ma aktywną dzierżawę. Po przerwaniu dzierżawy nie można jej odnowić. Każde autoryzowane żądanie może przerwać dzierżawę; żądanie nie jest wymagane do określenia zgodnego identyfikatora dzierżawy. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w tym czasie nie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia na obiekcie blob. Po pomyślnym przerwaniu dzierżawy odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy. Dzierżawa, która została przerwana, może zostać również zwolniona. W takim przypadku inny klient może natychmiast uzyskać dzierżawę obiektu blob.
break_container_lease	Przerwij dzierżawę, jeśli kontener ma aktywną dzierżawę. Po przerwaniu dzierżawy nie można jej odnowić. Każde autoryzowane żądanie może przerwać dzierżawę; żądanie nie jest wymagane do określenia zgodnego identyfikatora dzierżawy. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w którym nie będzie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w kontenerze. Po pomyślnym przerwaniu dzierżawy odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy.
change_blob_lease	Zmienia identyfikator dzierżawy aktywnej dzierżawy. Zmiana musi zawierać bieżący identyfikator dzierżawy i nowy identyfikator dzierżawy.
change_container_lease	Zmień identyfikator dzierżawy aktywnej dzierżawy. Zmiana musi zawierać bieżący identyfikator dzierżawy i nowy identyfikator dzierżawy.
copy_blob	Asynchronicznie kopiuje obiekt blob. Ta operacja zwraca obiekt właściwości operacji kopiowania, w tym identyfikator kopii, którego można użyć do sprawdzenia lub przerwania operacji kopiowania. Usługa Blob service kopiuje obiekty blob na zasadzie najlepszego nakładu pracy. Ź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 trwa operacja kopiowania. Podczas kopiowania ze stronicowego obiektu blob usługa Blob tworzy docelowy stronicowy obiekt blob o długości źródłowego obiektu blob, początkowo zawierający 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ą liczbę zatwierdzonych 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ą liczbę zatwierdzonych bloków co źródło. W przypadku wszystkich typów obiektów blob można wywołać get_blob_properties w docelowym obiekcie blob, aby sprawdzić stan operacji kopiowania. Końcowy obiekt blob zostanie zatwierdzony po zakończeniu kopiowania.
create_container	Tworzy nowy kontener w ramach określonego konta. Jeśli kontener o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem, jeśli fail_on_exist ma wartość True.
delete_blob	Oznacza określony obiekt blob lub migawkę 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 Usuń obiekt blob. Jeśli dla usługi włączono zasady przechowywania usuwania, ta operacja nietrwała usuwa obiekt blob lub migawkę i zachowuje obiekt blob lub migawkę przez określoną liczbę dni. Po określonej liczbie dni dane obiektu blob są usuwane z usługi podczas odzyskiwania pamięci. Usunięty nietrwale obiekt blob lub migawka jest dostępny za pośrednictwem interfejsu API list obiektów blob, określając opcję include=Include.Deleted. Usunięty nietrwale obiekt blob lub migawka można przywrócić przy użyciu interfejsu API cofania usuwania.
delete_container	Oznacza określony kontener do usunięcia. Kontener i wszystkie zawarte w nim obiekty blob zostaną później usunięte podczas odzyskiwania pamięci.
exists	Zwraca wartość logiczną wskazującą, czy kontener istnieje (jeśli blob_name to Brak), czy też wartość logiczna wskazująca, czy obiekt blob istnieje.
extract_date_and_request_id
generate_account_shared_access_signature	Generuje sygnaturę dostępu współdzielonego dla usługi blob. Użyj zwróconego podpisu z parametrem sas_token dowolnej usługi BlobService.
generate_blob_shared_access_signature	Generuje sygnaturę dostępu współdzielonego dla obiektu blob lub jednej z jego migawek. Użyj zwróconego podpisu z parametrem sas_token dowolnej usługi BlobService.
generate_container_shared_access_signature	Generuje sygnaturę dostępu współdzielonego dla kontenera. Użyj zwróconego podpisu z parametrem sas_token dowolnej usługi BlobService.
get_blob_account_information	Pobiera informacje związane z kontem magazynu. Informacje te można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob.
get_blob_metadata	Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego obiektu blob lub migawki.
get_blob_properties	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob. Zwraca wartość Blob z BlobProperties dyktami metadanych i .
get_blob_service_properties	Pobiera właściwości usługi Blob service konta magazynu, w tym usługi Azure analityka magazynu.
get_blob_service_stats	Pobiera statystyki związane z replikacją dla usługi Blob Service. Jest ona dostępna tylko wtedy, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa z dostępem do odczytu. Dzięki replikacji geograficznie nadmiarowej usługa Azure Storage utrzymuje trwałość danych w dwóch lokalizacjach. W obu lokalizacjach usługa Azure Storage stale utrzymuje wiele replik w dobrej kondycji danych. Lokalizacja, w której odczytujesz, utworzysz, zaktualizujesz lub usuniesz dane, jest podstawową lokalizacją konta magazynu. Lokalizacja podstawowa istnieje w wybranym regionie podczas tworzenia konta za pośrednictwem klasycznego portalu Azure Management Azure, na przykład Północno-środkowe stany USA. Lokalizacja, do której są replikowane dane, to lokalizacja pomocnicza. Lokalizacja pomocnicza jest automatycznie określana na podstawie lokalizacji podstawowej; znajduje się w drugim centrum danych, które znajduje się w tym samym regionie co lokalizacja podstawowa. Dostęp tylko do odczytu jest dostępny z lokalizacji pomocniczej, jeśli dla konta magazynu włączono replikację geograficznie nadmiarową z dostępem do odczytu.
get_blob_to_bytes	Pobiera obiekt blob jako tablicę bajtów z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami, metadanymi i zawartością.
get_blob_to_path	Pobiera obiekt blob do ścieżki pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami i metadanymi.
get_blob_to_stream	Pobiera obiekt blob do strumienia z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami i metadanymi.
get_blob_to_text	Pobiera obiekt blob jako tekst Unicode z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami, metadanymi i zawartością.
get_container_acl	Pobiera uprawnienia dla określonego kontenera. Uprawnienia wskazują, czy dane kontenera mogą być dostępne publicznie.
get_container_metadata	Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego kontenera.
get_container_properties	Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego kontenera. Zwrócone dane nie zawierają listy obiektów blob kontenera.
get_user_delegation_key	Uzyskaj klucz delegowania użytkownika na potrzeby podpisywania tokenów SAS. Poświadczenia tokenu muszą być obecne w obiekcie usługi, aby to żądanie powiodło się.
list_blob_names	Zwraca generator, aby wyświetlić listę nazw obiektów blob w określonym kontenerze. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po zwróceniu wszystkich obiektów blob lub osiągnięciu num_results. Jeśli określono num_results i konto ma więcej niż określoną liczbę obiektów blob, po zakończeniu generator będzie miał wypełnione pole next_marker. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.
list_blobs	Zwraca generator, aby wyświetlić listę obiektów blob w określonym kontenerze. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po zwróceniu wszystkich obiektów blob lub osiągnięciu num_results. Jeśli określono num_results i konto ma więcej niż określoną liczbę obiektów blob, po zakończeniu generator będzie miał wypełnione pole next_marker. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.
list_containers	Zwraca generator, aby wyświetlić listę kontenerów w ramach określonego konta. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po powrocie wszystkich kontenerów lub osiągnięciu num_results. Jeśli określono num_results i konto ma więcej niż określoną liczbę kontenerów, po zakończeniu generator będzie miał wypełnione pole next_marker. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.
make_blob_url	Tworzy adres URL w celu uzyskania dostępu do obiektu blob.
make_container_url	Tworzy adres URL w celu uzyskania dostępu do kontenera.
release_blob_lease	Zwalnia dzierżawę. Dzierżawa może zostać zwolniona, jeśli identyfikator dzierżawy określony w żądaniu jest zgodny z elementem skojarzonym z obiektem blob. Zwolnienie dzierżawy umożliwia innemu klientowi natychmiastowe uzyskanie dzierżawy dla obiektu blob natychmiast po zakończeniu wydania.
release_container_lease	Zwolnij dzierżawę. Dzierżawa może zostać zwolniona, jeśli określona lease_id jest zgodna z kontenerem skojarzonym z kontenerem. Zwolnienie dzierżawy umożliwia innemu klientowi natychmiastowe uzyskanie dzierżawy dla kontenera zaraz po zakończeniu wydania.
renew_blob_lease	Odnawia dzierżawę. Dzierżawę można odnowić, jeśli identyfikator dzierżawy określony na żądaniu jest zgodny z obiektem blob skojarzonym z obiektem blob. Należy pamiętać, że dzierżawa może zostać odnowiona nawet wtedy, gdy obiekt blob nie został zmodyfikowany lub dzierżawiony ponownie od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy zostanie zresetowany.
renew_container_lease	Odnawia dzierżawę. Dzierżawę można odnowić, jeśli określony identyfikator dzierżawy jest zgodny z kontenerem skojarzonym z kontenerem. Należy pamiętać, że dzierżawa może zostać odnowiona, nawet jeśli wygasła, o ile kontener nie został ponownie dzierżawiony od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy zostanie zresetowany.
set_blob_metadata	Ustawia metadane zdefiniowane przez użytkownika dla określonego obiektu blob jako jedną lub więcej par name-value.
set_blob_properties	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_blob_service_properties	Ustawia właściwości usługi Blob service konta magazynu, w tym usługi Azure analityka magazynu. Jeśli element (np. rejestrowanie) jest pozostawiony jako Brak, istniejące ustawienia usługi dla tej funkcji zostaną zachowane.
set_container_acl	Ustawia uprawnienia dla określonego kontenera lub przechowywanych zasad dostępu, które mogą być używane z sygnaturami dostępu współdzielonego. Uprawnienia wskazują, czy obiekty blob w kontenerze mogą być dostępne publicznie.
set_container_metadata	Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego kontenera. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do kontenera. Aby usunąć wszystkie metadane z kontenera, wywołaj tę operację bez dyktowania metadanych.
set_proxy	Ustawia hosta i port serwera proxy dla tunelowania HTTP CONNECT.
snapshot_blob	Tworzy migawkę obiektu blob tylko do odczytu.
undelete_blob	Operacja cofania usuwania obiektu blob przywraca zawartość i metadane nietrwałego usuniętego obiektu blob lub migawki. Próba cofnięcia usunięcia obiektu blob lub migawki, która nie zostanie usunięta nietrwale, powiedzie się bez żadnych zmian.

abort_copy_blob

Przerywa oczekującą operację copy_blob i pozostawia docelowy obiekt blob o zerowej długości i pełnych metadanych.

abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera docelowego.

blob_name

str

Wymagane

Nazwa docelowego obiektu blob.

copy_id

str

Wymagane

Skopiuj identyfikator podany w copy.id oryginalnej operacji copy_blob.

lease_id

str

wartość domyślna: None

Wymagany, jeśli docelowy obiekt blob ma aktywną dzierżawę nieskończoną.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

acquire_blob_lease

Żąda nowej dzierżawy. Jeśli obiekt blob nie ma aktywnej dzierżawy, usługa Blob tworzy dzierżawę obiektu blob i zwraca nowy identyfikator dzierżawy.

acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

lease_duration

int

wartość domyślna: -1

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

proposed_lease_id

str

wartość domyślna: None

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ść domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, i nie powiedzie się operacji, jeśli istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Str

acquire_container_lease

Żąda nowej dzierżawy. Jeśli kontener nie ma aktywnej dzierżawy, usługa Blob tworzy dzierżawę kontenera i zwraca nowy identyfikator dzierżawy.

acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_duration

int

wartość domyślna: -1

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

proposed_lease_id

str

wartość domyślna: None

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ść domyślna: None

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ść domyślna: None

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.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Str

batch_delete_blobs

Wysyła partię wielu żądań usuwania obiektów blob.

Metoda delete obiektu blob usuwa określony obiekt blob lub migawkę. Należy pamiętać, że usunięcie obiektu blob powoduje również usunięcie wszystkich jego migawek. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/rest/api/storageservices/delete-blob.

batch_delete_blobs(batch_delete_sub_requests, timeout=None)

Parametry

batch_delete_sub_requests

list(BatchDeleteSubRequest)

Wymagane

Żądania usuwania obiektów blob do wysłania jako partia.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Przeanalizowano odpowiedź HTTP usuwania wsadowego

Typ zwracany

list <xref:of> BatchSubResponse

break_blob_lease

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

Dzierżawa, która została przerwana, może zostać również zwolniona. W takim przypadku inny klient może natychmiast uzyskać dzierżawę obiektu blob.

break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

lease_break_period

int

wartość domyślna: None

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

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

int

break_container_lease

Przerwij dzierżawę, jeśli kontener ma aktywną dzierżawę. Po przerwaniu dzierżawy nie można jej odnowić. Każde autoryzowane żądanie może przerwać dzierżawę; żądanie nie jest wymagane do określenia zgodnego identyfikatora dzierżawy. Gdy dzierżawa zostanie przerwana, okres przerwania dzierżawy może upłynąć, w którym nie będzie można wykonać operacji dzierżawy z wyjątkiem przerwania i zwolnienia w kontenerze. Po pomyślnym przerwaniu dzierżawy odpowiedź wskazuje interwał w sekundach do momentu uzyskania nowej dzierżawy.

break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_break_period

int

wartość domyślna: None

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

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

int

change_blob_lease

Zmienia identyfikator dzierżawy aktywnej dzierżawy. Zmiana musi zawierać bieżący identyfikator dzierżawy i nowy identyfikator dzierżawy.

change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

lease_id

str

Wymagane

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

proposed_lease_id

str

Wymagane

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

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

change_container_lease

Zmień identyfikator dzierżawy aktywnej dzierżawy. Zmiana musi zawierać bieżący identyfikator dzierżawy i nowy identyfikator dzierżawy.

change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_id

str

Wymagane

Identyfikator dzierżawy dla aktywnej dzierżawy.

proposed_lease_id

str

Wymagane

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

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

copy_blob

Asynchronicznie kopiuje obiekt blob. Ta operacja zwraca obiekt właściwości operacji kopiowania, w tym identyfikator kopii, którego można użyć do sprawdzenia lub przerwania operacji kopiowania. Usługa Blob service kopiuje obiekty blob na zasadzie najlepszego nakładu pracy.

Ź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 trwa operacja kopiowania.

Podczas kopiowania ze stronicowego obiektu blob usługa Blob tworzy docelowy stronicowy obiekt blob o długości źródłowego obiektu blob, początkowo zawierający 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ą liczbę zatwierdzonych 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ą liczbę zatwierdzonych bloków co źródło.

W przypadku wszystkich typów obiektów blob można wywołać get_blob_properties w docelowym obiekcie blob, aby sprawdzić stan operacji kopiowania. Końcowy obiekt blob zostanie zatwierdzony po zakończeniu kopiowania.

copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera docelowego. Kontener musi istnieć.

blob_name

str

Wymagane

Nazwa docelowego obiektu blob. Jeśli docelowy obiekt blob istnieje, zostanie zastąpiony. W przeciwnym razie zostanie utworzony.

copy_source

str

Wymagane

Adres URL o długości do 2 KB określający plik lub obiekt blob platformy Azure. 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/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata

dict(str, str)

wartość domyślna: None

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.

source_if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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_if_match

<xref:ETag>

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek warunkowy, aby skopiować źródłowy obiekt blob tylko wtedy, gdy jego element ETag jest zgodny z określoną wartością. Jeśli wartości elementu ETag nie są zgodne, usługa Blob zwraca kod stanu 412 (Niepowodzenie warunku wstępnego). Nie można określić tego nagłówka, jeśli źródło jest plikiem platformy Azure.

source_if_none_match

<xref:ETag>

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek warunkowy, aby skopiować obiekt blob tylko wtedy, gdy jego element ETag nie jest zgodny z określoną wartością. Jeśli wartości są identyczne, usługa Blob Service zwraca kod stanu 412 (Niepowodzenie warunku wstępnego). Nie można określić tego nagłówka, jeśli źródło jest plikiem platformy Azure.

destination_if_modified_since

datetime

wartość domyślna: None

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

destination_if_unmodified_since

datetime

wartość domyślna: None

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

destination_if_match

<xref:ETag>

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ wartość elementu ETag dla tego nagłówka warunkowego, aby skopiować obiekt blob tylko wtedy, gdy określona wartość elementu ETag jest zgodna z wartością ETag dla istniejącego docelowego obiektu blob. Jeśli element ETag docelowego obiektu blob nie jest zgodny z elementem ETag określonym dla elementu If-Match, usługa Blob zwraca kod stanu 412 (Niepowodzenie warunku wstępnego).

destination_if_none_match

<xref:ETag>

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ wartość elementu ETag dla tego nagłówka warunkowego, aby skopiować obiekt blob tylko wtedy, gdy określona wartość elementu ETag jest niezgodna z wartością ETag docelowego obiektu blob. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy docelowy obiekt blob nie istnieje. Jeśli określony warunek nie zostanie spełniony, usługa Blob zwróci kod stanu 412 (Niepowodzenie warunku wstępnego).

destination_lease_id

str

wartość domyślna: None

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_id

str

wartość domyślna: None

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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Właściwości operacji kopiowania, takie jak stan, źródło i identyfikator.

Typ zwracany

CopyProperties

create_container

Tworzy nowy kontener w ramach określonego konta. Jeśli kontener o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem, jeśli fail_on_exist ma wartość True.

create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera do utworzenia. Nazwa kontenera może zawierać tylko małe litery, cyfry i łączniki oraz musi zaczynać się literą lub cyfrą. Przed i za każdym łącznikiem musi znajdować się znak inny niż łącznik. Nazwa musi również zawierać od 3 do 63 znaków.

metadata

dict(str, str)

wartość domyślna: None

Dykt z name_value parami do skojarzenia z kontenerem jako metadanymi. Przykład:{'Category':'test'}

public_access

PublicAccess

wartość domyślna: None

Możliwe wartości to: kontener, obiekt blob.

fail_on_exist

bool

wartość domyślna: False

Określ, czy zgłaszać wyjątek, gdy kontener istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Wartość True, jeśli kontener został utworzony, wartość False, jeśli kontener już istnieje.

Typ zwracany

bool

delete_blob

Oznacza określony obiekt blob lub migawkę 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 Usuń obiekt blob.

Jeśli dla usługi włączono zasady przechowywania usuwania, ta operacja nietrwała usuwa obiekt blob lub migawkę i zachowuje obiekt blob lub migawkę przez określoną liczbę dni. Po określonej liczbie dni dane obiektu blob są usuwane z usługi podczas odzyskiwania pamięci. Usunięty nietrwale obiekt blob lub migawka jest dostępny za pośrednictwem interfejsu API list obiektów blob, określając opcję include=Include.Deleted. Usunięty nietrwale obiekt blob lub migawka można przywrócić przy użyciu interfejsu API cofania usuwania.

delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob do usunięcia.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

delete_snapshots

DeleteSnapshot

wartość domyślna: None

Wymagane, jeśli obiekt blob ma skojarzone migawki.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

delete_container

Oznacza określony kontener do usunięcia. Kontener i wszystkie zawarte w nim obiekty blob zostaną później usunięte podczas odzyskiwania pamięci.

delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera do usunięcia.

fail_not_exist

bool

wartość domyślna: False

Określ, czy zgłaszać wyjątek, gdy kontener nie istnieje.

lease_id

str

wartość domyślna: None

Jeśli zostanie określony, delete_container powiedzie się tylko wtedy, gdy dzierżawa kontenera jest aktywna i jest zgodna z tym identyfikatorem. Wymagane, jeśli kontener ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Wartość True, jeśli kontener został usunięty, kontener False nie istnieje.

Typ zwracany

bool

exists

Zwraca wartość logiczną wskazującą, czy kontener istnieje (jeśli blob_name to Brak), czy też wartość logiczna wskazująca, czy obiekt blob istnieje.

exists(container_name, blob_name=None, snapshot=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera.

blob_name

str

wartość domyślna: None

Nazwa obiektu blob. Jeśli brak, kontener zostanie sprawdzony pod kątem istnienia.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Wartość logiczna wskazująca, czy zasób istnieje.

Typ zwracany

bool

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parametry

retry_context

Wymagane

generate_account_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla usługi blob. Użyj zwróconego podpisu z parametrem sas_token dowolnej usługi BlobService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Parametry

resource_types

<xref:ResourceTypes>

Wymagane

Określa typy zasobów, które są dostępne za pomocą sygnatury dostępu współdzielonego konta.

permission

<xref:AccountPermissions>

Wymagane

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu.

expiry

datetime lub str

Wymagane

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. W przypadku pominięcia zakłada się, że godzina rozpoczęcia tego wywołania to czas odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

ip

str

wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol

str

wartość domyślna: None

Określa protokół dozwolony dla żądania. Wartość domyślna to https,http. Zobacz Protocol , aby uzyskać możliwe wartości.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

generate_blob_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla obiektu blob lub jednej z jego migawek. Użyj zwróconego podpisu z parametrem sas_token dowolnej usługi BlobService.

generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera.

blob_name

str

Wymagane

Nazwa obiektu blob.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob w celu udzielenia uprawnień.

permission

BlobPermissions

wartość domyślna: None

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Uprawnienia muszą być uporządkowane odczytu, zapisu, usuwania, listy. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu.

expiry

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. W przypadku pominięcia zakłada się, że godzina rozpoczęcia tego wywołania to czas odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

id

str

wartość domyślna: None

Unikatowa wartość o długości do 64 znaków, która jest skorelowana z zapisanymi zasadami dostępu. Aby utworzyć przechowywane zasady dostępu, użyj polecenia set_container_acl.

ip

str

wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol

str

wartość domyślna: None

Określa protokół dozwolony dla żądania. Wartość domyślna to https,http. Zobacz Protocol , aby uzyskać możliwe wartości.

cache_control

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla Cache-Control, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_disposition

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla właściwości Content-Disposition, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_encoding

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla kodowania zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_language

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla języka zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_type

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

user_delegation_key

UserDelegationKey

wartość domyślna: None

Zamiast klucza konta użytkownik może przekazać klucz delegowania użytkownika. Klucz delegowania użytkownika można uzyskać z usługi, uwierzytelniając się przy użyciu tożsamości usługi AAD; Można to osiągnąć, wywołując get_user_delegation_key. Gdy jest obecny, sygnatura dostępu współdzielonego jest podpisana przy użyciu klucza delegowania użytkownika.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

generate_container_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla kontenera. Użyj zwróconego podpisu z parametrem sas_token dowolnej usługi BlobService.

generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera.

permission

ContainerPermissions

wartość domyślna: None

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Uprawnienia muszą być uporządkowane odczytu, zapisu, usuwania, listy. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu.

expiry

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. W przypadku pominięcia zakłada się, że godzina rozpoczęcia tego wywołania to czas odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

id

str

wartość domyślna: None

Unikatowa wartość o długości do 64 znaków, która jest skorelowana z zapisanymi zasadami dostępu. Aby utworzyć przechowywane zasady dostępu, użyj set_blob_service_properties.

ip

str

wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol

str

wartość domyślna: None

Określa protokół dozwolony dla żądania. Wartość domyślna to https,http. Zobacz Protocol , aby uzyskać możliwe wartości.

cache_control

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla Cache-Control, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_disposition

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla właściwości Content-Disposition, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_encoding

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla kodowania zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_language

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla języka zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_type

str

wartość domyślna: None

Wartość nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

user_delegation_key

UserDelegationKey

wartość domyślna: None

Zamiast klucza konta użytkownik może przekazać klucz delegowania użytkownika. Klucz delegowania użytkownika można uzyskać z usługi, uwierzytelniając się przy użyciu tożsamości usługi AAD; Można to osiągnąć, wywołując get_user_delegation_key. Gdy jest obecny, sygnatura dostępu współdzielonego jest podpisana przy użyciu klucza delegowania użytkownika.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

get_blob_account_information

Pobiera informacje związane z kontem magazynu. Informacje te można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob.

get_blob_account_information(container_name=None, blob_name=None, timeout=None)

Parametry

container_name

str

wartość domyślna: None

Nazwa istniejącego kontenera. Opcjonalnie, chyba że używasz tokenu SYGNATURy dostępu współdzielonego do określonego kontenera lub obiektu blob, w tym przypadku jest to wymagane.

blob_name

str

wartość domyślna: None

Nazwa istniejącego obiektu blob. Opcjonalnie, chyba że do określonego obiektu blob jest używany token SYGNATURy dostępu współdzielonego, w tym przypadku jest to wymagane.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Element AccountInformation.

get_blob_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego obiektu blob lub migawki.

get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością, która w chwili obecnej określa migawkę obiektu blob do pobrania.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

Odszyfrowuje 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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Słownik reprezentujący nazwę metadanych obiektu blob, pary wartości.

Typ zwracany

dict(str, str)

get_blob_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob. Zwraca wartość Blob z BlobProperties dyktami metadanych i .

get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob do pobrania.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

Odszyfrowuje 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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

obiekt blob, w tym właściwości i metadane.

Typ zwracany

Blob

get_blob_service_properties

Pobiera właściwości usługi Blob service konta magazynu, w tym usługi Azure analityka magazynu.

get_blob_service_properties(timeout=None)

Parametry

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Obiekt blob ServiceProperties z dołączoną właściwością target_version.

get_blob_service_stats

Pobiera statystyki związane z replikacją dla usługi Blob Service. Jest ona dostępna tylko wtedy, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa z dostępem do odczytu.

Dzięki replikacji geograficznie nadmiarowej usługa Azure Storage utrzymuje trwałość danych w dwóch lokalizacjach. W obu lokalizacjach usługa Azure Storage stale utrzymuje wiele replik w dobrej kondycji danych. Lokalizacja, w której odczytujesz, utworzysz, zaktualizujesz lub usuniesz dane, jest podstawową lokalizacją konta magazynu. Lokalizacja podstawowa istnieje w wybranym regionie podczas tworzenia konta za pośrednictwem klasycznego portalu Azure Management Azure, na przykład Północno-środkowe stany USA. Lokalizacja, do której są replikowane dane, to lokalizacja pomocnicza. Lokalizacja pomocnicza jest automatycznie określana na podstawie lokalizacji podstawowej; znajduje się w drugim centrum danych, które znajduje się w tym samym regionie co lokalizacja podstawowa. Dostęp tylko do odczytu jest dostępny z lokalizacji pomocniczej, jeśli dla konta magazynu włączono replikację geograficznie nadmiarową z dostępem do odczytu.

get_blob_service_stats(timeout=None)

Parametry

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Statystyki usługi blob.

Typ zwracany

ServiceStats

get_blob_to_bytes

Pobiera obiekt blob jako tablicę bajtów z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami, metadanymi i zawartością.

get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob do pobrania.

start_range

int

wartość domyślna: None

Początek zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

end_range

int

wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

validate_content

bool

wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części obiektu blob. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją signature (current, total), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar obiektu blob, jeśli jest znany.

max_connections

int

wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajtów obiektu blob. Jeśli jest to cały obiekt blob, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli wiele obiektów blob ma być pustych, ponieważ dodatkowe żądanie jest wymagane w przypadku pustych obiektów blob, jeśli max_connections jest większa niż 1.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

Odszyfrowuje 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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

Zwraca

Obiekt blob z właściwościami i metadanymi. Jeśli max_connections jest większa niż 1, content_md5 (jeśli jest ustawiona na obiekcie blob) nie zostanie zwrócona. Jeśli ta wartość jest wymagana, użyj get_blob_properties lub ustaw max_connections na 1.

Typ zwracany

Blob

get_blob_to_path

Pobiera obiekt blob do ścieżki pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami i metadanymi.

get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

file_path

str

Wymagane

Ścieżka pliku do zapisania.

open_mode

str

wartość domyślna: wb

Tryb do użycia podczas otwierania pliku. Należy pamiętać, że określanie dołączania tylko open_mode uniemożliwia pobieranie równoległe. Dlatego max_connections musi być ustawiona na 1, jeśli jest używana ta open_mode.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob do pobrania.

start_range

int

wartość domyślna: None

Początek zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

end_range

int

wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

validate_content

bool

wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części obiektu blob. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją signature (current, total), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar obiektu blob, jeśli jest znany.

max_connections

int

wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajtów obiektu blob. Jeśli jest to cały obiekt blob, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli wiele obiektów blob ma być pustych, ponieważ dodatkowe żądanie jest wymagane w przypadku pustych obiektów blob, jeśli max_connections jest większa niż 1.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

Odszyfrowuje 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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

Zwraca

Obiekt blob z właściwościami i metadanymi. Jeśli max_connections jest większa niż 1, content_md5 (jeśli jest ustawiona na obiekcie blob) nie zostanie zwrócona. Jeśli ta wartość jest wymagana, użyj get_blob_properties lub ustaw max_connections na 1.

Typ zwracany

Blob

get_blob_to_stream

Pobiera obiekt blob do strumienia z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami i metadanymi.

get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

stream

IOBase

Wymagane

Otwarty strumień do zapisu.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob do pobrania.

start_range

int

wartość domyślna: None

Początek zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

end_range

int

wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

validate_content

bool

wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części obiektu blob. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją signature (current, total), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar obiektu blob, jeśli jest znany.

max_connections

int

wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajtów obiektu blob. Jeśli jest to cały obiekt blob, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli wiele obiektów blob ma być pustych, ponieważ dodatkowe żądanie jest wymagane w przypadku pustych obiektów blob, jeśli max_connections jest większa niż 1.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

Odszyfrowuje 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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

Zwraca

Obiekt blob z właściwościami i metadanymi. Jeśli max_connections jest większa niż 1, content_md5 (jeśli jest ustawiona na obiekcie blob) nie zostanie zwrócona. Jeśli ta wartość jest wymagana, użyj get_blob_properties lub ustaw max_connections na 1.

Typ zwracany

Blob

get_blob_to_text

Pobiera obiekt blob jako tekst Unicode z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu Blob z właściwościami, metadanymi i zawartością.

get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

encoding

str

wartość domyślna: utf-8

Kodowanie języka Python używane podczas dekodowania danych obiektu blob.

snapshot

str

wartość domyślna: None

Parametr migawki jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa migawkę obiektu blob do pobrania.

start_range

int

wartość domyślna: None

Początek zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

end_range

int

wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji obiektu blob. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów obiektu blob.

validate_content

bool

wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części obiektu blob. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją signature (current, total), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar obiektu blob, jeśli jest znany.

max_connections

int

wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajtów obiektu blob. Jeśli jest to cały obiekt blob, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli wiele obiektów blob ma być pustych, ponieważ dodatkowe żądanie jest wymagane w przypadku pustych obiektów blob, jeśli max_connections jest większa niż 1.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

Odszyfrowuje 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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

Zwraca

Obiekt blob z właściwościami i metadanymi. Jeśli max_connections jest większa niż 1, content_md5 (jeśli jest ustawiona na obiekcie blob) nie zostanie zwrócona. Jeśli ta wartość jest wymagana, użyj get_blob_properties lub ustaw max_connections na 1.

Typ zwracany

Blob

get_container_acl

Pobiera uprawnienia dla określonego kontenera. Uprawnienia wskazują, czy dane kontenera mogą być dostępne publicznie.

get_container_acl(container_name, lease_id=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_id

wartość domyślna: None

Jeśli zostanie określony, get_container_acl powiedzie się tylko wtedy, gdy dzierżawa kontenera jest aktywna i jest zgodna z tym identyfikatorem.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Słownik zasad dostępu skojarzonych z kontenerem. dict of str to AccessPolicy i właściwość public_access, jeśli dostęp publiczny jest włączony

get_container_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego kontenera.

get_container_metadata(container_name, lease_id=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_id

str

wartość domyślna: None

Jeśli zostanie określony, get_container_metadata powiedzie się tylko wtedy, gdy dzierżawa kontenera jest aktywna i jest zgodna z tym identyfikatorem.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Słownik reprezentujący nazwę metadanych kontenera, pary wartości.

Typ zwracany

dict(str, str)

get_container_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego kontenera. Zwrócone dane nie zawierają listy obiektów blob kontenera.

get_container_properties(container_name, lease_id=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_id

str

wartość domyślna: None

Jeśli zostanie określony, get_container_properties powiedzie się tylko wtedy, gdy dzierżawa kontenera jest aktywna i jest zgodna z tym identyfikatorem.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

właściwości określonego kontenera w obiekcie kontenera.

Typ zwracany

Container

get_user_delegation_key

Uzyskaj klucz delegowania użytkownika na potrzeby podpisywania tokenów SAS. Poświadczenia tokenu muszą być obecne w obiekcie usługi, aby to żądanie powiodło się.

get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)

Parametry

key_start_time

datetime

Wymagane

Wartość typu Data/godzina. Wskazuje, kiedy klucz staje się prawidłowy.

key_expiry_time

datetime

Wymagane

Wartość typu Data/godzina. Wskazuje, kiedy klucz przestanie być prawidłowy.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Klucz delegowania użytkownika.

Typ zwracany

UserDelegationKey

list_blob_names

Zwraca generator, aby wyświetlić listę nazw obiektów blob w określonym kontenerze. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po zwróceniu wszystkich obiektów blob lub osiągnięciu num_results.

Jeśli określono num_results i konto ma więcej niż określoną liczbę obiektów blob, po zakończeniu generator będzie miał wypełnione pole next_marker. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

prefix

str

wartość domyślna: None

Filtruje wyniki, aby zwracać tylko obiekty blob, których nazwy zaczynają się od określonego prefiksu.

num_results

int

wartość domyślna: None

Określa maksymalną liczbę obiektów blob do zwrócenia, łącznie ze wszystkimi <xref:azure.storage.blob.baseblobservice.BlobPrefix> elementami. Jeśli żądanie nie określi num_results lub określa wartość większą niż 5000, serwer zwróci do 5000 elementów. Ustawienie num_results wartości mniejszej lub równej zero powoduje wyświetlenie kodu odpowiedzi błędu 400 (Nieprawidłowe żądanie).

include

Include

wartość domyślna: None

Określa co najmniej jeden dodatkowy zestaw danych do uwzględnienia w odpowiedzi.

delimiter

str

wartość domyślna: None

Gdy żądanie zawiera ten parametr, operacja zwraca BlobPrefix element na liście wyników, który działa jako symbol zastępczy dla wszystkich obiektów blob, których nazwy zaczynają się od tego samego podciągu aż do wyglądu znaku ogranicznika. Ogranicznik może być pojedynczym znakiem lub ciągiem.

marker

str

wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli określono num_results i że generator zakończył wyliczanie wyników. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników z punktu, w którym poprzedni generator zatrzymał.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

list_blobs

Zwraca generator, aby wyświetlić listę obiektów blob w określonym kontenerze. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po zwróceniu wszystkich obiektów blob lub osiągnięciu num_results.

Jeśli określono num_results i konto ma więcej niż określoną liczbę obiektów blob, po zakończeniu generator będzie miał wypełnione pole next_marker. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

prefix

str

wartość domyślna: None

Filtruje wyniki, aby zwracać tylko obiekty blob, których nazwy zaczynają się od określonego prefiksu.

num_results

int

wartość domyślna: None

Określa maksymalną liczbę obiektów blob do zwrócenia, łącznie ze wszystkimi <xref:azure.storage.blob.baseblobservice.BlobPrefix> elementami. Jeśli żądanie nie określi num_results lub określa wartość większą niż 5000, serwer zwróci do 5000 elementów. Ustawienie num_results wartości mniejszej lub równej zero powoduje wyświetlenie kodu odpowiedzi błędu 400 (Nieprawidłowe żądanie).

include

Include

wartość domyślna: None

Określa co najmniej jeden dodatkowy zestaw danych do uwzględnienia w odpowiedzi.

delimiter

str

wartość domyślna: None

Gdy żądanie zawiera ten parametr, operacja zwraca BlobPrefix element na liście wyników, który działa jako symbol zastępczy dla wszystkich obiektów blob, których nazwy zaczynają się od tego samego podciągu aż do wyglądu znaku ogranicznika. Ogranicznik może być pojedynczym znakiem lub ciągiem.

marker

str

wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli określono num_results i że generator zakończył wyliczanie wyników. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników z punktu, w którym poprzedni generator zatrzymał.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

list_containers

Zwraca generator, aby wyświetlić listę kontenerów w ramach określonego konta. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po powrocie wszystkich kontenerów lub osiągnięciu num_results.

Jeśli określono num_results i konto ma więcej niż określoną liczbę kontenerów, po zakończeniu generator będzie miał wypełnione pole next_marker. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)

Parametry

prefix

str

wartość domyślna: None

Filtruje wyniki, aby zwracać tylko kontenery, których nazwy zaczynają się od określonego prefiksu.

num_results

int

wartość domyślna: None

Określa maksymalną liczbę kontenerów do zwrócenia. Żądanie pojedynczej listy może zwrócić maksymalnie 1000 contianers i potencjalnie token kontynuacji, który należy wykonać w celu uzyskania dodatkowych ponownych zmian.

include_metadata

bool

wartość domyślna: False

Określa, że metadane kontenera mają być zwracane w odpowiedzi.

marker

str

wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli określono num_results i że generator zakończył wyliczanie wyników. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników z punktu, w którym poprzedni generator zatrzymał.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

make_blob_url

Tworzy adres URL w celu uzyskania dostępu do obiektu blob.

make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera.

blob_name

str

Wymagane

Nazwa obiektu blob.

protocol

str

wartość domyślna: None

Protokół do użycia: "http" lub "https". Jeśli nie zostanie określony, użyje protokołu określonego podczas inicjowania usługi BaseBlobService.

sas_token

str

wartość domyślna: None

Token sygnatury dostępu współdzielonego utworzony za pomocą generate_shared_access_signature.

snapshot

str

wartość domyślna: None

Wartość ciągu, która unikatowo identyfikuje migawkę. Wartość tego parametru zapytania wskazuje wersję migawki.

Zwraca

Adres URL dostępu do obiektów blob.

Typ zwracany

str

make_container_url

Tworzy adres URL w celu uzyskania dostępu do kontenera.

make_container_url(container_name, protocol=None, sas_token=None)

Parametry

container_name

str

Wymagane

Nazwa kontenera.

protocol

str

wartość domyślna: None

Protokół do użycia: "http" lub "https". Jeśli nie zostanie określony, użyje protokołu określonego podczas inicjowania usługi BaseBlobService.

sas_token

str

wartość domyślna: None

Token sygnatury dostępu współdzielonego utworzony za pomocą generate_shared_access_signature.

Zwraca

adres URL dostępu do kontenera.

Typ zwracany

str

release_blob_lease

Zwalnia dzierżawę. Dzierżawa może zostać zwolniona, jeśli identyfikator dzierżawy określony w żądaniu jest zgodny z elementem skojarzonym z obiektem blob. Zwolnienie dzierżawy umożliwia innemu klientowi natychmiastowe uzyskanie dzierżawy dla obiektu blob natychmiast po zakończeniu wydania.

release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

lease_id

str

Wymagane

Identyfikator dzierżawy dla aktywnej dzierżawy.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

release_container_lease

Zwolnij dzierżawę. Dzierżawa może zostać zwolniona, jeśli określona lease_id jest zgodna z kontenerem skojarzonym z kontenerem. Zwolnienie dzierżawy umożliwia innemu klientowi natychmiastowe uzyskanie dzierżawy dla kontenera zaraz po zakończeniu wydania.

release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_id

str

Wymagane

Identyfikator dzierżawy dla aktywnej dzierżawy.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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 UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

renew_blob_lease

Odnawia dzierżawę. Dzierżawę można odnowić, jeśli identyfikator dzierżawy określony na żądaniu jest zgodny z obiektem blob skojarzonym z obiektem blob. Należy pamiętać, że dzierżawa może zostać odnowiona nawet wtedy, gdy obiekt blob nie został zmodyfikowany lub dzierżawiony ponownie od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy zostanie zresetowany.

renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

lease_id

str

Wymagane

Identyfikator dzierżawy dla aktywnej dzierżawy.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, i nie powiedzie się operacji, jeśli istnieje.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Str

renew_container_lease

Odnawia dzierżawę. Dzierżawę można odnowić, jeśli określony identyfikator dzierżawy jest zgodny z kontenerem skojarzonym z kontenerem. Należy pamiętać, że dzierżawa może zostać odnowiona, nawet jeśli wygasła, o ile kontener nie został ponownie dzierżawiony od czasu wygaśnięcia tej dzierżawy. Po odnowieniu dzierżawy czas trwania dzierżawy zostanie zresetowany.

renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

lease_id

str

Wymagane

Identyfikator dzierżawy dla aktywnej dzierżawy.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Str

set_blob_metadata

Ustawia metadane zdefiniowane przez użytkownika dla określonego obiektu blob jako jedną lub więcej par name-value.

set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

metadata

dict(str, str)

wartość domyślna: None

Dict zawierający pary nazw i wartości. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do obiektu blob. Aby usunąć wszystkie metadane z obiektu blob, wywołaj tę operację bez nagłówków metadanych.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, i nie powiedzie się operacji, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

ETag i ostatnio zmodyfikowane właściwości zaktualizowanego obiektu blob

Typ zwracany

ResourceProperties

set_blob_properties

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_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

content_settings

ContentSettings

wartość domyślna: None

Obiekt ContentSettings używany do ustawiania właściwości obiektu blob.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, i nie powiedzie się operacji, jeśli istnieje.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

ETag i ostatnio zmodyfikowane właściwości zaktualizowanego obiektu blob

Typ zwracany

ResourceProperties

set_blob_service_properties

Ustawia właściwości usługi Blob service konta magazynu, w tym usługi Azure analityka magazynu. Jeśli element (np. rejestrowanie) jest pozostawiony jako Brak, istniejące ustawienia usługi dla tej funkcji zostaną zachowane.

set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)

Parametry

logging

Logging

wartość domyślna: None

Grupuje ustawienia rejestrowania usługi Azure Analytics.

hour_metrics

Metrics

wartość domyślna: None

Ustawienia metryk godzin zawierają podsumowanie statystyk żądań pogrupowanych według interfejsu API w agregacjach godzinowych dla obiektów blob.

minute_metrics

Metrics

wartość domyślna: None

Ustawienia metryk minut zapewniają statystyki żądań dla każdej minuty dla obiektów blob.

cors

list(CorsRule)

wartość domyślna: None

Na liście można uwzględnić maksymalnie pięć elementów CorsRule. Jeśli zostanie określona pusta lista, wszystkie reguły CORS zostaną usunięte, a mechanizm CORS zostanie wyłączony dla usługi.

target_version

str

wartość domyślna: None

Wskazuje domyślną wersję, która ma być używana dla żądań, jeśli nie określono wersji żądania przychodzącego.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

delete_retention_policy

DeleteRetentionPolicy

wartość domyślna: None

Zasady przechowywania usuwania określają, czy zachować usunięte obiekty blob. Określa również liczbę dni i wersje obiektu blob, które mają być zachowywane.

static_website

StaticWebsite

wartość domyślna: None

Określa, czy funkcja statycznej witryny internetowej jest włączona, a jeśli tak, wskazuje dokument indeksu i dokument o błędzie 404 do użycia.

set_container_acl

Ustawia uprawnienia dla określonego kontenera lub przechowywanych zasad dostępu, które mogą być używane z sygnaturami dostępu współdzielonego. Uprawnienia wskazują, czy obiekty blob w kontenerze mogą być dostępne publicznie.

set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

signed_identifiers

dict(str, AccessPolicy)

wartość domyślna: None

Słownik zasad dostępu do skojarzenia z kontenerem. Słownik może zawierać maksymalnie 5 elementów. Pusty słownik wyczyści zasady dostępu ustawione w usłudze.

public_access

PublicAccess

wartość domyślna: None

Możliwe wartości to: kontener, obiekt blob.

lease_id

str

wartość domyślna: None

Jeśli zostanie określony, set_container_acl powiedzie się tylko wtedy, gdy dzierżawa kontenera jest aktywna i jest zgodna z tym identyfikatorem.

if_modified_since

datetime

wartość domyślna: None

Wartość daty/godziny. 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ślonej daty/godziny.

if_unmodified_since

datetime

wartość domyślna: None

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

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

ETag i ostatnio zmodyfikowane właściwości zaktualizowanego kontenera

Typ zwracany

ResourceProperties

set_container_metadata

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego kontenera. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do kontenera. Aby usunąć wszystkie metadane z kontenera, wywołaj tę operację bez dyktowania metadanych.

set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

metadata

dict(str, str)

wartość domyślna: None

Dykt zawierający pary name-value do skojarzenia z kontenerem jako metadane. Przykład: {'category':'test'}

lease_id

str

wartość domyślna: None

Jeśli zostanie określony, set_container_metadata powiedzie się tylko wtedy, gdy dzierżawa kontenera jest aktywna i jest zgodna z tym identyfikatorem.

if_modified_since

datetime

wartość domyślna: None

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.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

ETag i ostatnio zmodyfikowane właściwości zaktualizowanego kontenera

Typ zwracany

ResourceProperties

set_proxy

Ustawia hosta i port serwera proxy dla tunelowania HTTP CONNECT.

set_proxy(host, port, user=None, password=None)

Parametry

host

str

Wymagane

Adres serwera proxy. Na przykład: "192.168.0.100"

port

int

Wymagane

Port serwera proxy. Na przykład: 6000

user

str

wartość domyślna: None

Użytkownik na potrzeby autoryzacji serwera proxy.

password

str

wartość domyślna: None

Hasło do autoryzacji serwera proxy.

snapshot_blob

Tworzy migawkę obiektu blob tylko do odczytu.

snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

metadata

dict(str, str)

wartość domyślna: None

Określa parę nazwa-wartość zdefiniowaną przez użytkownika skojarzona z obiektem blob. Jeśli nie określono żadnych par name-value, operacja skopiuje podstawowe metadane obiektu blob do migawki. Jeśli zostanie określona co najmniej jedna para nazwa-wartość, migawka zostanie utworzona z określonymi metadanymi, a metadane nie zostaną skopiowane z podstawowego obiektu blob.

if_modified_since

datetime

wartość domyślna: None

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ść domyślna: None

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.

if_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (*). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu jest zgodny z określoną wartością.

if_none_match

str

wartość domyślna: None

Wartość elementu ETag lub symbol wieloznaczny (). Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy element ETag zasobu nie jest zgodny z określoną wartością. Określ symbol wieloznaczny (), aby wykonać operację tylko wtedy, gdy zasób nie istnieje, a operacja zakończy się niepowodzeniem, jeśli istnieje.

lease_id

str

wartość domyślna: None

Wymagane, jeśli obiekt blob ma aktywną dzierżawę.

cpk

CustomerProvidedEncryptionKey

wartość domyślna: None

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

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

właściwości migawki

Typ zwracany

Blob

undelete_blob

Operacja cofania usuwania obiektu blob przywraca zawartość i metadane nietrwałego usuniętego obiektu blob lub migawki. Próba cofnięcia usunięcia obiektu blob lub migawki, która nie zostanie usunięta nietrwale, powiedzie się bez żadnych zmian.

undelete_blob(container_name, blob_name, timeout=None)

Parametry

container_name

str

Wymagane

Nazwa istniejącego kontenera.

blob_name

str

Wymagane

Nazwa istniejącego obiektu blob.

timeout

int

wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Atrybuty

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432