BlockBlobClient class
BlockBlobClient definuje sadu operací použitelných pro objekty blob bloku.
- Extends
Konstruktory
Block |
Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL NEBUDE dvakrát uváděn, pouze speciální znaky v cestě URL budou unikovány. Pokud název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL. |
Block |
Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL NEBUDE dvakrát uváděn, pouze speciální znaky v cestě URL budou unikovány. Pokud název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL. |
Block |
Vytvoří instanci BlockBlobClient. |
Vlastnosti
container |
Název kontejneru úložiště, ke které je objekt blob přidružený. |
name | Název objektu blob. |
Zděděné vlastnosti
account |
|
credential | Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z |
url | Zakódovaná hodnota řetězce adresy URL. |
Metody
commit |
Zapíše objekt blob zadáním seznamu ID bloků, která tvoří objekt blob. Aby se blok zapisoval jako součást objektu blob, musí být úspěšně zapsán na server v předchozí fázi OperaceBlock . Pokud chcete aktualizovat objekt blob, můžete volat commitBlockList tak, že nahrajete jenom ty bloky, které se změnily, a pak společně potvrdíte nový a existující blok. Všechny bloky, které nejsou zadané v seznamu blokovaných a trvale odstraněny. Viz https://docs.microsoft.com/rest/api/storageservices/put-block-list. |
get |
Vrátí seznam bloků, které byly odeslány jako součást objektu blob bloku pomocí zadaného filtru seznamu bloků. Viz https://docs.microsoft.com/rest/api/storageservices/get-block-list. |
query(string, Block |
K DISPOZICI POUZE V NODE.JS RUNTIME. Rychlý dotaz na objekt blob ve formátu JSON nebo CSV Příklad použití (Node.js):
|
stage |
Nahraje zadaný blok do "pracovní oblasti" objektu blob bloku, aby byl později potvrzen voláním commitBlockList. Viz https://docs.microsoft.com/rest/api/storageservices/put-block. |
stage |
Operace Blokování fáze z adresy URL vytvoří nový blok, který se potvrdí jako součást objektu blob, ve kterém se obsah načítá z adresy URL. Toto rozhraní API je k dispozici od verze 2018-03-28. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url. |
sync |
Vytvoří nový objekt blob bloku, ve kterém se obsah objektu blob přečte z dané adresy URL. Toto rozhraní API se podporuje od verze 2020-04-08. Částečné aktualizace nejsou podporovány s vložením objektu blob z adresy URL. obsah existujícího objektu blob se přepíše obsahem nového objektu blob. Pokud chcete provést částečné aktualizace obsahu objektu blob bloku pomocí zdrojové adresy URL, použijte stageBlockFromURL a commitBlockList. |
upload(Request |
Vytvoří nový objekt blob bloku nebo aktualizuje obsah existujícího objektu blob bloku. Aktualizace existujícího objektu blob bloku přepíše všechna existující metadata objektu blob. Částečné aktualizace nejsou podporovány. obsah existujícího objektu blob se přepíše novým obsahem. Pokud chcete provést částečnou aktualizaci objektů blob bloku, použijte stageBlock a commitBlockList. Toto je neelní metoda nahrávání. Pro zajištění lepšího výkonu při souběžném nahrávání použijte uploadFile, uploadStream nebo uploadBrowserData . Viz https://docs.microsoft.com/rest/api/storageservices/put-blob. |
upload |
K DISPOZICI POUZE V PROHLÍŽEČÍCH. Nahraje objekt Blob/File/ArrayBuffer/ArrayBufferView prohlížeče do objektu blob bloku. Pokud je délka vyrovnávací paměti menší nebo rovna 256 MB, tato metoda k dokončení nahrávání použije 1 volání nahrávání. V opačném případě tato metoda zavolá stageBlock k nahrání bloků a nakonec zavolá commitBlockList k potvrzení seznamu blokovaných. Běžnou možností nastavení objektu blobHTTPHeaders je |
upload |
Nahraje buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView objektu BlockBlob. Pokud délka dat není větší než specifikovaná hodnota maxSingleShotSize (výchozí hodnota je <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), použije tato metoda k dokončení nahrávání 1 volání nahrávání . V opačném případě tato metoda zavolá stageBlock k nahrání bloků a nakonec zavolá commitBlockList k potvrzení seznamu blokovaných. Běžnou možností nastavení objektu blobHTTPHeaders je |
upload |
K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje místní soubor v blocích do objektu blob bloku. Pokud je velikost souboru menší nebo rovna 256 MB, použije tato metoda k dokončení nahrávání 1 volání. V opačném případě tato metoda zavolá stageBlock k nahrání bloků a nakonec zavolá commitBlockList k potvrzení seznamu blokovaných. |
upload |
K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje Node.js čitelný stream do objektu blob bloku. TIPY KE ZLEPŠENÍ VÝKONU:
|
with |
Vytvoří nový objekt BlockBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Pokud zadáte , odebere se snímek a vrátí adresu URL základního objektu blob. |
Zděděné metody
abort |
Přeruší čekající asynchronní operaci kopírování objektu blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty. Verze 2012-02-12 a novější. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob. |
begin |
Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště.
Tato metoda vrátí dlouhotrvající operaci poller, který umožňuje čekat neomezeně dlouho, dokud se kopírování nedokončí.
Můžete také zrušit kopii před jejím dokončením zavoláním Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektu blob potvrzený objekt blob v libovolném účtu úložiště Azure. Od verze 2015-02-21 může být zdrojem operace kopírování objektu blob soubor Azure v libovolném účtu úložiště Azure. Kopírování z jiného účtu úložiště umožňují pouze účty úložiště vytvořené 7. června 2012 nebo později. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob. Příklad použití automatického dotazování:
Příklad použití ručního dotazování:
Příklad použití aktualizací průběhu:
Příklad použití intervalu měnícího se dotazování (výchozí hodnota je 15 sekund):
Příklad použití zrušení kopírování:
|
create |
Vytvoří snímek objektu blob jen pro čtení. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob. |
delete(Blob |
Označí zadaný objekt blob nebo snímek k odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete objekt blob odstranit, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob. |
delete |
Označí zadaný objekt blob nebo snímek k odstranění, pokud existuje. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete objekt blob odstranit, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob. |
delete |
Odstraňte zásady neměnnosti objektu blob. |
download(number, number, Blob |
Načte nebo stáhne objekt blob ze systému, včetně jeho metadat a vlastností. Pokud chcete přečíst snímek, můžete také volat metodu Get Blob (Získat objekt blob).
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob. |
download |
K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob. Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost downloadToFile. |
download |
K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob. Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost downloadToFile. |
download |
K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, pass 0 a undefined pro stažení celého objektu blob. |
exists(Blob |
Vrátí hodnotu true, pokud prostředek objektu blob Azure reprezentovaný tímto klientem existuje. v opačném případě false. POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové objekty blob. |
generate |
K dispozici pouze pro Objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby Blob Service na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas. |
get |
Vytvoří objekt AppendBlobClient. |
get |
Získejte objekt BlobLeaseClient , který spravuje zapůjčení objektu blob. |
get |
Vytvoří objekt BlockBlobClient. |
get |
Vytvoří objekt PageBlobClient. |
get |
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties. UPOZORNĚNÍ: Objekt |
get |
Získá značky přidružené k základnímu objektu blob. |
set |
Nastaví úroveň objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a pro objekt blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier. |
set |
Nastaví systémové vlastnosti objektu blob. Pokud se pro zadané hlavičky HTTP objektů blob nezadá žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties. |
set |
Nastavte zásady neměnnosti objektu blob. |
set |
Nastavte blokování objektu blob z právních důvodů. |
set |
Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jeden nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata objektu blob se odeberou. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata. |
set |
Nastaví značky v podkladovém objektu blob. Objekt blob může mít až 10 značek. Klíče značek musí mít délku 1 až 128 znaků. Hodnoty značek musí být v rozsahu 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0–9), mezeru (' '), plus ('+'), mínus ('-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítka ('_') . |
sync |
Synchronní operace Kopírovat z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopírování dokončeno, nevrátí odpověď. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url. |
undelete(Blob |
Obnoví obsah a metadata obnovitelného odstraněného objektu blob a všechny přidružené obnovitelné odstraněné snímky. Zrušení odstranění objektu blob se podporuje jenom ve verzi 2017-07-29 nebo novější. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob. |
with |
Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Zadání "" odebere id verze a vrátí klienta do základního objektu blob. |
Podrobnosti konstruktoru
BlockBlobClient(string, PipelineLike)
Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL NEBUDE dvakrát uváděn, pouze speciální znaky v cestě URL budou unikovány. Pokud název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.
new BlockBlobClient(url: string, pipeline: PipelineLike)
Parametry
- url
-
string
Řetězec adresy URL odkazující na objekt blob bloku Azure Storage, například "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL NEBUDE dvakrát uváděn, pouze speciální znaky v cestě URL budou unikovány. Pokud ale název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL. Například objekt blob s názvem "my?blob%", adresa URL by měla být "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline
- PipelineLike
Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.
BlockBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL NEBUDE dvakrát uváděn, pouze speciální znaky v cestě URL budou unikovány. Pokud název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.
new BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametry
- url
-
string
Řetězec adresy URL odkazující na objekt blob bloku Azure Storage, například "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL NEBUDE dvakrát uváděn, pouze speciální znaky v cestě URL budou unikovány. Pokud ale název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL. Například objekt blob s názvem "my?blob%", adresa URL by měla být "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity
balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.
- options
- StoragePipelineOptions
Nepovinný parametr. Možnosti konfigurace kanálu HTTP
BlockBlobClient(string, string, string, StoragePipelineOptions)
Vytvoří instanci BlockBlobClient.
new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
Parametry
- connectionString
-
string
Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure.
[ Poznámka : Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu –
DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Příklad připojovacího řetězce SAS – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- containerName
-
string
Název kontejneru.
- blobName
-
string
Název objektu blob.
- options
- StoragePipelineOptions
Nepovinný parametr. Možnosti konfigurace kanálu HTTP
Podrobnosti vlastnosti
containerName
Název kontejneru úložiště, ke které je objekt blob přidružený.
string containerName
Hodnota vlastnosti
string
name
Název objektu blob.
string name
Hodnota vlastnosti
string
Podrobnosti zděděných vlastností
accountName
credential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity
balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Hodnota vlastnosti
Zděděno zblobClient.credential
url
Zakódovaná hodnota řetězce adresy URL.
url: string
Hodnota vlastnosti
string
Zděděno zadresy BlobClient.url
Podrobnosti metody
commitBlockList(string[], BlockBlobCommitBlockListOptions)
Zapíše objekt blob zadáním seznamu ID bloků, která tvoří objekt blob. Aby se blok zapisoval jako součást objektu blob, musí být úspěšně zapsán na server v předchozí fázi OperaceBlock . Pokud chcete aktualizovat objekt blob, můžete volat commitBlockList tak, že nahrajete jenom ty bloky, které se změnily, a pak společně potvrdíte nový a existující blok. Všechny bloky, které nejsou zadané v seznamu blokovaných a trvale odstraněny.
Viz https://docs.microsoft.com/rest/api/storageservices/put-block-list.
function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>
Parametry
- blocks
-
string[]
Pole 64 bajtů s kódováním base64
- options
- BlockBlobCommitBlockListOptions
Možnosti operace Potvrzení seznamu blokovaných objektů blob bloku
Návraty
Promise<BlockBlobCommitBlockListResponse>
Data odpovědí pro operaci Potvrzení seznamu blokovaných objektů blob bloku.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)
Vrátí seznam bloků, které byly odeslány jako součást objektu blob bloku pomocí zadaného filtru seznamu bloků.
Viz https://docs.microsoft.com/rest/api/storageservices/get-block-list.
function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>
Parametry
- listType
- BlockListType
Určuje, zda se má vrátit seznam potvrzených bloků, seznam nepotvrzených bloků nebo oba seznamy najednou.
- options
- BlockBlobGetBlockListOptions
Možnosti operace Získání seznamu blokovaných objektů blob
Návraty
Promise<BlockBlobGetBlockListResponse>
Data odpovědí pro operaci Získání seznamu blokových objektů blob.
query(string, BlockBlobQueryOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME.
Rychlý dotaz na objekt blob ve formátu JSON nebo CSV
Příklad použití (Node.js):
// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>
Parametry
- query
-
string
- options
- BlockBlobQueryOptions
Návraty
Promise<BlobDownloadResponseModel>
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)
Nahraje zadaný blok do "pracovní oblasti" objektu blob bloku, aby byl později potvrzen voláním commitBlockList.
Viz https://docs.microsoft.com/rest/api/storageservices/put-block.
function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>
Parametry
- blockId
-
string
Hodnota 64 bajtů, která je zakódovaná jako base64
- body
- HttpRequestBody
Data, která se mají nahrát do pracovní oblasti.
- contentLength
-
number
Počet bajtů k nahrání
- options
- BlockBlobStageBlockOptions
Možnosti operace blokového bloku fáze objektu blob.
Návraty
Promise<BlockBlobStageBlockResponse>
Data odpovědí pro operaci blokového bloku v objektu blob fáze.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)
Operace Blokování fáze z adresy URL vytvoří nový blok, který se potvrdí jako součást objektu blob, ve kterém se obsah načítá z adresy URL. Toto rozhraní API je k dispozici od verze 2018-03-28.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url.
function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>
Parametry
- blockId
-
string
Hodnota 64 bajtů, která je zakódovaná jako base64
- sourceURL
-
string
Určuje adresu URL objektu blob. Hodnotou může být adresa URL o délce až 2 kB, která určuje objekt blob. Hodnota by měla být zakódovaná jako v identifikátoru URI požadavku. Zdrojový objekt blob musí být buď veřejný, nebo musí být ověřený prostřednictvím sdíleného přístupového podpisu. Pokud je zdrojový objekt blob veřejný, nevyžaduje se k provedení operace žádné ověřování. Tady je několik příkladů adres URL zdrojových objektů: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
- offset
-
number
Z jaké pozice objektu blob ke stažení, větší než nebo rovno 0
- count
-
number
Kolik dat se má stáhnout, větší než 0. Bude stahovat až do konce, pokud není definováno
Možnosti operace blokového bloku objektu blob fáze blokování z adresy URL
Návraty
Promise<BlockBlobStageBlockFromURLResponse>
Data odezvy pro operaci Blokování z adresy URL fáze objektu blob bloku.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)
Vytvoří nový objekt blob bloku, ve kterém se obsah objektu blob přečte z dané adresy URL. Toto rozhraní API se podporuje od verze 2020-04-08. Částečné aktualizace nejsou podporovány s vložením objektu blob z adresy URL. obsah existujícího objektu blob se přepíše obsahem nového objektu blob. Pokud chcete provést částečné aktualizace obsahu objektu blob bloku pomocí zdrojové adresy URL, použijte stageBlockFromURL a commitBlockList.
function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>
Parametry
- sourceURL
-
string
Určuje adresu URL objektu blob. Hodnotou může být adresa URL o délce až 2 kB, která určuje objekt blob. Hodnota by měla být zakódovaná jako v identifikátoru URI požadavku. Zdrojový objekt blob musí být buď veřejný, nebo musí být ověřený prostřednictvím sdíleného přístupového podpisu. Pokud je zdrojový objekt blob veřejný, nevyžaduje se k provedení operace žádné ověřování. Tady je několik příkladů adres URL zdrojových objektů: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Volitelné parametry.
Návraty
Promise<BlockBlobPutBlobFromUrlResponse>
upload(RequestBodyType, number, BlockBlobUploadOptions)
Vytvoří nový objekt blob bloku nebo aktualizuje obsah existujícího objektu blob bloku. Aktualizace existujícího objektu blob bloku přepíše všechna existující metadata objektu blob. Částečné aktualizace nejsou podporovány. obsah existujícího objektu blob se přepíše novým obsahem. Pokud chcete provést částečnou aktualizaci objektů blob bloku, použijte stageBlock a commitBlockList.
Toto je neelní metoda nahrávání. Pro zajištění lepšího výkonu při souběžném nahrávání použijte uploadFile, uploadStream nebo uploadBrowserData .
Viz https://docs.microsoft.com/rest/api/storageservices/put-blob.
function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>
Parametry
- body
- HttpRequestBody
Objekt blob, řetězec, ArrayBuffer, ArrayBufferView nebo funkce, která vrací nový čitelný datový proud, jehož posun je od začátku zdroje dat.
- contentLength
-
number
Délka těla v bajtech. Použijte Buffer.byteLength() k výpočtu délky textu pro řetězec, který zahrnuje nekódované znaky Base64/Hex.
- options
- BlockBlobUploadOptions
Možnosti operace nahrání objektu blob bloku
Návraty
Promise<BlockBlobUploadResponse>
Data odpovědí na operaci nahrání objektu blob bloku.
Příklad použití:
const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)
K DISPOZICI POUZE V PROHLÍŽEČÍCH.
Nahraje objekt Blob/File/ArrayBuffer/ArrayBufferView prohlížeče do objektu blob bloku.
Pokud je délka vyrovnávací paměti menší nebo rovna 256 MB, tato metoda k dokončení nahrávání použije 1 volání nahrávání. V opačném případě tato metoda zavolá stageBlock k nahrání bloků a nakonec zavolá commitBlockList k potvrzení seznamu blokovaných.
Běžnou možností nastavení objektu blobHTTPHeaders je blobContentType
, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.
function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Parametry
- browserData
-
Blob | ArrayBuffer | ArrayBufferView
Blob, File, ArrayBuffer nebo ArrayBufferView
- options
- BlockBlobParallelUploadOptions
Možnosti pro nahrání dat prohlížeče
Návraty
Promise<BlobUploadCommonResponse>
Data odpovědí pro operaci Nahrání do objektu blob
uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)
Nahraje buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView objektu BlockBlob.
Pokud délka dat není větší než specifikovaná hodnota maxSingleShotSize (výchozí hodnota je <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), použije tato metoda k dokončení nahrávání 1 volání nahrávání . V opačném případě tato metoda zavolá stageBlock k nahrání bloků a nakonec zavolá commitBlockList k potvrzení seznamu blokovaných.
Běžnou možností nastavení objektu blobHTTPHeaders je blobContentType
, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.
function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Parametry
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
Buffer(Node.js), Blob, ArrayBuffer nebo ArrayBufferView
- options
- BlockBlobParallelUploadOptions
Návraty
Promise<BlobUploadCommonResponse>
uploadFile(string, BlockBlobParallelUploadOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME.
Nahraje místní soubor v blocích do objektu blob bloku.
Pokud je velikost souboru menší nebo rovna 256 MB, použije tato metoda k dokončení nahrávání 1 volání. V opačném případě tato metoda zavolá stageBlock k nahrání bloků a nakonec zavolá commitBlockList k potvrzení seznamu blokovaných.
function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Parametry
- filePath
-
string
Úplná cesta k místnímu souboru
- options
- BlockBlobParallelUploadOptions
Možnosti operace nahrání do objektu blob bloku
Návraty
Promise<BlobUploadCommonResponse>
Data odpovědi pro operaci nahrání do objektu blob.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME.
Nahraje Node.js čitelný stream do objektu blob bloku.
TIPY KE ZLEPŠENÍ VÝKONU:
- Vstupní proud highWaterMark je lepší nastavit stejnou hodnotu s bufferSize parametr, který zabrání buffer.concat() operacím.
function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>
Parametry
- stream
-
Readable
Node.js čitelný stream
- bufferSize
-
number
Velikost každé přidělené vyrovnávací paměti, také velikost bloku v nahraném objektu blob bloku. Výchozí hodnota je 8 MB.
- maxConcurrency
-
number
Maximální souběžnost udává maximální počet vyrovnávacích pamětí, které je možné přidělit, kladná korelace s maximální souběžností nahrávání. Výchozí hodnota je 5.
- options
- BlockBlobUploadStreamOptions
Možnosti operace nahrání streamu do objektu blob bloku
Návraty
Promise<BlobUploadCommonResponse>
Data odpovědi pro operaci nahrání do objektu blob.
withSnapshot(string)
Vytvoří nový objekt BlockBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Pokud zadáte , odebere se snímek a vrátí adresu URL základního objektu blob.
function withSnapshot(snapshot: string): BlockBlobClient
Parametry
- snapshot
-
string
Časové razítko snímku.
Návraty
Nový objekt BlockBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku.
Podrobnosti zděděných metod
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Přeruší čekající asynchronní operaci kopírování objektu blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty. Verze 2012-02-12 a novější.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob.
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Parametry
- copyId
-
string
ID operace Kopírovat z adresy URL.
- options
- BlobAbortCopyFromURLOptions
Volitelné možnosti operace Přerušení kopírování z adresy URL objektu blob
Návraty
Promise<BlobAbortCopyFromURLResponse>
Zděděno zobjektu blobClient.abortCopyFromURL
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště.
Tato metoda vrátí dlouhotrvající operaci poller, který umožňuje čekat neomezeně dlouho, dokud se kopírování nedokončí.
Můžete také zrušit kopii před jejím dokončením zavoláním cancelOperation
na poller.
Všimněte si, že zpětné volání onProgress nebude vyvoláno, pokud se operace dokončí v prvním požadavku, a při pokusu o zrušení dokončené kopie dojde k chybě.
Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektu blob potvrzený objekt blob v libovolném účtu úložiště Azure. Od verze 2015-02-21 může být zdrojem operace kopírování objektu blob soubor Azure v libovolném účtu úložiště Azure. Kopírování z jiného účtu úložiště umožňují pouze účty úložiště vytvořené 7. června 2012 nebo později.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob.
Příklad použití automatického dotazování:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Příklad použití ručního dotazování:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Příklad použití aktualizací průběhu:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Příklad použití intervalu měnícího se dotazování (výchozí hodnota je 15 sekund):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Příklad použití zrušení kopírování:
const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
await copyPoller.cancelOperation();
// calls to get the result now throw PollerCancelledError
await copyPoller.getResult();
} catch (err) {
if (err.name === 'PollerCancelledError') {
console.log('The copy was cancelled.');
}
}
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Parametry
- copySource
-
string
adresu url zdrojového objektu blob nebo souboru Azure.
- options
- BlobBeginCopyFromURLOptions
Volitelné možnosti operace Spuštění kopírování z adresy URL objektu blob.
Návraty
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Zděděno zblobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Vytvoří snímek objektu blob jen pro čtení.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob.
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parametry
- options
- BlobCreateSnapshotOptions
Volitelné možnosti operace Vytvoření snímku objektu blob
Návraty
Promise<BlobCreateSnapshotResponse>
Zděděno zobjektu BlobClient.createSnapshot
delete(BlobDeleteOptions)
Označí zadaný objekt blob nebo snímek k odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete objekt blob odstranit, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parametry
- options
- BlobDeleteOptions
Volitelné možnosti operace odstranění objektu blob
Návraty
Promise<BlobDeleteResponse>
Zděděno zobjektu blobClient.delete
deleteIfExists(BlobDeleteOptions)
Označí zadaný objekt blob nebo snímek k odstranění, pokud existuje. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete objekt blob odstranit, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parametry
- options
- BlobDeleteOptions
Volitelné možnosti operace odstranění objektu blob
Návraty
Promise<BlobDeleteIfExistsResponse>
Zděděno zobjektu BlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Odstraňte zásady neměnnosti objektu blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parametry
Volitelné možnosti pro odstranění zásad neměnnosti objektu blob
Návraty
Promise<BlobDeleteImmutabilityPolicyResponse>
Zděděno zblobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Načte nebo stáhne objekt blob ze systému, včetně jeho metadat a vlastností. Pokud chcete přečíst snímek, můžete také volat metodu Get Blob (Získat objekt blob).
- V Node.js se data vrací v čitelném streamu readableStreamBody.
- V prohlížečích se data vrací v příslibu blobBody.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob.
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parametry
- offset
-
number
Z jaké pozice objektu blob se má stáhnout, větší než nebo rovna 0
- count
-
number
Kolik dat se má stáhnout, větší než 0 Bude stahovat až do konce, pokud není definováno.
- options
- BlobDownloadOptions
Volitelné možnosti operace stažení objektu blob
Příklad použití (Node.js):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Příklad použití (prohlížeč):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
"Downloaded blob content",
downloaded
);
async function blobToString(blob: Blob): Promise<string> {
const fileReader = new FileReader();
return new Promise<string>((resolve, reject) => {
fileReader.onloadend = (ev: any) => {
resolve(ev.target!.result);
};
fileReader.onerror = reject;
fileReader.readAsText(blob);
});
}
Návraty
Promise<BlobDownloadResponseParsed>
Zděděno ze souboruBlobClient.download
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME.
Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob.
Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost downloadToFile.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parametry
- buffer
-
Buffer
Vyrovnávací paměť, která se má vyplnit, musí mít délku větší, než je počet
- offset
-
number
Z jaké pozice objektu blob bloku se má stáhnout (v bajtech)
- count
-
number
Kolik dat (v bajtech) se má stáhnout. Stáhne se až do konce, když předáte nedefinované
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Návraty
Promise<Buffer>
Zděděno zBlobClient.downloadToBuffer
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME.
Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob.
Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost downloadToFile.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parametry
- offset
-
number
Z jaké pozice objektu blob bloku se má stáhnout (v bajtech)
- count
-
number
Kolik dat (v bajtech) se má stáhnout. Stáhne se až do konce, když předáte nedefinované
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Návraty
Promise<Buffer>
Zděděno zBlobClient.downloadToBuffer
downloadToFile(string, number, number, BlobDownloadOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME.
Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, pass 0 a undefined pro stažení celého objektu blob.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parametry
- filePath
-
string
- offset
-
number
Z jaké pozice objektu blob bloku se má stáhnout.
- count
-
number
Kolik dat se má stáhnout. Stáhne se až do konce, když předáte nedefinované.
- options
- BlobDownloadOptions
Možnosti stažení objektů blob
Návraty
Promise<BlobDownloadResponseParsed>
Data odpovědi na operaci stažení objektu blob, ale s funkcí readableStreamBody nastavenou na hodnotu undefined, protože její obsah je již přečten a zapsán do místního souboru v zadané cestě.
Zděděno zBlobClient.downloadToFile
exists(BlobExistsOptions)
Vrátí hodnotu true, pokud prostředek objektu blob Azure reprezentovaný tímto klientem existuje. v opačném případě false.
POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové objekty blob.
function exists(options?: BlobExistsOptions): Promise<boolean>
Parametry
- options
- BlobExistsOptions
možnosti operace Existuje.
Návraty
Promise<boolean>
Zděděno zBlobClient.exists
generateSasUrl(BlobGenerateSasUrlOptions)
K dispozici pouze pro Objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.
Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby Blob Service na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
Parametry
- options
- BlobGenerateSasUrlOptions
Volitelné parametry.
Návraty
Promise<string>
Identifikátor URI SAS sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následně z vygenerovaného tokenu SAS.
Zděděno zobjektu BlobClient.generateSasUrl
getAppendBlobClient()
Vytvoří objekt AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Návraty
Zděděno zblobClient.getAppendBlobClient
getBlobLeaseClient(string)
Získejte objekt BlobLeaseClient , který spravuje zapůjčení objektu blob.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parametry
- proposeLeaseId
-
string
Počáteční navrhované ID zapůjčení
Návraty
Nový objekt BlobLeaseClient pro správu zapůjčení objektu blob.
Zděděno zblobClient.getBlobLeaseClient
getBlockBlobClient()
Vytvoří objekt BlockBlobClient.
function getBlockBlobClient(): BlockBlobClient
Návraty
Zděděno zBlobClient.getBlockBlobClient
getPageBlobClient()
Vytvoří objekt PageBlobClient.
function getPageBlobClient(): PageBlobClient
Návraty
Zděděno zBlobClient.getPageBlobClient
getProperties(BlobGetPropertiesOptions)
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.
UPOZORNĚNÍ: Objekt metadata
vrácený v odpovědi bude mít své klíče malými písmeny, i když původně obsahovaly velká písmena. To se liší od klíčů metadat vrácených metodami ContainerClient , které vypisují objekty blob pomocí includeMetadata
možnosti, která si zachová jejich původní velikost písmen.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parametry
- options
- BlobGetPropertiesOptions
Volitelné možnosti operace Získat vlastnosti
Návraty
Promise<BlobGetPropertiesResponse>
Zděděno zblobClient.getProperties
getTags(BlobGetTagsOptions)
Získá značky přidružené k základnímu objektu blob.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parametry
- options
- BlobGetTagsOptions
Návraty
Promise<BlobGetTagsResponse>
Zděděno zblobClient.getTags
setAccessTier(string, BlobSetTierOptions)
Nastaví úroveň objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a pro objekt blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier.
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Parametry
- tier
-
string
Úroveň, která se má nastavit v objektu blob. Platné hodnoty jsou Horká, Studená nebo Archivní.
- options
- BlobSetTierOptions
Volitelné možnosti pro operaci Vrstvy sady objektů blob
Návraty
Promise<BlobSetTierResponse>
Zděděno zobjektu BlobClient.setAccessTier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Nastaví systémové vlastnosti objektu blob.
Pokud se pro zadané hlavičky HTTP objektů blob nezadá žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Parametry
- blobHTTPHeaders
- BlobHTTPHeaders
Pokud se pro zadané hlavičky HTTP objektů blob nezadá žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány.
Běžná hlavička, která se má nastavit, umožňuje blobContentType
prohlížeči poskytovat funkce na základě typu souboru.
- options
- BlobSetHTTPHeadersOptions
Volitelné možnosti operace Nastavení hlaviček HTTP objektů blob
Návraty
Promise<BlobSetHTTPHeadersResponse>
Zděděno zobjektu BlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Nastavte zásady neměnnosti objektu blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parametry
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Volitelné možnosti nastavení zásad neměnnosti objektu blob
Návraty
Promise<BlobSetImmutabilityPolicyResponse>
Zděděno zBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Nastavte blokování objektu blob z právních důvodů.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parametry
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Volitelné možnosti nastavení blokování z právních důvodů pro objekt blob
Návraty
Promise<BlobSetLegalHoldResponse>
Zděděno zobjektu BlobClient.setLegalHold
setMetadata(Metadata, BlobSetMetadataOptions)
Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jeden nebo více dvojic název-hodnota.
Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata objektu blob se odeberou.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
Parametry
- metadata
- Metadata
Nahraďte existující metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata budou odebrána.
- options
- BlobSetMetadataOptions
Volitelné možnosti pro operaci Nastavit metadata
Návraty
Promise<BlobSetMetadataResponse>
Zděděno zblobClient.setMetadata
setTags(Tags, BlobSetTagsOptions)
Nastaví značky v podkladovém objektu blob. Objekt blob může mít až 10 značek. Klíče značek musí mít délku 1 až 128 znaků. Hodnoty značek musí být v rozsahu 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0–9), mezeru (' '), plus ('+'), mínus ('-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítka ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parametry
- tags
- Tags
- options
- BlobSetTagsOptions
Návraty
Promise<BlobSetTagsResponse>
Zděděno zobjektu BlobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Synchronní operace Kopírovat z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopírování dokončeno, nevrátí odpověď.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url.
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parametry
- copySource
-
string
Zdrojová adresa URL, ze které se má kopírovat, sdílený přístupový podpis (SAS) možná potřeba pro ověřování
- options
- BlobSyncCopyFromURLOptions
Návraty
Promise<BlobCopyFromURLResponse>
Zděděno zblobClient.syncCopyFromURL
undelete(BlobUndeleteOptions)
Obnoví obsah a metadata obnovitelného odstraněného objektu blob a všechny přidružené obnovitelné odstraněné snímky. Zrušení odstranění objektu blob se podporuje jenom ve verzi 2017-07-29 nebo novější.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Parametry
- options
- BlobUndeleteOptions
Volitelné možnosti operace Odstranění objektu blob
Návraty
Promise<BlobUndeleteResponse>
Zděděno zBlobClient.undelete
withVersion(string)
Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Zadání "" odebere id verze a vrátí klienta do základního objektu blob.
function withVersion(versionId: string): BlobClient
Parametry
- versionId
-
string
Id verze.
Návraty
Nový objekt BlobClient odkazující na verzi tohoto objektu blob
Zděděno zobjektu BlobClient.withVersion