BaseBlobService Třída
Toto je hlavní třída, která spravuje prostředky objektů blob.
Služba Blob Service ukládá textová a binární data jako objekty blob v cloudu. Služba Blob Service nabízí následující tři prostředky: účet úložiště, kontejnery a objekty blob. Kontejnery v rámci účtu úložiště poskytují způsob, jak uspořádat sady objektů blob. Další informace najdete tady: https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx
:type ~azure.storage.common.TokenCredential
- Dědičnost
-
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
Název účtu úložiště. Používá se k ověřování požadavků podepsaných pomocí klíče účtu a k vytvoření koncového bodu úložiště. Vyžaduje se, pokud není zadána připojovací řetězec nebo pokud se s anonymním ověřováním nepoužívá vlastní doména.
- account_key
- str
Klíč účtu úložiště. Používá se pro ověřování pomocí sdíleného klíče. Pokud není zadaný žádný klíč účtu ani token SAS, použije se anonymní přístup.
- sas_token
- str
Token sdíleného přístupového podpisu, který se použije k ověřování požadavků místo klíče účtu. Pokud zadáte klíč účtu i token SAS, použije se k podepsání klíč účtu. Pokud není zadaný ani jeden, použije se anonymní přístup.
- is_emulated
- bool
Určuje, jestli se má emulátor použít. Výchozí hodnota je False. Pokud je zadán, přepíše všechny ostatní parametry kromě připojovací řetězec a relace požadavku.
- protocol
- str
Protokol, který se má použít pro požadavky. Výchozí hodnota je https.
- endpoint_suffix
- str
Základní komponenta hostitele adresy URL bez názvu účtu. Výchozí hodnota je Azure (core.windows.net). Přepište ho, pokud chcete používat cloud v Číně (core.chinacloudapi.cn).
- custom_domain
- str
Vlastní doména, která se má použít. Můžete to nastavit na webu Azure Portal. Například "www.mydomain.com".
- request_session
- <xref:requests.Session>
Objekt relace, který se má použít pro požadavky HTTP.
- connection_string
- str
Pokud je zadaný, přepíše se tím všechny ostatní parametry kromě relace požadavku. Formát připojovací řetězec viz http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/
- socket_timeout
- int
Pokud je zadaný, přepíše se tím výchozí časový limit soketu. Zadaný časový limit je v sekundách. Výchozí hodnotu najdete v DEFAULT_SOCKET_TIMEOUT v _constants.py.
- token_credential
Přihlašovací údaje tokenu používané k ověřování požadavků HTTPS. Hodnota tokenu by se měla aktualizovat před vypršením jeho platnosti.
Proměnné
- MAX_SINGLE_GET_SIZE
- int
Velikost prvního rozsahu prováděného metodami get_blob_to_*, pokud je max_connections větší než 1. Pokud je objekt blob menší, vrátí se méně dat.
- MAX_CHUNK_GET_SIZE
- int
Velikost následujícího rozsahu se provede metodami get_blob_to_*, pokud je max_connections větší než 1 a objekt blob je větší než MAX_SINGLE_GET_SIZE. Pokud je zbytek objektu blob menší než tento, vrátí se méně dat. Pokud je nastavená velikost větší než 4 MB, content_validation vyvolá chybu, pokud je povolená. Pokud ale content_validation není žádoucí, může být optimální velikost větší než 4 MB. Nastavení na nižší než 4 MB se nedoporučuje.
- key_encryption_key
- object
Klíč-šifrování-klíč volitelně poskytnutý uživatelem. Pokud je k dispozici, použije se k šifrování/dešifrování v podporovaných metodách. Pro metody vyžadující dešifrování musí být k dispozici buď key_encryption_key, NEBO překladač. Pokud jsou k dispozici obě možnosti, bude mít překladač přednost. Pro rozhraní API vyžadující šifrování je nutné implementovat následující metody: wrap_key(klíč) – zabalí zadaný klíč (bajty) pomocí algoritmu podle volby uživatele. Vrátí šifrovaný klíč jako bajty. get_key_wrap_algorithm()–vrátí algoritmus použitý k zabalení zadaného symetrického klíče. get_kid()-vrátí id klíče řetězce pro tento klíč key-encryption-key. Pro rozhraní API vyžadující dešifrování je nutné implementovat následující metody: unwrap_key(klíč, algoritmus)-vrátí nezabalený tvar zadaného symetrického klíče pomocí algoritmu zadaného řetězcem. get_kid()-vrátí id klíče řetězce pro tento klíč key-encryption-key.
- key_resolver_function
- kid) (<xref:function>
Funkce pro překlad klíčů, které volitelně poskytuje uživatel. Pokud je k dispozici, použije se k dešifrování v podporovaných metodách. Pro metody vyžadující dešifrování musí být k dispozici buď key_encryption_key, NEBO překladač. Pokud jsou k dispozici obě možnosti, bude mít překladač přednost. Používá řetězec dítěte k vrácení klíče-šifrování-klíč implementuje rozhraní definované výše.
- require_encryption
- bool
Příznak, který může být nastaven tak, aby se zajistilo, že všechny zprávy úspěšně nahrané do fronty a všechny zprávy stažené a úspěšně přečtené z fronty jsou zašifrované na serveru. Pokud je tento příznak nastavený, musí být zadané všechny požadované parametry pro šifrování a dešifrování. Projděte si výše uvedené komentáře k key_encryption_key a překladače.
Metody
abort_copy_blob |
Přeruší čekající operaci copy_blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty. |
acquire_blob_lease |
Požádá o nové zapůjčení. Pokud objekt blob nemá aktivní zapůjčení, služba Blob Service vytvoří zapůjčení objektu blob a vrátí nové ID zapůjčení. |
acquire_container_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í. |
batch_delete_blobs |
Odešle dávku více žádostí o odstranění objektu blob. Metoda odstranění objektu blob odstraní zadaný objekt blob nebo snímek. Upozorňujeme, že odstraněním objektu blob se odstraní také všechny jeho snímky. Další informace najdete v tématu https://docs.microsoft.com/rest/api/storageservices/delete-blob. |
break_blob_lease |
Pokud má objekt blob aktivní zapůjčení, přeruší zapůjčení. Jakmile je zapůjčení přerušeno, nelze ho obnovit. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Pokud je zapůjčení přerušené, může uplynout období přerušení zapůjčení, během kterého se s objektem blob nedají provádět žádné operace zapůjčení s výjimkou přerušení a uvolnění. Pokud je zapůjčení úspěšně přerušeno, odpověď indikuje interval v sekundách, dokud nebude možné získat nové zapůjčení. Zapůjčení, které bylo přerušeno, může být také uvolněno. V takovém případě může zapůjčení objektu blob okamžitě získat jiný klient. |
break_container_lease |
Pokud má kontejner aktivní zapůjčení, přerušte zapůjčení. Jakmile je zapůjčení přerušeno, nelze ho obnovit. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Pokud je zapůjčení přerušeno, může uplynout období přerušení zapůjčení, během kterého se v kontejneru nedají provádět žádné operace zapůjčení s výjimkou přerušení a uvolnění. Pokud je zapůjčení úspěšně přerušeno, odpověď indikuje interval v sekundách, dokud nebude možné získat nové zapůjčení. |
change_blob_lease |
Změní ID zapůjčení aktivního zapůjčení. Změna musí zahrnovat aktuální ID zapůjčení a nové ID zapůjčení. |
change_container_lease |
Změňte ID zapůjčení aktivního zapůjčení. Změna musí zahrnovat aktuální ID zapůjčení a nové ID zapůjčení. |
copy_blob |
Asynchronně zkopíruje objekt blob. Tato operace vrátí objekt vlastností operace kopírování, včetně ID kopírování, které můžete použít ke kontrole nebo přerušení operace kopírování. Služba Blob Service kopíruje objekty blob s maximálním úsilím. Zdrojovým objektem blob pro operaci kopírování může být objekt blob bloku, doplňovací objekt blob nebo objekt blob stránky. Pokud cílový objekt blob již existuje, musí být stejného typu objektu blob jako zdrojový objekt blob. Všechny existující cílové objekty blob se přepíšou. Cílový objekt blob nelze změnit, když probíhá operace kopírování. Při kopírování z objektu blob stránky vytvoří služba Blob service cílový objekt blob stránky o délce zdrojového objektu blob, který zpočátku obsahuje všechny nuly. Potom se zobrazí výčet oblastí zdrojové stránky a zkopírují se neprázdné oblasti. V případě objektu blob bloku nebo doplňovacího objektu blob služba Blob service před návratem z této operace vytvoří potvrzený objekt blob nulové délky. Při kopírování z objektu blob bloku se zkopírují všechny potvrzené bloky a jejich ID bloků. Nepotvrzené bloky se nekopírují. Na konci operace kopírování bude mít cílový objekt blob stejný počet potvrzených bloků jako zdroj. Při kopírování z doplňovacího objektu blob se zkopírují všechny potvrzené bloky. Na konci operace kopírování bude mít cílový objekt blob stejný počet potvrzených bloků jako zdroj. Pro všechny typy objektů blob můžete volat get_blob_properties v cílovém objektu blob a zkontrolovat stav operace kopírování. Konečný objekt blob se potvrdí po dokončení kopírování. |
create_container |
Vytvoří nový kontejner pod zadaným účtem. Pokud už kontejner se stejným názvem existuje, operace selže, pokud má fail_on_exist hodnotu True. |
delete_blob |
Označí zadaný objekt blob nebo snímek k odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete objekt blob odstranit, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob. Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace objekt blob nebo snímek obnovitelné odstraní a zachová objekt blob nebo snímek po zadaný počet dnů. Po zadaném počtu dnů se data objektu blob během uvolňování paměti odeberou ze služby. Obnovitelně odstraněný objekt blob nebo snímek jsou přístupné prostřednictvím rozhraní API seznamu objektů blob s možností include=Include.Deleted. Obnovitelně odstraněný objekt blob nebo snímek je možné obnovit pomocí rozhraní API undelete. |
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. |
exists |
Vrátí logickou hodnotu označující, jestli kontejner existuje (pokud je blob_name none), nebo jinou logickou hodnotu označující, jestli objekt blob existuje. |
extract_date_and_request_id | |
generate_account_shared_access_signature |
Vygeneruje sdílený přístupový podpis pro službu Blob Service. Použijte vrácený podpis s parametrem sas_token libovolné služby BlobService. |
generate_blob_shared_access_signature |
Vygeneruje sdílený přístupový podpis pro objekt blob nebo jeden z jeho snímků. Použijte vrácený podpis s parametrem sas_token libovolné služby BlobService. |
generate_container_shared_access_signature |
Vygeneruje sdílený přístupový podpis pro kontejner. Použijte vrácený podpis s parametrem sas_token libovolné služby BlobService. |
get_blob_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. |
get_blob_metadata |
Vrátí všechna uživatelem definovaná metadata pro zadaný objekt blob nebo snímek. |
get_blob_properties |
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob. Vrátí příkaz Blob se BlobProperties diktem metadat a . |
get_blob_service_properties |
Získá vlastnosti služby Blob service účtu úložiště, včetně Azure Analýza úložiště. |
get_blob_service_stats |
Načte statistiky související s replikací pro službu Blob Service. Je k dispozici pouze v případě, že je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení. Díky geograficky redundantní replikaci azure storage udržuje vaše data odolná ve dvou umístěních. V obou umístěních Azure Storage neustále udržuje několik replik dat, které jsou v pořádku. Umístění, kde čtete, vytváříte, aktualizujete nebo odstraňujete data, je primární umístění účtu úložiště. Primární umístění existuje v oblasti, kterou zvolíte, v okamžiku vytvoření účtu prostřednictvím portálu Azure Management Azure Classic, například USA – středosever. Umístění, do kterého se data replikují, je sekundární umístění. Sekundární umístění je automaticky určeno na základě umístění primární; nachází se ve druhém datovém centru, které se nachází ve stejné oblasti jako primární umístění. Přístup jen pro čtení je k dispozici ze sekundárního umístění, pokud je pro váš účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení. |
get_blob_to_bytes |
Stáhne objekt blob jako pole bajtů s oznámeními o automatickém vytváření bloků dat a průběhu. Vrátí instanci s Blob vlastnostmi, metadaty a obsahem. |
get_blob_to_path |
Stáhne objekt blob do cesty k souboru s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s Blob vlastnostmi a metadaty. |
get_blob_to_stream |
Stáhne objekt blob do datového proudu s automatickým blokováním dat a oznámeními o průběhu. Vrátí instanci Blob s vlastnostmi a metadaty. |
get_blob_to_text |
Stáhne objekt blob jako text unicode s automatickým zápisem bloků dat a oznámeními o průběhu. Vrátí instanci Blob s vlastnostmi, metadaty a obsahem. |
get_container_acl |
Získá oprávnění pro zadaný kontejner. Oprávnění označují, jestli je možné k datům kontejneru přistupovat veřejně. |
get_container_metadata |
Vrátí všechna uživatelem definovaná metadata pro zadaný kontejner. |
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_user_delegation_key |
Získejte klíč delegování uživatele pro účely podepisování tokenů SAS. Aby byl tento požadavek úspěšný, musí být v objektu služby k dispozici přihlašovací údaje tokenu. |
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 a zastaví se, jakmile se vrátí všechny objekty blob nebo se dosáhne num_results. Pokud je zadána num_results a účet má více než tento počet objektů blob, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky. |
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 a zastaví se, jakmile se vrátí všechny objekty blob nebo se dosáhne num_results. Pokud je zadána num_results a účet má více než tento počet objektů blob, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky. |
list_containers |
Vrátí generátor pro výpis kontejnerů v zadaném účtu. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny kontejnery nebo se dosáhne num_results. Pokud je zadána num_results a účet má více než tento počet kontejnerů, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky. |
make_blob_url |
Vytvoří adresu URL pro přístup k objektu blob. |
make_container_url |
Vytvoří adresu URL pro přístup ke kontejneru. |
release_blob_lease |
Uvolní zapůjčení. Zapůjčení může být uvolněno, pokud ID zapůjčení zadané v požadavku odpovídá id přidružené k objektu blob. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení objektu blob, jakmile se vydání dokončí. |
release_container_lease |
Uvolněte zapůjčení. Zapůjčení může být uvolněno, pokud zadaný lease_id odpovídá tomu, co je přidružené ke kontejneru. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení kontejneru, jakmile se uvolnění dokončí. |
renew_blob_lease |
Prodlouží zapůjčení. Zapůjčení je možné prodloužit, pokud ID zapůjčení zadané v požadavku odpovídá ID přidruženému k objektu blob. Mějte na paměti, že zapůjčení je možné obnovit i v případě, že vypršela jeho platnost, pokud se objekt blob od vypršení platnosti zapůjčení nezměnil nebo znovu nepronajal. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení. |
renew_container_lease |
Prodlouží zapůjčení. Zapůjčení je možné prodloužit, pokud zadané ID zapůjčení odpovídá ID přidruženému ke kontejneru. Mějte na paměti, že zapůjčení může být obnoveno i v případě, že jeho platnost vypršela, pokud se kontejner od vypršení platnosti zapůjčení znovu nepronajal. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení. |
set_blob_metadata |
Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jednu nebo více dvojic název-hodnota. |
set_blob_properties |
Nastaví systémové vlastnosti objektu blob. Pokud je pro content_settings nastavená jedna vlastnost, všechny vlastnosti se přepíšou. |
set_blob_service_properties |
Nastaví vlastnosti služby Blob service účtu úložiště, včetně Azure Analýza úložiště. Pokud je prvek (např. Protokolování) ponechán jako None, stávající nastavení služby pro tuto funkci se zachovají. |
set_container_acl |
Nastaví oprávnění pro zadaný kontejner nebo uložené zásady přístupu, které lze 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í jednu 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_proxy |
Nastaví hostitele proxy serveru a port pro tunelování HTTP CONNECT. |
snapshot_blob |
Vytvoří snímek objektu blob jen pro čtení. |
undelete_blob |
Operace odstranění objektu blob obnoví obsah a metadata obnovitelně odstraněného objektu blob nebo snímku. Pokus o zrušení odstranění objektu blob nebo snímku, který není obnovitelně odstraněný, bude úspěšný bez jakýchkoli změn. |
abort_copy_blob
Přeruší čekající operaci copy_blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty.
abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)
Parametry
- lease_id
- str
Vyžaduje se, pokud má cílový objekt blob aktivní nekonečné zapůjčení.
acquire_blob_lease
Požádá o nové zapůjčení. Pokud objekt blob nemá aktivní zapůjčení, služba Blob Service vytvoří zapůjčení objektu blob a vrátí nové ID zapůjčení.
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
- lease_duration
- int
Určuje dobu zapůjčení v sekundách nebo zápornou dobu (-1) pro zapůjčení, jehož platnost nikdy nevyprší. Nenekonečná zapůjčení může být mezi 15 a 60 sekund. Dobu trvání zapůjčení není možné změnit obnovením nebo změnou. Výchozí hodnota je -1 (nekonečné zapůjčení).
- proposed_lease_id
- str
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 předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Návraty
Str
acquire_container_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_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- lease_duration
- int
Určuje dobu zapůjčení v sekundách nebo zápornou dobu (-1) pro zapůjčení, jehož platnost nikdy nevyprší. Nenekonečná zapůjčení může být mezi 15 a 60 sekund. Dobu trvání zapůjčení není možné změnit obnovením nebo změnou. Výchozí hodnota je -1 (nekonečné zapůjčení).
- proposed_lease_id
- str
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 předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
Návraty
Str
batch_delete_blobs
Odešle dávku více žádostí o odstranění objektu blob.
Metoda odstranění objektu blob odstraní zadaný objekt blob nebo snímek. Upozorňujeme, že odstraněním objektu blob se odstraní také všechny jeho snímky. Další informace najdete v tématu 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)
Odstranění objektu blob vyžaduje odeslání v dávce.
Návraty
Parsovaná odpověď HTTP na dávkové odstranění
Návratový typ
break_blob_lease
Pokud má objekt blob aktivní zapůjčení, přeruší zapůjčení. Jakmile je zapůjčení přerušeno, nelze ho obnovit. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Pokud je zapůjčení přerušené, může uplynout období přerušení zapůjčení, během kterého se s objektem blob nedají provádět žádné operace zapůjčení s výjimkou přerušení a uvolnění. Pokud je zapůjčení úspěšně přerušeno, odpověď indikuje interval v sekundách, dokud nebude možné získat nové zapůjčení.
Zapůjčení, které bylo přerušeno, může být také uvolněno. V takovém případě může zapůjčení objektu blob okamžitě získat jiný klient.
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
- lease_break_period
- int
U operace přerušení je to navrhovaná doba trvání sekund, po které by zapůjčení mělo pokračovat, než se přeruší, od 0 do 60 sekund. Toto období přestávky se použije pouze v případě, že je kratší než zbývající doba zapůjčení. Pokud je delší, použije se zbývající doba zapůjčení. Nové zapůjčení nebude k dispozici před vypršením doby přerušení, ale zapůjčení může být drženo déle, než je doba přerušení. Pokud se tato hlavička nezobrazí s operací přerušení, po uplynutí zbývající doby zapůjčení se přeruší zapůjčení na dobu určitou a nekonečné zapůjčení se okamžitě přeruší.
- 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_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Návraty
int
break_container_lease
Pokud má kontejner aktivní zapůjčení, přerušte zapůjčení. Jakmile je zapůjčení přerušeno, nelze ho obnovit. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Pokud je zapůjčení přerušeno, může uplynout období přerušení zapůjčení, během kterého se v kontejneru nedají provádět žádné operace zapůjčení s výjimkou přerušení a uvolnění. Pokud je zapůjčení úspěšně přerušeno, odpověď indikuje interval v sekundách, dokud nebude možné získat nové zapůjčení.
break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- lease_break_period
- int
Toto je navrhovaná doba trvání sekund, kterou by mělo zapůjčení pokračovat, než se přeruší, mezi 0 a 60 sekund. Toto období přestávky se použije pouze v případě, že je kratší než zbývající doba zapůjčení. Pokud je delší, použije se zbývající doba zapůjčení. Nové zapůjčení nebude k dispozici před vypršením doby přerušení, ale zapůjčení může být drženo déle, než je doba přerušení. Pokud se tato hlavička nezobrazí s operací přerušení, po uplynutí zbývající doby zapůjčení se přeruší zapůjčení na dobu určitou a nekonečné zapůjčení se okamžitě přeruší.
- 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.
Návraty
int
change_blob_lease
Změní ID zapůjčení aktivního zapůjčení. Změna musí zahrnovat aktuální ID zapůjčení a nové ID zapůjčení.
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
- proposed_lease_id
- str
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.
- if_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
change_container_lease
Změňte ID zapůjčení aktivního zapůjčení. Změna musí zahrnovat aktuální ID zapůjčení a nové ID zapůjčení.
change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- proposed_lease_id
- str
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.
copy_blob
Asynchronně zkopíruje objekt blob. Tato operace vrátí objekt vlastností operace kopírování, včetně ID kopírování, které můžete použít ke kontrole nebo přerušení operace kopírování. Služba Blob Service kopíruje objekty blob s maximálním úsilím.
Zdrojovým objektem blob pro operaci kopírování může být objekt blob bloku, doplňovací objekt blob nebo objekt blob stránky. Pokud cílový objekt blob již existuje, musí být stejného typu objektu blob jako zdrojový objekt blob. Všechny existující cílové objekty blob se přepíšou. Cílový objekt blob nelze změnit, když probíhá operace kopírování.
Při kopírování z objektu blob stránky vytvoří služba Blob service cílový objekt blob stránky o délce zdrojového objektu blob, který zpočátku obsahuje všechny nuly. Potom se zobrazí výčet oblastí zdrojové stránky a zkopírují se neprázdné oblasti.
V případě objektu blob bloku nebo doplňovacího objektu blob služba Blob service před návratem z této operace vytvoří potvrzený objekt blob nulové délky. Při kopírování z objektu blob bloku se zkopírují všechny potvrzené bloky a jejich ID bloků. Nepotvrzené bloky se nekopírují. Na konci operace kopírování bude mít cílový objekt blob stejný počet potvrzených bloků jako zdroj.
Při kopírování z doplňovacího objektu blob se zkopírují všechny potvrzené bloky. Na konci operace kopírování bude mít cílový objekt blob stejný počet potvrzených bloků jako zdroj.
Pro všechny typy objektů blob můžete volat get_blob_properties v cílovém objektu blob a zkontrolovat stav operace kopírování. Konečný objekt blob se potvrdí po dokončení kopírování.
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
- blob_name
- str
Název cílového objektu blob. Pokud cílový objekt blob existuje, přepíše se. V opačném případě se vytvoří.
- copy_source
- str
Adresa URL o délce až 2 kB, která určuje soubor Azure nebo objekt blob. Hodnota by měla být zakódovaná jako v identifikátoru URI požadavku. Pokud je zdroj v jiném účtu, musí být buď veřejný, nebo musí být ověřený prostřednictvím sdíleného přístupového podpisu. Pokud je zdroj veřejný, nevyžaduje se ověřování. Příklady: 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
Páry název-hodnota přidružené k objektu blob jako metadata. Pokud nejsou zadané žádné páry název-hodnota, operace zkopíruje metadata ze zdrojového objektu blob nebo souboru do cílového objektu blob. Pokud je zadána jedna nebo více dvojic název-hodnota, cílový objekt blob se vytvoří se zadanými metadaty a metadata se ze zdrojového objektu blob nebo souboru nezkopírují.
- source_if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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 podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že zdrojový objekt blob byl od zadaného data a času změněn.
- source_if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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 podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že zdrojový objekt blob nebyl od zadaného data a času změněn.
- source_if_match
- <xref:ETag>
Hodnota ETag nebo zástupný znak (*). Zadáním této podmíněné hlavičky zkopírujete zdrojový objekt blob pouze v případě, že jeho značka ETag odpovídá zadané hodnotě. Pokud se hodnoty značky ETag neshodují, vrátí služba Blob service stavový kód 412 (Předběžná podmínka se nezdařila). Tuto hlavičku nelze zadat, pokud je zdrojem Soubor Azure.
- source_if_none_match
- <xref:ETag>
Hodnota ETag nebo zástupný znak (*). Tuto podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že jeho značka ETag neodpovídá zadané hodnotě. Pokud jsou hodnoty identické, vrátí služba Blob Service stavový kód 412 (Předběžná podmínka se nezdařila). Tuto hlavičku nelze zadat, pokud je zdrojem Soubor Azure.
- destination_if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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 podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že se cílový objekt blob od zadaného data a času změnil. Pokud se cílový objekt blob nezměnil, vrátí služba Blob service stavový kód 412 (Předběžná podmínka se nezdařila).
- destination_if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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 podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že cílový objekt blob nebyl od zadaného data a času změněn. Pokud se cílový objekt blob změnil, vrátí služba Blob service stavový kód 412 (Předběžná podmínka se nezdařila).
- destination_if_match
- <xref:ETag>
Hodnota ETag nebo zástupný znak (*). Zadáním hodnoty ETag pro tuto podmíněnou hlavičku zkopírujte objekt blob pouze v případě, že zadaná hodnota značky ETag odpovídá hodnotě ETag pro existující cílový objekt blob. Pokud značka ETag cílového objektu blob neodpovídá značkě ETag zadané pro If-Match, vrátí služba Blob service stavový kód 412 (Předběžná podmínka selhala).
- destination_if_none_match
- <xref:ETag>
Hodnota ETag nebo zástupný znak (). Zadáním hodnoty ETag pro tuto podmíněnou hlavičku zkopírujte objekt blob pouze v případě, že zadaná hodnota značky ETag neodpovídá hodnotě ETag cílového objektu blob. Zadejte zástupný znak (), který provede operaci pouze v případě, že cílový objekt blob neexistuje. Pokud zadaná podmínka není splněná, vrátí služba Blob service stavový kód 412 (Předběžná podmínka selhala).
- destination_lease_id
- str
ID zapůjčení zadané pro tuto hlavičku se musí shodovat s ID zapůjčení cílového objektu blob. Pokud požadavek neobsahuje ID zapůjčení nebo není platný, operace selže se stavovým kódem 412 (Předběžná podmínka selhala).
- source_lease_id
- str
Tuto možnost zadejte, pokud chcete operaci Kopírování objektu blob provést pouze v případě, že zadané ID zapůjčení odpovídá ID aktivního zapůjčení zdrojového objektu blob.
Návraty
Vlastnosti operace kopírování, jako je stav, zdroj a ID.
Návratový typ
create_container
Vytvoří nový kontejner pod zadaným účtem. Pokud už kontejner se stejným názvem existuje, operace selže, pokud má fail_on_exist hodnotu True.
create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)
Parametry
- container_name
- str
Název kontejneru, který se má vytvořit. Název kontejneru může obsahovat pouze malá písmena, číslice a spojovníky a musí začínat písmenem nebo číslicí. Před i za každým spojovníkem musí být jiný znak než spojovník. Název musí být také dlouhý 3 až 63 znaků.
Dikt s name_value spáruje, aby se přidružil ke kontejneru jako metadata. Příklad:{'Category':'test'}
- fail_on_exist
- bool
Určete, jestli se má vyvolat výjimka, když kontejner existuje.
Návraty
True, pokud je kontejner vytvořený, false, pokud kontejner už existuje.
Návratový typ
delete_blob
Označí zadaný objekt blob nebo snímek k odstranění. Objekt blob se později odstraní během uvolňování paměti.
Upozorňujeme, že pokud chcete objekt blob odstranit, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace objekt blob nebo snímek obnovitelné odstraní a zachová objekt blob nebo snímek po zadaný počet dnů. Po zadaném počtu dnů se data objektu blob během uvolňování paměti odeberou ze služby. Obnovitelně odstraněný objekt blob nebo snímek jsou přístupné prostřednictvím rozhraní API seznamu objektů blob s možností include=Include.Deleted. Obnovitelně odstraněný objekt blob nebo snímek je možné obnovit pomocí rozhraní API undelete.
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
- snapshot
- str
Parametr snapshot je neprůsažná hodnota DateTime, která pokud je k dispozici, určuje snímek objektu blob, který se má odstranit.
- delete_snapshots
- DeleteSnapshot
Vyžaduje se, pokud má objekt blob přidružené snímky.
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
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(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- fail_not_exist
- bool
Určete, jestli má dojít k výjimce, když kontejner neexistuje.
- lease_id
- 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.
Návraty
True, pokud je kontejner odstraněný, kontejner False neexistuje.
Návratový typ
exists
Vrátí logickou hodnotu označující, jestli kontejner existuje (pokud je blob_name none), nebo jinou logickou hodnotu označující, jestli objekt blob existuje.
exists(container_name, blob_name=None, snapshot=None, timeout=None)
Parametry
- blob_name
- str
Název objektu blob. Pokud žádný, zkontroluje se existence kontejneru.
- snapshot
- str
Parametr snapshot je neprůselná hodnota DateTime, která, pokud je k dispozici, určuje snímek.
Návraty
Logická hodnota označující, jestli prostředek existuje.
Návratový typ
extract_date_and_request_id
static extract_date_and_request_id(retry_context)
Parametry
- retry_context
generate_account_shared_access_signature
Vygeneruje sdílený přístupový podpis pro službu Blob Service. Použijte vrácený podpis s parametrem sas_token libovolné služby BlobService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)
Parametry
- resource_types
- <xref:ResourceTypes>
Určuje typy prostředků, které jsou přístupné pomocí SAS účtu.
- permission
- <xref:AccountPermissions>
Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.
Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
- ip
- str
Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy.
- protocol
- str
Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https,http. Projděte si Protocol možné hodnoty.
Návraty
Token sdíleného přístupového podpisu (SAS).
Návratový typ
generate_blob_shared_access_signature
Vygeneruje sdílený přístupový podpis pro objekt blob nebo jeden z jeho snímků. Použijte vrácený podpis s parametrem sas_token libovolné služby 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
- snapshot
- str
Parametr snapshot je neprůselná hodnota DateTime, která pokud je k dispozici, určuje snímek objektu blob, který má udělit oprávnění.
- permission
- BlobPermissions
Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Oprávnění musí být seřazená pro čtení, zápis, odstranění a seznam. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.
Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
- id
- str
Jedinečná hodnota o délce až 64 znaků, která koreluje s uloženými zásadami přístupu. K vytvoření uložených zásad přístupu použijte set_container_acl.
- ip
- str
Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy.
- protocol
- str
Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https,http. Projděte si Protocol možné hodnoty.
- cache_control
- str
Hodnota hlavičky odpovědi pro Cache-Control při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu.
- content_disposition
- str
Hodnota hlavičky odpovědi pro Content-Disposition při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu
- content_encoding
- str
Hodnota hlavičky odpovědi pro Content-Encoding při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu
- content_language
- str
Hodnota hlavičky odpovědi pro Content-Language při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu
- content_type
- str
Hodnota hlavičky odpovědi pro Content-Type při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu.
- user_delegation_key
- UserDelegationKey
Místo klíče účtu může uživatel předat klíč delegování uživatele. Klíč delegování uživatele lze ze služby získat ověřením pomocí identity AAD. toho lze dosáhnout voláním get_user_delegation_key. Pokud je sas k dispozici, místo toho se podepíše pomocí klíče delegování uživatele.
Návraty
Token sdíleného přístupového podpisu (SAS).
Návratový typ
generate_container_shared_access_signature
Vygeneruje sdílený přístupový podpis pro kontejner. Použijte vrácený podpis s parametrem sas_token libovolné služby 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
- permission
- ContainerPermissions
Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Oprávnění musí být seřazená pro čtení, zápis, odstranění a seznam. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.
Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
- id
- str
Jedinečná hodnota o délce až 64 znaků, která koreluje s uloženými zásadami přístupu. K vytvoření uložených zásad přístupu použijte set_blob_service_properties.
- ip
- str
Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy.
- protocol
- str
Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https,http. Projděte si Protocol možné hodnoty.
- cache_control
- str
Hodnota hlavičky odpovědi pro Cache-Control při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu.
- content_disposition
- str
Hodnota hlavičky odpovědi pro Content-Disposition při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu
- content_encoding
- str
Hodnota hlavičky odpovědi pro Content-Encoding při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu
- content_language
- str
Hodnota hlavičky odpovědi pro Content-Language při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu
- content_type
- str
Hodnota hlavičky odpovědi pro Content-Type při přístupu k prostředku pomocí tohoto sdíleného přístupového podpisu.
- user_delegation_key
- UserDelegationKey
Místo klíče účtu může uživatel předat klíč delegování uživatele. Klíč delegování uživatele lze ze služby získat ověřením pomocí identity AAD. toho lze dosáhnout voláním get_user_delegation_key. Pokud je sas k dispozici, místo toho se podepíše pomocí klíče delegování uživatele.
Návraty
Token sdíleného přístupového podpisu (SAS).
Návratový typ
get_blob_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.
get_blob_account_information(container_name=None, blob_name=None, timeout=None)
Parametry
- container_name
- str
Název existujícího kontejneru. Volitelné, pokud nepoužíváte token SAS ke konkrétnímu kontejneru nebo objektu blob, v takovém případě je to povinné.
- blob_name
- str
Název existujícího objektu blob. Volitelné, pokud nepoužíváte token SAS ke konkrétnímu objektu blob, v takovém případě je to povinné.
Návraty
Hodnota AccountInformation
get_blob_metadata
Vrátí všechna uživatelem definovaná metadata pro zadaný objekt blob nebo snímek.
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
- snapshot
- str
Parametr snapshot je neprůselná hodnota, která pokud je k dispozici, určuje snímek objektu blob, který se má načíst.
- 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_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Deš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í.
Návraty
Slovník představující název metadat objektu blob, páry hodnot.
Návratový typ
get_blob_properties
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob. Vrátí příkaz Blob se BlobProperties diktem metadat a .
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
- snapshot
- str
Parametr snapshot je neprůselná hodnota DateTime, která při přítomnosti určuje snímek objektu blob, který se má načíst.
- 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_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Deš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í.
Návraty
objekt blob včetně vlastností a metadat.
Návratový typ
get_blob_service_properties
Získá vlastnosti služby Blob service účtu úložiště, včetně Azure Analýza úložiště.
get_blob_service_properties(timeout=None)
Parametry
Návraty
Objekt blob ServiceProperties s připojenou vlastností target_version.
get_blob_service_stats
Načte statistiky související s replikací pro službu Blob Service. Je k dispozici pouze v případě, že je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.
Díky geograficky redundantní replikaci azure storage udržuje vaše data odolná ve dvou umístěních. V obou umístěních Azure Storage neustále udržuje několik replik dat, které jsou v pořádku. Umístění, kde čtete, vytváříte, aktualizujete nebo odstraňujete data, je primární umístění účtu úložiště. Primární umístění existuje v oblasti, kterou zvolíte, v okamžiku vytvoření účtu prostřednictvím portálu Azure Management Azure Classic, například USA – středosever. Umístění, do kterého se data replikují, je sekundární umístění. Sekundární umístění je automaticky určeno na základě umístění primární; nachází se ve druhém datovém centru, které se nachází ve stejné oblasti jako primární umístění. Přístup jen pro čtení je k dispozici ze sekundárního umístění, pokud je pro váš účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.
get_blob_service_stats(timeout=None)
Parametry
Návraty
Statistiky služby Blob Service.
Návratový typ
get_blob_to_bytes
Stáhne objekt blob jako pole bajtů s oznámeními o automatickém vytváření bloků dat a průběhu. Vrátí instanci s Blob vlastnostmi, metadaty a obsahem.
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
- snapshot
- str
Parametr snapshot je neprůselná hodnota DateTime, která při přítomnosti určuje snímek objektu blob, který se má načíst.
- start_range
- int
Začátek rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- end_range
- int
Konec rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- validate_content
- bool
Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část objektu blob. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že služba bude vracet pouze transakční md5 pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud já. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že výpočet md5 trvá zpracování a kvůli zmenšené velikosti bloků dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Zpětné volání pro průběh funkce signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a celkový počet je velikost objektu blob, pokud je znám.
- max_connections
- int
Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první sebe. MAX_SINGLE_GET_SIZE bajtů objektu blob. Pokud se jedná o celý objekt blob, vrátí metoda v tomto okamžiku. Pokud tomu tak není, stáhne zbývající data paralelně s použitím počtu vláken rovnajících se max_connections. Každý blok dat bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhlednutelný datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se očekává, že mnoho objektů blob bude prázdné, protože pro prázdné objekty blob se vyžaduje další požadavek, pokud je max_connections větší než 1.
- 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_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Deš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í.
- timeout
- int
Parametr časového limitu je vyjádřen v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť.
Návraty
Objekt blob s vlastnostmi a metadaty. Pokud je max_connections větší než 1, content_md5 (pokud je nastavený na objekt blob) se nevrátí. Pokud tuto hodnotu požadujete, použijte get_blob_properties nebo nastavte max_connections na hodnotu 1.
Návratový typ
get_blob_to_path
Stáhne objekt blob do cesty k souboru s automatickými oznámeními o blokování dat a průběhu. Vrátí instanci s Blob vlastnostmi a metadaty.
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
- open_mode
- str
Režim, který se má použít při otevírání souboru. Všimněte si, že zadání pouze open_mode brání paralelnímu stahování. Pokud se tedy používá tato open_mode, musí být max_connections nastavená na hodnotu 1.
- snapshot
- str
Parametr snapshot je neprůselná hodnota DateTime, která při přítomnosti určuje snímek objektu blob, který se má načíst.
- start_range
- int
Začátek rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- end_range
- int
Konec rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- validate_content
- bool
Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část objektu blob. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že služba bude vracet pouze transakční md5 pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud já. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že výpočet md5 trvá zpracování a kvůli zmenšené velikosti bloků dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Zpětné volání pro průběh funkce signatury (aktuální, celkem), kde aktuální je počet dosud přenesených bajtů a celkový počet je velikost objektu blob, pokud je znám.
- max_connections
- int
Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první sebe. MAX_SINGLE_GET_SIZE bajtů objektu blob. Pokud se jedná o celý objekt blob, vrátí metoda v tomto okamžiku. Pokud tomu tak není, stáhne zbývající data paralelně s použitím počtu vláken rovnajících se max_connections. Každý blok dat bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhlednutelný datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se očekává, že mnoho objektů blob bude prázdné, protože pro prázdné objekty blob se vyžaduje další požadavek, pokud je max_connections větší než 1.
- 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_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Deš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í.
- timeout
- int
Parametr časového limitu je vyjádřen v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se bude vztahovat na každé volání zvlášť.
Návraty
Objekt blob s vlastnostmi a metadaty. Pokud je max_connections větší než 1, content_md5 (pokud je nastavený na objekt blob) se nevrátí. Pokud tuto hodnotu požadujete, použijte get_blob_properties nebo nastavte max_connections na hodnotu 1.
Návratový typ
get_blob_to_stream
Stáhne objekt blob do datového proudu s automatickým blokováním dat a oznámeními o průběhu. Vrátí instanci Blob s vlastnostmi a metadaty.
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
- snapshot
- str
Parametr snapshot je neprůselná hodnota DateTime, která při přítomnosti určuje snímek objektu blob, který se má načíst.
- start_range
- int
Začátek rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud není zadaný žádný end_range, stáhnou se všechny bajty po start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- end_range
- int
Konec rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud end_range, je nutné zadat start_range. Start_range a end_range parametry jsou včetně. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- validate_content
- bool
Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část objektu blob. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že služba vrátí transakční md5 pouze pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud ano. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že zpracování md5 vyžaduje čas a kvůli zmenšené velikosti bloku dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Zpětné volání pro průběh funkce signature (aktuální, celkem), kde current je počet dosud přenesených bajtů a celkový počet je velikost objektu blob, pokud je známa.
- max_connections
- int
Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první já. MAX_SINGLE_GET_SIZE bajtů objektu blob. Pokud se jedná o celý objekt blob, vrátí metoda v tomto okamžiku. Pokud není, stáhne zbývající data paralelně s použitím počtu vláken, který se rovná max_connections. Každý blok bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhledávající datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se očekává, že mnoho objektů blob bude prázdných, protože pro prázdné objekty blob se vyžaduje další požadavek, pokud je max_connections větší než 1.
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Dešifruje data na straně služby s daným klíčem. 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í.
- timeout
- int
Parametr časového limitu se vyjadřuje v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se použije pro každé volání zvlášť.
Návraty
Objekt blob s vlastnostmi a metadaty Pokud je max_connections větší než 1, content_md5 (pokud je pro objekt blob nastavený) se nevrátí. Pokud tuto hodnotu požadujete, použijte get_blob_properties nebo nastavte max_connections na 1.
Návratový typ
get_blob_to_text
Stáhne objekt blob jako text unicode s automatickým zápisem bloků dat a oznámeními o průběhu. Vrátí instanci Blob s vlastnostmi, metadaty a obsahem.
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
- encoding
- str
Kódování Pythonu, které se má použít při dekódování dat objektů blob.
- snapshot
- str
Parametr snapshot je neprůzná hodnota DateTime, která pokud je k dispozici, určuje snímek objektu blob, který se má načíst.
- start_range
- int
Začátek rozsahu bajtů, který se použije ke stažení části objektu blob. Pokud není zadán žádný end_range, stáhnou se všechny bajty po start_range. Parametry start_range a end_range jsou inkluzivní. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- end_range
- int
Konec rozsahu bajtů, který se má použít ke stažení části objektu blob. Pokud je zadán end_range, je nutné zadat start_range. Parametry start_range a end_range jsou inkluzivní. Příklad: start_range=0, end_range=511 stáhne prvních 512 bajtů objektu blob.
- validate_content
- bool
Pokud je nastavená hodnota true, ověří hodnotu hash MD5 pro každou načtenou část objektu blob. To je primárně užitečné pro detekci bitflips na drátu, pokud se už ověří použití protokolu HTTP místo https jako https (výchozí nastavení). Všimněte si, že služba vrátí transakční md5 pouze pro bloky dat o velikosti 4 MB nebo méně, takže první požadavek na získání bude mít vlastní velikost. MAX_CHUNK_GET_SIZE místo sebe sama. MAX_SINGLE_GET_SIZE. Pokud ano. MAX_CHUNK_GET_SIZE byla nastavena na větší než 4 MB, vyvolá se chyba. Vzhledem k tomu, že zpracování md5 vyžaduje čas a kvůli zmenšené velikosti bloku dat bude potřeba provést více požadavků, může dojít k určitému zvýšení latence.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Zpětné volání pro průběh funkce signature (aktuální, celkem), kde current je počet dosud přenesených bajtů a celkový počet je velikost objektu blob, pokud je známa.
- max_connections
- int
Pokud je nastavená hodnota 2 nebo vyšší, provede se počáteční získání pro první já. MAX_SINGLE_GET_SIZE bajtů objektu blob. Pokud se jedná o celý objekt blob, vrátí metoda v tomto okamžiku. Pokud není, stáhne zbývající data paralelně s použitím počtu vláken, který se rovná max_connections. Každý blok bude mít vlastní velikost. MAX_CHUNK_GET_SIZE. Pokud je nastavená hodnota 1, provede se jedna velká žádost o získání. To se obecně nedoporučuje, ale je k dispozici, pokud by se mělo použít velmi málo vláken, síťové požadavky jsou velmi nákladné nebo nevyhledávající datový proud brání paralelnímu stahování. To může být užitečné také v případě, že se očekává, že mnoho objektů blob bude prázdných, protože pro prázdné objekty blob se vyžaduje další požadavek, pokud je max_connections větší než 1.
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Dešifruje data na straně služby s daným klíčem. 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í.
- timeout
- int
Parametr časového limitu se vyjadřuje v sekundách. Tato metoda může provádět více volání služby Azure a časový limit se použije pro každé volání zvlášť.
Návraty
Objekt blob s vlastnostmi a metadaty Pokud je max_connections větší než 1, content_md5 (pokud je pro objekt blob nastavený) se nevrátí. Pokud tuto hodnotu požadujete, použijte get_blob_properties nebo nastavte max_connections na 1.
Návratový typ
get_container_acl
Získá oprávnění pro zadaný kontejner. Oprávnění označují, jestli je možné k datům kontejneru přistupovat veřejně.
get_container_acl(container_name, lease_id=None, timeout=None)
Parametry
- lease_id
Pokud zadáte hodnotu, get_container_acl bude úspěšná jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.
Návraty
Slovník zásad přístupu přidružených ke kontejneru. dict str to AccessPolicy a public_access vlastnost, pokud je zapnutý veřejný přístup
get_container_metadata
Vrátí všechna uživatelem definovaná metadata pro zadaný kontejner.
get_container_metadata(container_name, lease_id=None, timeout=None)
Parametry
- lease_id
- str
Pokud zadáte hodnotu, get_container_metadata bude úspěšná jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.
Návraty
Slovník představující název metadat kontejneru a páry hodnot.
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(container_name, lease_id=None, timeout=None)
Parametry
- lease_id
- str
Pokud je zadaný parametr, get_container_properties bude úspěšný jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.
Návraty
vlastnosti zadaného kontejneru v rámci objektu kontejneru.
Návratový typ
get_user_delegation_key
Získejte klíč delegování uživatele pro účely podepisování tokenů SAS. Aby byl tento požadavek úspěšný, musí být v objektu služby k dispozici přihlašovací údaje tokenu.
get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)
Parametry
Návraty
Klíč delegování uživatele.
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 a zastaví se, jakmile se vrátí všechny objekty blob nebo se dosáhne num_results.
Pokud je zadána num_results a účet má více než tento počet objektů blob, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)
Parametry
- prefix
- str
Filtruje výsledky tak, aby vracely jenom objekty blob, jejichž názvy začínají zadanou předponou.
- num_results
- int
Určuje maximální počet objektů blob, které se mají vrátit, včetně všech <xref:azure.storage.blob.baseblobservice.BlobPrefix> prvků. Pokud požadavek neurčuje num_results nebo určuje hodnotu větší než 5 000, server vrátí až 5 000 položek. Nastavení num_results na hodnotu menší nebo rovnou nule vede k chybě s kódem odpovědi na chybu 400 (chybný požadavek).
- include
- Include
Určuje jednu nebo více dalších datových sad, které se mají zahrnout do odpovědi.
- delimiter
- str
Pokud požadavek obsahuje tento parametr, operace vrátí BlobPrefix prvek v seznamu výsledků, který funguje jako zástupný symbol pro všechny objekty blob, jejichž názvy začínají stejným podřetěžcem až do vzhledu znaku oddělovače. Oddělovačem může být jeden znak nebo řetězec.
- marker
- str
Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán num_results a tento generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil.
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 a zastaví se, jakmile se vrátí všechny objekty blob nebo se dosáhne num_results.
Pokud je zadána num_results a účet má více než tento počet objektů blob, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)
Parametry
- prefix
- str
Filtruje výsledky tak, aby vracely jenom objekty blob, jejichž názvy začínají zadanou předponou.
- num_results
- int
Určuje maximální počet objektů blob, které se mají vrátit, včetně všech <xref:azure.storage.blob.baseblobservice.BlobPrefix> prvků. Pokud požadavek neurčuje num_results nebo určuje hodnotu větší než 5 000, server vrátí až 5 000 položek. Nastavení num_results na hodnotu menší nebo rovnou nule vede k chybě s kódem odpovědi na chybu 400 (chybný požadavek).
- include
- Include
Určuje jednu nebo více dalších datových sad, které se mají zahrnout do odpovědi.
- delimiter
- str
Pokud požadavek obsahuje tento parametr, operace vrátí BlobPrefix prvek v seznamu výsledků, který funguje jako zástupný symbol pro všechny objekty blob, jejichž názvy začínají stejným podřetěžcem až do vzhledu znaku oddělovače. Oddělovačem může být jeden znak nebo řetězec.
- marker
- str
Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán num_results a tento generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil.
list_containers
Vrátí generátor pro výpis kontejnerů v zadaném účtu. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny kontejnery nebo se dosáhne num_results.
Pokud je zadána num_results a účet má více než tento počet kontejnerů, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)
Parametry
- prefix
- str
Filtruje výsledky tak, aby vracely pouze kontejnery, jejichž názvy začínají zadanou předponou.
- num_results
- int
Určuje maximální počet kontejnerů, které se mají vrátit. Jedna žádost o seznam může vrátit až 1 000 kondianerů a potenciálně token pokračování, který by měl být dodržen, aby se získaly další resutls.
- marker
- str
Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán num_results a tento generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil.
make_blob_url
Vytvoří adresu URL pro přístup k objektu blob.
make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)
Parametry
- protocol
- str
Protokol, který se má použít: http nebo https. Pokud není zadaný, použije protokol zadaný při inicializaci služby BaseBlobService.
- sas_token
- str
Token sdíleného přístupových podpisů vytvořený pomocí generate_shared_access_signature.
- snapshot
- str
Řetězcová hodnota, která jednoznačně identifikuje snímek. Hodnota tohoto parametru dotazu označuje verzi snímku.
Návraty
adresa URL přístupu k objektu blob.
Návratový typ
make_container_url
Vytvoří adresu URL pro přístup ke kontejneru.
make_container_url(container_name, protocol=None, sas_token=None)
Parametry
- protocol
- str
Protokol, který se má použít: http nebo https. Pokud není zadaný, použije protokol zadaný při inicializaci služby BaseBlobService.
- sas_token
- str
Token sdíleného přístupových podpisů vytvořený pomocí generate_shared_access_signature.
Návraty
přístupová adresa URL kontejneru.
Návratový typ
release_blob_lease
Uvolní zapůjčení. Zapůjčení může být uvolněno, pokud ID zapůjčení zadané v požadavku odpovídá id přidružené k objektu blob. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení objektu blob, jakmile se vydání dokončí.
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
- 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_match
- str
Hodnota značky ETag nebo zástupný znak (*). Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota značky ETag nebo zástupný znak (). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak () pro provedení operace pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
release_container_lease
Uvolněte zapůjčení. Zapůjčení může být uvolněno, pokud zadaný lease_id odpovídá tomu, co je přidružené ke kontejneru. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení kontejneru, jakmile se uvolnění dokončí.
release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
renew_blob_lease
Prodlouží zapůjčení. Zapůjčení je možné prodloužit, pokud ID zapůjčení zadané v požadavku odpovídá ID přidruženému k objektu blob. Mějte na paměti, že zapůjčení je možné obnovit i v případě, že vypršela jeho platnost, pokud se objekt blob od vypršení platnosti zapůjčení nezměnil nebo znovu nepronajal. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení.
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
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
Návraty
Str
renew_container_lease
Prodlouží zapůjčení. Zapůjčení je možné prodloužit, pokud zadané ID zapůjčení odpovídá ID přidruženému ke kontejneru. Mějte na paměti, že zapůjčení může být obnoveno i v případě, že jeho platnost vypršela, pokud se kontejner od vypršení platnosti zapůjčení znovu nepronajal. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení.
renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
Návraty
Str
set_blob_metadata
Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jednu nebo více dvojic název-hodnota.
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
Dict obsahující páry název a hodnota. Každé volání této operace nahradí všechna existující metadata připojená k objektu blob. Pokud chcete z objektu blob odebrat všechna metadata, zavolejte tuto operaci bez hlaviček metadat.
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
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í.
Návraty
Značka ETag a naposledy změněné vlastnosti aktualizovaného objektu blob
Návratový typ
set_blob_properties
Nastaví systémové vlastnosti objektu blob. Pokud je pro content_settings nastavená jedna vlastnost, všechny vlastnosti se přepíšou.
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
- content_settings
- ContentSettings
Objekt ContentSettings použitý k nastavení vlastností objektu blob.
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
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í.
Návraty
Značka ETag a naposledy změněné vlastnosti aktualizovaného objektu blob
Návratový typ
set_blob_service_properties
Nastaví vlastnosti služby Blob service účtu úložiště, včetně Azure Analýza úložiště. Pokud je prvek (např. Protokolování) ponechán jako None, stávající nastavení služby pro tuto funkci se zachovají.
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
- hour_metrics
- Metrics
Nastavení hodinových metrik poskytuje souhrn statistik žádostí seskupených podle rozhraní API v hodinové agregaci objektů blob.
- minute_metrics
- Metrics
Nastavení minutových metrik poskytuje statistiku požadavků pro každou minutu pro objekty blob.
- cors
- list(CorsRule)
Do seznamu můžete zahrnout až pět prvků CorsRule. Pokud zadáte prázdný seznam, odstraní se všechna pravidla CORS a CORS se pro službu zakáže.
- target_version
- str
Určuje výchozí verzi, která se má použít pro požadavky, pokud není zadaná verze příchozího požadavku.
- delete_retention_policy
- DeleteRetentionPolicy
Zásada uchovávání informací o odstranění určuje, jestli se mají zachovat odstraněné objekty blob. Určuje také počet dnů a verze objektu blob, který se má zachovat.
- static_website
- StaticWebsite
Určuje, jestli je povolená funkce statického webu, a pokud ano, označuje dokument indexu a dokument chyby 404, který se má použít.
set_container_acl
Nastaví oprávnění pro zadaný kontejner nebo uložené zásady přístupu, které lze 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_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
Parametry
- signed_identifiers
- dict(str, AccessPolicy)
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é pro službu.
- lease_id
- str
Pokud je zadaný parametr, set_container_acl bude úspěšný jenom v případě, že je zapůjčení kontejneru aktivní a odpovídá tomuto ID.
- if_modified_since
- datetime
Hodnota data a času. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného data a času změnil.
- if_unmodified_since
- datetime
Hodnota data a času. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
Návraty
Značka ETag a naposledy změněné vlastnosti aktualizovaného kontejneru
Návratový typ
set_container_metadata
Nastaví jednu 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(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)
Parametry
Dict obsahující páry název-hodnota, které se přidruží ke kontejneru jako metadata. Příklad: {'category':'test'}
- lease_id
- str
Pokud je tato hodnota zadána, 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 předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
Návraty
Značka ETag a naposledy změněné vlastnosti aktualizovaného kontejneru
Návratový typ
set_proxy
Nastaví hostitele proxy serveru a port pro tunelování HTTP CONNECT.
set_proxy(host, port, user=None, password=None)
Parametry
snapshot_blob
Vytvoří snímek objektu blob jen pro čtení.
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
Určuje uživatelsky definovanou dvojici název-hodnota přidruženou k objektu blob. Pokud nejsou zadané žádné páry název-hodnota, operace zkopíruje základní metadata objektu blob do snímku. Pokud je zadána jedna nebo více dvojic název-hodnota, snímek se vytvoří se zadanými metadaty a metadata se nezkopírují ze základního objektu blob.
- if_modified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.
- if_unmodified_since
- datetime
Hodnota DateTime. Azure očekává, že předaná hodnota 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, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.
- if_match
- str
Hodnota ETag nebo zástupný znak (*). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě.
- if_none_match
- str
Hodnota ETag nebo zástupný znak (). Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Zadejte zástupný znak (), který provede operaci pouze v případě, že prostředek neexistuje, a pokud existuje, operaci se nezdaří.
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í.
Návraty
vlastnosti snímku
Návratový typ
undelete_blob
Operace odstranění objektu blob obnoví obsah a metadata obnovitelně odstraněného objektu blob nebo snímku. Pokus o zrušení odstranění objektu blob nebo snímku, který není obnovitelně odstraněný, bude úspěšný bez jakýchkoli změn.
undelete_blob(container_name, blob_name, timeout=None)
Parametry
Atributy
protocol
request_session
socket_timeout
MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 4194304
MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
Azure SDK for Python
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro