azure.storage.blob.BlobClient class

Přerušení probíhající operace kopírování

Tím zůstane cílový objekt blob s nulovou délkou a úplnými metadaty. Pokud už operace kopírování skončila, dojde k chybě.

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

Parametry

copy_id: str nebo BlobProperties

Vyžadováno

Operace kopírování se přeruší. Může to být řetězec ID nebo instance BlobProperties.

Návratový typ

None

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é zapůjčení.

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

Parametry

lease_duration: int

Vyžadováno

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

lease_id: str

Vyžadováno

Navrhované ID zapůjčení ve formátu řetězce GUID Pokud navrhované ID zapůjčení není ve správném formátu, vrátí služba Blob Service chybu 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

Návraty

Objekt BlobLeaseClient.

Návratový typ

BlobLeaseClient

Potvrdí nový blok dat na konec existujícího doplňovacího objektu blob.

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

Parametry

data: bytes nebo str nebo Iterable

Vyžadováno

Obsah bloku. Může se jednat o bajty, text, objekt s možností iterace nebo objekt podobný souboru.

length: int

Vyžadováno

Velikost bloku v bajtech

validate_content: bool

Pokud je true, vypočítá hodnotu hash MD5 obsahu bloku. Služba úložiště zkontroluje hodnotu hash doručeného obsahu s odeslanou hodnotou hash. To je primárně užitečné pro detekci bitflips na drátu, pokud používáte http místo https, protože https (výchozí) se už ověří. Všimněte si, že tato hodnota hash MD5 se neukládá s objektem blob.

maxsize_condition: int

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

appendpos_condition: int

Volitelná podmíněná hlavička, která se používá pouze pro operaci Připojit blok. Číslo označující posun bajtů, který se má porovnat. Blok připojení bude úspěšný pouze v případě, že se pozice připojení rovná tomuto číslu. Pokud není, požadavek selže s chybou AppendPositionConditionNotMet (stavový kód HTTP 412 – Předběžná podmínka se nezdařila).

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

encoding: str

Výchozí hodnota je UTF-8.

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného objektu blob (značka Etag, poslední úprava, posun připojení, počet potvrzených bloků)

Návratový typ

dict(str, Any)

Vytvoří nový blok, který se potvrdí jako součást objektu blob, kde se obsah načte ze zdrojové adresy URL.

append_block_from_url(copy_source_url: str, source_offset: int | None = None, source_length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parametry

copy_source_url: str

Vyžadováno

Adresa URL zdrojových dat. Může odkazovat na libovolný objekt blob nebo soubor Azure, který je veřejný nebo má připojený sdílený přístupový podpis.

source_offset: int

Vyžadováno

To označuje začátek rozsahu bajtů (včetně), který je třeba vzít ze zdroje kopie.

source_length: int

Vyžadováno

Označuje konec rozsahu bajtů, které je třeba vzít ze zdroje kopírování.

source_content_md5: bytearray

V takovém případě služba vypočítá hodnotu hash MD5 obsahu bloku a porovná ji s touto hodnotou.

maxsize_condition: int

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

appendpos_condition: int

Volitelná podmíněná hlavička, která se používá pouze pro operaci Připojit blok. Číslo označující posun bajtů, který se má porovnat. Blok připojení bude úspěšný pouze v případě, že se pozice připojení rovná tomuto číslu. Pokud není, požadavek selže s chybou AppendPositionConditionNotMet (stavový kód HTTP 412 – Předběžná podmínka se nezdařila).

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

Cílová hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

match_condition: MatchConditions

Podmínka shody cíle, která se použije u značky etag.

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

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 hlavičku zadejte, pokud chcete operaci provést pouze v případě, že zdrojový prostředek byl od zadaného č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 hlavičku zadejte, pokud chcete operaci provést pouze v případě, že zdrojový prostředek nebyl od zadaného data a času změněn.

source_etag: str

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

source_match_condition: MatchConditions

Podmínka shody zdroje, která se použije u značky eTag.

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

source_authorization: str

Ověřování jako instančního objektu pomocí tajného klíče klienta pro přístup ke zdrojovému objektu blob Ujistěte se, že "bearer" je předpona řetězce source_authorization.

Vymaže rozsah stránek.

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

Parametry

offset: int

Vyžadováno

Začátek rozsahu bajtů pro zápis do oddílu objektu blob. Stránky musí být zarovnány s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

length: int

Vyžadováno

Počet bajtů, které se mají použít pro zápis do oddílu objektu blob Stránky musí být zarovnány s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

lease: BlobLeaseClient nebo str

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

if_sequence_number_lte: int

Pokud je pořadové číslo objektu blob menší než nebo rovno zadané hodnotě, požadavek pokračuje; v opačném případě selže.

if_sequence_number_lt: int

Pokud je pořadové číslo objektu blob menší než zadaná hodnota, požadavek pokračuje; v opačném případě selže.

if_sequence_number_eq: int

Pokud se pořadové číslo objektu blob rovná zadané hodnotě, požadavek pokračuje; v opačném případě selže.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

Návraty

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

Návratový typ

dict(str, Any)

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

close()

Operace Commit Block List zapíše objekt blob zadáním seznamu ID bloků, které tvoří objekt blob.

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

Parametry

block_list: list

Vyžadováno

Seznam blockblobs.

content_settings: ContentSettings

Vyžadováno

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

metadata: dict[str, str]

Vyžadováno

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

tags: dict(str, str)

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují velká a malá písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít délku 1 až 128 znaků a hodnoty značek musí obsahovat 0 až 256 znaků. Platné znaky klíče a hodnoty značky: malá a velká písmena, číslice (0–9), mezera ( >><<), plus (+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_)

Novinka ve verzi 12.4.0.

lease: BlobLeaseClient nebo str

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

immutability_policy: ImmutabilityPolicy

Určuje zásady neměnnosti objektu blob, snímku objektu blob nebo verze objektu blob.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

legal_hold: bool

Určuje se, jestli má být v objektu blob nastavené blokování z právních důvodů.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

validate_content: bool

Pokud ano, vypočítá hodnotu hash MD5 obsahu stránky. Služba úložiště zkontroluje hodnotu hash obsahu, která přišla s hodnotou hash, která byla odeslána. To je primárně užitečné pro detekci bitflips na drátu, pokud použijete http místo https, protože https (výchozí nastavení) už ověří. Všimněte si, že tato hodnota hash MD5 se s objektem blob neukládá.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s cílovým objektem blob s odpovídající hodnotou.

Novinka ve verzi 12.4.0.

standard_blob_tier: StandardBlobTier

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

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

Návratový typ

dict(str, Any)

Vytvoří nový doplňovací objekt blob. Tato operace vytvoří nový doplňovací objekt blob o délce 0. Obsah jakéhokoli existujícího objektu blob se přepíše nově inicializovaným doplňovacím objektem blob. Pokud chcete přidat obsah do doplňovacího objektu blob, zavolejte metodu append_block nebo append_block_from_url .

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

Parametry

content_settings: ContentSettings

Vyžadováno

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

metadata: dict(str, str)

Vyžadováno

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

tags: dict(str, str)

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují velká a malá písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít délku 1 až 128 znaků a hodnoty značek musí obsahovat 0 až 256 znaků. Platné znaky klíče a hodnoty značky: malá a velká písmena, číslice (0–9), mezera ( >><<), plus (+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_)

Novinka ve verzi 12.4.0.

lease: BlobLeaseClient nebo str

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

immutability_policy: ImmutabilityPolicy

Určuje zásady neměnnosti objektu blob, snímku objektu blob nebo verze objektu blob.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

legal_hold: bool

Určuje se, jestli má být v objektu blob nastavené blokování z právních důvodů.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

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

Návratový typ

dict[str, Any]

Vytvoří nový objekt blob stránky o zadané velikosti.

create_page_blob(size: int, content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, premium_page_blob_tier: str | PremiumPageBlobTier | None = None, **kwargs) -> Dict[str, str | datetime]

Parametry

size: int

Vyžadováno

Určuje maximální velikost objektu blob stránky, až 1 TB. Velikost objektu blob stránky musí být zarovnaná na hranici 512 bajtů.

content_settings: ContentSettings

Vyžadováno

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

metadata: dict(str, str)

Vyžadováno

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

premium_page_blob_tier: PremiumPageBlobTier

Vyžadováno

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

tags: dict(str, str)

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují velká a malá písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít délku 1 až 128 znaků a hodnoty značek musí obsahovat 0 až 256 znaků. Platné znaky klíče a hodnoty značky: malá a velká písmena, číslice (0–9), mezera ( >><<), plus (+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_)

Novinka ve verzi 12.4.0.

sequence_number: int

Pouze pro objekty blob stránky. Pořadové číslo je uživatelem řízená hodnota, kterou můžete použít ke sledování požadavků. Hodnota pořadového čísla musí být mezi 0 a 2^63 až 1. Výchozí hodnota je 0.

lease: BlobLeaseClient nebo str

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

immutability_policy: ImmutabilityPolicy

Určuje zásady neměnnosti objektu blob, snímku objektu blob nebo verze objektu blob.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

legal_hold: bool

Určuje se, jestli má být v objektu blob nastavené blokování z právních důvodů.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

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

Návratový typ

dict[str, Any]

Vytvoří snímek objektu blob.

Snímek je verze objektu blob jen pro čtení, která se pořídí k určitému bodu v čase. Dá se číst, kopírovat nebo odstraňovat, ale ne upravovat. Snímky poskytují způsob, jak zálohovat objekt blob tak, jak se zobrazí v okamžiku v čase.

Snímek objektu blob má stejný název jako základní objekt blob, ze kterého je snímek pořízen, s přidanou hodnotou DateTime, která označuje čas pořízení snímku.

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

Parametry

metadata: dict(str, str)

Vyžadováno

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s cílovým objektem blob s odpovídající hodnotou.

Novinka ve verzi 12.4.0.

lease: BlobLeaseClient nebo str

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného objektu blob (ID snímku, značka Etag a poslední změna)

Návratový typ

dict[str, Any]

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

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

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

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

Parametry

delete_snapshots: str

Vyžadováno

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

"only": Odstraní pouze snímky objektů blob.
"include": Odstraní objekt blob spolu se všemi snímky.

version_id: str

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

Novinka ve verzi 12.4.0.

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

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

Návratový typ

None

Operace Odstranit zásadu neměnnosti odstraní zásady neměnnosti objektu blob.

Novinka ve verzi 12.10.0: Tato operace byla zavedena ve verzi rozhraní API 2020-10-02.

delete_immutability_policy(**kwargs: Any) -> None

Parametry

timeout: int

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

Návraty

Páry klíčových hodnot značek objektů blob.

Návratový typ

Dict[str, str]

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

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

Parametry

offset: int

Vyžadováno

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

length: int

Vyžadováno

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

version_id: str

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

Novinka ve verzi 12.4.0.

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

validate_content: bool

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

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

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

max_concurrency: int

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

encoding: str

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

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

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

timeout: int

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

Návraty

Objekt streamování (StorageStreamDownloader)

Návratový typ

StorageStreamDownloader

Vrátí hodnotu True, pokud objekt blob existuje s definovanými parametry, a v opačném případě vrátí hodnotu False.

exists(**kwargs: Any) -> bool

Parametry

version_id: str

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

timeout: int

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

Návraty

boolean

Návratový typ

bool

Vytvořte Objekt BlobClient z adresy URL objektu blob. Tato možnost nepodporuje přizpůsobenou adresu URL objektu blob s /v názvu objektu blob.

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

Parametry

blob_url: str

Vyžadováno

Úplná adresa URL koncového bodu objektu blob, včetně tokenu SAS a snímku, pokud se používá. V závislosti na aktuálním location_mode to může být primární koncový bod nebo sekundární koncový bod.

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

výchozí hodnota: None

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

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

snapshot: str

výchozí hodnota: None

Volitelný snímek objektu blob, se kterým se má pracovat. Může to být řetězec ID snímku nebo odpověď vrácená z create_snapshot. Pokud je zadaný, přepíše se tím snímek v adrese URL.

version_id: str

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

Návraty

Klient objektů blob.

Návratový typ

BlobClient

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

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

Parametry

conn_str: str

Vyžadováno

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

container_name: str

Vyžadováno

Název kontejneru objektu blob.

blob_name: str

Vyžadováno

Název objektu blob, se kterým chcete pracovat.

snapshot: str

výchozí hodnota: None

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

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

výchozí hodnota: None

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

version_id: str

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

Návraty

Klient objektů blob.

Návratový typ

BlobClient

Získá informace související s účtem úložiště, ve kterém se nachází objekt blob.

Tyto informace je také možné načíst, pokud má uživatel sas ke kontejneru nebo objektu blob. Klíče ve vráceném slovníku zahrnují "sku_name" a "account_kind".

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

Návraty

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

Návratový typ

dict(str, str)

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob.

get_blob_properties(**kwargs: Any) -> BlobProperties

Parametry

lease: BlobLeaseClient nebo str

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

version_id: str

Parametr id verze je neprůselná hodnota DateTime, která pokud je k dispozici, určuje verzi objektu blob pro získání vlastností.

Novinka ve verzi 12.4.0.

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

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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes 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

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

Návraty

Vlastnosti objektu blob

Návratový typ

BlobProperties

Operace Získat značky umožňuje uživatelům získat značky pro objekt blob, konkrétní verzi objektu blob nebo snímek.

Novinka ve verzi 12.4.0: Tato operace byla zavedena ve verzi rozhraní API 2019-12-12.2012.

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

Parametry

version_id: str

Parametr id verze je neprůselná hodnota DateTime, která pokud je k dispozici, určuje verzi objektu blob, do kterého se mají přidat značky.

if_tags_match_condition: str

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

lease: BlobLeaseClient nebo str

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

timeout: int

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

Návraty

Páry klíčových hodnot značek objektů blob.

Návratový typ

Dict[str, str]

Operace Získat seznam bloků načte seznam bloků, které se nahrály jako součást objektu blob bloku.

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

Parametry

block_list_type: str

Vyžadováno

Určuje, jestli se má vrátit seznam potvrzených bloků, seznam nepotvrzených bloků nebo oba seznamy dohromady. Mezi možné hodnoty patří: "committed", 'uncommitted', 'all'

lease: BlobLeaseClient nebo str

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

if_tags_match_condition: str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze u cílového objektu blob s odpovídající hodnotou.

Novinka ve verzi 12.4.0.

timeout: int

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

Návraty

Řazená kolekce dvou seznamů – potvrzené a nepotvrzené bloky

Návratový typ

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

Vrátí seznam platných rozsahů stránek pro spravovaný disk nebo snímek.

Poznámka

Tato operace je k dispozici pouze pro účty spravovaných disků.

Novinka ve verzi 12.2.0: Tato operace byla zavedena ve verzi rozhraní API 2019-07-07.

get_page_range_diff_for_managed_disk(previous_snapshot_url: str, offset: int | None = None, length: int | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parametry

previous_snapshot_url

Vyžadováno

Určuje adresu URL předchozího snímku spravovaného disku. Odpověď bude obsahovat jenom stránky, které se změnily mezi cílovým objektem blob a jeho předchozím snímkem.

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se použije pro získání platných rozsahů stránek. Pokud není uvedena žádná délka, budou prohledány všechny bajty po posunu. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

length: int

Vyžadováno

Počet bajtů, které se mají použít pro získání platných rozsahů stránek Pokud je uvedena délka, musí být poskytnut posun. Tato oblast vrátí platné rozsahy stránek od začátku posunu až po zadanou délku. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

Návraty

Řazená kolekce členů se dvěma seznamy rozsahů stránek jako slovníky s klávesami "start" a "end". První prvek jsou vyplněné rozsahy stránek, druhý prvek je vymazán rozsahy stránek.

Návratový typ

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

ZASTARALÉ: Vrátí seznam platných rozsahů stránek pro objekt blob stránky nebo snímek objektu blob stránky.

get_page_ranges(offset: int | None = None, length: int | None = None, previous_snapshot_diff: str | Dict[str, Any] | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parametry

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se použije pro získání platných rozsahů stránek. Pokud není uvedena žádná délka, budou prohledány všechny bajty po posunu. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

length: int

Vyžadováno

Počet bajtů, které se mají použít pro získání platných rozsahů stránek Pokud je uvedena délka, musí být poskytnut posun. Tato oblast vrátí platné rozsahy stránek od začátku posunu až po zadanou délku. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

previous_snapshot_diff: str

Vyžadováno

Parametr rozdílu snímku, který obsahuje neprůselnou hodnotu DateTime, která určuje předchozí snímek objektu blob, který se má porovnat s novějším snímkem nebo aktuálním objektem blob.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

Návraty

Řazená kolekce členů se dvěma seznamy rozsahů stránek jako slovníky s klávesami "start" a "end". První prvek jsou vyplněné rozsahy stránek, druhý prvek je vymazán rozsahy stránek.

Návratový typ

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

Vrátí seznam platných rozsahů stránek pro objekt blob stránky nebo snímek objektu blob stránky. Pokud zadáte previous_snapshot , výsledkem bude rozdíl změn mezi cílovým objektem blob a předchozím snímkem.

list_page_ranges(*, offset: int | None = None, length: int | None = None, previous_snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> ItemPaged[PageRange]

Parametry

offset: int

Začátek rozsahu bajtů, který se použije pro získání platných rozsahů stránek. Pokud není uvedena žádná délka, budou prohledány všechny bajty po posunu. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

length: int

Počet bajtů, které se mají použít pro získání platných rozsahů stránek Pokud je uvedena délka, musí být poskytnut posun. Tato oblast vrátí platné rozsahy stránek od začátku posunu až po zadanou délku. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

previous_snapshot: str nebo Dict[str, Any]

Hodnota snímku, která určuje, že odpověď bude obsahovat jenom stránky, které se změnily mezi cílovým objektem blob a předchozím snímkem. Změněné stránky zahrnují aktualizované i vymazané stránky. Cílovým objektem blob může být snímek, pokud je snímek zadaný previous_snapshot starší z těchto dvou.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

results_per_page: int

Maximální počet rozsahů stránek, které se mají načíst na volání rozhraní API.

timeout: int

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

Návraty

Iterable (automatické stránkování) PageRange.

Návratový typ

ItemPaged[PageRange]

Umožňuje uživatelům vybrat nebo promítnout data objektu blob nebo snímku objektu blob tím, že poskytuje jednoduché výrazy dotazu. Tato operace vrátí objekt BlobQueryReader, uživatelé musí k získání dat dotazu použít readall() nebo readinto().

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

Parametry

query_expression: str

Vyžadováno

Povinná hodnota. příkaz dotazu. Další podrobnosti najdete tady: https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error: Callable[BlobQueryError]

Funkce, která se má volat při všech chybách zpracování vrácených službou.

blob_format: DelimitedTextDialect nebo DelimitedJsonDialect nebo QuickQueryDialect nebo str

Nepovinný parametr. Definuje serializaci dat aktuálně uložených v objektu blob. Ve výchozím nastavení se s daty objektů blob zachází jako s daty CSV formátovanými ve výchozím dialektu. To lze přepsat pomocí vlastní DelimitedTextDialect, nebo DelimitedJsonDialect nebo "ParquetDialect" (předané jako řetězec nebo výčet). Tyto dialekty lze předávat prostřednictvím příslušných tříd, výčtu QuickQueryDialect nebo jako řetězec.

output_format: DelimitedTextDialect nebo DelimitedJsonDialect nebo list[ArrowDialect] nebo QuickQueryDialect nebo str

Nepovinný parametr. Definuje výstupní serializaci pro datový proud. Ve výchozím nastavení se data vrátí tak, jak jsou reprezentovaná v objektu blob (výchozí formát Parquet je DelimitedTextDialect). Poskytnutím výstupního formátu se data objektů blob přeformátují podle daného profilu. Tato hodnota může být DelimitedTextDialect nebo DelimitedJsonDialect nebo ArrowDialect. Tyto dialekty lze předávat prostřednictvím příslušných tříd, výčtu QuickQueryDialect nebo jako řetězec.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

Zašifruje data na straně služby pomocí daného klíče. Klíče poskytnuté zákazníkem se musí používat přes 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

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

Návraty

Objekt streamování (BlobQueryReader)

Návratový typ

BlobQueryReader

Změní velikost objektu blob stránky na zadanou velikost.

Pokud je zadaná hodnota menší než aktuální velikost objektu blob, vymažou se všechny stránky nad zadanou hodnotou.

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

Parametry

size: int

Vyžadováno

Velikost použitá ke změně velikosti objektu blob Maximální velikost objektu blob stránky je až 1 TB. Velikost objektu blob stránky musí být zarovnaná na hranici 512 bajtů.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

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

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného objektu blob (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Operace Seal zapečetí objekt blob připojení, aby byl jen pro čtení.

Novinka ve verzi 12.4.0.

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

Parametry

appendpos_condition: int

Volitelná podmíněná hlavička, která se používá pouze pro operaci Připojit blok. Číslo označující posun bajtů, který se má porovnat. Blok připojení bude úspěšný pouze v případě, že se pozice připojení rovná tomuto číslu. Pokud není, požadavek selže s chybou AppendPositionConditionNotMet (stavový kód HTTP 412 – Předběžná podmínka se nezdařila).

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného objektu blob (značka Etag, poslední úprava, posun připojení, počet potvrzených bloků)

Návratový typ

dict(str, Any)

Nastaví uživatelem definovaná metadata pro objekt blob jako jeden nebo více dvojic název-hodnota.

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

Parametry

metadata: dict(str, str)

Vyžadováno

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.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

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

Operace Nastavit značky umožňuje uživatelům nastavit značky pro objekt blob nebo konkrétní verzi objektu blob, ale ne pro snímek. Každé volání této operace nahradí všechny existující značky připojené k objektu blob. Pokud chcete z objektu blob odebrat všechny značky, zavolejte tuto operaci bez nastavených značek.

Novinka ve verzi 12.4.0: Tato operace byla zavedena ve verzi rozhraní API 2019-12-12.2012.

set_blob_tags(tags: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

Parametry

tags: dict(str, str)

Vyžadováno

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují malá a velká písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít 1 až 128 znaků a hodnoty značek musí mít 0 až 256 znaků. Platné znaky klíče značky a hodnoty: malá a velká písmena, číslice (0-9), mezera (), plus ( >><<+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_).

version_id: str

Parametr id verze je neprůselná hodnota DateTime, která pokud je k dispozici, určuje verzi objektu blob, do kterého se mají přidat značky.

validate_content: bool

Pokud je true, vypočítá hodnotu hash MD5 obsahu značek. Služba úložiště zkontroluje hodnotu hash doručeného obsahu s odeslanou hodnotou hash. To je primárně užitečné pro detekci bitflips na drátu, pokud používáte http místo https, protože https (výchozí) se už ověří. Všimněte si, že tato hodnota hash MD5 se neukládá s objektem blob.

if_tags_match_condition: str

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

lease: BlobLeaseClient nebo str

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

timeout: int

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

Návraty

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

Návratový typ

Dict[str, Any]

Nastaví systémové vlastnosti objektu blob.

Pokud je pro content_settings nastavená jedna vlastnost, všechny vlastnosti se přepíšou.

set_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None

Parametry

content_settings: ContentSettings

Vyžadováno

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

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

Návraty

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

Návratový typ

Dict[str, Any]

Operace Nastavit zásadu neměnnosti nastaví zásadu neměnnosti objektu blob.

Novinka ve verzi 12.10.0: Tato operace byla zavedena ve verzi rozhraní API z 2020-10-02.

set_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]

Parametry

immutability_policy: ImmutabilityPolicy

Vyžadováno

Určuje zásady neměnnosti objektu blob, snímku objektu blob nebo verze objektu blob.

Novinka ve verzi 12.10.0: Tato funkce byla zavedena ve verzi rozhraní API z 2020-10-02.

timeout: int

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

Návraty

Páry klíčových hodnot značek objektů blob.

Návratový typ

Dict[str, str]

Operace Nastavit blokování z právních důvodů nastaví blokování objektu blob z právních důvodů.

Novinka ve verzi 12.10.0: Tato operace byla zavedena ve verzi rozhraní API 2020-10-02.

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

Parametry

legal_hold: bool

Vyžadováno

Určuje se, jestli se má pro objekt blob nastavit blokování z právních důvodů.

timeout: int

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

Návraty

Páry klíčových hodnot značek objektů blob.

Návratový typ

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

Nastaví vrstvy objektů blob stránky v objektu blob. Toto rozhraní API se podporuje jenom pro objekty blob stránky na účtech Premium.

set_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None

Parametry

premium_page_blob_tier: PremiumPageBlobTier

Vyžadováno

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

lease: BlobLeaseClient nebo str

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

Návratový typ

None

Nastaví pořadové číslo objektu blob.

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

Parametry

sequence_number_action: str

Vyžadováno

Tato vlastnost označuje, jak má služba upravit pořadové číslo objektu blob. Další informace naleznete v tématu SequenceNumberAction.

sequence_number: str

Vyžadováno

Tato vlastnost nastaví pořadové číslo objektu blob. Pořadové číslo je uživatelem řízená vlastnost, kterou můžete použít ke sledování požadavků a správě problémů se souběžností.

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

Návraty

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

Návratový typ

dict(str, Any)

Tato operace nastaví úroveň objektu blob bloku.

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

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

Parametry

standard_blob_tier: str nebo StandardBlobTier

Vyžadováno

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

rehydrate_priority: RehydratePriority

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

version_id: str

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

Novinka ve verzi 12.4.0.

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

timeout: int

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

lease: BlobLeaseClient nebo str

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

Návratový typ

None

Vytvoří nový blok, který se potvrdí jako součást objektu blob.

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

Parametry

block_id: str

Vyžadováno

Řetězcová hodnota, která identifikuje blok. Velikost řetězce by měla být menší nebo rovna 64 bajtům. Pro daný objekt blob musí mít block_id stejnou velikost pro každý blok.

data

Vyžadováno

Data objektů blob.

length: int

Vyžadováno

Velikost bloku.

validate_content: bool

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

lease: BlobLeaseClient nebo str

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

encoding: str

Výchozí hodnota je UTF-8.

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

Návraty

Dikt vlastnosti objektu blob.

Návratový typ

dict[str, Any]

Vytvoří nový blok, který se potvrdí jako součást objektu blob, kde se obsah načte z adresy URL.

stage_block_from_url(block_id: str | int, source_url: str, source_offset: int | None = None, source_length: int | None = None, source_content_md5: bytes | bytearray | None = None, **kwargs) -> Dict[str, Any]

Parametry

block_id: str

Vyžadováno

Řetězcová hodnota, která identifikuje blok. Velikost řetězce by měla být menší nebo rovna 64 bajtům. Pro daný objekt blob musí mít block_id stejnou velikost pro každý blok.

source_url: str

Vyžadováno

Adresa URL.

source_offset: int

Vyžadováno

Začátek rozsahu bajtů, který se má použít pro blok. Pokud je k dispozici délka zdroje, musí být nastavená.

source_length: int

Vyžadováno

Velikost bloku v bajtech.

source_content_md5: bytearray

Vyžadováno

Zadejte md5 vypočítaný pro rozsah bajtů, které musí být načteny ze zdroje kopírování.

lease: BlobLeaseClient nebo str

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

source_authorization: str

Ověření jako instančního objektu pomocí tajného klíče klienta pro přístup ke zdrojovému objektu blob Ujistěte se, že "bearer" je předpona řetězce source_authorization.

Návraty

Dikt vlastnosti objektu blob.

Návratový typ

dict[str, Any]

Zkopíruje objekt blob z dané adresy URL.

Tato operace vrátí slovník obsahující copy_status a copy_id, který lze použít ke kontrole stavu operace kopírování nebo k přerušení operace kopírování. copy_status bude "úspěch", pokud se kopírování dokončilo synchronně, nebo "čeká na vyřízení", pokud bylo kopírování spuštěno asynchronně. U asynchronních kopií je možné stav zkontrolovat dotazováním get_blob_properties metody a kontrolou stavu kopírování. Pokud chcete vynutit synchronní kopírování, nastavte requires_sync na True. 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.

start_copy_from_url(source_url: str, metadata: Dict[str, str] | None = None, incremental_copy: bool = False, **kwargs: Any) -> Dict[str, str | datetime]

Parametry

source_url: str

Vyžadováno

Adresa URL o délce až 2 kB, která určuje soubor 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/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata: dict(str, str)

Vyžadováno

Páry název-hodnota přidružené k objektu blob jako metadata. Pokud nejsou zadány žá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án jeden nebo více dvojic název-hodnota, cílový objekt blob se vytvoří se zadanými metadaty a metadata se nezkopírují ze zdrojového objektu blob nebo souboru.

incremental_copy: bool

Vyžadováno

Zkopíruje snímek objektu blob zdrojové stránky do cílového objektu blob stránky. Snímek se zkopíruje tak, aby se do cíle přenesly pouze rozdílové změny mezi dříve zkopírovaným snímkem. Zkopírované snímky jsou kompletní kopie původního snímku a je možné je číst nebo kopírovat jako obvykle. Výchozí hodnota je False.

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

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují velká a malá písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít délku 1 až 128 znaků a hodnoty značek musí obsahovat 0 až 256 znaků. Mezi platné znaky klíče a hodnoty značky patří: malá a velká písmena, číslice (0–9), mezera ( >><<), plus (+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_).

Literál COPY (rozlišují se velká a malá písmena) se místo toho dá předat ke kopírování značek ze zdrojového objektu blob. Tato možnost je dostupná jenom v případě , že incremental_copy=False a requires_sync=True.

Novinka ve verzi 12.4.0.

immutability_policy: ImmutabilityPolicy

Určuje zásady neměnnosti objektu blob, snímku objektu blob nebo verze objektu blob.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

legal_hold: bool

Určuje se, jestli má být v objektu blob nastavené blokování z právních důvodů.

Novinka ve verzi 12.10.0: Tato verze byla zavedena ve verzi rozhraní API '2020-10-02'.

source_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 podmíněnou hlavičku zadejte pro zkopírování objektu blob pouze v případě, že se zdrojový objekt blob od zadaného data a času změnil.

source_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. Zadáním této podmíněné hlavičky zkopírujete objekt blob pouze v případě, že zdrojový objekt blob nebyl od zadaného data a času změněn.

source_etag: str

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

source_match_condition: MatchConditions

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

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. Zadáním této podmíněné hlavičky zkopírujete objekt blob jenom 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).

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. Zadáním této podmíněné hlavičky zkopírujete objekt blob jenom v případě, že se cílový objekt blob od zadaného data a času nezměnil. 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).

etag: str

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

match_condition: MatchConditions

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

destination_lease: BlobLeaseClient nebo 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: BlobLeaseClient nebo 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á aktivnímu ID zapůjčení zdrojového objektu blob.

timeout: int

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

premium_page_blob_tier: PremiumPageBlobTier

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

standard_blob_tier: StandardBlobTier

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

rehydrate_priority: RehydratePriority

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

seal_destination_blob: bool

Zapečetění cílového doplňovacího objektu blob Tato operace je určena pouze pro doplňovací objekt blob.

Novinka ve verzi 12.4.0.

requires_sync: bool

Vynucuje, že služba nevrátí odpověď, dokud se kopírování nedokoní.

source_authorization: str

Ověření jako instančního objektu pomocí tajného klíče klienta pro přístup ke zdrojovému objektu blob Ujistěte se, že "bearer" je předpona řetězce source_authorization. Tato možnost je dostupná jenom v případě , že je incremental_copy nastavená na Hodnotu False a requires_sync je nastavená na Hodnotu True.

Novinka ve verzi 12.9.0.

encryption_scope: str

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

Novinka ve verzi 12.10.0.

Návraty

Slovník vlastností kopírování (etag, last_modified, copy_id copy_status).

Návratový typ

dict[str, Union[str, datetime]]

Obnoví obnovitelně odstraněné objekty blob nebo snímky.

Operace bude úspěšná jenom v případě, že se použije v rámci zadaného počtu dnů nastaveného v zásadách uchovávání informací o odstranění.

Pokud je povolená správa verzí objektu blob, nelze pomocí této metody obnovit základní objekt blob. Místo toho použijte start_copy_from_url adresu URL verze objektu blob, kterou chcete zvýšit na aktuální verzi.

undelete_blob(**kwargs: Any) -> None

Parametry

timeout: int

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

Návratový typ

None

Vytvoří nový objekt blob ze zdroje dat s automatickým vytvářením bloků dat.

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

Parametry

data

Vyžadováno

Data objektu blob, která se mají nahrát.

blob_type: BlobType

Vyžadováno

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

length: int

Vyžadováno

Počet bajtů, které se mají číst z datového proudu Tato možnost je volitelná, ale pro zajištění optimálního výkonu by měla být dodána.

metadata: dict(str, str)

Vyžadováno

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

tags: dict(str, str)

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují malá a velká písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít 1 až 128 znaků a hodnoty značek musí mít 0 až 256 znaků. Platné znaky klíče značky a hodnoty: malá a velká písmena, číslice (0-9), mezera (), plus ( >><<+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_).

Novinka ve verzi 12.4.0.

overwrite: bool

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

content_settings: ContentSettings

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

validate_content: bool

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

lease: BlobLeaseClient nebo str

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

if_modified_since: datetime

Hodnota DateTime. Azure očekává, že 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.

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

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

standard_blob_tier: StandardBlobTier

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

immutability_policy: ImmutabilityPolicy

Určuje zásady neměnnosti objektu blob, snímku objektu blob nebo verze objektu blob. V současné době je tento parametr rozhraní API upload_blob() pouze pro BlockBlob.

Novinka ve verzi 12.10.0: Tato funkce byla zavedena ve verzi rozhraní API z 2020-10-02.

legal_hold: bool

Určuje se, jestli se má pro objekt blob nastavit blokování z právních důvodů. V současné době je tento parametr rozhraní API upload_blob() pouze pro BlockBlob.

Novinka ve verzi 12.10.0: Tato funkce byla zavedena ve verzi rozhraní API z 2020-10-02.

maxsize_condition: int

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

max_concurrency: int

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

encoding: str

Výchozí hodnota je UTF-8.

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

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

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného objektu blob (značka Etag a poslední úprava)

Návratový typ

dict[str, Any]

Vytvoří nový objekt blob bloku, ve kterém se obsah objektu blob přečte z dané adresy URL. Obsah existujícího objektu blob se přepíše novým objektem blob.

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

Parametry

source_url: str

Vyžadováno

Adresa URL o délce až 2 kB, která určuje soubor 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/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

overwrite: bool

Jestli má objekt blob, který se má nahrát, přepsat aktuální data. Pokud je true, upload_blob přepíše existující data. Pokud je nastavená hodnota False, operace selže s chybou ResourceExistsError.

include_source_blob_properties: bool

Určuje, jestli se mají zkopírovat vlastnosti ze zdrojového objektu blob. Výchozí hodnota je Pravda.

tags: dict(str, str)

Páry název-hodnota přidružené k objektu blob jako značka. U značek se rozlišují velká a malá písmena. Sada značek může obsahovat maximálně 10 značek. Klíče značek musí mít délku 1 až 128 znaků a hodnoty značek musí obsahovat 0 až 256 znaků. Platné znaky klíče a hodnoty značky: malá a velká písmena, číslice (0–9), mezera ( >><<), plus (+), minus (-), tečka (.), solidus (/), dvojtečka (:), rovná se (=), podtržítko (_)

source_content_md5: bytearray

Zadejte md5, který se používá k ověření integrity zdrojových bajtů.

source_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. Zadáním této hlavičky provedete operaci pouze v případě, že zdrojový prostředek byl od zadaného času změněn.

source_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 zdrojový prostředek nebyl od zadaného data a času změněn.

source_etag: str

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

source_match_condition: MatchConditions

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

destination_lease: BlobLeaseClient nebo 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).

timeout: int

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

content_settings: ContentSettings

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

standard_blob_tier: StandardBlobTier

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

source_authorization: str

Ověření jako instančního objektu pomocí tajného klíče klienta pro přístup ke zdrojovému objektu blob Ujistěte se, že "bearer" je předpona řetězce source_authorization.

Operace Nahrát stránky zapíše rozsah stránek do objektu blob stránky.

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

Parametry

page: bytes

Vyžadováno

Obsah stránky.

offset: int

Vyžadováno

Začátek rozsahu bajtů, který se má použít pro zápis do části objektu blob. Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

length: int

Vyžadováno

Počet bajtů, které se mají použít pro zápis do části objektu blob Stránky musí být zarovnané s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

lease: BlobLeaseClient nebo str

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

validate_content: bool

Pokud ano, vypočítá hodnotu hash MD5 obsahu stránky. Služba úložiště zkontroluje hodnotu hash obsahu, která přišla s hodnotou hash, která byla odeslána. To je primárně užitečné pro detekci bitflips na drátu, pokud použijete http místo https, protože https (výchozí nastavení) už ověří. Všimněte si, že tato hodnota hash MD5 se s objektem blob neukládá.

if_sequence_number_lte: int

Pokud je pořadové číslo objektu blob menší než nebo rovno zadané hodnotě, požadavek pokračuje; v opačném případě selže.

if_sequence_number_lt: int

Pokud je pořadové číslo objektu blob menší než zadaná hodnota, požadavek pokračuje; v opačném případě selže.

if_sequence_number_eq: int

Pokud se pořadové číslo objektu blob rovná zadané hodnotě, požadavek pokračuje; v opačném případě selže.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

encoding: str

Výchozí hodnota je UTF-8.

timeout: int

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

Návraty

Dikt vlastnosti aktualizovaného objektu blob (značka Etag a naposledy změněno)

Návratový typ

dict(str, Any)

Operace Nahrát stránky zapíše rozsah stránek do objektu blob stránky, kde se obsah přečte z adresy URL.

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

Parametry

source_url: str

Vyžadováno

Adresa URL zdrojových dat. Může odkazovat na libovolný objekt blob nebo soubor Azure, který je veřejný nebo má připojený sdílený přístupový podpis.

offset: int

Vyžadováno

Začátek rozsahu bajtů pro zápis do oddílu objektu blob. Stránky musí být zarovnány s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

length: int

Vyžadováno

Počet bajtů, které se mají použít pro zápis do oddílu objektu blob Stránky musí být zarovnány s hranicemi 512 bajtů, počáteční posun musí být modul 512 a délka musí být modul 512.

source_offset: int

Vyžadováno

To označuje začátek rozsahu bajtů (včetně), který se má ze zdroje kopírování přebít. Služba načte stejný počet bajtů jako cílový rozsah (posun délky).

source_content_md5: bytes

V takovém případě služba vypočítá hodnotu hash MD5 obsahu bloku a porovná ji s touto hodnotou.

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 hlavičku zadejte, pokud chcete operaci provést pouze v případě, že zdrojový prostředek byl od zadaného č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 hlavičku zadejte, pokud chcete operaci provést pouze v případě, že zdrojový prostředek nebyl od zadaného data a času změněn.

source_etag: str

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

source_match_condition: MatchConditions

Podmínka shody zdroje, která se použije u značky eTag.

lease: BlobLeaseClient nebo str

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

if_sequence_number_lte: int

Pokud je pořadové číslo objektu blob menší než nebo rovno zadané hodnotě, požadavek pokračuje; v opačném případě selže.

if_sequence_number_lt: int

Pokud je pořadové číslo objektu blob menší než zadaná hodnota, požadavek pokračuje; v opačném případě selže.

if_sequence_number_eq: int

Pokud se pořadové číslo objektu blob rovná zadané hodnotě, požadavek pokračuje; v opačném případě selže.

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.

etag: str

Cílová hodnota značky ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

match_condition: MatchConditions

Podmínka shody cíle, která se použije u značky etag.

if_tags_match_condition: str

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

Novinka ve verzi 12.4.0.

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

Novinka ve verzi 12.2.0.

timeout: int

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

source_authorization: str

Ověřování jako instančního objektu pomocí tajného klíče klienta pro přístup ke zdrojovému objektu blob Ujistěte se, že "bearer" je předpona řetězce source_authorization.

Verze rozhraní API služby Storage používaná pro požadavky.

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

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

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

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

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

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

Výjimky

ValueError

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

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

Úplná adresa URL koncového bodu této entity, včetně tokenu SAS, pokud se používá.

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

abort_copy	Přerušení probíhající operace kopírování Tím zůstane cílový objekt blob s nulovou délkou a úplnými metadaty. Pokud už operace kopírování skončila, dojde k chybě.
acquire_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é zapůjčení.
append_block	Potvrdí nový blok dat na konec existujícího doplňovacího objektu blob.
append_block_from_url	Vytvoří nový blok, který se potvrdí jako součást objektu blob, kde se obsah načte ze zdrojové adresy URL.
clear_page	Vymaže rozsah stránek.
close	Tato metoda slouží k zavření soketů otevřených klientem. Nemusí se používat při použití se správcem kontextu.
commit_block_list	Operace Commit Block List zapíše objekt blob zadáním seznamu ID bloků, které tvoří objekt blob.
create_append_blob	Vytvoří nový doplňovací objekt blob. Tato operace vytvoří nový doplňovací objekt blob o délce 0. Obsah jakéhokoli existujícího objektu blob se přepíše nově inicializovaným doplňovacím objektem blob. Pokud chcete přidat obsah do doplňovacího objektu blob, zavolejte metodu append_block nebo append_block_from_url .
create_page_blob	Vytvoří nový objekt blob stránky o zadané velikosti.
create_snapshot	Vytvoří snímek objektu blob. Snímek je verze objektu blob jen pro čtení, která se pořídí k určitému bodu v čase. Dá se číst, kopírovat nebo odstraňovat, ale ne upravovat. Snímky poskytují způsob, jak zálohovat objekt blob tak, jak se zobrazí v okamžiku v čase. Snímek objektu blob má stejný název jako základní objekt blob, ze kterého je snímek pořízen, s přidanou hodnotou DateTime, která označuje čas pořízení snímku.
delete_blob	Označí zadaný objekt blob pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obě operace můžete odstranit současně pomocí operace delete_blob(). Pokud je pro službu povolená zásada uchovávání informací o odstranění, pak tato operace obnovitelné odstranění objektu blob a zachová objekt blob po zadaný počet dnů. Po zadaném počtu dnů se data objektu blob odeberou ze služby během uvolňování paměti. Obnovitelně odstraněný objekt blob je přístupný zadáním list_blobs možnosti include=['deleted']. Obnovitelně odstraněný objekt blob je možné obnovit pomocí <xref:azure.storage.blob.undelete> operace.
delete_immutability_policy	Operace Odstranit zásadu neměnnosti odstraní zásady neměnnosti objektu blob. Novinka ve verzi 12.10.0: Tato operace byla zavedena ve verzi rozhraní API 2020-10-02.
download_blob	Stáhne objekt blob do storageStreamDownloaderu. Ke čtení veškerého obsahu se musí použít metoda readall() nebo ke stažení objektu blob do datového proudu se musí použít metoda readinto(). Použití chunks() vrátí iterátor, který uživateli umožní iterovat obsah v blocích.
exists	Vrátí hodnotu True, pokud objekt blob existuje s definovanými parametry, a v opačném případě vrátí hodnotu False.
from_blob_url	Vytvořte Objekt BlobClient z adresy URL objektu blob. Tato možnost nepodporuje přizpůsobenou adresu URL objektu blob s /v názvu objektu blob.
from_connection_string	Vytvořte Objekt BlobClient z připojovacího řetězce.
get_account_information	Získá informace související s účtem úložiště, ve kterém se nachází objekt blob. Tyto informace je také možné načíst, pokud má uživatel sas ke kontejneru nebo objektu blob. Klíče ve vráceném slovníku zahrnují "sku_name" a "account_kind".
get_blob_properties	Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob.
get_blob_tags	Operace Získat značky umožňuje uživatelům získat značky pro objekt blob, konkrétní verzi objektu blob nebo snímek. Novinka ve verzi 12.4.0: Tato operace byla zavedena ve verzi rozhraní API 2019-12-12.2012.
get_block_list	Operace Získat seznam bloků načte seznam bloků, které se nahrály jako součást objektu blob bloku.
get_page_range_diff_for_managed_disk	Vrátí seznam platných rozsahů stránek pro spravovaný disk nebo snímek. Poznámka Tato operace je k dispozici pouze pro účty spravovaných disků. Novinka ve verzi 12.2.0: Tato operace byla zavedena ve verzi rozhraní API 2019-07-07.
get_page_ranges	ZASTARALÉ: Vrátí seznam platných rozsahů stránek pro objekt blob stránky nebo snímek objektu blob stránky.
list_page_ranges	Vrátí seznam platných rozsahů stránek pro objekt blob stránky nebo snímek objektu blob stránky. Pokud zadáte previous_snapshot , výsledkem bude rozdíl změn mezi cílovým objektem blob a předchozím snímkem.
query_blob	Umožňuje uživatelům vybrat nebo promítnout data objektu blob nebo snímku objektu blob tím, že poskytuje jednoduché výrazy dotazu. Tato operace vrátí objekt BlobQueryReader, uživatelé musí k získání dat dotazu použít readall() nebo readinto().
resize_blob	Změní velikost objektu blob stránky na zadanou velikost. Pokud je zadaná hodnota menší než aktuální velikost objektu blob, vymažou se všechny stránky nad zadanou hodnotou.
seal_append_blob	Operace Seal zapečetí objekt blob připojení, aby byl jen pro čtení. Novinka ve verzi 12.4.0.
set_blob_metadata	Nastaví uživatelem definovaná metadata pro objekt blob jako jeden nebo více dvojic název-hodnota.
set_blob_tags	Operace Nastavit značky umožňuje uživatelům nastavit značky pro objekt blob nebo konkrétní verzi objektu blob, ale ne pro snímek. Každé volání této operace nahradí všechny existující značky připojené k objektu blob. Pokud chcete z objektu blob odebrat všechny značky, zavolejte tuto operaci bez nastavených značek. Novinka ve verzi 12.4.0: Tato operace byla zavedena ve verzi rozhraní API 2019-12-12.2012.
set_http_headers	Nastaví systémové vlastnosti objektu blob. Pokud je pro content_settings nastavená jedna vlastnost, všechny vlastnosti se přepíšou.
set_immutability_policy	Operace Nastavit zásadu neměnnosti nastaví zásadu neměnnosti objektu blob. Novinka ve verzi 12.10.0: Tato operace byla zavedena ve verzi rozhraní API z 2020-10-02.
set_legal_hold	Operace Nastavit blokování z právních důvodů nastaví blokování objektu blob z právních důvodů. Novinka ve verzi 12.10.0: Tato operace byla zavedena ve verzi rozhraní API 2020-10-02.
set_premium_page_blob_tier	Nastaví vrstvy objektů blob stránky v objektu blob. Toto rozhraní API se podporuje jenom pro objekty blob stránky na účtech Premium.
set_sequence_number	Nastaví pořadové číslo objektu blob.
set_standard_blob_tier	Tato operace nastaví úroveň objektu blob bloku. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob.
stage_block	Vytvoří nový blok, který se potvrdí jako součást objektu blob.
stage_block_from_url	Vytvoří nový blok, který se potvrdí jako součást objektu blob, kde se obsah načte z adresy URL.
start_copy_from_url	Zkopíruje objekt blob z dané adresy URL. Tato operace vrátí slovník obsahující copy_status a copy_id, který lze použít ke kontrole stavu operace kopírování nebo k přerušení operace kopírování. copy_status bude "úspěch", pokud se kopírování dokončilo synchronně, nebo "čeká na vyřízení", pokud bylo kopírování spuštěno asynchronně. U asynchronních kopií je možné stav zkontrolovat dotazováním get_blob_properties metody a kontrolou stavu kopírování. Pokud chcete vynutit synchronní kopírování, nastavte requires_sync na True. 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.
undelete_blob	Obnoví obnovitelně odstraněné objekty blob nebo snímky. Operace bude úspěšná jenom v případě, že se použije v rámci zadaného počtu dnů nastaveného v zásadách uchovávání informací o odstranění. Pokud je povolená správa verzí objektu blob, nelze pomocí této metody obnovit základní objekt blob. Místo toho použijte start_copy_from_url adresu URL verze objektu blob, kterou chcete zvýšit na aktuální verzi.
upload_blob	Vytvoří nový objekt blob ze zdroje dat s automatickým vytvářením bloků dat.
upload_blob_from_url	Vytvoří nový objekt blob bloku, ve kterém se obsah objektu blob přečte z dané adresy URL. Obsah existujícího objektu blob se přepíše novým objektem blob.
upload_page	Operace Nahrát stránky zapíše rozsah stránek do objektu blob stránky.
upload_pages_from_url	Operace Nahrát stránky zapíše rozsah stránek do objektu blob stránky, kde se obsah přečte z adresy URL.

BlobClient Třída

Konstruktor

Parametry

Metody

abort_copy

Parametry

Návratový typ

acquire_lease

Parametry

Návraty

Návratový typ

append_block

Parametry

Návraty

Návratový typ

append_block_from_url

Parametry

clear_page

Parametry

Návraty

Návratový typ

close

commit_block_list

Parametry

Návraty

Návratový typ

create_append_blob

Parametry

Návraty

Návratový typ

create_page_blob

Parametry

Návraty

Návratový typ

create_snapshot

Parametry

Návraty

Návratový typ

delete_blob

Parametry

Návratový typ

delete_immutability_policy

Parametry

Návraty

Návratový typ

download_blob

Parametry

Návraty

Návratový typ

exists

Parametry

Návraty

Návratový typ

from_blob_url

Parametry

Návraty

Návratový typ

from_connection_string

Parametry

Návraty

Návratový typ

get_account_information

Návraty

Návratový typ

get_blob_properties

Parametry

Návraty

Návratový typ

get_blob_tags

Parametry

Návraty

Návratový typ

get_block_list

Parametry

Návraty

Návratový typ

get_page_range_diff_for_managed_disk

Parametry

Návraty

Návratový typ