BlockBlobClient class

Referens

Paket:: @azure/storage-blob

BlockBlobClient definierar en uppsättning åtgärder som gäller för blockblobar.

Extends: BlobClient

Konstruktorer

BlockBlobClient(string, PipelineLike)	Skapar en instans av BlockBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en blockblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Skapar en instans av BlockBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en blockblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Skapar en instans av BlockBlobClient.

Egenskaper

accountName
containerName	Namnet på lagringscontainern som bloben är associerad med.
credential	Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera `@azure/identity` begäranden till tjänsten. Du kan också ange ett -objekt som implementerar TokenCredential-gränssnittet. Om inget anges används AnonymousCredential.
name	Namnet på bloben.
url	Kodat URL-strängvärde.

Metoder

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Avbryter en väntande asynkron kopieringsblobåtgärd och lämnar en målblob med noll längd och fullständiga metadata. Version 2012-02-12 och senare.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Kopierar asynkront en blob till ett mål i lagringskontot. Den här metoden returnerar en tidskrävande åtgärdspolerare som gör att du kan vänta på obestämd tid tills kopieringen har slutförts. Du kan också avbryta en kopia innan den har slutförts genom att anropa `cancelOperation` på pollern. Observera att återanropet onProgress inte anropas om åtgärden slutförs i den första begäran, och om du försöker avbryta en slutförd kopia genereras ett fel. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i valfritt Azure-lagringskonto. Från och med version 2015-02-21 kan källan för en kopieringsblobåtgärd vara en Azure-fil i valfritt Azure-lagringskonto. Endast lagringskonton som skapats den 7 juni 2012 eller senare tillåter att åtgärden Kopiera blob kopieras från ett annat lagringskonto.
commitBlockList(string[], BlockBlobCommitBlockListOptions)	Skriver en blob genom att ange listan över block-ID:t som utgör bloben. För att kunna skrivas som en del av en blob måste ett block ha skrivits till servern i en tidigare <xref:stageBlock> åtgärd. Du kan anropa <xref:commitBlockList> för att uppdatera en blob genom att bara ladda upp de block som har ändrats och sedan checka in de nya och befintliga blocken tillsammans. Alla block som inte har angetts i blockeringslistan och tagits bort permanent.
createSnapshot(BlobCreateSnapshotOptions)	Skapar en skrivskyddad ögonblicksbild av en blob.
delete(BlobDeleteOptions)	Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
deleteIfExists(BlobDeleteOptions)	Markerar den angivna bloben eller ögonblicksbilden för borttagning om den finns. Bloben tas senare bort under skräpinsamlingen. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Ta bort immutablility-principen på bloben.
download(number, number, BlobDownloadOptions)	Läser eller laddar ned en blob från systemet, inklusive dess metadata och egenskaper. Du kan också anropa Hämta blob för att läsa en ögonblicksbild. I Node.js returnerar data i en läsbar dataström läsbarStreamBody I webbläsare returneras data i en promise blobBody
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob parallellt till en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte anges. Varning! Buffertar kan bara ha stöd för filer upp till cirka en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För blobar som är större än den här storleken bör du överväga <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob parallellt till en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte anges. Varning! Buffertar kan bara ha stöd för filer upp till cirka en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För blobar som är större än den här storleken bör du överväga <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierade för att ladda ned hela bloben.
exists(BlobExistsOptions)	Returnerar true om Azure-blobresursen som representeras av den här klienten finns. annars falskt. Obs! Använd den här funktionen med försiktighet eftersom en befintlig blob kan tas bort av andra klienter eller program. Vice versa nya blobar kan läggas till av andra klienter eller program när den här funktionen har slutförts.
generateSasUrl(BlobGenerateSasUrlOptions)	Endast tillgängligt för BlobClient som skapats med autentiseringsuppgifter för delad nyckel. Genererar en SAS-URI (Signatur för delad åtkomst) för Blob Service baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.
getAppendBlobClient()	Skapar ett AppendBlobClient-objekt.
getBlobLeaseClient(string)	Hämta en <xref:BlobLeaseClient> som hanterar lån på bloben.
getBlockBlobClient()	Skapar ett BlockBlobClient-objekt.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Returnerar listan över block som har laddats upp som en del av en blockblob med det angivna blocklistfiltret.
getPageBlobClient()	Skapar ett PageBlobClient-objekt.
getProperties(BlobGetPropertiesOptions)	Returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för bloben. Den returnerar inte innehållet i bloben.
getTags(BlobGetTagsOptions)	Hämtar taggarna som är associerade med den underliggande bloben.
query(string, BlockBlobQueryOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Snabbfråga för en JSON- eller CSV-formaterad blob. Exempelanvändning (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); }); }
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Anger nivån för en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett Blob Storage-konto (endast lokalt redundant lagring). Nivån för en premium-sidblob avgör tillåten storlek, IOPS och bandbredd för bloben. Blockblobens nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Anger systemegenskaper för bloben. Om inget värde anges, eller om inget värde har angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobrubriker utan ett värde.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Ange en immutablility-princip för bloben.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Ange bevarande av juridiska skäl för bloben.
setMetadata(Metadata, BlobSetMetadataOptions)	Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par. Om inget alternativ har angetts, eller inga metadata som definierats i parametern, tas blobmetadata bort.
setTags(Tags, BlobSetTagsOptions)	Anger taggar för den underliggande bloben. En blob kan ha upp till 10 taggar. Taggnycklar måste vara mellan 1 och 128 tecken. Taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken innehåller gemener och versaler, siffror (0–9), blanksteg (" ), plus ("+", minus ("-", punkt (".",), snedstreck ('/'), kolon (':'), lika med ('=') och understreck ('_') .
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)	Laddar upp det angivna blocket till blockblobens "mellanlagringsområde" som senare ska checkas in av ett anrop till commitBlockList.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Åtgärden Stage Block From URL (Stegblock från URL) skapar ett nytt block som ska checkas in som en del av en blob där innehållet läse från en URL. Det här API:et är tillgängligt från och med version 2018-03-28.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Åtgärden för synkron kopiering från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte något svar förrän kopian har slutförts.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Skapar en ny blockblob där innehållet i bloben läse från en viss URL. Det här API:et stöds från och med 2020-04-08-versionen. Partiella uppdateringar stöds inte med Placera blob från URL; innehållet i en befintlig blob skrivs över med innehållet i den nya bloben. Om du vill utföra partiella uppdateringar av en blockblobs innehåll med hjälp av en käll-URL använder du <xref:stageBlockFromURL> och <xref:commitBlockList>.
undelete(BlobUndeleteOptions)	Återställer innehållet och metadata för mjukt borttagna blobar och eventuella associerade mjukt borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare.
upload(HttpRequestBody, number, BlockBlobUploadOptions)	Skapar en ny blockblob eller uppdaterar innehållet i en befintlig blockblob. Om du uppdaterar en befintlig blockblob skrivs befintliga metadata över på bloben. Partiella uppdateringar stöds inte. innehållet i den befintliga bloben skrivs över med det nya innehållet. Om du vill utföra en partiell uppdatering av en blockblob använder du <xref:stageBlock> och <xref:commitBlockList>. Det här är en icke-parallell uppladdningsmetod, använd <xref:uploadFile><xref:uploadStream> eller <xref:uploadBrowserData> för bättre prestanda med samtidighetsuppladdning.
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	ENDAST TILLGÄNGLIGT I WEBBLÄSARE. Laddar upp ett blob-/fil-/matrisbuffer-/ArrayBufferView-objekt i webbläsaren till blockblob. När buffertlängden är mindre än eller lika med 256 MB använder den här metoden 1 uppladdningsanrop för att slutföra uppladdningen. Annars anropar <xref:stageBlock> den här metoden för att ladda upp block och anropar <xref:commitBlockList> slutligen för att checka in blockeringslistan. Ett vanligt <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> alternativ att ange är `blobContentType`, vilket gör att webbläsaren kan tillhandahålla funktioner baserat på filtyp.
uploadData(Buffer \| Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	Laddar upp ett Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-objekt till en BlockBlob. När datalängden inte är mer än den anifierade <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (standardvärdet är <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>) använder den här metoden 1 <xref:upload> anrop för att slutföra uppladdningen. Annars anropar <xref:stageBlock> den här metoden för att ladda upp block och anropar <xref:commitBlockList> slutligen för att checka in blockeringslistan. Ett vanligt <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> alternativ att ange är `blobContentType`, vilket gör att webbläsaren kan tillhandahålla funktioner baserat på filtyp.
uploadFile(string, BlockBlobParallelUploadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en lokal fil i block till en blockblob. När filstorleken är mindre än eller lika med 256 MB använder den här metoden 1 uppladdningsanrop för att slutföra uppladdningen. Annars anropar den här metoden stageBlock för att ladda upp block och anropar slutligen commitBlockList för att checka in blockeringslistan.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar dataström till blockblob. TIPS FÖR PRESTANDAFÖRBÄTTRING: HighWaterMark för indataströmmen är bättre att ange samma värde med bufferSize-parametern, vilket undviker Buffer.concat()-åtgärder.
withSnapshot(string)	Skapar ett nytt BlockBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilden. Ange "" tar bort ögonblicksbilden och returnerar en URL till basbloben.
withVersion(string)	Skapar ett nytt BlobClient-objekt som pekar på en version av den här bloben. Ange "" tar bort versionId och returnerar en klient till basbloben.

Konstruktorinformation

BlockBlobClient(string, PipelineLike)

Skapar en instans av BlockBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en blockblob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parametrar

url: string

En URL-sträng som pekar på Azure Storage-blockblob, till exempel "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en blob. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Men om ett blobnamn innehåller ? eller %, blobnamnet måste vara kodat i URL:en. Till exempel en blob med namnet "my?blob%" ska URL:en vara "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

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

Parametrar

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

options: StoragePipelineOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Skapar en instans av BlockBlobClient.

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Parametrar

connectionString: string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

Containernamn.

blobName: string

Blobnamn.

options: StoragePipelineOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Egenskapsinformation

accountName

accountName: string

Egenskapsvärde

string

containerName

Namnet på lagringscontainern som bloben är associerad med.

string containerName

Egenskapsvärde

string

credential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett -objekt som implementerar TokenCredential-gränssnittet. Om inget anges används AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

Namnet på bloben.

string name

Egenskapsvärde

string

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

Metodinformation

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Avbryter en väntande asynkron kopieringsblobåtgärd och lämnar en målblob med noll längd och fullständiga metadata. Version 2012-02-12 och senare.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Parametrar

copyId: string

ID för åtgärden Kopiera från URL.

options: BlobAbortCopyFromURLOptions

Valfria alternativ för åtgärden Avbryt kopiering av blob från URL.

Returer

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopierar asynkront en blob till ett mål i lagringskontot. Den här metoden returnerar en tidskrävande åtgärdspolerare som gör att du kan vänta på obestämd tid tills kopieringen har slutförts. Du kan också avbryta en kopia innan den har slutförts genom att anropa cancelOperation på pollern. Observera att återanropet onProgress inte anropas om åtgärden slutförs i den första begäran, och om du försöker avbryta en slutförd kopia genereras ett fel. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i valfritt Azure-lagringskonto. Från och med version 2015-02-21 kan källan för en kopieringsblobåtgärd vara en Azure-fil i valfritt Azure-lagringskonto. Endast lagringskonton som skapats den 7 juni 2012 eller senare tillåter att åtgärden Kopiera blob kopieras från ett annat lagringskonto.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

Parametrar

copySource: string

url till källan Azure Blob/File.

options: BlobBeginCopyFromURLOptions

Valfria alternativ för åtgärden Starta blobkopiering från URL.

Returer

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Skriver en blob genom att ange listan över block-ID:t som utgör bloben. För att kunna skrivas som en del av en blob måste ett block ha skrivits till servern i en tidigare <xref:stageBlock> åtgärd. Du kan anropa <xref:commitBlockList> för att uppdatera en blob genom att bara ladda upp de block som har ändrats och sedan checka in de nya och befintliga blocken tillsammans. Alla block som inte har angetts i blockeringslistan och tagits bort permanent.

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

Parametrar

blocks: string[]

Matris med 64 byte-värde som är base64-kodad

options: BlockBlobCommitBlockListOptions

Alternativ för åtgärden Checka in blockeringslista för blockblob.

Returer

Promise<BlockBlobCommitBlockListResponse>

Svarsdata för åtgärden Checka in blockeringslista för blockblob.

createSnapshot(BlobCreateSnapshotOptions)

Skapar en skrivskyddad ögonblicksbild av en blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametrar

options: BlobCreateSnapshotOptions

Valfria alternativ för åtgärden Skapa ögonblicksbild av blob.

Returer

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.

function delete(options?: BlobDeleteOptions)

Parametrar

options: BlobDeleteOptions

Valfria alternativ för blobborttagningsåtgärd.

Returer

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Markerar den angivna bloben eller ögonblicksbilden för borttagning om den finns. Bloben tas senare bort under skräpinsamlingen. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.

function deleteIfExists(options?: BlobDeleteOptions)

Parametrar

options: BlobDeleteOptions

Valfria alternativ för blobborttagningsåtgärd.

Returer

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Ta bort immutablility-principen på bloben.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametrar

options: BlobDeleteImmutabilityPolicyOptions

Valfria alternativ för att ta bort oföränderlighetsprincipen på bloben.

Returer

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

Läser eller laddar ned en blob från systemet, inklusive dess metadata och egenskaper. Du kan också anropa Hämta blob för att läsa en ögonblicksbild.

I Node.js returnerar data i en läsbar dataström läsbarStreamBody
I webbläsare returneras data i en promise blobBody

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

Parametrar

offset: number

Från vilken position bloben ska laddas ned, större än eller lika med 0

count: number

Hur mycket data som ska laddas ned, större än 0. Laddas ned till slutet när det är odefinierat

options: BlobDownloadOptions

Valfria alternativ för blobnedladdning.

Exempelanvändning (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);
});
}

Exempelanvändning (webbläsare):

// 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);
  });
}

Returer

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob parallellt till en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte anges.

Varning! Buffertar kan bara ha stöd för filer upp till cirka en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För blobar som är större än den här storleken bör du överväga <xref:downloadToFile>.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Parametrar

buffer: Buffer

Buffert som ska fyllas, måste ha en längd som är större än antalet

offset: number

Från vilken position blockbloben ska laddas ned (i byte)

count: number

Hur mycket data (i byte) som ska laddas ned. Laddas ned till slutet när odefinierade skickas

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Returer

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob parallellt till en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte anges.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Parametrar

offset: number

Från vilken position blockbloben ska laddas ned (i byte)

count: number

Hur mycket data (i byte) som ska laddas ned. Laddas ned till slutet när odefinierade skickas

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Returer

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierade för att ladda ned hela bloben.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Parametrar

filePath: string

offset: number

Från vilken position blockbloben ska laddas ned.

count: number

Hur mycket data som ska laddas ned. Laddas ned till slutet när odefinierade skickas.

options: BlobDownloadOptions

Alternativ för alternativ för blobnedladdning.

Returer

Promise<BlobDownloadResponseParsed>

Svarsdata för blobnedladdningsåtgärden, men med readableStreamBody inställt på odefinierad eftersom dess innehåll redan har lästs och skrivits till en lokal fil på den angivna sökvägen.

exists(BlobExistsOptions)

Returnerar true om Azure-blobresursen som representeras av den här klienten finns. annars falskt. Obs! Använd den här funktionen med försiktighet eftersom en befintlig blob kan tas bort av andra klienter eller program. Vice versa nya blobar kan läggas till av andra klienter eller program när den här funktionen har slutförts.

function exists(options?: BlobExistsOptions)

Parametrar

options: BlobExistsOptions

alternativ för åtgärden Finns.

Returer

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Endast tillgängligt för BlobClient som skapats med autentiseringsuppgifter för delad nyckel. Genererar en SAS-URI (Signatur för delad åtkomst) för Blob Service baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parametrar

options: BlobGenerateSasUrlOptions

Valfria parametrar.

Returer

Promise<string>

SAS-URI:n som består av URI:n till resursen som representeras av den här klienten, följt av den genererade SAS-token.

getAppendBlobClient()

Skapar ett AppendBlobClient-objekt.

function getAppendBlobClient()

Returer

AppendBlobClient

getBlobLeaseClient(string)

Hämta en <xref:BlobLeaseClient> som hanterar lån på bloben.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametrar

proposeLeaseId: string

Ursprungligt föreslaget låne-ID.

Returer

BlobLeaseClient

Ett nytt BlobLeaseClient-objekt för att hantera lån på bloben.

getBlockBlobClient()

Skapar ett BlockBlobClient-objekt.

function getBlockBlobClient()

Returer

BlockBlobClient

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Returnerar listan över block som har laddats upp som en del av en blockblob med det angivna blocklistfiltret.

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

Parametrar

listType: BlockListType

Anger om du vill returnera listan över bekräftade block, listan över ej bekräftade block eller båda listorna tillsammans.

options: BlockBlobGetBlockListOptions

Alternativ för åtgärden Hämta blocklista för blockblob.

Returer

Promise<BlockBlobGetBlockListResponse>

Svarsdata för åtgärden Hämta blocklista för blockblob.

getPageBlobClient()

Skapar ett PageBlobClient-objekt.

function getPageBlobClient()

Returer

PageBlobClient

getProperties(BlobGetPropertiesOptions)

Returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för bloben. Den returnerar inte innehållet i bloben.

function getProperties(options?: BlobGetPropertiesOptions)

Parametrar

options: BlobGetPropertiesOptions

Valfria alternativ för att hämta egenskaper.

Returer

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Hämtar taggarna som är associerade med den underliggande bloben.

function getTags(options?: BlobGetTagsOptions)

Parametrar

options: BlobGetTagsOptions

Returer

Promise<BlobGetTagsResponse>

query(string, BlockBlobQueryOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Snabbfråga för en JSON- eller CSV-formaterad blob.

Exempelanvändning (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)

Parametrar

query: string

options: BlockBlobQueryOptions

Returer

Promise<BlobDownloadResponseModel>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Anger nivån för en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett Blob Storage-konto (endast lokalt redundant lagring). Nivån för en premium-sidblob avgör tillåten storlek, IOPS och bandbredd för bloben. Blockblobens nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Parametrar

tier: BlockBlobTier | PremiumPageBlobTier | string

Den nivå som ska anges för bloben. Giltiga värden är Frekvent, Lågfrekvent eller Arkiv.

options: BlobSetTierOptions

Valfria alternativ för åtgärden blobuppsättningsnivå.

Returer

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Anger systemegenskaper för bloben. Om inget värde anges, eller om inget värde har angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobrubriker utan ett värde.

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

Parametrar

blobHTTPHeaders: BlobHTTPHeaders

Om inget värde anges, eller om inget värde har angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobrubriker utan ett värde. Ett vanligt sidhuvud att ange är blobContentType att göra det möjligt för webbläsaren att tillhandahålla funktioner baserat på filtyp.

options: BlobSetHTTPHeadersOptions

Valfria alternativ för åtgärden Blob Ange HTTP-huvuden.

Returer

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Ange en immutablility-princip för bloben.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

Parametrar

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Valfria alternativ för att ange en oföränderlighetsprincip för bloben.

Returer

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Ange bevarande av juridiska skäl för bloben.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

Parametrar

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Valfria alternativ för att ange bevarande av juridiska skäl för bloben.

Returer

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par. Om inget alternativ har angetts, eller inga metadata som definierats i parametern, tas blobmetadata bort.

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

Parametrar

metadata: Metadata

Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.

options: BlobSetMetadataOptions

Valfria alternativ för att ange metadataåtgärd.

Returer

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

Anger taggar för den underliggande bloben. En blob kan ha upp till 10 taggar. Taggnycklar måste vara mellan 1 och 128 tecken. Taggvärdena måste vara mellan 0 och 256 tecken. Giltiga taggnyckel- och värdetecken innehåller gemener och versaler, siffror (0–9), blanksteg (" ), plus ("+", minus ("-", punkt (".",), snedstreck ('/'), kolon (':'), lika med ('=') och understreck ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Parametrar

tags: Tags

options: BlobSetTagsOptions

Returer

Promise<BlobSetTagsResponse>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

Laddar upp det angivna blocket till blockblobens "mellanlagringsområde" som senare ska checkas in av ett anrop till commitBlockList.

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

Parametrar

blockId: string

Ett värde på 64 byte som är base64-kodat

body: HttpRequestBody

Data som ska laddas upp till mellanlagringsområdet.

contentLength: number

Antal byte som ska laddas upp.

options: BlockBlobStageBlockOptions

Alternativ för blockblobstegblocket.

Returer

Promise<BlockBlobStageBlockResponse>

Svarsdata för blockblobstegblocksåtgärden.

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

Åtgärden Stage Block From URL (Stegblock från URL) skapar ett nytt block som ska checkas in som en del av en blob där innehållet läse från en URL. Det här API:et är tillgängligt från och med version 2018-03-28.

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

Parametrar

blockId: string

Ett värde på 64 byte som är base64-kodat

sourceURL: string

Anger blobens URL. Värdet kan vara en URL på upp till 2 kB som anger en blob. Värdet ska vara URL-kodat som det skulle visas i en begärande-URI. Källbloben måste antingen vara offentlig eller autentiseras via en signatur för delad åtkomst. Om källbloben är offentlig krävs ingen autentisering för att utföra åtgärden. Här följer några exempel på URL:er för källobjekt: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

Från vilken position bloben ska laddas ned, större än eller lika med 0

count: number

Hur mycket data som ska laddas ned, större än 0. Laddas ned till slutet när det är odefinierat

options: BlockBlobStageBlockFromURLOptions

Alternativ för åtgärden BlockBlobstegblock från URL.

Returer

Promise<BlockBlobStageBlockFromURLResponse>

Svarsdata för åtgärden Blockblobstegblock från URL.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Åtgärden för synkron kopiering från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte något svar förrän kopian har slutförts.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

Parametrar

copySource: string

Käll-URL:en att kopiera från, signatur för delad åtkomst (SAS) kanske behövs för autentisering

options: BlobSyncCopyFromURLOptions

Returer

Promise<BlobCopyFromURLResponse>

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Skapar en ny blockblob där innehållet i bloben läse från en viss URL. Det här API:et stöds från och med 2020-04-08-versionen. Partiella uppdateringar stöds inte med Placera blob från URL; innehållet i en befintlig blob skrivs över med innehållet i den nya bloben. Om du vill utföra partiella uppdateringar av en blockblobs innehåll med hjälp av en käll-URL använder du <xref:stageBlockFromURL> och <xref:commitBlockList>.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

Parametrar

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Valfria parametrar.

Returer

Promise<BlockBlobPutBlobFromUrlResponse>

undelete(BlobUndeleteOptions)

Återställer innehållet och metadata för mjukt borttagna blobar och eventuella associerade mjukt borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare.

function undelete(options?: BlobUndeleteOptions)

Parametrar

options: BlobUndeleteOptions

Valfria alternativ för att ta bort blobborttagning.

Returer

Promise<BlobUndeleteResponse>

upload(HttpRequestBody, number, BlockBlobUploadOptions)

Skapar en ny blockblob eller uppdaterar innehållet i en befintlig blockblob. Om du uppdaterar en befintlig blockblob skrivs befintliga metadata över på bloben. Partiella uppdateringar stöds inte. innehållet i den befintliga bloben skrivs över med det nya innehållet. Om du vill utföra en partiell uppdatering av en blockblob använder du <xref:stageBlock> och <xref:commitBlockList>. Det här är en icke-parallell uppladdningsmetod, använd <xref:uploadFile><xref:uploadStream> eller <xref:uploadBrowserData> för bättre prestanda med samtidighetsuppladdning.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parametrar

body: HttpRequestBody

Blob, sträng, ArrayBuffer, ArrayBufferView eller en funktion som returnerar en ny läsbar ström vars förskjutning kommer från datakällans början.

contentLength: number

Längden på brödtexten i byte. Använd Buffer.byteLength() för att beräkna brödtextlängden för en sträng, inklusive icke-Base64/Hex-kodade tecken.

options: BlockBlobUploadOptions

Alternativ för blockblobuppladdningsåtgärden.

Returer

Promise<BlockBlobUploadResponse>

Svarsdata för blockblobuppladdningsåtgärden.

Exempel på användning:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Varning

Det här API:et är nu inaktuellt.

Use <xref:uploadData> instead.

ENDAST TILLGÄNGLIGT I WEBBLÄSARE. Laddar upp ett blob-/fil-/matrisbuffer-/ArrayBufferView-objekt i webbläsaren till blockblob.

När buffertlängden är mindre än eller lika med 256 MB använder den här metoden 1 uppladdningsanrop för att slutföra uppladdningen. Annars anropar <xref:stageBlock> den här metoden för att ladda upp block och anropar <xref:commitBlockList> slutligen för att checka in blockeringslistan.

Ett vanligt <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> alternativ att ange är blobContentType, vilket gör att webbläsaren kan tillhandahålla funktioner baserat på filtyp.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parametrar

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, Fil, ArrayBuffer eller ArrayBufferView

options: BlockBlobParallelUploadOptions

Alternativ för att ladda upp webbläsardata.

Returer

Promise<BlobUploadCommonResponse>

Svarsdata för blobuppladdningsåtgärden.

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

Laddar upp ett Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-objekt till en BlockBlob. När datalängden inte är mer än den anifierade <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (standardvärdet är <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>) använder den här metoden 1 <xref:upload> anrop för att slutföra uppladdningen. Annars anropar <xref:stageBlock> den här metoden för att ladda upp block och anropar <xref:commitBlockList> slutligen för att checka in blockeringslistan.

Ett vanligt <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> alternativ att ange är blobContentType, vilket gör att webbläsaren kan tillhandahålla funktioner baserat på filtyp.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parametrar

data: Buffer | Blob | ArrayBuffer | ArrayBufferView

Buffer(Node.js), Blob, ArrayBuffer eller ArrayBufferView

options: BlockBlobParallelUploadOptions

Returer

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en lokal fil i block till en blockblob.

När filstorleken är mindre än eller lika med 256 MB använder den här metoden 1 uppladdningsanrop för att slutföra uppladdningen. Annars anropar den här metoden stageBlock för att ladda upp block och anropar slutligen commitBlockList för att checka in blockeringslistan.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

Parametrar

filePath: string

Fullständig sökväg till lokal fil

options: BlockBlobParallelUploadOptions

Alternativ för att ladda upp till blockblobåtgärd.

Returer

Promise<BlobUploadCommonResponse>

Svarsdata för blobuppladdningsåtgärden.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar dataström till blockblob.

TIPS FÖR PRESTANDAFÖRBÄTTRING:

HighWaterMark för indataströmmen är bättre att ange samma värde med bufferSize-parametern, vilket undviker Buffer.concat()-åtgärder.

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

Parametrar

stream: Readable

Node.js läsbar dataström

bufferSize: number

Storleken på varje allokerad buffert, även blockstorleken i den uppladdade blockbloben. Standardvärdet är 8 MB

maxConcurrency: number

Maximal samtidighet anger det maximala antalet buffertar som kan allokeras, positiv korrelation med maximal samtidighet vid uppladdning. Standardvärdet är 5

options: BlockBlobUploadStreamOptions

Alternativ för att ladda upp ström till blockblobåtgärd.

Returer

Promise<BlobUploadCommonResponse>

Svarsdata för blobuppladdningsåtgärden.

withSnapshot(string)

Skapar ett nytt BlockBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilden. Ange "" tar bort ögonblicksbilden och returnerar en URL till basbloben.

function withSnapshot(snapshot: string)

Parametrar

snapshot: string

Tidsstämpeln för ögonblicksbilden.

Returer

BlockBlobClient

Ett nytt BlockBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilden.

withVersion(string)

Skapar ett nytt BlobClient-objekt som pekar på en version av den här bloben. Ange "" tar bort versionId och returnerar en klient till basbloben.

function withVersion(versionId: string)

Parametrar

versionId: string

VersionId.

Returer

BlobClient

Ett nytt BlobClient-objekt som pekar på versionen av den här bloben.