BlobClient class

Referens

Paket:: @azure/storage-blob

En BlobClient representerar en URL till en Azure Storage-blob. bloben kan vara en blockblob, en tilläggsblob eller en sidblob.

Extends: StorageClient

Konstruktorer

BlobClient(string, PipelineLike)	Skapar en instans av BlobClient. 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. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Skapar en instans av BlobClient. 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. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.
BlobClient(string, string, string, StoragePipelineOptions)	Skapar en instans av BlobClient från anslutningssträngen.

Egenskaper

containerName	Namnet på lagringscontainern som bloben är associerad med.
name	Namnet på bloben.

Ärvda egenskaper

accountName
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.
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Exempel med automatisk avsökning: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Exempel med manuell avsökning: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Exempel med förloppsuppdateringar: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Exempel med ett föränderligt avsökningsintervall (standard 15 sekunder): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Exempel med kopieringsavbokning: `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)	Skapar en skrivskyddad ögonblicksbild av en blob. Se https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-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.jsreturnerar data i en läsbar dataström readableStreamBody I webbläsare returneras data i en löftesblobKropp Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
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 ladda nedToFileför blobar som är större än den här storleken.
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 ladda nedToFileför blobar som är större än den här storleken.
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.
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.
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	Åtgärden Hämta kontoinformation returnerar sku-namnet och kontotyp för det angivna kontot. Åtgärden Hämta kontoinformation är tillgänglig i tjänstversioner från och med version 2018-03-28. Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()	Skapar ett AppendBlobClient-objekt.
getBlobLeaseClient(string)	Hämta en BlobLeaseClient- som hanterar lån på bloben.
getBlockBlobClient()	Skapar ett BlockBlobClient-objekt.
getPageBlobClient()	Skapar ett PageBlobClient-objekt.
getProperties(BlobGetPropertiesOptions)	Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för bloben. Det returnerar inte innehållet i bloben. Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties VARNING! Det `metadata` objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoderna för ContainerClient som listar blobar med alternativet `includeMetadata`, som behåller sitt ursprungliga hölje.
getTags(BlobGetTagsOptions)	Hämtar taggarna som är associerade med den underliggande bloben.
setAccessTier(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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Ange en oföränderlig princip för bloben.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Ange lagligt undantag 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 om inga metadata har definierats i parametern, tas blobmetadata bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
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 ('_') .
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
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. Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withSnapshot(string)	Skapar ett nytt BlobClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en klient 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

BlobClient(string, PipelineLike)

Skapar en instans av BlobClient. 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. Om ett blobnamn innehåller ? eller %måste blobnamnet kodas i URL:en.

new BlobClient(url: string, pipeline: PipelineLike)

Parametrar

url: string

En URL-sträng som pekar på Azure Storage-blob, till exempel "https://myaccount.blob.core.windows.net/mycontainer/blob". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net/mycontainer/blob?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.

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

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

Parametrar

url: string

En klientsträng som pekar på Azure Storage-blobtjänsten, till exempel "https://myaccount.blob.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net?sasString".

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.

BlobClient(string, string, string, StoragePipelineOptions)

Skapar en instans av BlobClient från anslutningssträngen.

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

containerName

Namnet på lagringscontainern som bloben är associerad med.

string containerName

Egenskapsvärde

string

name

Namnet på bloben.

string name

Egenskapsvärde

string

Information om ärvda egenskaper

accountName

accountName: string

Egenskapsvärde

string

ärvd från StorageClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ärvd från StorageClient.credential

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

ärvd från StorageClient.url

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.

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

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

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.

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

Exempel med automatisk avsökning:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Exempel med manuell avsökning:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Exempel med förloppsuppdateringar:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Exempel med ett föränderligt avsökningsintervall (standard 15 sekunder):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Exempel med kopieringsavbokning:

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

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

createSnapshot(BlobCreateSnapshotOptions)

Skapar en skrivskyddad ögonblicksbild av en blob.

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

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

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parametrar

options: BlobDeleteOptions

Valfria alternativ för blobborttagning.

Returer

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Ta bort immutablility-principen på bloben.

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

Parametrar

options: BlobDeleteImmutabilityPolicyOptions

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

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 ladda nedToFileför blobar som är större än den här storleken.

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

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

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.

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

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

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): Promise<BlobDownloadResponseParsed>

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): Promise<boolean>

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.

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

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

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.

getAccountInfo(BlobGetAccountInfoOptions)

Åtgärden Hämta kontoinformation returnerar sku-namnet och kontotyp för det angivna kontot. Åtgärden Hämta kontoinformation är tillgänglig i tjänstversioner från och med version 2018-03-28.

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

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

Parametrar

options: BlobGetAccountInfoOptions

Alternativ för åtgärden Hämta kontoinformation för tjänsten.

Returer

Promise<BlobGetAccountInfoResponse>

Svarsdata för åtgärden Hämta kontoinformation för tjänsten.

getAppendBlobClient()

Skapar ett AppendBlobClient-objekt.

function getAppendBlobClient(): AppendBlobClient

Returer

AppendBlobClient

getBlobLeaseClient(string)

Hämta en BlobLeaseClient- som hanterar lån på bloben.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

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

Returer

BlockBlobClient

getPageBlobClient()

Skapar ett PageBlobClient-objekt.

function getPageBlobClient(): PageBlobClient

Returer

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoderna för ContainerClient som listar blobar med alternativet includeMetadata, som behåller sitt ursprungliga hölje.

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

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): Promise<BlobGetTagsResponse>

Parametrar

options: BlobGetTagsOptions

Returer

Promise<BlobGetTagsResponse>

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parametrar

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

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 en oföränderlig princip för bloben.

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

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): Promise<BlobSetLegalHoldResponse>

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

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): Promise<BlobSetTagsResponse>

Parametrar

tags: Tags

options: BlobSetTagsOptions

Returer

Promise<BlobSetTagsResponse>

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

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>

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parametrar

options: BlobUndeleteOptions

Valfria alternativ för åtgärden Ta bort borttagning av blob.

Returer

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

Parametrar

snapshot: string

Tidsstämpeln för ögonblicksbilden.

Returer

BlobClient

Ett nytt BlobClient-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): BlobClient

Parametrar

versionId: string

VersionId.

Returer

BlobClient

Ett nytt BlobClient-objekt som pekar på den här blobens version.

Dela via

BlobClient class

Konstruktorer

Egenskaper

Ärvda egenskaper

Metoder

Konstruktorinformation

BlobClient(string, PipelineLike)

Parametrar

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

Parametrar

BlobClient(string, string, string, StoragePipelineOptions)

Parametrar

Egenskapsinformation

containerName

Egenskapsvärde

name

Egenskapsvärde

Information om ärvda egenskaper

accountName

Egenskapsvärde

credential

Egenskapsvärde

url

Egenskapsvärde

Metodinformation

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametrar

Returer

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametrar

Returer

createSnapshot(BlobCreateSnapshotOptions)

Parametrar

Returer

delete(BlobDeleteOptions)

Parametrar

Returer

deleteIfExists(BlobDeleteOptions)

Parametrar

Returer

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parametrar

Returer

download(number, number, BlobDownloadOptions)

Parametrar

Returer

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametrar

Returer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametrar

Returer

downloadToFile(string, number, number, BlobDownloadOptions)

Parametrar

Returer

exists(BlobExistsOptions)

Parametrar

Returer

generateSasUrl(BlobGenerateSasUrlOptions)

Parametrar

Returer

getAccountInfo(BlobGetAccountInfoOptions)

Parametrar

Returer

getAppendBlobClient()

Returer

getBlobLeaseClient(string)

Parametrar

Returer

getBlockBlobClient()

Returer

getPageBlobClient()

Returer

getProperties(BlobGetPropertiesOptions)

Parametrar

Returer

getTags(BlobGetTagsOptions)

Parametrar

Returer