BlobClient class

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 %, blobnamnet måste kodas i URL:en.

new BlobClient(url: string, pipeline: PipelineLike)

Parametrar

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 %, blobnamnet måste kodas i URL:en.

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

Parametrar

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

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

Parametrar

accountName: string

Egenskapsvärde

Namnet på lagringscontainern som bloben är associerad med.

string containerName

Egenskapsvärde

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

Namnet på bloben.

string name

Egenskapsvärde

Kodat URL-strängvärde.

url: string

Egenskapsvärde

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

Returer

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

Returer

Skapar en skrivskyddad ögonblicksbild av en blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametrar

Returer

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

Returer

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

Returer

Ta bort immutablility-principen på bloben.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametrar

Returer

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

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

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

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

Returer

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(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Parametrar

Returer

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

Returer

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.

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

Returer

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

Returer

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.

Skapar ett AppendBlobClient-objekt.

function getAppendBlobClient()

Returer

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parametrar

Returer

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

Skapar ett BlockBlobClient-objekt.

function getBlockBlobClient()

Returer

Skapar ett PageBlobClient-objekt.

function getPageBlobClient()

Returer

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

function getProperties(options?: BlobGetPropertiesOptions)

Parametrar

Returer

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

function getTags(options?: BlobGetTagsOptions)

Parametrar

Returer

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

Returer

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

Returer

Ange en immutablility-princip för bloben.

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

Parametrar

Returer

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

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

Parametrar

Returer

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

Returer

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

Returer

Å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

Returer

Å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

Returer

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

function withSnapshot(snapshot: string)

Parametrar

Returer

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

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

Returer

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