BlobClient class

Reference

Balíček:: @azure/storage-blob

Objekt BlobClient představuje adresu URL objektu blob služby Azure Storage. objektem blob může být objekt blob bloku, doplňovací objekt blob nebo objekt blob stránky.

Extends: StorageClient

Konstruktory

BlobClient(string, PipelineLike)	Vytvoří instanci BlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud název objektu blob zahrnuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Vytvoří instanci BlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud název objektu blob zahrnuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.
BlobClient(string, string, string, StoragePipelineOptions)	Vytvoří instanci BlobClient z připojovacího řetězce.

Vlastnosti

containerName	Název kontejneru úložiště, ke které je objekt blob přidružený.
name	Název objektu blob.

Zděděné vlastnosti

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.
url	Zakódovaná hodnota řetězce adresy URL.

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ší. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob.
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. 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í změny intervalu dotazování (výchozí 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.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Vytvoří snímek objektu blob jen pro čtení. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob.
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. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
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. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Odstraňte zásady neměnnosti objektu blob.
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. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob.
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.
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.
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.
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.
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.
getAppendBlobClient()	Vytvoří objekt AppendBlobClient.
getBlobLeaseClient(string)	Získejte objekt BlobLeaseClient , který spravuje zapůjčení objektu blob.
getBlockBlobClient()	Vytvoří objekt BlockBlobClient.
getPageBlobClient()	Vytvoří objekt PageBlobClient.
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.
getTags(BlobGetTagsOptions)	Získá značky přidružené k základnímu objektu blob.
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.
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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Nastavte zásady neměnnosti objektu blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Nastavte blokování objektu blob z právních důvodů.
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.
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 ('_') .
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.
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.
withSnapshot(string)	Vytvoří nový objekt BlobClient shodný se zdrojem, ale se zadaným časovým razítkem snímku. Poskytnutím příkazu odeberete snímek a vrátíte klienta do základního objektu blob.
withVersion(string)	Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Pokud zadáte , odebere se id verze a klient se vrátí do základního objektu blob.

Podrobnosti konstruktoru

BlobClient(string, PipelineLike)

Vytvoří instanci BlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud název objektu blob zahrnuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.

new BlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

Řetězec adresy URL odkazující na objekt blob služby Azure Storage, například "https://myaccount.blob.core.windows.net/mycontainer/blob". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. 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 příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

new BlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametry

url: string

Řetězec klienta odkazující na službu objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options: StoragePipelineOptions

Nepovinný parametr. Možnosti konfigurace kanálu HTTP

BlobClient(string, string, string, StoragePipelineOptions)

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

new BlobClient(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

accountName: string

Hodnota vlastnosti

string

Zděděno z StorageClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zděděno z StorageClient.credential

url

Zakódovaná hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Zděděno z StorageClient.url

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

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

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í změny intervalu dotazování (výchozí 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

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<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

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>

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.

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>

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.

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>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Odstraňte zásady neměnnosti objektu blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Parametry

options: BlobDeleteImmutabilityPolicyOptions

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.

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

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.

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>

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ě.

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>

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.

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Návraty

AppendBlobClient

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

BlobLeaseClient

Nový objekt BlobLeaseClient pro správu zapůjčení objektu blob.

getBlockBlobClient()

Vytvoří objekt BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Návraty

BlockBlobClient

getPageBlobClient()

Vytvoří objekt PageBlobClient.

function getPageBlobClient(): PageBlobClient

Návraty

PageBlobClient

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

withSnapshot(string)

Vytvoří nový objekt BlobClient shodný se zdrojem, ale se zadaným časovým razítkem snímku. Poskytnutím příkazu odeberete snímek a vrátíte klienta do základního objektu blob.

function withSnapshot(snapshot: string): BlobClient

Parametry

snapshot: string

Časové razítko snímku.

Návraty

BlobClient

Nový objekt BlobClient 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. Pokud zadáte , odebere se id verze a klient se vrátí do základního objektu blob.

function withVersion(versionId: string): BlobClient

Parametry

versionId: string

VersionId.

Návraty

BlobClient

Nový objekt BlobClient odkazující na verzi tohoto objektu blob.

Sdílet prostřednictvím

BlobClient class

Konstruktory

Vlastnosti

Zděděné vlastnosti

Metody

Podrobnosti konstruktoru

BlobClient(string, PipelineLike)

Parametry

BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parametry

BlobClient(string, string, string, StoragePipelineOptions)

Parametry

Podrobnosti vlastnosti

containerName

Hodnota vlastnosti

name

Hodnota vlastnosti

Podrobnosti zděděných vlastností

accountName

Hodnota vlastnosti

credential

Hodnota vlastnosti

url

Hodnota vlastnosti

Podrobnosti metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametry

Návraty

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametry

Návraty

createSnapshot(BlobCreateSnapshotOptions)

Parametry

Návraty

delete(BlobDeleteOptions)

Parametry

Návraty

deleteIfExists(BlobDeleteOptions)

Parametry

Návraty

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parametry

Návraty

download(number, number, BlobDownloadOptions)

Parametry

Návraty

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametry

Návraty

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametry

Návraty

downloadToFile(string, number, number, BlobDownloadOptions)

Parametry

Návraty

exists(BlobExistsOptions)

Parametry

Návraty

generateSasUrl(BlobGenerateSasUrlOptions)

Parametry

Návraty

getAppendBlobClient()

Návraty

getBlobLeaseClient(string)

Parametry

Návraty

getBlockBlobClient()

Návraty

getPageBlobClient()

Návraty

getProperties(BlobGetPropertiesOptions)

Parametry

Návraty

getTags(BlobGetTagsOptions)

Parametry

Návraty

setAccessTier(string, BlobSetTierOptions)

Parametry

Návraty