BlobClient class

Reference

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

BlobClient představuje adresu URL objektu blob služby Azure Storage; objekt 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 nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Vytvoří instanci BlobClient. 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 uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován 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 balíčku `@azure/identity` k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. 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í dlouhotrvající operaci poller, která umožňuje čekat na neomezenou dobu, dokud se kopie nedokončí. Kopii můžete také zrušit před dokončením voláním `cancelOperation` na poller. Všimněte si, že zpětné volání onProgress se nevyvolá, 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ších může být zdrojem operace kopírování objektů 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í objektů blob soubor Azure v jakémkoli účtu úložiště Azure. 7. června 2012 umožňují kopírování z jiného účtu úložiště pouze účty úložiště vytvořené po 7. červnu 2012. 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ěně 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt blob. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Odstraňte zásadu immutablility v objektu blob.
download(number, number, BlobDownloadOptions)	Načte nebo stáhne objekt blob ze systému, včetně jeho metadat a vlastností. Můžete také volat Get Blob ke čtení snímku. V Node.jsvrátí data v čitelném streamu readableStreamBody. V prohlížečích se data vrátí do 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 k dispozici, stáhne celý objekt blob. Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. U objektů blob větších, než je tato velikost, zvažte 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 k dispozici, stáhne celý objekt blob. Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. U objektů blob větších, než je tato velikost, zvažte 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é, předání 0 a nedefinované, aby se stáhl celý objekt blob.
exists(BlobExistsOptions)	Vrátí hodnotu true, pokud prostředek objektu blob Azure reprezentovaný tímto klientem existuje. jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové objekty blob naopak přidány jinými klienty nebo aplikacemi.
generateSasStringToSign(BlobGenerateSasUrlOptions)	K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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
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 služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	Vygeneruje identifikátor URI sdíleného přístupového podpisu služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()	Vytvoří objekt AppendBlobClient.
getBlobLeaseClient(string)	Získejte BlobLeaseClient, který spravuje zapůjčení objektu blob.
getBlockBlobClient()	Vytvoří objekt BlockBlobClient.
getPageBlobClient()	Vytvoří objekt PageBlobClient.
getProperties(BlobGetPropertiesOptions)	Vrátí všechna uživatelsky 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 klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami ContainerClient, které vypisují objekty blob pomocí možnosti `includeMetadata`, což zachová původní velikost velikosti.
getTags(BlobGetTagsOptions)	Získá značky přidružené k podkladovému objektu blob.
setAccessTier(string, BlobSetTierOptions)	Nastaví úroveň objektu blob. Operace je povolená na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku 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 není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Nastavte zásadu neměnnosti objektu blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Nastavte blokování z právních důvodů objektu blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Nastaví uživatelsky definovaná metadata pro zadaný objekt blob jako jeden nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo v parametru nejsou definovaná žádná metadata, odeberou se metadata objektu blob. 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í mít délku 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0–9), mezeru (' '), plus (+'), minus (-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítko ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Synchronní operace kopírování z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopie dokončena, odpověď se nevrátí. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Obnoví obsah a metadata obnovitelně odstraněného objektu blob a všechny přidružené snímky obnovitelného odstranění. Odstranění objektu blob je podporováno pouze 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. Zadejte "" odebere snímek a vrátí klienta do základního objektu blob.
withVersion(string)	Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Zadejte "" odebere id verze a vrátí klienta do základního objektu blob.

Podrobnosti konstruktoru

BlobClient(string, PipelineLike)

Vytvoří instanci BlobClient. 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 uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován 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 nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud ale název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL. Například objekt blob s názvem "my?blob%", adresa URL by měla býthttps://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený 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 balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

options: StoragePipelineOptions

Volitelný. 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 lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net – 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

Volitelný. 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 ze StorageClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

zděděné z StorageClient.credential

url

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

url: string

Hodnota vlastnosti

string

zděděno ze 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 Přerušení kopírování objektu blob z adresy URL

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í dlouhotrvající operaci poller, která umožňuje čekat na neomezenou dobu, dokud se kopie nedokončí. Kopii můžete také zrušit před dokončením voláním cancelOperation na poller. Všimněte si, že zpětné volání onProgress se nevyvolá, 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ších může být zdrojem operace kopírování objektů 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í objektů blob soubor Azure v jakémkoli účtu úložiště Azure. 7. června 2012 umožňují kopírování z jiného účtu úložiště pouze účty úložiště vytvořené po 7. červnu 2012.

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ěně 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í objektu blob z adresy URL.

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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt 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ásadu immutablility v objektu blob.

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

Parametry

options: BlobDeleteImmutabilityPolicyOptions

Volitelné možnosti pro odstranění zásad neměnnosti v 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í. Můžete také volat Get Blob ke čtení snímku.

V Node.jsvrátí data v čitelném streamu readableStreamBody.
V prohlížečích se data vrátí do 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

Ze které pozice objektu blob ke stažení, větší než nebo rovno 0

count: number

Kolik dat se má stáhnout, větší než 0 Po nedefinované verzi se stáhne na konec.

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 k dispozici, stáhne celý objekt blob.

Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. U objektů blob větších, než je tato velikost, zvažte 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ž počet.

offset: number

Ze které pozice objektu blob bloku ke stažení (v bajtech)

count: number

Kolik dat (v bajtech) se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

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 k dispozici, stáhne celý objekt blob.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parametry

offset: number

Ze které pozice objektu blob bloku ke stažení (v bajtech)

count: number

Kolik dat (v bajtech) se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

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é, předání 0 a nedefinované, aby se stáhl celý objekt 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. Při předání nedefinovaného souboru se stáhne na konec.

options: BlobDownloadOptions

Možnosti stahování objektů blob

Návraty

Promise<BlobDownloadResponseParsed>

Data odpovědi pro operaci stažení objektu blob, ale s parametrem readableStreamBody nastavenou na nedefinovanou, protože jeho 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. jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové objekty blob naopak přidány jinými klienty nebo aplikacemi.

function exists(options?: BlobExistsOptions): Promise<boolean>

Parametry

options: BlobExistsOptions

možnosti pro operaci Existuje.

Návraty

Promise<boolean>

generateSasStringToSign(BlobGenerateSasUrlOptions)

K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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 generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parametry

options: BlobGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

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 služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametry

options: BlobGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey: UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje identifikátor URI sdíleného přístupového podpisu služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametry

options: BlobGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey: UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

Promise<string>

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

getAccountInfo(BlobGetAccountInfoOptions)

Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Parametry

options: BlobGetAccountInfoOptions

Možnosti operace Získání informací o účtu služby

Návraty

Promise<BlobGetAccountInfoResponse>

Data odpovědí pro operaci Získání informací o účtu služby

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Návraty

AppendBlobClient

getBlobLeaseClient(string)

Získejte 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živatelsky 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 klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami ContainerClient, které vypisují objekty blob pomocí možnosti includeMetadata, což zachová původní velikost velikosti.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parametry

options: BlobGetPropertiesOptions

Volitelné možnosti operace Získání vlastností

Návraty

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Získá značky přidružené k podkladové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á na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku 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 Archiv.

options: BlobSetTierOptions

Volitelné možnosti operace vrstvy sady objektů blob.

Návraty

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Nastaví systémové vlastnosti objektu blob.

Pokud není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou.

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 není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou. Společná hlavička, která se má nastavit, je blobContentType umožňuje prohlížeči poskytovat funkce na základě typu souboru.

options: BlobSetHTTPHeadersOptions

Volitelné možnosti operace nastavení hlaviček HTTP

Návraty

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Nastavte zásadu neměnnosti objektu blob.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Parametry

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Volitelné možnosti pro nastavení zásad neměnnosti objektu blob.

Návraty

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Nastavte blokování z právních důvodů objektu blob.

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ů objektu blob.

Návraty

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

Pokud není k dispozici žádná možnost nebo v parametru nejsou definovaná žádná metadata, odeberou se metadata objektu blob.

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 stávající metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata se odeberou.

options: BlobSetMetadataOptions

Volitelné možnosti pro nastavení operace metadat.

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í mít délku 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0–9), mezeru (' '), plus (+'), minus (-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítko ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parametry

tags: Tags

options: BlobSetTagsOptions

Návraty

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Synchronní operace kopírování z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopie dokončena, odpověď se nevrátí.

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 pro kopírování ze sdíleného přístupového podpisu (SAS) možná potřebuje k ověření.

options: BlobSyncCopyFromURLOptions

Návraty

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Obnoví obsah a metadata obnovitelně odstraněného objektu blob a všechny přidružené snímky obnovitelného odstranění. Odstranění objektu blob je podporováno pouze 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. Zadejte "" odebere snímek a vrátí 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 shodný 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. Zadejte "" 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

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

generateSasStringToSign(BlobGenerateSasUrlOptions)

Parametry

Návraty

generateSasUrl(BlobGenerateSasUrlOptions)

Parametry

Návraty

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

Parametry

Návraty

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

Parametry

Návraty

getAccountInfo(BlobGetAccountInfoOptions)

Parametry

Návraty

getAppendBlobClient()

Návraty

getBlobLeaseClient(string)

Parametry

Návraty

getBlockBlobClient()