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. Zakódovaný řetězec adresy URL nebude dvakrát uchvácený, 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. Zakódovaný řetězec adresy URL nebude dvakrát uchvácený, 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
account |
|
container |
Název kontejneru úložiště, ke které je objekt blob přidružený. |
credential | Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z |
name | Název objektu blob. |
url | Zakódovaná hodnota řetězce adresy URL. |
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ší. |
begin |
Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště.
Tato metoda vrátí dlouho běžící operaci poller, která vám umožní č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 |
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í <xref:stageBlock> operaci. Pokud chcete aktualizovat objekt blob, můžete volat <xref:commitBlockList> tak, že nahrajete jenom ty bloky, které se změnily, a pak nový a existující blok potvrdíte společně. Všechny bloky, které nejsou zadané v seznamu blokovaných a trvale odstraněny. |
create |
Vytvoří snímek objektu blob jen pro čtení. |
delete(Blob |
Označí zadaný objekt blob nebo snímek pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob. |
delete |
Označí zadaný objekt blob nebo snímek pro odstranění, pokud existuje. 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. Obojí můžete odstranit současně pomocí operace Odstranění objektu 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 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. U objektů blob větších, než je tato velikost, zvažte <xref: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. U objektů blob větších, než je tato velikost, zvažte <xref: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. |
get |
Vytvoří objekt AppendBlobClient. |
get |
<xref:BlobLeaseClient> Získejte objekt, který spravuje zapůjčení objektu blob. |
get |
Vytvoří objekt BlockBlobClient. |
get |
Vrátí seznam bloků, které byly odeslány jako součást objektu blob bloku pomocí zadaného filtru seznamu bloků. |
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. |
get |
Získá značky přidružené k základnímu objektu blob. |
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):
|
set |
Nastaví úroveň objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu 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. |
set |
Nastaví systémové vlastnosti objektu blob. Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány. |
set |
Nastavte pro objekt blob zásady neměnnosti. |
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. |
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 ('_') . |
stage |
Nahraje zadaný blok do "pracovní oblasti" objektu blob bloku, aby byl později potvrzen voláním commitBlockList. |
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. |
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ěď. |
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 <xref:stageBlockFromURL> a <xref:commitBlockList>. |
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ší. |
upload(Http |
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 <xref:stageBlock> a <xref:commitBlockList>. Jedná se o metodu, která není paralelní, použijte <xref:uploadFile><xref:uploadStream> , nebo <xref:uploadBrowserData> pro zajištění lepšího výkonu při nahrávání souběžnosti. |
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á <xref:stageBlock> k nahrání bloků a nakonec zavolá <xref:commitBlockList> potvrzení seznamu blokovaných. Běžnou <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> možností nastavení je |
upload |
Nahraje objekt Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView do BlockBlob. Pokud délka dat není větší než specifikovaná <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> hodnota (výchozí hodnota je <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), použije tato metoda k dokončení nahrávání 1 <xref:upload> volání. V opačném případě tato metoda zavolá <xref:stageBlock> k nahrání bloků a nakonec zavolá <xref:commitBlockList> potvrzení seznamu blokovaných. Běžnou <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> možností nastavení 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ý datový proud do objektu blob bloku. TIPY PRO ZVÝŠENÍ VÝKONU:
|
with |
Vytvoří nový objekt BlockBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Poskytnutím příkazu odeberete snímek a vrátíte adresu URL do základního objektu 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. Zakódovaný řetězec adresy URL nebude dvakrát uchvácený, 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. Zakódovaný řetězec adresy URL nebude dvakrát uchvácený, 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. Zakódovaný řetězec adresy URL nebude dvakrát uchvácený, 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. Zakódovaný řetězec adresy URL nebude dvakrát uchvácený, 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
accountName
accountName: string
Hodnota vlastnosti
string
containerName
Název kontejneru úložiště, ke které je objekt blob přidružený.
string containerName
Hodnota vlastnosti
string
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
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
name
Název objektu blob.
string name
Hodnota vlastnosti
string
url
Zakódovaná hodnota řetězce adresy URL.
url: string
Hodnota vlastnosti
string
Podrobnosti metody
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ší.
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)
Parametry
- copyId
-
string
ID operace Kopírovat z adresy URL.
- options
- BlobAbortCopyFromURLOptions
Volitelné možnosti operace Kopírování z adresy URL objektu blob
Návraty
Promise<BlobAbortCopyFromURLResponse>
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště.
Tato metoda vrátí dlouho běžící operaci poller, která vám umožní č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 pokus o zrušení dokončené kopie způsobí vyvolání chyby.
Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure.
Počínaje verzí 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.
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)
Parametry
- copySource
-
string
adresa 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<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
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í <xref:stageBlock> operaci. Pokud chcete aktualizovat objekt blob, můžete volat <xref:commitBlockList> tak, že nahrajete jenom ty bloky, které se změnily, a pak nový a existující blok potvrdíte společně. Všechny bloky, které nejsou zadané v seznamu blokovaných a trvale odstraněny.
function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)
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.
createSnapshot(BlobCreateSnapshotOptions)
Vytvoří snímek objektu blob jen pro čtení.
function createSnapshot(options?: BlobCreateSnapshotOptions)
Parametry
- options
- BlobCreateSnapshotOptions
Volitelné možnosti operace Vytvoření snímku objektu blob
Návraty
Promise<BlobCreateSnapshotResponse>
delete(BlobDeleteOptions)
Označí zadaný objekt blob nebo snímek pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
function delete(options?: BlobDeleteOptions)
Parametry
- options
- BlobDeleteOptions
Volitelné možnosti operace odstranění objektu blob
Návraty
Promise<BlobDeleteResponse>
deleteIfExists(BlobDeleteOptions)
Označí zadaný objekt blob nebo snímek pro odstranění, pokud existuje. 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. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
function deleteIfExists(options?: BlobDeleteOptions)
Parametry
- options
- BlobDeleteOptions
Volitelné možnosti operace odstranění objektu blob
Návraty
Promise<BlobDeleteIfExistsResponse>
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Odstraňte zásady neměnnosti objektu blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)
Parametry
Volitelné možnosti pro odstranění zásad neměnnosti objektu blob
Návraty
Promise<BlobDeleteImmutabilityPolicyResponse>
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 get blob.
- V Node.js vrátí data v čitelném streamu readableStreamBody.
- V prohlížečích se data vrací v objektu blobBody příslibu.
function download(offset?: number, count?: number, options?: BlobDownloadOptions)
Parametry
- 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
- 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>
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. U objektů blob větších, než je tato velikost, zvažte <xref:downloadToFile>.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)
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. Bude stahovat až do konce, když předáte nedefinované
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Návraty
Promise<Buffer>
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. U objektů blob větších, než je tato velikost, zvažte <xref:downloadToFile>.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)
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. Bude stahovat až do konce, když předáte nedefinované
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Návraty
Promise<Buffer>
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)
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ě.
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)
Parametry
- options
- BlobExistsOptions
možnosti operace Existuje.
Návraty
Promise<boolean>
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.
function generateSasUrl(options: BlobGenerateSasUrlOptions)
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.
getAppendBlobClient()
getBlobLeaseClient(string)
<xref:BlobLeaseClient> Získejte objekt, který spravuje zapůjčení objektu blob.
function getBlobLeaseClient(proposeLeaseId?: string)
Parametry
- proposeLeaseId
-
string
Počáteční navrhované ID zapůjčení
Návraty
Nový objekt BlobLeaseClient pro správu zapůjčení objektu blob.
getBlockBlobClient()
getBlockList(BlockListType, BlockBlobGetBlockListOptions)
Vrátí seznam bloků, které byly odeslány jako součást objektu blob bloku pomocí zadaného filtru seznamu bloků.
function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)
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.
getPageBlobClient()
getProperties(BlobGetPropertiesOptions)
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob.
function getProperties(options?: BlobGetPropertiesOptions)
Parametry
- options
- BlobGetPropertiesOptions
Volitelné možnosti operace Získat vlastnosti
Návraty
Promise<BlobGetPropertiesResponse>
getTags(BlobGetTagsOptions)
Získá značky přidružené k základnímu objektu blob.
function getTags(options?: BlobGetTagsOptions)
Parametry
- options
- BlobGetTagsOptions
Návraty
Promise<BlobGetTagsResponse>
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)
Parametry
- query
-
string
- options
- BlockBlobQueryOptions
Návraty
Promise<BlobDownloadResponseModel>
setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)
Nastaví úroveň objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu 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.
function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)
Parametry
- tier
-
BlockBlobTier | PremiumPageBlobTier | 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>
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Nastaví systémové vlastnosti objektu blob. Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány.
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)
Parametry
- blobHTTPHeaders
- BlobHTTPHeaders
Pokud pro zadané hlavičky HTTP objektů blob není zadána žá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>
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Nastavte pro objekt blob zásady neměnnosti.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)
Parametry
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Volitelné možnosti nastavení zásad neměnnosti objektu blob
Návraty
Promise<BlobSetImmutabilityPolicyResponse>
setLegalHold(boolean, BlobSetLegalHoldOptions)
Nastavte blokování objektu blob z právních důvodů.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)
Parametry
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Volitelné možnosti nastavení blokování z právních důvodů pro objekt blob
Návraty
Promise<BlobSetLegalHoldResponse>
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.
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)
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>
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)
Parametry
- tags
- Tags
- options
- BlobSetTagsOptions
Návraty
Promise<BlobSetTagsResponse>
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)
Nahraje zadaný blok do "pracovní oblasti" objektu blob bloku, aby byl později potvrzen voláním commitBlockList.
function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)
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.
function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)
Parametry
- blockId
-
string
Hodnota 64 bajtů, která je zakódovaná jako base64
- sourceURL
-
string
Určuje adresu URL objektu blob. Hodnota 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.
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ěď.
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)
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>
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 <xref:stageBlockFromURL> a <xref:commitBlockList>.
function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)
Parametry
- sourceURL
-
string
Určuje adresu URL objektu blob. Hodnota 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>
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ší.
function undelete(options?: BlobUndeleteOptions)
Parametry
- options
- BlobUndeleteOptions
Volitelné možnosti operace Odstranění objektu blob
Návraty
Promise<BlobUndeleteResponse>
upload(HttpRequestBody, 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 <xref:stageBlock> a <xref:commitBlockList>. Jedná se o metodu, která není paralelní, použijte <xref:uploadFile><xref:uploadStream> , nebo <xref:uploadBrowserData> pro zajištění lepšího výkonu při nahrávání souběžnosti.
function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)
Parametry
- body
-
HttpRequestBody
Blob, string, 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ý obsahuje nekódované znaky Base64/Hex.
- options
- BlockBlobUploadOptions
Možnosti operace nahrání objektu blob bloku
Návraty
Promise<BlockBlobUploadResponse>
Data odpovědí pro 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)
Upozornění
Toto rozhraní API je teď zastaralé.
Use <xref:uploadData> instead.
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á <xref:stageBlock> k nahrání bloků a nakonec zavolá <xref:commitBlockList> potvrzení seznamu blokovaných.
Běžnou <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> možností nastavení je blobContentType
, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.
function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)
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(Buffer | Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)
Nahraje objekt Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView do BlockBlob. Pokud délka dat není větší než specifikovaná <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> hodnota (výchozí hodnota je <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), použije tato metoda k dokončení nahrávání 1 <xref:upload> volání. V opačném případě tato metoda zavolá <xref:stageBlock> k nahrání bloků a nakonec zavolá <xref:commitBlockList> potvrzení seznamu blokovaných.
Běžnou <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> možností nastavení je blobContentType
, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.
function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)
Parametry
- data
-
Buffer | Blob | ArrayBuffer | ArrayBufferView
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)
Parametry
- filePath
-
string
Úplná cesta k místnímu souboru
- options
- BlockBlobParallelUploadOptions
Možnosti pro nahrání do operace objektu blob bloku
Návraty
Promise<BlobUploadCommonResponse>
Data odpovědí pro operaci Nahrání do objektu blob
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)
K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje Node.js čitelný datový proud do objektu blob bloku.
TIPY PRO ZVÝŠENÍ VÝKONU:
- Vstupní stream highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, který zabrání operacím Buffer.concat().
function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)
Parametry
- stream
-
Readable
Node.js čitelný datový proud
- bufferSize
-
number
Velikost každé přidělené vyrovnávací paměti a také velikost bloku v nahraném objektu blob bloku. Výchozí hodnota je 8 MB.
- maxConcurrency
-
number
Maximální souběžnost označuje maximální počet vyrovnávacích pamětí, které je možné přidělit, a pozitivní korelaci s maximální souběžností nahrávání. Výchozí hodnota je 5.
- options
- BlockBlobUploadStreamOptions
Možnosti pro nahrání streamu do operace objektu blob bloku
Návraty
Promise<BlobUploadCommonResponse>
Data odpovědí 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. Poskytnutím příkazu odeberete snímek a vrátíte adresu URL do základního objektu blob.
function withSnapshot(snapshot: string)
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.
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)
Parametry
- versionId
-
string
Id verze.
Návraty
Nový objekt BlobClient odkazující na verzi tohoto objektu blob
Azure SDK for JavaScript
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro