Sdílet prostřednictvím


ContainerClient Třída

Klient pro interakci s konkrétním kontejnerem, i když tento kontejner ještě nemusí existovat.

Pro operace související s konkrétním objektem blob v rámci tohoto kontejneru je možné klienta objektů blob načíst pomocí get_blob_client funkce .

Další volitelnou konfiguraci potřebujete kliknutím sem.

Dědičnost
azure.storage.blob._shared.base_client.StorageAccountHostsMixin
ContainerClient
azure.storage.blob._encryption.StorageEncryptionMixin
ContainerClient

Konstruktor

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

Parametry

account_url
str
Vyžadováno

Identifikátor URI účtu úložiště Pokud chcete vytvořit klienta s úplným identifikátorem URI kontejneru, použijte metodu from_container_url třídy .

container_name
str
Vyžadováno

Název kontejneru objektu blob.

credential
výchozí hodnota: None

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už token SAS má. Hodnotou může být řetězec tokenu SAS, instance AzureSasCredential nebo AzureNamedKeyCredential z azure.core.credentials, sdílený přístupový klíč účtu nebo instance třídy TokenCredentials z azure.identity. Pokud identifikátor URI prostředku už obsahuje token SAS, bude se tento token ignorovat ve prospěch explicitních přihlašovacích údajů.

  • s výjimkou případu AzureSasCredential, kde konfliktní tokeny SAS způsobí chybu ValueError. Pokud používáte instanci AzureNamedKeyCredential, název by měl být název účtu úložiště a klíč by měl být klíč účtu úložiště.
api_version
str

Verze rozhraní API služby Storage, která se má použít pro požadavky. Výchozí hodnota je nejnovější verze služby, která je kompatibilní s aktuální sadou SDK. Nastavení na starší verzi může mít za následek snížení kompatibility funkcí.

Novinka ve verzi 12.2.0.

secondary_hostname
str

Název hostitele sekundárního koncového bodu.

max_block_size
int

Maximální velikost bloku pro nahrání objektu blob bloku v blocích. Výchozí hodnota je 4*1024*1024 nebo 4 MB.

max_single_put_size
int

Pokud je velikost objektu blob menší nebo rovna max_single_put_size, pak se objekt blob nahraje jenom s jedním požadavkem HTTP PUT. Pokud je velikost objektu blob větší než max_single_put_size, nahraje se objekt blob v blocích. Výchozí hodnota je 64*1024*1024 nebo 64 MB.

min_large_block_upload_threshold
int

Minimální velikost bloku potřebné k použití algoritmu efektivního z hlediska paměti při nahrávání objektu blob bloku. Výchozí hodnota je 4*1024*1024+1.

use_byte_buffer
bool

Pro nahrávání objektů blob bloku použijte vyrovnávací paměť bajtů. Výchozí hodnota je False.

max_page_size
int

Maximální velikost bloků dat pro nahrání objektu blob stránky Výchozí hodnota je 4*1024*1024 nebo 4 MB.

max_single_get_size
int

Maximální velikost objektu blob ke stažení při jednom volání, překročená část se stáhne v blocích (může být paralelní). Výchozí hodnota je 32*1024*1024 nebo 32 MB.

max_chunk_get_size
int

Maximální velikost bloku dat použitá ke stažení objektu blob. Výchozí hodnota je 4*1024*1024 nebo 4 MB.

Metody

acquire_lease

Požádá o nové zapůjčení. Pokud kontejner nemá aktivní zapůjčení, služba Blob Service vytvoří zapůjčení kontejneru a vrátí nové ID zapůjčení.

close

Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.

create_container

Vytvoří nový kontejner pod zadaným účtem. Pokud kontejner se stejným názvem již existuje, operace selže.

delete_blob

Označí zadaný objekt blob nebo snímek pro odstranění.

Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obě operace můžete odstranit současně s operací delete_blob.

Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace obnovitelné odstraní objekt blob nebo snímek a zachová objekt blob nebo snímek po zadaný počet dnů. Po zadaném počtu dnů se data objektu blob odeberou ze služby během uvolňování paměti. Obnovitelně odstraněný objekt blob nebo snímek jsou přístupné prostřednictvím list_blobs možnosti include=["deleted"]. Obnovitelně odstraněný objekt blob nebo snímek je možné obnovit pomocí <xref:azure.storage.blob.BlobClient.undelete>

delete_blobs

Označí zadané objekty blob nebo snímky k odstranění.

Objekty blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekty blob, musíte odstranit všechny jejich snímky. Obě operace můžete odstranit současně s operací delete_blobs.

Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace obnovitelné odstranění objektů blob nebo snímků a uchovávání objektů blob nebo snímků po zadaný počet dnů. Po zadaném počtu dnů se data objektů blob odeberou ze služby během uvolňování paměti. Obnovitelně odstraněné objekty blob nebo snímky jsou přístupné zadáním list_blobspříkazu include=["deleted"] Obnovitelně odstraněné objekty blob nebo snímky je možné obnovit pomocí <xref:azure.storage.blob.BlobClient.undelete>

Maximální počet objektů blob, které je možné odstranit v jednom požadavku, je 256.

delete_container

Označí zadaný kontejner pro odstranění. Kontejner a všechny objekty blob v něm obsažené se později odstraní během uvolňování paměti.

download_blob

Stáhne objekt blob do StorageStreamDownloaderu. Ke čtení veškerého obsahu se musí použít metoda readall(), nebo se musí použít metoda readinto() ke stažení objektu blob do datového proudu. Funkce chunks() vrátí iterátor, který uživateli umožňuje iterovat obsah v blocích.

exists

Vrátí hodnotu True, pokud kontejner existuje, a v opačném případě vrátí hodnotu False.

find_blobs_by_tags

Vrátí generátor pro výpis objektů blob v zadaném kontejneru, jehož značky odpovídají danému vyhledávacímu výrazu. Generátor bude líně sledovat tokeny pokračování vrácené službou.

from_connection_string

Vytvořte ContainerClient z připojovacího řetězce.

from_container_url

Vytvořte ContainerClient z adresy URL kontejneru.

get_account_information

Získá informace související s účtem úložiště.

Informace je možné načíst také v případě, že má uživatel sas ke kontejneru nebo objektu blob. Mezi klíče ve vráceném slovníku patří "sku_name" a "account_kind".

get_blob_client

Získejte klienta pro interakci se zadaným objektem blob.

Objekt blob ještě nemusí existovat.

get_container_access_policy

Získá oprávnění pro zadaný kontejner. Oprávnění označují, jestli je možné veřejně přistupovat k datům kontejneru.

get_container_properties

Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadaný kontejner. Vrácená data nezahrnují seznam objektů blob kontejneru.

list_blob_names

Vrátí generátor pro výpis názvů objektů blob v zadaném kontejneru. Generátor bude líně sledovat tokeny pokračování vrácené službou.

Všimněte si, že při použití tohoto rozhraní API nebudou vráceny žádné další vlastnosti ani metadata. Kromě toho toto rozhraní API nemá možnost zahrnout další objekty blob, jako jsou snímky, verze, obnovitelné odstraněné objekty blob atd. Pokud chcete získat některá z těchto dat, použijte list_blobs.

list_blobs

Vrátí generátor pro výpis objektů blob v zadaném kontejneru. Generátor bude líně sledovat tokeny pokračování vrácené službou.

set_container_access_policy

Nastaví oprávnění pro zadaný kontejner nebo uložené zásady přístupu, které se můžou použít se sdílenými přístupovými podpisy. Oprávnění označují, jestli je možné k objektům blob v kontejneru přistupovat veřejně.

set_container_metadata

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadaný kontejner. Každé volání této operace nahradí všechna existující metadata připojená ke kontejneru. Pokud chcete z kontejneru odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.

set_premium_page_blob_tier_blobs

Nastaví úrovně objektů blob stránky na všech objektech blob. Toto rozhraní API se podporuje jenom pro objekty blob stránky na účtech Premium.

Maximální počet objektů blob, které je možné aktualizovat v jednom požadavku, je 256.

set_standard_blob_tier_blobs

Tato operace nastaví úroveň objektů blob bloku.

Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob.

Maximální počet objektů blob, které je možné aktualizovat v jednom požadavku, je 256.

upload_blob

Vytvoří nový objekt blob ze zdroje dat s automatickým dělením bloků dat.

walk_blobs

Vrátí generátor pro výpis objektů blob v zadaném kontejneru. Generátor bude líně sledovat tokeny pokračování vrácené službou. Tato operace vypíše objekty blob v souladu s hierarchií oddělenou zadaným znakem oddělovače.

acquire_lease

Požádá o nové zapůjčení. Pokud kontejner nemá aktivní zapůjčení, služba Blob Service vytvoří zapůjčení kontejneru a vrátí nové ID zapůjčení.

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

Parametry

lease_duration
int
Vyžadováno

Určuje dobu zapůjčení v sekundách nebo zápornou (-1) pro zapůjčení, jehož platnost nikdy nevyprší. Nenekonečná zapůjčení může být 15 až 60 sekund. Dobu zapůjčení nelze změnit pomocí obnovení nebo změny. Výchozí hodnota je -1 (nekonečné zapůjčení).

lease_id
str
Vyžadováno

Navrhované ID zapůjčení ve formátu řetězce GUID Pokud navrhované ID zapůjčení není ve správném formátu, vrátí služba Blob Service hodnotu 400 (Neplatný požadavek).

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k chování podle podmínky zadané parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Objekt BlobLeaseClient, který lze spustit ve správci kontextu.

Návratový typ

close

Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.

close()

create_container

Vytvoří nový kontejner pod zadaným účtem. Pokud kontejner se stejným názvem již existuje, operace selže.

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

Parametry

metadata
dict[str, str]
Vyžadováno

Dikt s name_value páry, které se přidružují ke kontejneru jako metadata. Příklad:{'Category':'test'}

public_access
PublicAccess
Vyžadováno

Mezi možné hodnoty patří kontejner, objekt blob.

container_encryption_scope
dict nebo ContainerEncryptionScope

Určuje výchozí obor šifrování, který se nastaví v kontejneru a použije se pro všechny budoucí zápisy.

Novinka ve verzi 12.2.0.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Slovník hlaviček odpovědi.

Návratový typ

delete_blob

Označí zadaný objekt blob nebo snímek pro odstranění.

Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obě operace můžete odstranit současně s operací delete_blob.

Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace obnovitelné odstraní objekt blob nebo snímek a zachová objekt blob nebo snímek po zadaný počet dnů. Po zadaném počtu dnů se data objektu blob odeberou ze služby během uvolňování paměti. Obnovitelně odstraněný objekt blob nebo snímek jsou přístupné prostřednictvím list_blobs možnosti include=["deleted"]. Obnovitelně odstraněný objekt blob nebo snímek je možné obnovit pomocí <xref:azure.storage.blob.BlobClient.undelete>

delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None

Parametry

blob
str nebo BlobProperties
Vyžadováno

Objekt blob, se kterým chcete pracovat. Pokud je tato hodnota zadaná, přepíše hodnotu objektu blob zadanou v adrese URL objektu blob.

delete_snapshots
str
Vyžadováno

Vyžaduje se, pokud má objekt blob přidružené snímky. Mezi tyto hodnoty patří:

  • "only": Odstraní pouze snímky objektů blob.

  • "include": Odstraní objekt blob spolu se všemi snímky.

version_id
str

Parametr id verze je neprůsažná hodnota DateTime, která pokud je k dispozici, určuje verzi objektu blob, který se má odstranit.

Novinka ve verzi 12.4.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2019-12-12.

lease
BlobLeaseClient nebo str

Vyžaduje se, pokud má objekt blob aktivní zapůjčení. Hodnota může být objekt BlobLeaseClient nebo ID zapůjčení jako řetězec.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k chování podle podmínky zadané parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.0.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

delete_blobs

Označí zadané objekty blob nebo snímky k odstranění.

Objekty blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekty blob, musíte odstranit všechny jejich snímky. Obě operace můžete odstranit současně s operací delete_blobs.

Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace obnovitelné odstranění objektů blob nebo snímků a uchovávání objektů blob nebo snímků po zadaný počet dnů. Po zadaném počtu dnů se data objektů blob odeberou ze služby během uvolňování paměti. Obnovitelně odstraněné objekty blob nebo snímky jsou přístupné zadáním list_blobspříkazu include=["deleted"] Obnovitelně odstraněné objekty blob nebo snímky je možné obnovit pomocí <xref:azure.storage.blob.BlobClient.undelete>

Maximální počet objektů blob, které je možné odstranit v jednom požadavku, je 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parametry

blobs
str nebo dict(str, Any) nebo BlobProperties
Vyžadováno

Objekty blob, které chcete odstranit. Může to být jeden objekt blob nebo může být zadáno více hodnot, přičemž každá hodnota je buď název objektu blob (str), nebo Objekt blobProperties.

Poznámka

Pokud je typ objektu blob dict, tady je seznam klíčů a pravidel hodnot.

název objektu blob:

key: 'name', value type: str

snímek, který chcete odstranit:

key: 'snapshot', typ hodnoty: str

ID verze:

key: 'version_id', typ hodnoty: str

jestli se mají odstranit snímky při odstraňování objektu blob:

key: "delete_snapshots", hodnota: "include" nebo "only"

pokud se objekt blob změnil nebo ne:

key: 'if_modified_since', 'if_unmodified_since', typ hodnoty: datetime

Etag:

key: 'etag', typ hodnoty: str

shodovat se značkou etag nebo ne:

key: 'match_condition', typ hodnoty: MatchConditions

podmínka shody značek:

key: 'if_tags_match_condition', typ hodnoty: str

Pronájem:

key: 'lease_id', typ hodnoty: Union[str, LeaseClient]

časový limit dílčího požadavku:

key: 'timeout', value type: int

delete_snapshots
str

Vyžaduje se, pokud má objekt blob přidružené snímky. Mezi tyto hodnoty patří:

  • "only": Odstraní pouze snímky objektů blob.

  • "include": Odstraní objekt blob spolu se všemi snímky.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.0.

raise_on_any_failure
bool

Toto je logický parametr, který má výchozí hodnotu True. Pokud je tato možnost nastavená, vyvolá se výjimka, i když dojde k selhání jedné operace.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Iterátor odpovědí, jeden pro každý objekt blob v pořadí

Návratový typ

delete_container

Označí zadaný kontejner pro odstranění. Kontejner a všechny objekty blob v něm obsažené se později odstraní během uvolňování paměti.

delete_container(**kwargs: Any) -> None

Parametry

lease
BlobLeaseClient nebo str

Pokud je zadáno, delete_container bude úspěšná jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID. Vyžaduje se, pokud má kontejner aktivní zapůjčení.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k chování podle podmínky zadané parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

download_blob

Stáhne objekt blob do StorageStreamDownloaderu. Ke čtení veškerého obsahu se musí použít metoda readall(), nebo se musí použít metoda readinto() ke stažení objektu blob do datového proudu. Funkce chunks() vrátí iterátor, který uživateli umožňuje iterovat obsah v blocích.

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

Parametry

blob
str nebo BlobProperties
Vyžadováno

Objekt blob, se kterým chcete pracovat. Pokud je tato hodnota zadaná, přepíše hodnotu objektu blob zadanou v adrese URL objektu blob.

offset
int
Vyžadováno

Začátek rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud je k dispozici délka, musí být nastavena.

length
int
Vyžadováno

Počet bajtů ke čtení ze streamu Tato možnost je volitelná, ale pro zajištění optimálního výkonu by měla být poskytována.

version_id
str

Parametr id verze je neprůselná hodnota DateTime, která pokud je k dispozici, určuje verzi objektu blob, který se má stáhnout.

Novinka ve verzi 12.4.0.

Tento argument klíčového slova byl zaveden ve verzi rozhraní API 2019-12-12.

validate_content
bool

Pokud ano, vypočítá hodnotu hash MD5 pro každý blok objektu blob. Služba úložiště zkontroluje hodnotu hash obsahu, která přišla s hodnotou hash, která byla odeslána. To je primárně užitečné pro detekci bitflips na drátu, pokud použijete http místo https, protože https (výchozí nastavení) už ověří. Všimněte si, že tato hodnota hash MD5 se s objektem blob neukládá. Všimněte si také, že pokud je povolená, algoritmus nahrávání efektivní z paměti se nepoužije, protože výpočet hodnoty hash MD5 vyžaduje ukládání do vyrovnávací paměti celých bloků, a tím se porazí účel algoritmu efektivního z hlediska paměti.

lease
BlobLeaseClient nebo str

Vyžaduje se, pokud má objekt blob aktivní zapůjčení. Pokud je zadáno, download_blob bude úspěšná jenom v případě, že je zapůjčení objektu blob aktivní a odpovídá tomuto ID. Hodnota může být objekt BlobLeaseClient nebo ID zapůjčení jako řetězec.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k chování podle podmínky zadané parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.0.

cpk
CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes HTTPS. Vzhledem k tomu, že v požadavku je k dispozici samotný šifrovací klíč, musí být pro přenos klíče navázáno zabezpečené připojení.

max_concurrency
int

Počet paralelních připojení ke stažení.

encoding
str

Kódování pro dekódování stažených bajtů. Výchozí hodnota je Žádný, tj. bez dekódování.

progress_hook
Callable[[int, int], None]

Zpětné volání pro sledování průběhu dlouhotrvajícího stahování. Podpis je function(current: int, total: int), kde current je počet dosud přenesených bajtů a total je celková velikost stahování.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady. Tato metoda může provádět více volání služby a časový limit bude platit pro každé volání zvlášť. více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť.

Návraty

Objekt streamování (StorageStreamDownloader)

Návratový typ

exists

Vrátí hodnotu True, pokud kontejner existuje, a v opačném případě vrátí hodnotu False.

exists(**kwargs: Any) -> bool

Parametry

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

boolean

Návratový typ

find_blobs_by_tags

Vrátí generátor pro výpis objektů blob v zadaném kontejneru, jehož značky odpovídají danému vyhledávacímu výrazu. Generátor bude líně sledovat tokeny pokračování vrácené službou.

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

Parametry

filter_expression
str
Vyžadováno

Výraz pro vyhledání objektů blob, jejichž značky odpovídají zadané podmínce. např. ""yourtagname"='firsttag' and "yourtagname2"='secondtag'"

results_per_page
int

Maximální výsledek na stránku při stránkování

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Iterovatelná (automaticky stránkovací) odpověď filteredBlob.

Návratový typ

from_connection_string

Vytvořte ContainerClient z připojovacího řetězce.

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

Parametry

conn_str
str
Vyžadováno

Připojovací řetězec k účtu služby Azure Storage.

container_name
str
Vyžadováno

Název kontejneru objektu blob.

credential
výchozí hodnota: None

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už má token SAS nebo připojovací řetězec už obsahuje hodnoty sdíleného přístupového klíče. Hodnotou může být řetězec tokenu SAS, instance AzureSasCredential nebo AzureNamedKeyCredential z azure.core.credentials, sdílený přístupový klíč účtu nebo instance třídy TokenCredentials z azure.identity. Zde zadané přihlašovací údaje budou mít přednost před přihlašovacími údaji v připojovacím řetězci. Pokud používáte instanci AzureNamedKeyCredential, název by měl být název účtu úložiště a klíč by měl být klíč účtu úložiště.

Návraty

Klient kontejneru.

Návratový typ

from_container_url

Vytvořte ContainerClient z adresy URL kontejneru.

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

Parametry

container_url
str
Vyžadováno

Úplná adresa URL koncového bodu kontejneru, včetně tokenu SAS, pokud je použit. V závislosti na aktuálním location_mode to může být buď primární koncový bod, nebo sekundární koncový bod.

credential
výchozí hodnota: None

Přihlašovací údaje, pomocí kterých se má ověřit. Tato možnost je volitelná, pokud adresa URL účtu už má token SAS nebo připojovací řetězec už obsahuje hodnoty sdíleného přístupového klíče. Hodnotou může být řetězec tokenu SAS, instance AzureSasCredential nebo AzureNamedKeyCredential z azure.core.credentials, sdílený přístupový klíč účtu nebo instance třídy TokenCredentials z azure.identity. Pokud identifikátor URI prostředku už obsahuje token SAS, bude se tento token ignorovat ve prospěch explicitních přihlašovacích údajů.

  • s výjimkou případu AzureSasCredential, kde konfliktní tokeny SAS způsobí chybu ValueError. Pokud používáte instanci AzureNamedKeyCredential, název by měl být název účtu úložiště a klíč by měl být klíč účtu úložiště.

Návraty

Klient kontejneru.

Návratový typ

get_account_information

Získá informace související s účtem úložiště.

Informace je možné načíst také v případě, že má uživatel sas ke kontejneru nebo objektu blob. Mezi klíče ve vráceném slovníku patří "sku_name" a "account_kind".

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

Návraty

Dikt informací o účtu (SKU a typ účtu).

Návratový typ

get_blob_client

Získejte klienta pro interakci se zadaným objektem blob.

Objekt blob ještě nemusí existovat.

get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient

Parametry

blob
str nebo BlobProperties
Vyžadováno

Objekt blob, se kterým chcete pracovat.

snapshot
str
výchozí hodnota: None

Volitelný snímek objektu blob, se kterým se má pracovat. Může to být řetězec ID snímku nebo odpověď vrácená z create_snapshot.

version_id
str

Parametr id verze je neprůselná hodnota DateTime, která pokud je k dispozici, určuje verzi objektu blob, se kterou se má pracovat.

Návraty

A BlobClient.

Návratový typ

get_container_access_policy

Získá oprávnění pro zadaný kontejner. Oprávnění označují, jestli je možné veřejně přistupovat k datům kontejneru.

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

Parametry

lease
BlobLeaseClient nebo str

Pokud je zadáno, get_container_access_policy bude úspěšná jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Přístup k informacím o zásadách v diktu

Návratový typ

get_container_properties

Vrátí všechna uživatelem definovaná metadata a systémové vlastnosti pro zadaný kontejner. Vrácená data nezahrnují seznam objektů blob kontejneru.

get_container_properties(**kwargs: Any) -> ContainerProperties

Parametry

lease
BlobLeaseClient nebo str

Pokud je zadáno, get_container_properties bude úspěšná jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Vlastnosti zadaného kontejneru v rámci objektu kontejneru.

Návratový typ

list_blob_names

Vrátí generátor pro výpis názvů objektů blob v zadaném kontejneru. Generátor bude líně sledovat tokeny pokračování vrácené službou.

Všimněte si, že při použití tohoto rozhraní API nebudou vráceny žádné další vlastnosti ani metadata. Kromě toho toto rozhraní API nemá možnost zahrnout další objekty blob, jako jsou snímky, verze, obnovitelné odstraněné objekty blob atd. Pokud chcete získat některá z těchto dat, použijte list_blobs.

list_blob_names(**kwargs: Any) -> ItemPaged[str]

Parametry

name_starts_with
str

Filtruje výsledky tak, aby vracely jenom objekty blob, jejichž názvy začínají zadanou předponou.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Iterovatelná odpověď (automatické stránkování) názvů objektů blob jako řetězců.

Návratový typ

list_blobs

Vrátí generátor pro výpis objektů blob v zadaném kontejneru. Generátor bude líně sledovat tokeny pokračování vrácené službou.

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

Parametry

name_starts_with
str
Vyžadováno

Filtruje výsledky tak, aby vracely jenom objekty blob, jejichž názvy začínají zadanou předponou.

include
list[str] nebo str
Vyžadováno

Určuje jednu nebo více dalších datových sad, které se mají zahrnout do odpovědi. Mezi možnosti patří snímky, metadata, uncommittedblobs, copy, deleted, deletedwithversions, tags, versions, immutabilitypolicy, legalhold.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Iterovatelná (automaticky stránkovací) odpověď objektu BlobProperties.

Návratový typ

set_container_access_policy

Nastaví oprávnění pro zadaný kontejner nebo uložené zásady přístupu, které se můžou použít se sdílenými přístupovými podpisy. Oprávnění označují, jestli je možné k objektům blob v kontejneru přistupovat veřejně.

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Parametry

signed_identifiers
dict[str, AccessPolicy]
Vyžadováno

Slovník zásad přístupu, který se má přidružit ke kontejneru. Slovník může obsahovat až 5 prvků. Prázdný slovník vymaže zásady přístupu nastavené ve službě.

public_access
PublicAccess
Vyžadováno

Mezi možné hodnoty patří kontejner, objekt blob.

lease
BlobLeaseClient nebo str

Vyžaduje se, pokud má kontejner aktivní zapůjčení. Hodnota může být objekt BlobLeaseClient nebo ID zapůjčení jako řetězec.

if_modified_since
datetime

Hodnota datetime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného data a času změněn.

if_unmodified_since
datetime

Hodnota datetime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Dikt vlastnosti aktualizovaného kontejneru (značka Etag a poslední změna)

Návratový typ

set_container_metadata

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadaný kontejner. Každé volání této operace nahradí všechna existující metadata připojená ke kontejneru. Pokud chcete z kontejneru odebrat všechna metadata, zavolejte tuto operaci bez diktování metadat.

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

Parametry

metadata
dict[str, str]
Vyžadováno

Dikt obsahující páry název-hodnota, které se přidružují ke kontejneru jako metadata. Příklad: {'category':'test'}

lease
BlobLeaseClient nebo str

Pokud je zadáno, set_container_metadata bude úspěšná jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k chování podle podmínky zadané parametrem match_condition .

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Dikt vlastnosti aktualizovaného kontejneru (značka Etag a poslední změna)

Návratový typ

set_premium_page_blob_tier_blobs

Nastaví úrovně objektů blob stránky na všech objektech blob. Toto rozhraní API se podporuje jenom pro objekty blob stránky na účtech Premium.

Maximální počet objektů blob, které je možné aktualizovat v jednom požadavku, je 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parametry

premium_page_blob_tier
PremiumPageBlobTier
Vyžadováno

Hodnota úrovně objektu blob stránky, na kterou chcete objekt blob nastavit. Úroveň koreluje s velikostí objektu blob a počtem povolených IOPS. To platí jenom pro objekty blob stránky v účtech premium storage.

Poznámka

Pokud chcete nastavit jinou úroveň pro různé objekty blob, nastavte tento poziční parametr na Hodnotu None.

Pak se zabere úroveň objektů blob na všech objektech blobProperties.

blobs
str nebo dict(str, Any) nebo BlobProperties
Vyžadováno

Objekty blob, se kterými se má pracovat. Může to být jeden objekt blob nebo může být zadáno více hodnot, přičemž každá hodnota je buď název objektu blob (str), nebo Objekt blobProperties.

Poznámka

Pokud je typ objektu blob dict, tady je seznam klíčů a pravidel hodnot.

název objektu blob:

key: 'name', value type: str

Úroveň objektů blob premium:

key: 'blob_tier', typ hodnoty: PremiumPageBlobTier

Pronájem:

key: 'lease_id', typ hodnoty: Union[str, LeaseClient]

časový limit dílčího požadavku:

key: 'timeout', value type: int

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

raise_on_any_failure
bool

Toto je logický parametr, který má výchozí hodnotu True. Pokud je tato možnost nastavená, vyvolá se výjimka, i když dojde k selhání jedné operace.

Návraty

Iterátor odpovědí, jeden pro každý objekt blob v pořadí

Návratový typ

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Tato operace nastaví úroveň objektů blob bloku.

Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob.

Maximální počet objektů blob, které je možné aktualizovat v jednom požadavku, je 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parametry

standard_blob_tier
str nebo StandardBlobTier
Vyžadováno

Označuje úroveň, která se má nastavit pro všechny objekty blob. Mezi možnosti patří horké, studené, archivní. Horká úroveň je optimalizovaná pro ukládání dat, ke kterým se přistupuje často. Studená úroveň úložiště je optimalizovaná pro ukládání dat, ke kterým se zřídka přistupuje a která se ukládají nejméně jeden měsíc. Archivní úroveň je optimalizovaná pro ukládání zřídka používaných dat, která jsou uložena nejméně po dobu šesti měsíců s flexibilními požadavky na latenci.

Poznámka

Pokud chcete nastavit jinou úroveň pro různé objekty blob, nastavte tento poziční parametr na Hodnotu None.

Pak se zabere úroveň objektů blob na všech objektech blobProperties.

blobs
str nebo dict(str, Any) nebo BlobProperties
Vyžadováno

Objekty blob, se kterými se má pracovat. Může to být jeden objekt blob nebo může být zadáno více hodnot, přičemž každá hodnota je buď název objektu blob (str), nebo Objekt blobProperties.

Poznámka

Pokud je typ objektu blob dict, tady je seznam klíčů a pravidel hodnot.

název objektu blob:

key: 'name', value type: str

Standardní úroveň objektů blob:

key: 'blob_tier', typ hodnoty: StandardBlobTier

priorita dosazování:

key: 'rehydrate_priority', typ hodnoty: RehydratePriority

Pronájem:

key: 'lease_id', typ hodnoty: Union[str, LeaseClient]

Snímek:

key: "snapshot", typ hodnoty: str

ID verze:

key: "version_id", typ hodnoty: str

podmínka shody značek:

key: 'if_tags_match_condition', typ hodnoty: str

časový limit dílčího požadavku:

key: 'timeout', value type: int

rehydrate_priority
RehydratePriority

Určuje prioritu, s jakou se má dosadovat archivovaný objekt blob.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.0.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota není v klientovi sledována ani ověřena. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

raise_on_any_failure
bool

Toto je logický parametr, který má výchozí hodnotu True. Pokud je tato možnost nastavená, vyvolá se výjimka, i když dojde k selhání jedné operace.

Návraty

Iterátor odpovědí, jeden pro každý objekt blob v pořadí

Návratový typ

upload_blob

Vytvoří nový objekt blob ze zdroje dat s automatickým dělením bloků dat.

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

Parametry

name
str nebo BlobProperties
Vyžadováno

Objekt blob, se kterým chcete pracovat. Pokud je tato hodnota zadaná, přepíše hodnotu objektu blob zadanou v adrese URL objektu blob.

data
Vyžadováno

Data objektů blob, která se mají nahrát.

blob_type
BlobType
Vyžadováno

Typ objektu blob. Může to být BlockBlob, PageBlob nebo AppendBlob. Výchozí hodnota je BlockBlob.

length
int
Vyžadováno

Počet bajtů ke čtení ze streamu Tato možnost je volitelná, ale pro zajištění optimálního výkonu by měla být poskytována.

metadata
dict(str, str)
Vyžadováno

Páry název-hodnota přidružené k objektu blob jako metadata.

overwrite
bool

Jestli má objekt blob, který se má nahrát, přepsat aktuální data. Pokud je true, upload_blob přepíše existující data. Pokud je nastavená hodnota False, operace selže s chybou ResourceExistsError. Výjimkou z výše uvedeného je připojení typů objektů blob: Pokud je nastavená hodnota False a data už existují, nevyvolá se chyba a data se připojí k existujícímu objektu blob. Pokud nastavíte overwrite=True, odstraní se existující doplňovací objekt blob a vytvoří se nový. Výchozí hodnota je False.

content_settings
ContentSettings

Objekt ContentSettings použitý k nastavení vlastností objektu blob. Slouží k nastavení typu obsahu, kódování, jazyka, dispozice, md5 a řízení mezipaměti.

validate_content
bool

Pokud ano, vypočítá hodnotu hash MD5 pro každý blok objektu blob. Služba úložiště zkontroluje hodnotu hash obsahu, která přišla s hodnotou hash, která byla odeslána. To je primárně užitečné pro detekci bitflips na drátu, pokud použijete http místo https, protože https (výchozí nastavení) už ověří. Všimněte si, že tato hodnota hash MD5 se s objektem blob neukládá. Všimněte si také, že pokud je povolená, algoritmus nahrávání efektivní z paměti se nepoužije, protože výpočet hodnoty hash MD5 vyžaduje ukládání celých bloků do vyrovnávací paměti, a tím se porazí účel algoritmu efektivního z hlediska paměti.

lease
BlobLeaseClient nebo str

Vyžaduje se, pokud má kontejner aktivní zapůjčení. Hodnota může být objekt BlobLeaseClient nebo ID zapůjčení jako řetězec.

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, aby se operace prováděla pouze v případě, že byl prostředek od zadaného času změněn.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že hodnota předaného data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k chování podle podmínky zadané parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se má použít u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.0.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady. Tato metoda může provádět více volání služby a časový limit se použije pro každé volání zvlášť.

premium_page_blob_tier
PremiumPageBlobTier

Hodnota úrovně objektu blob stránky, na kterou se objekt blob nastaví. Úroveň koreluje s velikostí objektu blob a počtem povolených IOPS. To platí jenom pro objekty blob stránky v účtech premium storage.

standard_blob_tier
StandardBlobTier

Standardní hodnota úrovně objektu blob, na kterou se objekt blob nastaví. Pro tuto verzi knihovny to platí jenom pro objekty blob bloku v účtech úložiště úrovně Standard.

maxsize_condition
int

Volitelná podmíněná hlavička. Maximální délka v bajtech povolená pro doplňovací objekt blob. Pokud by operace připojení bloku způsobila překročení tohoto limitu objektu blob nebo pokud je velikost objektu blob již větší než hodnota zadaná v této hlavičce, požadavek selže s chybou MaxBlobSizeConditionNotMet (stavový kód HTTP 412 – Předběžná podmínka selhala).

max_concurrency
int

Maximální počet paralelních připojení, která se mají použít, když velikost objektu blob překročí 64 MB.

cpk
CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes protokol HTTPS. Vzhledem k tomu, že požadavek poskytuje samotný šifrovací klíč, musí být pro přenos klíče navázáno zabezpečené připojení.

encryption_scope
str

Předdefinovaný obor šifrování, který se používá k šifrování dat ve službě. Obor šifrování je možné vytvořit pomocí rozhraní API pro správu a odkazovat sem podle názvu. Pokud je v kontejneru definovaný výchozí obor šifrování, tato hodnota ho přepíše, pokud je obor na úrovni kontejneru nakonfigurovaný tak, aby umožňoval přepsání. V opačném případě dojde k chybě.

Novinka ve verzi 12.2.0.

encoding
str

Výchozí hodnota je UTF-8.

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

Zpětné volání ke sledování průběhu dlouhotrvajícího nahrávání. Podpis je function(current: int, total: Optional[int]), kde current je počet doposud přenesených bajtů, a total je velikost objektu blob, nebo None (Žádný), pokud je velikost neznámá.

Návraty

Objekt BlobClient pro interakci s nově nahraným objektem blob.

Návratový typ

walk_blobs

Vrátí generátor pro výpis objektů blob v zadaném kontejneru. Generátor bude líně sledovat tokeny pokračování vrácené službou. Tato operace vypíše objekty blob v souladu s hierarchií oddělenou zadaným znakem oddělovače.

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any | None) -> ItemPaged[BlobProperties]

Parametry

name_starts_with
str
Vyžadováno

Filtruje výsledky tak, aby vracely pouze objekty blob, jejichž názvy začínají zadanou předponou.

include
list[str] nebo str
Vyžadováno

Určuje jednu nebo více dalších datových sad, které se mají zahrnout do odpovědi. Mezi možnosti patří snímky, metadata, uncommittedblobs, copy, deleted, deletedwithversions, tags, versions, immutabilitypolicy, legalhold.

delimiter
str
Vyžadováno

Když požadavek obsahuje tento parametr, operace vrátí element BlobPrefix v těle odpovědi, který funguje jako zástupný symbol pro všechny objekty blob, jejichž názvy začínají stejným podřetěžcem až do vzhledu oddělovače. Oddělovačem může být jeden znak nebo řetězec.

timeout
int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Iterovatelná odpověď (automatické stránkování) objektu BlobProperties.

Návratový typ

Atributy

api_version

Verze rozhraní API služby Storage, která se používá pro požadavky.

location_mode

Režim umístění, který klient aktuálně používá.

Ve výchozím nastavení to bude "primární". Mezi možnosti patří "primární" a "sekundární".

primary_endpoint

Úplná adresa URL primárního koncového bodu.

primary_hostname

Název hostitele primárního koncového bodu.

secondary_endpoint

Úplná adresa URL sekundárního koncového bodu, pokud je nakonfigurovaná.

Pokud není k dispozici, bude vyvolána chyba ValueError. Pokud chcete explicitně zadat název sekundárního hostitele, použijte volitelný argument secondary_hostname klíčového slova pro vytvoření instance.

Výjimky

secondary_hostname

Název hostitele sekundárního koncového bodu.

Pokud není k dispozici, bude to Žádný. Pokud chcete explicitně zadat název sekundárního hostitele, použijte volitelný argument secondary_hostname klíčového slova pro vytvoření instance.

url

Úplná adresa URL koncového bodu pro tuto entitu, včetně tokenu SAS, pokud je použit.

To může být primární koncový bod nebo sekundární koncový bod v závislosti na aktuálním location_mode. :returns: Úplná adresa URL koncového bodu pro tuto entitu, včetně tokenu SAS, pokud je použit. :rtype: str