AppendBlobClient class

Referens

Paket:: @azure/storage-blob

AppendBlobClient definierar en uppsättning åtgärder som gäller för tilläggsblobar.

Extends: BlobClient

Konstruktorer

AppendBlobClient(string, PipelineLike)	Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. 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.
AppendBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. 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.
AppendBlobClient(string, string, string, StoragePipelineOptions)	Skapar en instans av AppendBlobClient.

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.
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	Genomför ett nytt datablock i slutet av den befintliga tilläggsbloben.
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	Åtgärden Lägg till block checkar in ett nytt datablock i slutet av en befintlig tilläggsblob där innehållet läse från en käll-URL.
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 är klar genom att anropa `cancelOperation` i polleraren. 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 utlöses ett fel. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i alla Azure Storage-konton. 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.
create(AppendBlobCreateOptions)	Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob.
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob. Om bloben med samma namn redan finns förblir innehållet i den befintliga bloben oförändrat.
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 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.
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.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Ta bort principen för immutablility 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 readableStreamBody I webbläsare returnerar data i en promise blobBody
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 för Node.js/V8. Överväg <xref:downloadToFile>fö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 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.
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.
seal(AppendBlobSealOptions)	Förseglar tilläggsbloben, vilket gör den skrivskyddad.
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 ('_') .
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.
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.
withSnapshot(string)	Skapar ett nytt AppendBlobClient-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.
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

AppendBlobClient(string, PipelineLike)

Skapar en instans av AppendBlobClient. Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en tilläggsblob. 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 AppendBlobClient(url: string, pipeline: PipelineLike)

Parametrar

url: string

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

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

new AppendBlobClient(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.

AppendBlobClient(string, string, string, StoragePipelineOptions)

Skapar en instans av AppendBlobClient.

new AppendBlobClient(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 Avbruten blobkopiering från URL.

Returer

Promise<BlobAbortCopyFromURLResponse>

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

Genomför ett nytt datablock i slutet av den befintliga tilläggsbloben.

function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions)

Parametrar

body: HttpRequestBody

Data som ska läggas till.

contentLength: number

Längden på brödtexten i byte.

options: AppendBlobAppendBlockOptions

Alternativ för åtgärden Lägg till block.

Exempel på användning:

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

Returer

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Åtgärden Lägg till block checkar in ett nytt datablock i slutet av en befintlig tilläggsblob där innehållet läse från en käll-URL.

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions)

Parametrar

sourceURL: string

          The url to the blob that will be the source of the copy. A source blob in the same storage account can
          be authenticated via Shared Key. However, if the source is a blob in another account, the source blob
          must either be public or must be authenticated via a shared access signature. If the source blob is
          public, no authentication is required to perform the operation.

sourceOffset: number

Förskjutning i källa som ska läggas till

count: number

Antal byte som ska läggas till som ett block

options: AppendBlobAppendBlockFromURLOptions

Returer

Promise<AppendBlobAppendBlockFromUrlResponse>

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 är klar genom att anropa cancelOperation i polleraren. 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 utlöses ett fel. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i alla Azure Storage-konton. 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 Starta blobkopiering från URL.

Returer

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

create(AppendBlobCreateOptions)

Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob.

function create(options?: AppendBlobCreateOptions)

Parametrar

options: AppendBlobCreateOptions

Alternativ för åtgärden Lägg till block skapa.

Exempel på användning:

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

Returer

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

Skapar en tilläggsblob med 0 längder. Anropa AppendBlock för att lägga till data i en tilläggsblob. Om bloben med samma namn redan finns förblir innehållet i den befintliga bloben oförändrat.

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions)

Parametrar

options: AppendBlobCreateIfNotExistsOptions

Returer

Promise<AppendBlobCreateIfNotExistsResponse>

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

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 principen för immutablility på bloben.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametrar

options: BlobDeleteImmutabilityPolicyOptions

Valfria alternativ för att ta bort principen för oföränderlighet 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 readableStreamBody
I webbläsare returnerar 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.

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 för 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. 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.

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

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

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>

seal(AppendBlobSealOptions)

Förseglar tilläggsbloben, vilket gör den skrivskyddad.

function seal(options?: AppendBlobSealOptions)

Parametrar

options: AppendBlobSealOptions

Returer

Promise<AppendBlobAppendBlockResponse>

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>

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>

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>

withSnapshot(string)

Skapar ett nytt AppendBlobClient-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

snapshot: string

Tidsstämpeln för ögonblicksbilden.

Returer

AppendBlobClient

Ett nytt AppendBlobClient-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.