PageBlobClient class

Referens

Paket:: @azure/storage-blob

PageBlobClient definierar en uppsättning åtgärder som gäller för sidblobar.

Extends: BlobClient

Konstruktorer

PageBlobClient(string, PipelineLike)	Skapar en instans av PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Skapar en instans av PageBlobClient. 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.
PageBlobClient(string, string, string, StoragePipelineOptions)	Skapar en instans av PageBlobClient.

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 det inte anges används AnonymousCredential.
name	Namnet på bloben.
url	Kodat URL-strängvärde.

Metoder

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Avbryter en väntande asynkron kopieringsblobåtgärd och lämnar en målblob med noll längd och fullständiga metadata. Version 2012-02-12 och senare.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Kopierar asynkront en blob till ett mål i lagringskontot. Den här metoden returnerar en tidskrävande åtgärdspolerare som gör att du kan vänta på obestämd tid tills kopieringen har slutförts. Du kan också avbryta en kopia innan den har slutförts genom att anropa `cancelOperation` på pollern. Observera att återanropet onProgress inte anropas om åtgärden slutförs i den första begäran, och om du försöker avbryta en slutförd kopia genereras ett fel. I version 2012-02-12 och senare kan källan för en kopieringsblobåtgärd vara en checkad blob i valfritt Azure-lagringskonto. Från och med version 2015-02-21 kan källan för en kopieringsblobåtgärd vara en Azure-fil i valfritt Azure-lagringskonto. Endast lagringskonton som skapats den 7 juni 2012 eller senare tillåter att åtgärden Kopiera blob kopieras från ett annat lagringskonto.
clearPages(number, number, PageBlobClearPagesOptions)	Frigör de angivna sidorna från sidbloben.
create(number, PageBlobCreateOptions)	Skapar en sidblob med den angivna längden. Anropa uploadPages för att ladda upp data till en sidblob.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Skapar en sidblob med den angivna längden. Anropa uploadPages för att ladda upp data till en sidblob. 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 om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
deleteIfExists(BlobDeleteOptions)	Markerar den angivna bloben eller ögonblicksbilden för borttagning om den finns. Bloben tas senare bort under skräpinsamlingen. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt med åtgärden Ta bort blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Ta bort immutablility-principen på bloben.
download(number, number, BlobDownloadOptions)	Läser eller laddar ned en blob från systemet, inklusive dess metadata och egenskaper. Du kan också anropa Hämta blob för att läsa en ögonblicksbild. I Node.js returnerar data i en läsbar dataström läsbarStreamBody I webbläsare returneras data i en promise blobBody
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob parallellt till en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte anges. Varning! Buffertar kan bara ha stöd för filer upp till cirka en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För blobar som är större än den här storleken bör du överväga <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-blob parallellt till en buffert. Förskjutning och antal är valfria, laddar ned hela bloben om de inte anges. Varning! Buffertar kan bara ha stöd för filer upp till cirka en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. Överväg <xref:downloadToFile>fö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 true 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. Tvärtom kan nya blobar 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 en autentiseringsuppgift med delad nyckel. Genererar en SAS-URI (Blob Service Shared Access Signature) 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.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Returnerar listan över giltiga sidintervall för en sidblob eller ögonblicksbild av en sidblob.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Hämtar samlingen med sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Hämtar samlingen med sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben för hanterade diskar.
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.
resize(number, PageBlobResizeOptions)	Ändrar storlek på sidbloben till den angivna storleken (som måste vara en multipel av 512).
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-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs 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 inget värde som angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan värde.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Ange immutablility-princip på 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 definierats i parametern tas blobmetadata bort.
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 ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Påbörjar en åtgärd för att starta en inkrementell kopia från ögonblicksbilden av en sidblob till den här sidbloben. Ögonblicksbilden kopieras så att endast differentiella ändringar mellan den tidigare kopierade ögonblicksbilden överförs till målet. De kopierade ögonblicksbilderna är fullständiga kopior av den ursprungliga ögonblicksbilden och kan läsas eller kopieras från som vanligt.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Den synkrona åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte ett svar förrän kopian har slutförts.
undelete(BlobUndeleteOptions)	Återställer innehållet och metadata för mjuk borttagen blob och eventuella associerade mjukt borttagna ögonblicksbilder. Undelete Blob stöds endast i version 2017-07-29 eller senare.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Anger en sidblobs sekvensnummer.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Skriver 1 eller flera sidor till sidbloben. Start- och slutförskjutningarna måste vara en multipel av 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Åtgärden Ladda upp sidor skriver ett sidintervall till en sidblob där innehållet läse från en URL.
withSnapshot(string)	Skapar ett nytt PageBlobClient-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 blobben. Ange "" tar bort versionId och returnerar en klient till basbloben.

Konstruktorinformation

PageBlobClient(string, PipelineLike)

Skapar en instans av PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametrar

url: string

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

pipeline: PipelineLike

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

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

Skapar en instans av PageBlobClient. 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 PageBlobClient(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 inget anges används AnonymousCredential.

options: StoragePipelineOptions

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

PageBlobClient(string, string, string, StoragePipelineOptions)

Skapar en instans av PageBlobClient.

new PageBlobClient(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 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 kopiering av blob från URL.

Returer

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

Parametrar

copySource: string

url till källan Azure Blob/File.

options: BlobBeginCopyFromURLOptions

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

Returer

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

clearPages(number, number, PageBlobClearPagesOptions)

Frigör de angivna sidorna från sidbloben.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Parametrar

offset: number

Startar bytepositionen för sidorna som ska rensas.

count: number

Antal byte som ska rensas.

options: PageBlobClearPagesOptions

Alternativ för åtgärden Rensa sidor för sidblob.

Returer

Promise<PageBlobClearPagesResponse>

Svarsdata för åtgärden Rensa sidor för sidblob.

create(number, PageBlobCreateOptions)

Skapar en sidblob med den angivna längden. Anropa uploadPages för att ladda upp data till en sidblob.

function create(size: number, options?: PageBlobCreateOptions)

Parametrar

size: number

sidblobens storlek.

options: PageBlobCreateOptions

Alternativ för åtgärden Skapa sidblob.

Returer

Promise<PageBlobCreateResponse>

Svarsdata för åtgärden Skapa sidblob.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Skapar en sidblob med den angivna längden. Anropa uploadPages för att ladda upp data till en sidblob. Om bloben med samma namn redan finns förblir innehållet i den befintliga bloben oförändrat.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Parametrar

size: number

sidblobens storlek.

options: PageBlobCreateIfNotExistsOptions

Returer

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Skapar en skrivskyddad ögonblicksbild av en blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametrar

options: BlobCreateSnapshotOptions

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

Returer

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

Parametrar

options: BlobDeleteOptions

Valfria alternativ för blobborttagningsåtgärd.

Returer

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

Parametrar

options: BlobDeleteOptions

Valfria alternativ för blobborttagningsåtgärd.

Returer

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Ta bort immutablility-principen på bloben.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametrar

options: BlobDeleteImmutabilityPolicyOptions

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

Returer

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

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

Parametrar

offset: number

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

count: number

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

options: BlobDownloadOptions

Valfria alternativ för blobnedladdning.

Exempelanvändning (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

Exempelanvändning (webbläsare):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Returer

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

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

Parametrar

buffer: Buffer

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

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Returer

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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. Ö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. 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)

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 blobnedladdning, 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 true 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. Tvärtom kan nya blobar 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 en autentiseringsuppgift med delad nyckel. Genererar en SAS-URI (Blob Service Shared Access Signature) 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 för den resurs 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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Returnerar listan över giltiga sidintervall för en sidblob eller ögonblicksbild av en sidblob.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Parametrar

offset: number

Startar bytepositionen för sidintervallen.

count: number

Antal byte som ska hämtas.

options: PageBlobGetPageRangesOptions

Alternativ för åtgärden Hämta intervall för sidblob.

Returer

Promise<PageBlobGetPageRangesResponse>

Svarsdata för åtgärden Hämta intervall för sidblob.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Hämtar samlingen med sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Parametrar

offset: number

Starta bytepositionen för sidbloben

count: number

Antal byte för att hämta intervalldiffert.

prevSnapshot: string

Tidsstämpel för ögonblicksbild för att hämta skillnaden.

options: PageBlobGetPageRangesDiffOptions

Alternativ för åtgärden Hämta sidintervall för sidblob.

Returer

Promise<PageBlobGetPageRangesDiffResponse>

Svarsdata för åtgärden Hämta sidintervallsdiiff för sidblob.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Hämtar samlingen med sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben för hanterade diskar.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Parametrar

offset: number

Starta bytepositionen för sidbloben

count: number

Antal byte för att hämta intervalldiffert.

prevSnapshotUrl: string

URL för ögonblicksbild för att hämta skillnaden.

options: PageBlobGetPageRangesDiffOptions

Alternativ för åtgärden Hämta sidintervall för sidblob.

Returer

Promise<PageBlobGetPageRangesDiffResponse>

Svarsdata för åtgärden Hämta sidintervallsdiiff för sidblob.

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>

resize(number, PageBlobResizeOptions)

Ändrar storlek på sidbloben till den angivna storleken (som måste vara en multipel av 512).

function resize(size: number, options?: PageBlobResizeOptions)

Parametrar

size: number

Målstorlek

options: PageBlobResizeOptions

Alternativ för åtgärden Ändra storlek på sidblob.

Returer

Promise<PageBlobResizeResponse>

Svarsdata för åtgärden Ändra storlek på sidblob.

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-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs 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 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 för bloben. Om inget värde anges, eller inget värde som angetts för de angivna HTTP-huvudena för bloben, 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-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan 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 Set HTTP Headers (Http-huvuden).

Returer

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Ange immutablility-princip på 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 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>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Påbörjar en åtgärd för att starta en inkrementell kopia från ögonblicksbilden av en sidblob till den här sidbloben. Ögonblicksbilden kopieras så att endast differentiella ändringar mellan den tidigare kopierade ögonblicksbilden överförs till målet. De kopierade ögonblicksbilderna är fullständiga kopior av den ursprungliga ögonblicksbilden och kan läsas eller kopieras från som vanligt.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Parametrar

copySource: string

Anger namnet på ögonblicksbilden av källsidans blob. Till exempel https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options: PageBlobStartCopyIncrementalOptions

Alternativ för inkrementell kopiering av sidblob.

Returer

Promise<PageBlobCopyIncrementalResponse>

Svarsdata för inkrementell kopiering av sidblob.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Den synkrona åtgärden Kopiera från URL kopierar en blob eller en Internetresurs till en ny blob. Det returnerar inte ett 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 mjuk borttagen blob 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 åtgärden Blob Undelete.

Returer

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Anger en sidblobs sekvensnummer.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Parametrar

sequenceNumberAction: SequenceNumberActionType

Anger hur tjänsten ska ändra blobens sekvensnummer.

sequenceNumber: number

Krävs om sequenceNumberAction är max eller uppdatering

options: PageBlobUpdateSequenceNumberOptions

Alternativ för åtgärden Sekvensnummer för sidblobuppdatering.

Returer

Promise<PageBlobUpdateSequenceNumberResponse>

Svarsdata för åtgärden Sekvensnummer för sidblobuppdatering.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Skriver 1 eller flera sidor till sidbloben. Start- och slutförskjutningarna måste vara en multipel av 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Parametrar

body: HttpRequestBody

Data som ska laddas upp

offset: number

Förskjutning av målsidans blob

count: number

Brödtextens innehållslängd, även antalet byte som ska laddas upp

options: PageBlobUploadPagesOptions

Alternativ för åtgärden Sidblobuppladdningssidor.

Returer

Promise<PageBlobUploadPagesResponse>

Svarsdata för åtgärden Sidblobuppladdningssidor.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

Åtgärden Ladda upp sidor skriver ett sidintervall till en sidblob där innehållet läse från en URL.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Parametrar

sourceURL: string

Ange en URL till kopieringskällan, signatur för delad åtkomst (SAS) som kanske behövs för autentisering

sourceOffset: number

Källförskjutningen att kopiera från. Skicka 0 för att kopiera från början av källsidans blob

destOffset: number

Förskjutning av målsidans blob

count: number

Antal byte som ska laddas upp från källsidans blob

options: PageBlobUploadPagesFromURLOptions

Returer

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Skapar ett nytt PageBlobClient-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)

Parametrar

snapshot: string

Tidsstämpeln för ögonblicksbilden.

Returer

PageBlobClient

Ett nytt PageBlobClient-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 blobben. 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å blobens version.

Dela via

PageBlobClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

PageBlobClient(string, PipelineLike)

Parametrar

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

Parametrar

PageBlobClient(string, string, string, StoragePipelineOptions)

Parametrar

Egenskapsinformation

accountName

Egenskapsvärde

containerName

Egenskapsvärde

credential

Egenskapsvärde

name

Egenskapsvärde

url

Egenskapsvärde

Metodinformation

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametrar

Returer

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametrar

Returer

clearPages(number, number, PageBlobClearPagesOptions)

Parametrar

Returer

create(number, PageBlobCreateOptions)

Parametrar

Returer

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

getAppendBlobClient()

Returer

getBlobLeaseClient(string)

Parametrar

Returer

getBlockBlobClient()

Returer

getPageBlobClient()

Returer

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parametrar