BlobServiceClient Klasa

Klient do interakcji z usługą Blob Service na poziomie konta.

Ten klient udostępnia operacje pobierania i konfigurowania właściwości konta, a także listy, tworzenia i usuwania kontenerów w ramach konta. W przypadku operacji związanych z określonym kontenerem lub obiektem blob klienci dla tych jednostek mogą być również pobierane przy użyciu funkcji get_client .

Aby uzyskać więcej opcjonalnych konfiguracji, kliknij tutaj.

Dziedziczenie

azure.storage.blob._shared.base_client.StorageAccountHostsMixin

BlobServiceClient

azure.storage.blob._encryption.StorageEncryptionMixin

BlobServiceClient

Konstruktor

BlobServiceClient(account_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parametry

account_url

str

Wymagane

Adres URL konta magazynu obiektów blob. Wszystkie inne jednostki uwzględnione w ścieżce adresu URL (np. kontener lub obiekt blob) zostaną odrzucone. Ten adres URL można opcjonalnie uwierzytelnić przy użyciu tokenu SAS.

credential

wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być ciągiem tokenu sygnatury dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z elementu azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z klasy azure.identity. Jeśli identyfikator URI zasobu zawiera już token sygnatury dostępu współdzielonego, zostanie on zignorowany na rzecz jawnego poświadczenia

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

api_version

str

Wersja interfejsu API usługi Storage do użycia dla żądań. Wartość domyślna to najnowsza wersja usługi zgodna z bieżącym zestawem SDK. Ustawienie starszej wersji może spowodować zmniejszenie zgodności funkcji.

Nowość w wersji 12.2.0.

secondary_hostname

str

Nazwa hosta pomocniczego punktu końcowego.

max_block_size

int

Maksymalny rozmiar fragmentu do przekazywania blokowego obiektu blob we fragmentach. Domyślnie 41024 1024lub 4 MB.

max_single_put_size

int

Jeśli rozmiar obiektu blob jest mniejszy lub równy max_single_put_size, obiekt blob zostanie przekazany tylko z jednym żądaniem HTTP PUT. Jeśli rozmiar obiektu blob jest większy niż max_single_put_size, obiekt blob zostanie przekazany we fragmentach. Domyślnie 641024 1024lub 64 MB.

min_large_block_upload_threshold

int

Minimalny rozmiar fragmentu wymagany do korzystania z wydajnego algorytmu pamięci podczas przekazywania blokowego obiektu blob. Wartość domyślna to 41024 1024+1.

use_byte_buffer

bool

Użyj buforu bajtów do przekazywania blokowych obiektów blob. Wartość domyślna to False.

max_page_size

int

Maksymalny rozmiar fragmentu do przekazywania stronicowego obiektu blob. Domyślnie 41024 1024lub 4 MB.

max_single_get_size

int

Maksymalny rozmiar obiektu blob do pobrania w jednym wywołaniu, przekroczona część zostanie pobrana we fragmentach (może być równoległa). Domyślnie 321024 1024lub 32 MB.

max_chunk_get_size

int

Maksymalny rozmiar fragmentu używany do pobierania obiektu blob. Domyślnie 41024 1024lub 4 MB.

Metody

close	Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.
create_container	Tworzy nowy kontener na określonym koncie. Jeśli kontener o tej samej nazwie już istnieje, zostanie zgłoszony błąd ResourceExistsError. Ta metoda zwraca klienta, z którym można korzystać z nowo utworzonego kontenera.
delete_container	Oznacza określony kontener do usunięcia. Kontener i wszystkie zawarte w nim obiekty blob są później usuwane podczas odzyskiwania pamięci. Jeśli kontener nie zostanie znaleziony, zostanie zgłoszony błąd ResourceNotFoundError.
find_blobs_by_tags	Operacja Filtruj obiekty blob umożliwia obiektom wywołującym wyświetlanie listy obiektów blob we wszystkich kontenerach, których tagi pasują do danego wyrażenia wyszukiwania. Filtrowanie obiektów blob wyszukuje wszystkie kontenery na koncie magazynu, ale może być ograniczone w wyrażeniu do jednego kontenera.
from_connection_string	Utwórz obiekt BlobServiceClient na podstawie parametrów połączenia.
get_account_information	Pobiera informacje związane z kontem magazynu. Informacje można również pobrać, jeśli użytkownik ma sygnaturę dostępu współdzielonego do kontenera lub obiektu blob. Klucze w zwróconym słowniku obejmują "sku_name" i "account_kind".
get_blob_client	Pobierz klienta do interakcji z określonym obiektem blob. Obiekt blob nie musi jeszcze istnieć.
get_container_client	Pobierz klienta do interakcji z określonym kontenerem. Kontener nie musi już istnieć.
get_service_properties	Pobiera właściwości usługi Blob konta magazynu, w tym usługi Azure analityka magazynu.
get_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 dostępu 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, 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 jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.
get_user_delegation_key	Uzyskaj klucz delegowania użytkownika na potrzeby podpisywania tokenów SAS. Poświadczenie tokenu musi znajdować się w obiekcie usługi, aby to żądanie zakończyło się pomyślnie.
list_containers	Zwraca generator, aby wyświetlić listę kontenerów w ramach określonego konta. Generator będzie leniwie podążał za tokenami kontynuacji zwróconymi przez usługę i zatrzymał się po powrocie wszystkich kontenerów.
set_service_properties	Ustawia właściwości usługi Blob konta magazynu, w tym azure analityka magazynu. Jeśli element (np. analytics_logging) zostanie pozostawiony jako Brak, zostaną zachowane istniejące ustawienia usługi dla tej funkcji.
undelete_container	Przywraca kontener usunięty nietrwale. Operacja zakończy się powodzeniem tylko wtedy, gdy zostanie użyta w określonej liczbie dni ustawionej w zasadach przechowywania usuwania. Nowość w wersji 12.4.0: Ta operacja została wprowadzona w interfejsie API w wersji "2019-12-12".

close

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

close()

create_container

Tworzy nowy kontener na określonym koncie.

Jeśli kontener o tej samej nazwie już istnieje, zostanie zgłoszony błąd ResourceExistsError. Ta metoda zwraca klienta, z którym można korzystać z nowo utworzonego kontenera.

create_container(name: str, metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs) -> ContainerClient

Parametry

name

str

Wymagane

Nazwa kontenera do utworzenia.

metadata

dict(str, str)

Wymagane

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

public_access

str lub PublicAccess

Wymagane

Możliwe wartości to: "container", "blob".

container_encryption_scope

dict lub ContainerEncryptionScope

Określa domyślny zakres szyfrowania, który ma zostać ustawiony w kontenerze i będzie używany dla wszystkich przyszłych zapisów.

Nowość w wersji 12.2.0.

timeout

int

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

Typ zwracany

ContainerClient

delete_container

Oznacza określony kontener do usunięcia.

Kontener i wszystkie zawarte w nim obiekty blob są później usuwane podczas odzyskiwania pamięci. Jeśli kontener nie zostanie znaleziony, zostanie zgłoszony błąd ResourceNotFoundError.

delete_container(container: ContainerProperties | str, lease: BlobLeaseClient | str | None = None, **kwargs) -> None

Parametry

container

str lub ContainerProperties

Wymagane

Kontener do usunięcia. Może to być nazwa kontenera lub wystąpienie właściwości ContainerProperties.

lease

Wymagane

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

if_unmodified_since

datetime

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

etag

str

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

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu.

timeout

int

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

Typ zwracany

None

find_blobs_by_tags

Operacja Filtruj obiekty blob umożliwia obiektom wywołującym wyświetlanie listy obiektów blob we wszystkich kontenerach, których tagi pasują do danego wyrażenia wyszukiwania. Filtrowanie obiektów blob wyszukuje wszystkie kontenery na koncie magazynu, ale może być ograniczone w wyrażeniu do jednego kontenera.

find_blobs_by_tags(filter_expression: str, **kwargs: Any) -> ItemPaged[FilteredBlob]

Parametry

filter_expression

str

Wymagane

Wyrażenie do znajdowania obiektów blob, których tagi są zgodne z określonym warunkiem. np. "yourtagname"='firsttag' i "yourtagname2"='secondtag'" Aby określić kontener, np. "@container='containerName" i "Name"='C'"

results_per_page

int

Maksymalny wynik na stronę podczas stronicowania.

timeout

int

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

Zwraca

Iterowalne (automatyczne stronicowanie) odpowiedź obiektu BlobProperties.

Typ zwracany

ItemPaged[FilteredBlob]

from_connection_string

Utwórz obiekt BlobServiceClient na podstawie parametrów połączenia.

from_connection_string(conn_str: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametry

conn_str

str

Wymagane

Parametry połączenia z kontem usługi Azure Storage.

credential

wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token sygnatury dostępu współdzielonego lub parametry połączenia mają już wartości klucza dostępu współdzielonego. Wartość może być ciągiem tokenu sygnatury dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z elementu azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z klasy azure.identity. Poświadczenia podane w tym miejscu będą miały pierwszeństwo przed tymi w parametrach połączenia. Jeśli używasz wystąpienia elementu AzureNamedKeyCredential, wartość "name" powinna być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.

Zwraca

Klient usługi Blob Service.

Typ zwracany

BlobServiceClient

get_account_information

Pobiera informacje związane z kontem magazynu.

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

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

Zwraca

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

Typ zwracany

dict(str, str)

get_blob_client

Pobierz klienta do interakcji z określonym obiektem blob.

Obiekt blob nie musi jeszcze istnieć.

get_blob_client(container: ContainerProperties | str, blob: BlobProperties | str, snapshot: Dict[str, Any] | str | None = None, *, version_id: str | None = None) -> BlobClient

Parametry

container

str lub ContainerProperties

Wymagane

Kontener, w ramach którego znajduje się obiekt blob. Może to być nazwa kontenera lub wystąpienie właściwości ContainerProperties.

blob

str lub BlobProperties

Wymagane

Obiekt blob, z którym można korzystać. Może to być nazwa obiektu blob lub wystąpienie obiektu BlobProperties.

snapshot

str lub dict(str, Any)

wartość domyślna: None

Opcjonalna migawka obiektu blob, na której ma działać. Może to być identyfikator migawki lub dane wyjściowe słownika zwrócone przez polecenie create_snapshot.

version_id

str

Parametr identyfikatora wersji jest nieprzezroczystą wartością DateTime, która w chwili obecnej określa wersję obiektu blob do działania.

Zwraca

Obiekt BlobClient.

Typ zwracany

BlobClient

get_container_client

Pobierz klienta do interakcji z określonym kontenerem.

Kontener nie musi już istnieć.

get_container_client(container: ContainerProperties | str) -> ContainerClient

Parametry

container

str lub ContainerProperties

Wymagane

Kontener. Może to być nazwa kontenera lub wystąpienie właściwości ContainerProperties.

Zwraca

KontenerClient.

Typ zwracany

ContainerClient

get_service_properties

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

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

Parametry

timeout

int

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

Zwraca

Obiekt zawierający właściwości usługi blob, takie jak rejestrowanie analiz, metryki godziny/minuty, reguły cors itp.

Typ zwracany

Dict[str, Any]

get_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 dostępu 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, 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 jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.

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

Parametry

timeout

int

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

Zwraca

Statystyki usługi blob.

Typ zwracany

Dict[str, Any]

get_user_delegation_key

Uzyskaj klucz delegowania użytkownika na potrzeby podpisywania tokenów SAS. Poświadczenie tokenu musi znajdować się w obiekcie usługi, aby to żądanie zakończyło się pomyślnie.

get_user_delegation_key(key_start_time: datetime, key_expiry_time: datetime, **kwargs: Any) -> UserDelegationKey

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 przestaje być prawidłowy.

timeout

int

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

Zwraca

Klucz delegowania użytkownika.

Typ zwracany

UserDelegationKey

list_containers

Zwraca generator, aby wyświetlić listę kontenerów w ramach określonego konta.

Generator będzie leniwie podążał za tokenami kontynuacji zwróconymi przez usługę i zatrzymał się po powrocie wszystkich kontenerów.

list_containers(name_starts_with: str | None = None, include_metadata: bool | None = False, **kwargs) -> ItemPaged[ContainerProperties]

Parametry

name_starts_with

str

Wymagane

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

include_metadata

bool

Wymagane

Określa, że metadane kontenera mają być zwracane w odpowiedzi. Wartość domyślna to False.

include_deleted

bool

Określa, że usunięte kontenery mają być zwracane w odpowiedzi. Dotyczy to konta z włączoną obsługą przywracania kontenerów. Wartość domyślna to False. .. versionadded:: 12.4.0

include_system

bool

Flaga określająca, że należy uwzględnić kontenery systemowe. .. versionadded:: 12.10.0

results_per_page

int

Maksymalna liczba nazw kontenerów do pobrania na wywołanie interfejsu API. Jeśli żądanie nie określi serwera, zwróci maksymalnie 5000 elementów.

timeout

int

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

Zwraca

Iterowalne (automatyczne stronicowanie) właściwości ContainerProperties.

Typ zwracany

ItemPaged[ContainerProperties]

set_service_properties

Ustawia właściwości usługi Blob konta magazynu, w tym azure analityka magazynu.

Jeśli element (np. analytics_logging) zostanie pozostawiony jako Brak, zostaną zachowane istniejące ustawienia usługi dla tej funkcji.

set_service_properties(analytics_logging: BlobAnalyticsLogging | None = None, hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, target_version: str | None = None, delete_retention_policy: RetentionPolicy | None = None, static_website: StaticWebsite | None = None, **kwargs) -> None

Parametry

analytics_logging

BlobAnalyticsLogging

Wymagane

Grupuje ustawienia rejestrowania usługi Azure Analytics.

hour_metrics

Metrics

Wymagane

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

minute_metrics

Metrics

Wymagane

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

cors

list[CorsRule]

Wymagane

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

Wymagane

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

delete_retention_policy

RetentionPolicy

Wymagane

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

static_website

StaticWebsite

Wymagane

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.

timeout

int

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

Typ zwracany

None

undelete_container

Przywraca kontener usunięty nietrwale.

Operacja zakończy się powodzeniem tylko wtedy, gdy zostanie użyta w określonej liczbie dni ustawionej w zasadach przechowywania usuwania.

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

undelete_container(deleted_container_name: str, deleted_container_version: str, **kwargs: Any) -> ContainerClient

Parametry

deleted_container_name

str

Wymagane

Określa nazwę usuniętego kontenera do przywrócenia.

deleted_container_version

str

Wymagane

Określa wersję usuniętego kontenera do przywrócenia.

timeout

int

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

Zwraca

Nieukończony element ContainerClient.

Typ zwracany

ContainerClient

Atrybuty

api_version

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

location_mode

Tryb lokalizacji używany przez klienta.

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

primary_endpoint

Pełny podstawowy adres URL punktu końcowego.

primary_hostname

Nazwa hosta podstawowego punktu końcowego.

secondary_endpoint

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

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

Wyjątki

ValueError

secondary_hostname

Nazwa hosta pomocniczego punktu końcowego.

Jeśli ta opcja nie będzie dostępna, będzie to Brak. Aby jawnie określić pomocniczą nazwę hosta, użyj opcjonalnego argumentu słowa kluczowego secondary_hostname wystąpienia.

url

Pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany.

Może to być podstawowy punkt końcowy lub pomocniczy punkt końcowy w zależności od bieżącego location_modeelementu . :zwraca: pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany. :rtype: str