BlockBlobClient class

Reference

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

BlockBlobClient definuje sadu operací použitelných pro objekty blob bloku.

Extends: BlobClient

Konstruktory

BlockBlobClient(string, PipelineLike)	Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL nebude 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.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL nebude 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.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Vytvoří instanci BlockBlobClient.

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

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Zapíše objekt blob zadáním seznamu ID bloků, které tvoří objekt blob. Aby bylo možné zapsat jako součást objektu blob, musí být blok úspěšně zapsán na server v předchozí operaci stageBlock. Můžete volat commitBlockList aktualizovat objekt blob tak, že nahrajete pouze ty bloky, které se změnily, a pak potvrdíte nové a existující bloky společně. Všechny bloky nezadané v seznamu blokovaných položek a trvale odstraněné. Viz https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Vrátí seznam bloků, které byly odeslány jako součást objektu blob bloku pomocí zadaného filtru seznamu bloků. Viz https://docs.microsoft.com/rest/api/storageservices/get-block-list
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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Nahraje zadaný blok do "pracovní oblasti" objektu blob bloku, který se později potvrdí voláním commitBlockList. Viz https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Operace Blokování fáze z adresy URL vytvoří nový blok, který se má potvrdit jako součást objektu blob, kde se obsah načítá z adresy URL. Toto rozhraní API je k dispozici od verze 2018-03-28. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Vytvoří nový objekt blob bloku, ve kterém se obsah objektu blob načte z dané adresy URL. Toto rozhraní API je podporované od verze 2020-04-08. Částečné aktualizace nejsou podporovány nástrojem Put Blob z adresy URL; obsah existujícího objektu blob se přepíše obsahem nového objektu blob. Pokud chcete provést částečné aktualizace obsahu objektu blob bloku pomocí zdrojové adresy URL, použijte stageBlockFromURL a commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Vytvoří nový objekt blob bloku nebo aktualizuje obsah existujícího objektu blob bloku. Aktualizace existujícího objektu blob bloku přepíše všechna existující metadata objektu blob. Částečné aktualizace nejsou podporovány; obsah existujícího objektu blob se přepíše novým obsahem. Pokud chcete provést částečnou aktualizaci objektu blob bloku, použijte stageBlock a commitBlockList. Jedná se o metodu ne paralelního nahrávání, použijte uploadFile, uploadStream nebo uploadBrowserData pro lepší výkon při nahrávání souběžnosti. Viz https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	K DISPOZICI POUZE V PROHLÍŽEČÍCH. Nahraje objekt Blob/File/ArrayBuffer/ArrayBufferView v prohlížeči do objektu blob bloku. Pokud je délka vyrovnávací paměti menší nebo rovna 256 MB, použije tato metoda k dokončení nahrávání 1 volání nahrávání. Jinak tato metoda zavolá stageBlock pro nahrání bloků a nakonec zavolá commitBlockList potvrzení seznamu blokovaných. Běžná možnost objektu blobHTTPHeaders nastavená je `blobContentType`, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Nahraje vyrovnávací paměť(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView objektu BlockBlob. Pokud délka dat není vyšší než specifikovaná maxSingleShotSize (výchozí hodnota je <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), tato metoda použije 1 nahrání volání dokončit nahrávání. Jinak tato metoda zavolá stageBlock pro nahrání bloků a nakonec zavolá commitBlockList potvrzení seznamu blokovaných. Běžná možnost objektu blobHTTPHeaders nastavená je `blobContentType`, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.
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í volání 1. Jinak tato metoda zavolá stageBlock pro nahrání bloků a nakonec volání commitBlockList k potvrzení seznamu blok.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje do objektu blob bloku Node.js čitelný datový proud. TIPY KE ZLEPŠENÍ VÝKONU: Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().
withSnapshot(string)	Vytvoří nový objekt BlockBlobClient shodný se zdrojem, ale se zadaným časovým razítkem snímku. Zadejte "" odebere snímek a vrátí adresu URL do základního objektu blob.

Zděděné 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
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

BlockBlobClient(string, PipelineLike)

Vytvoří instanci BlockBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob bloku. Kódovaný řetězec adresy URL nebude 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 BlockBlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

Řetězec adresy URL odkazující na objekt blob bloku služby Azure Storage, například "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL nebude 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.

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

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

Parametry

url: string

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

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

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

zděděné z blobClient.creden

url

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

url: string

Hodnota vlastnosti

string

zděděno z adresyBlobClient.url

Podrobnosti metody

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Zapíše objekt blob zadáním seznamu ID bloků, které tvoří objekt blob. Aby bylo možné zapsat jako součást objektu blob, musí být blok úspěšně zapsán na server v předchozí operaci stageBlock. Můžete volat commitBlockList aktualizovat objekt blob tak, že nahrajete pouze ty bloky, které se změnily, a pak potvrdíte nové a existující bloky společně. Všechny bloky nezadané v seznamu blokovaných položek a trvale odstraněné.

Viz https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parametry

blocks: string[]

Matice 64bajtů s kódováním base64

options: BlockBlobCommitBlockListOptions

Možnosti operace seznamu blokových bloků potvrzení objektu blob

Návraty

Promise<BlockBlobCommitBlockListResponse>

Data odpovědí pro operaci seznamu blokových bloků zápisu objektu blob bloku

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Vrátí seznam bloků, které byly odeslány jako součást objektu blob bloku pomocí zadaného filtru seznamu bloků.

Viz https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Parametry

listType: BlockListType

Určuje, jestli se má vrátit seznam potvrzených bloků, seznam nepotvrzených bloků nebo oba seznamy.

options: BlockBlobGetBlockListOptions

Možnosti operace Získání seznamu bloků objektů blob bloku

Návraty

Promise<BlockBlobGetBlockListResponse>

Data odpovědí pro operaci Získání seznamu bloků objektu blob bloku

query(string, BlockBlobQueryOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Rychlý dotaz na objekt blob ve formátu JSON nebo CSV

Příklad použití (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Parametry

query: string

options: BlockBlobQueryOptions

Návraty

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Nahraje zadaný blok do "pracovní oblasti" objektu blob bloku, který se později potvrdí voláním commitBlockList.

Viz https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parametry

blockId: string

Hodnota 64 bajtů, která má kódování 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 bloku objektu blob

Návraty

Promise<BlockBlobStageBlockResponse>

Data odpovědí pro operaci bloku blob

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Operace Blokování fáze z adresy URL vytvoří nový blok, který se má potvrdit jako součást objektu blob, kde se obsah načítá z adresy URL. Toto rozhraní API je k dispozici od verze 2018-03-28.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Parametry

blockId: string

Hodnota 64 bajtů, která má kódování 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 adresa URL, jak by se zobrazovala v identifikátoru URI požadavku. Zdrojový objekt blob musí být 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ý, k provedení operace se nevyžaduje žádné ověřování. Tady je několik příkladů adres URL zdrojového objektu: – https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

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: BlockBlobStageBlockFromURLOptions

Možnosti operace bloku z adresy URL

Návraty

Promise<BlockBlobStageBlockFromURLResponse>

Data odpovědí pro operaci bloku z adresy URL

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Vytvoří nový objekt blob bloku, ve kterém se obsah objektu blob načte z dané adresy URL. Toto rozhraní API je podporované od verze 2020-04-08. Částečné aktualizace nejsou podporovány nástrojem Put Blob z adresy URL; obsah existujícího objektu blob se přepíše obsahem nového objektu blob. Pokud chcete provést částečné aktualizace obsahu objektu blob bloku pomocí zdrojové adresy URL, použijte stageBlockFromURL a commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parametry

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Volitelné parametry.

Návraty

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Vytvoří nový objekt blob bloku nebo aktualizuje obsah existujícího objektu blob bloku. Aktualizace existujícího objektu blob bloku přepíše všechna existující metadata objektu blob. Částečné aktualizace nejsou podporovány; obsah existujícího objektu blob se přepíše novým obsahem. Pokud chcete provést částečnou aktualizaci objektu blob bloku, použijte stageBlock a commitBlockList.

Jedná se o metodu ne paralelního nahrávání, použijte uploadFile, uploadStream nebo uploadBrowserData pro lepší výkon při nahrávání souběžnosti.

Viz https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Parametry

body: HttpRequestBody

Objekt blob, řetězec, ArrayBuffer, ArrayBufferView nebo funkce, která vrací nový čitelný datový proud, jehož posun je od začátku zdroje dat.

contentLength: number

Délka těla v bajtech. Pomocí Buffer.byteLength() můžete vypočítat délku textu řetězce včetně nekódovaných znaků bez kódování 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 uploadData instead.

K DISPOZICI POUZE V PROHLÍŽEČÍCH.

Nahraje objekt Blob/File/ArrayBuffer/ArrayBufferView v prohlížeči do objektu blob bloku.

Pokud je délka vyrovnávací paměti menší nebo rovna 256 MB, použije tato metoda k dokončení nahrávání 1 volání nahrávání. Jinak tato metoda zavolá stageBlock pro nahrání bloků a nakonec zavolá commitBlockList potvrzení seznamu blokovaných.

Běžná možnost objektu blobHTTPHeaders nastavená je blobContentType, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametry

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer nebo ArrayBufferView

options: BlockBlobParallelUploadOptions

Možnosti pro nahrání dat prohlížeče

Návraty

Promise<BlobUploadCommonResponse>

Data odpovědí pro operaci nahrání objektu blob

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Nahraje vyrovnávací paměť(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView objektu BlockBlob.

Pokud délka dat není vyšší než specifikovaná maxSingleShotSize (výchozí hodnota je <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), tato metoda použije 1 nahrání volání dokončit nahrávání. Jinak tato metoda zavolá stageBlock pro nahrání bloků a nakonec zavolá commitBlockList potvrzení seznamu blokovaných.

Běžná možnost objektu blobHTTPHeaders nastavená je blobContentType, která prohlížeči umožňuje poskytovat funkce na základě typu souboru.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametry

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), Objekt 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í volání 1. Jinak tato metoda zavolá stageBlock pro nahrání bloků a nakonec volání commitBlockList k potvrzení seznamu blok.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametry

filePath: string

Úplná cesta k místnímu souboru

options: BlockBlobParallelUploadOptions

Možnosti nahrání do operace objektu blob bloku

Návraty

Promise<BlobUploadCommonResponse>

Data odpovědí pro operaci nahrání objektu blob

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Nahraje do objektu blob bloku Node.js čitelný datový proud.

TIPY KE ZLEPŠENÍ VÝKONU:

Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parametry

stream: Readable

Node.js čitelný datový proud

bufferSize: number

Velikost každé přidělené vyrovnávací paměti, také velikost bloku v nahraném objektu blob bloku. Výchozí hodnota je 8 MB

maxConcurrency: number

Maximální souběžnost označuje maximální počet vyrovnávacích pamětí, které je možné přidělit, pozitivní korelaci s maximální souběžností nahrávání. Výchozí hodnota je 5

options: BlockBlobUploadStreamOptions

Možnosti nahrání streamu do operace objektu blob bloku

Návraty

Promise<BlobUploadCommonResponse>

Data odpovědí pro operaci nahrání objektu blob

withSnapshot(string)

Vytvoří nový objekt BlockBlobClient shodný se zdrojem, ale se zadaným časovým razítkem snímku. Zadejte "" odebere snímek a vrátí adresu URL do základního objektu blob.

function withSnapshot(snapshot: string): BlockBlobClient

Parametry

snapshot: string

Časové razítko snímku.

Návraty

BlockBlobClient

Nový objekt BlockBlobClient shodný se zdrojem, ale se zadaným časovým razítkem snímku.

Podrobnosti zděděných metod

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Přeruší čekající asynchronní operaci kopírování objektu blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty. Verze 2012-02-12 a novější.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Parametry

copyId: string

ID operace Kopírovat z adresy URL.

options: BlobAbortCopyFromURLOptions

Volitelné možnosti operace Přerušení kopírování objektu blob z adresy URL

Návraty

Promise<BlobAbortCopyFromURLResponse>

zděděno zBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště. Tato metoda vrátí dlouhotrvající operaci poller, která umožňuje čekat 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>>

zděděno zBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Vytvoří snímek objektu blob jen pro čtení.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parametry

options: BlobCreateSnapshotOptions

Volitelné možnosti operace Vytvoření snímku objektu blob

Návraty

Promise<BlobCreateSnapshotResponse>

zděděno zBlobClient.createSnapshot

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>

zděděno zBlobClient.delete

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>

zděděno zBlobClient.deleteIfExists

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>

zděděno zeBlobClient.deleteImmutabilityPolicy

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>

zděděno ze souboruBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, pokud nejsou 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>

zděděno zBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, pokud nejsou 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>

zděděno zBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, 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ě.

zděděno ze souboruBlobClient.downloadToFile

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>

zděděno zeBlobClient.exists

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.

zděděno zBlobClient.generateSasStringToSign

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.

zděděno zBlobClient.generateSasUrl

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.

zděděno zBlobClient.generateUserDelegationSasStringToSign

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.

zděděno zeBlobClient.generateUserDelegationSasUrl

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

zděděné zBlobClient.getAccountInfo

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Návraty

AppendBlobClient

zděděné zBlobClient.getAppendBlobClient

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.

zděděné zBlobClient.getBlobLeaseClient

getBlockBlobClient()

Vytvoří objekt BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Návraty

BlockBlobClient

zděděno zBlobClient.getBlockBlobClient

getPageBlobClient()

Vytvoří objekt PageBlobClient.

function getPageBlobClient(): PageBlobClient

Návraty

PageBlobClient

zděděné zBlobClient.getPageBlobClient

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>

zděděno zBlobClient.getProperties

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>

zděděno zBlobClient.getTags

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>

zděděno zeBlobClient.setAccessTier

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>

zděděno zBlobClient.setHTTPHeaders

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>

zděděno zeBlobClient.setImmutabilityPolicy

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>

zděděno zeBlobClient.setLegalHold

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>

zděděno z BlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Nastaví značky v podkladovém objektu blob. Objekt blob může mít až 10 značek. Klíče značek musí mít délku 1 až 128 znaků. Hodnoty značek musí 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>

zděděné zBlobClient.setTags

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>

zděděno zBlobClient.syncCopyFromURL

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>

zděděno zBlobClient.undelete

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.

zděděné zBlobClient.withVersion

Sdílet prostřednictvím

BlockBlobClient class

Konstruktory

Vlastnosti

Zděděné vlastnosti

Metody

Zděděné metody

Podrobnosti konstruktoru

BlockBlobClient(string, PipelineLike)

Parametry

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

Parametry

BlockBlobClient(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

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parametry

Návraty

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parametry

Návraty

query(string, BlockBlobQueryOptions)

Parametry

Návraty

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parametry

Návraty

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Parametry

Návraty

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parametry

Návraty

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parametry

Návraty

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parametry

Návraty

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Parametry

Návraty

uploadFile(string, BlockBlobParallelUploadOptions)

Parametry

Návraty

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parametry

Návraty

withSnapshot(string)

Parametry

Návraty

Podrobnosti zděděných metod

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)