BlockBlobClient class
BlockBlobClient definierar en uppsättning åtgärder som gäller för blockblobar.
- Extends
Konstruktorer
| Block |
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 %måste blobnamnet kodas i URL:en. |
| Block |
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 %måste blobnamnet kodas i URL:en. |
| Block |
Skapar en instans av BlockBlobClient. |
Egenskaper
| account |
|
| container |
Namnet på lagringscontainern som bloben är associerad med. |
| credential | Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från |
| name | Namnet på bloben. |
| url | Kodat URL-strängvärde. |
Metoder
| abort |
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. |
| begin |
Kopierar asynkront en blob till ett mål i lagringskontot.
Den här metoden returnerar en tidskrävande åtgärdsmätning 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 slutförs genom att anropa |
| commit |
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 anges i blocklistan och tas bort permanent. |
| create |
Skapar en skrivskyddad ögonblicksbild av en blob. |
| delete(Blob |
Markerar den angivna bloben eller ögonblicksbilden för borttagning. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob. |
| delete |
Markerar den angivna bloben eller ögonblicksbilden för borttagning om den finns. Bloben tas senare bort under skräpinsamlingen. Observera att du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob. |
| delete |
Ta bort immutablility-principen på bloben. |
| download(number, number, Blob |
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.
|
| download |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls. Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. Överväg <xref:downloadToFile>för blobar som är större än den här storleken. |
| download |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls. Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. Överväg <xref:downloadToFile>för blobar som är större än den här storleken. |
| download |
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 odefinierat för att ladda ned hela bloben. |
| exists(Blob |
Returnerar sant om Azure Blob-resursen 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. |
| generate |
Endast tillgängligt för BlobClient som konstruerats med en delad nyckelautentiseringsuppgift. Genererar en SAS-URI (Blob Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. |
| get |
Skapar ett AppendBlobClient-objekt. |
| get |
Hämta en <xref:BlobLeaseClient> som hanterar lån på bloben. |
| get |
Skapar ett BlockBlobClient-objekt. |
| get |
Returnerar listan över block som har laddats upp som en del av en blockblob med det angivna blocklistfiltret. |
| get |
Skapar ett PageBlobClient-objekt. |
| get |
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Det returnerar inte innehållet i bloben. |
| get |
Hämtar taggarna som är associerade med den underliggande bloben. |
| query(string, Block |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Snabbfråga för en JSON- eller CSV-formaterad blob. Exempel på användning (Node.js):
|
| set |
Anger nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobnivå avgör blobens tillåtna storlek, IOPS och bandbredd. En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkiv. Den här åtgärden uppdaterar inte blobens ETag. |
| set |
Anger systemegenskaper på bloben. Om inget värde anges, eller inget värde som angetts för de angivna HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde. |
| set |
Ange principen för immutablility på bloben. |
| set |
Ange lagligt undantag för bloben. |
| set |
Anger användardefinierade metadata för den angivna bloben som ett eller flera namn/värde-par. Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas blobmetadata bort. |
| set |
Anger taggar på den underliggande bloben. En blob kan ha upp till 10 taggar. Taggnycklarna 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 ('_') . |
| stage |
Laddar upp det angivna blocket till blockblobens "mellanlagringsområde" som senare ska utföras av ett anrop till commitBlockList. |
| stage |
Åtgärden 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. |
| sync |
Åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte något svar förrän kopian är klar. |
| sync |
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 Put Blob from 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(Blob |
Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjuka borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare. |
| upload(Http |
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 vid samtidig uppladdning. |
| upload |
ENDAST TILLGÄNGLIGT I WEBBLÄSARE. Laddar upp ett blob-/fil-/matrisbuffer-/arraybufferview-objekt i webbläsaren för att blockera blob. 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 den här metoden <xref:stageBlock> för att ladda upp block och anropar slutligen <xref:commitBlockList> för att checka in blockeringslistan. Ett vanligt <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> alternativ att ange är |
| upload |
Laddar upp en buffert(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-objekt till en BlockBlob. När datalängden inte är mer än den specifikationsbara <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 den här metoden <xref:stageBlock> för att ladda upp block och anropar slutligen <xref:commitBlockList> för att checka in blockeringslistan. Ett vanligt <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> alternativ att ange är |
| upload |
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 ett 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 blocklistan. |
| upload |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar ström till blockblob. TIPS FÖR PRESTANDAFÖRBÄTTRING:
|
| with |
Skapar ett nytt BlockBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en URL till basbloben. |
| with |
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 %måste blobnamnet kodas 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 %måste blobnamnet kodas 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)
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 %måste blobnamnet kodas i URL:en.
new BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
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 %måste blobnamnet kodas 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".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera 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
Valfri. 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
Valfri. 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 eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte 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 blobkopiering 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ärdsmätning 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 slutförs 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 bekräftad 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 kopieringsblobåtgärden att kopiera 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 BlobStart Copy From URL (Blob Start Copy From 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 anges i blocklistan och tas 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 Blockera blockeringslista för blobincheckning.
Returer
Promise<BlockBlobCommitBlockListResponse>
Svarsdata för åtgärden Blockera blockering av blockeringslista för blobb.
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 du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
function delete(options?: BlobDeleteOptions)
Parametrar
- options
- BlobDeleteOptions
Valfria alternativ för blobborttagning.
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 du måste ta bort alla ögonblicksbilder för att kunna ta bort en blob. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
function deleteIfExists(options?: BlobDeleteOptions)
Parametrar
- options
- BlobDeleteOptions
Valfria alternativ för blobborttagning.
Returer
Promise<BlobDeleteIfExistsResponse>
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Ta bort immutablility-principen på bloben.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)
Parametrar
Valfria alternativ för att ta bort principen för oföränderlighet i 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.jsreturnerar data i en läsbar dataström readableStreamBody
- I webbläsare returneras data i en löftesblobKropp
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.
Exempel på anvä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);
});
}
Exempel på anvä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 med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls.
Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. Överväg <xref:downloadToFile>för blobar som är större än den här storleken.
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. Kommer att laddas ned till slutet när odefinierade skickas
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions (på engelska)
Returer
Promise<Buffer>
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob parallellt med en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte tillhandahålls.
Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. Överväg <xref:downloadToFile>för blobar som är större än den här storleken.
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. Kommer att laddas ned till slutet när odefinierade skickas
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions (på engelska)
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 odefinierat 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å odefinierat eftersom dess innehåll redan har lästs och skrivits till en lokal fil på den angivna sökvägen.
exists(BlobExistsOptions)
Returnerar sant om Azure Blob-resursen 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 konstruerats med en delad nyckelautentiseringsuppgift. Genererar en SAS-URI (Blob Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. 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 den resurs som representeras av den här klienten, följt av den genererade SAS-token.
getAppendBlobClient()
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
Ett nytt BlobLeaseClient-objekt för att hantera lån på bloben.
getBlockBlobClient()
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 listan över bekräftade block, listan över ej bekräftade block eller båda listorna ska returneras tillsammans.
- options
- BlockBlobGetBlockListOptions
Alternativ för åtgärden Hämta blockeringslista för blockblob.
Returer
Promise<BlockBlobGetBlockListResponse>
Svarsdata för åtgärden Hämta blockeringslista för blockblob.
getPageBlobClient()
getProperties(BlobGetPropertiesOptions)
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Det 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.
Exempel på anvä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 på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobnivå avgör blobens tillåtna storlek, IOPS och bandbredd. En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkiv. 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 på 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 på bloben. Om inget värde anges, eller inget värde som angetts för de angivna HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde.
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)
Parametrar
- blobHTTPHeaders
- BlobHTTPHeaders
Om inget värde anges, eller inget värde som angetts för de angivna HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde.
Ett vanligt huvud 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 principen för immutablility på bloben.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)
Parametrar
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Valfria alternativ för att ange oföränderlighetsprincip för bloben.
Returer
Promise<BlobSetImmutabilityPolicyResponse>
setLegalHold(boolean, BlobSetLegalHoldOptions)
Ange lagligt undantag 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 om inga metadata har 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 på den underliggande bloben. En blob kan ha upp till 10 taggar. Taggnycklarna 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 utföras av ett anrop till commitBlockList.
function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)
Parametrar
- blockId
-
string
Ett 64-bytesvärde 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 blockblobstegsblocket.
Returer
Promise<BlockBlobStageBlockResponse>
Svarsdata för åtgärden BlockBlobstegblock.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)
Åtgärden 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 64-bytesvärde 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 eftersom det 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=<DateTime>
- 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
Alternativ för åtgärden Blockera blockering av blobsteg från URL.
Returer
Promise<BlockBlobStageBlockFromURLResponse>
Svarsdata för åtgärden Blockera blobstegblock från URL.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte något svar förrän kopian är klar.
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)
Parametrar
- copySource
-
string
Käll-URL:en som ska kopieras 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 Put Blob from 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
Anger blobens URL. Värdet kan vara en URL på upp till 2 kB som anger en blob.
Värdet ska vara URL-kodat eftersom det 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=<DateTime>
Valfria parametrar.
Returer
Promise<BlockBlobPutBlobFromUrlResponse>
undelete(BlobUndeleteOptions)
Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjuka 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 åtgärden Ta bort borttagning av blob.
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 vid samtidig uppladdning.
function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)
Parametrar
- body
-
HttpRequestBody
Blob, string, 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ängd på brödtext 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 för att blockera blob.
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 den här metoden <xref:stageBlock> för att ladda upp block och anropar slutligen <xref:commitBlockList> 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, File, 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 en buffert(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-objekt till en BlockBlob. När datalängden inte är mer än den specifikationsbara <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 den här metoden <xref:stageBlock> för att ladda upp block och anropar slutligen <xref:commitBlockList> 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 ett 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 blocklistan.
function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)
Parametrar
- filePath
-
string
Fullständig sökväg för 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 ström till blockblob.
TIPS FÖR PRESTANDAFÖRBÄTTRING:
- HighWaterMark för indataström ä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 strö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 stream 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 ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en URL till basbloben.
function withSnapshot(snapshot: string)
Parametrar
- snapshot
-
string
Tidsstämpeln för ögonblicksbilden.
Returer
Ett nytt BlockBlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder.
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
Ett nytt BlobClient-objekt som pekar på den här blobens version.