Dela via

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 vara kodat i URL:en.
PageBlobClient(string, string, string, StoragePipelineOptions)

Skapar en instans av PageBlobClient.

Egenskaper

containerName

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

Namnet på bloben.

Ärvda egenskaper

accountName
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.
url

Kodat URL-strängvärde.

Metoder

clearPages(number, number, PageBlobClearPagesOptions)

Frigör de angivna sidorna från sidbloben.

Se https://docs.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/put-blob
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.

Se https://docs.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
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.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Returnerar en asynkron iterbar iterator till en lista över sidintervall för en sidblob.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() returnerar en asynkron itererbar iterator till en lista över sidintervall för en sidblob.

Exempel med syntax for await :

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exempel med iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exempel med byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exempel med sidindelning med en markör:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Returnerar en asynkron iterbar iterator till en lista över sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() returnerar en asynkron itererbar iterator till en lista över sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben.

Exempel med syntax for await :

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exempel med iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exempel med byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exempel med sidindelning med en markör:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Påbörjar en åtgärd för att starta en inkrementell kopia från en sidblobs ögonblicksbild till den här sidbloben. Ögonblicksbilden kopieras så att endast de differentiella ändringarna 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.

Se se https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Anger en sidblobs sekvensnummer.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
withSnapshot(string)

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

Ärvda 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 ä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.

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 (standardvärdet är 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 kopiering:

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

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 för Node.js/V8. Överväg att ladda nedToFile 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 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 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 att ladda nedToFile.
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.

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

Skapar ett AppendBlobClient-objekt.
getBlobLeaseClient(string)

Hämta en BlobLeaseClient som hanterar lån för 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.

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

VARNING! Objektet metadata som returnerades 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 hjälp av includeMetadata alternativet , 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 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. En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. 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 för bloben.

Om inget värde anges, eller inget värde för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-huvuden för blobar utan ett värde.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Ange en oföränderlighetsprincip 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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
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 omfattar 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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
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

PageBlobClient(string, PipelineLike)

Skapar en instans av PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametrar

url

string

En URL-strä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". 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.

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 vara kodat i URL:en.

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

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

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.

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

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

Ärvt frånBlobClient.accountName

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

Ärvd frånBlobClient.credential

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

Ärvd frånBlobClient.url

Metodinformation

clearPages(number, number, PageBlobClearPagesOptions)

Frigör de angivna sidorna från sidbloben.

Se https://docs.microsoft.com/rest/api/storageservices/put-page

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

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.

Se https://docs.microsoft.com/rest/api/storageservices/put-blob

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

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.

Se https://docs.microsoft.com/rest/api/storageservices/put-blob

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parametrar

size

number

sidblobens storlek.

options
PageBlobCreateIfNotExistsOptions

Returer

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

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.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parametrar

offset

number

Startar 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 sidintervall.

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.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parametrar

offset

number

Startar 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 sidintervall.

Returer

Promise<PageBlobGetPageRangesDiffResponse>

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

listPageRanges(number, number, PageBlobListPageRangesOptions)

Returnerar en asynkron iterbar iterator till en lista över sidintervall för en sidblob.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() returnerar en asynkron itererbar iterator till en lista över sidintervall för en sidblob.

Exempel med syntax for await :

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exempel med iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exempel med byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exempel med sidindelning med en markör:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parametrar

offset

number

Startar bytepositionen för sidintervallen.

count

number

Antal byte som ska hämtas.

options
PageBlobListPageRangesOptions

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

Returer

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

En asyncIterableIterator som stöder sidindelning.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Returnerar en asynkron iterbar iterator till en lista över sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben.

Se https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() returnerar en asynkron itererbar iterator till en lista över sidintervall som skiljer sig mellan en angiven ögonblicksbild och den här sidbloben.

Exempel med syntax for await :

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exempel med iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exempel med byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exempel med sidindelning med en markör:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parametrar

offset

number

Startar bytepositionen för sidintervallen.

count

number

Antal byte som ska hämtas.

prevSnapshot

string

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

options
PageBlobListPageRangesDiffOptions

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

Returer

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

En asyncIterableIterator som stöder sidindelning.

resize(number, PageBlobResizeOptions)

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

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

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

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.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Påbörjar en åtgärd för att starta en inkrementell kopia från en sidblobs ögonblicksbild till den här sidbloben. Ögonblicksbilden kopieras så att endast de differentiella ändringarna 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.

Se se https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

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.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Anger en sidblobs sekvensnummer.

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

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

Returer

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

Se https://docs.microsoft.com/rest/api/storageservices/put-page

function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

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 Ladda upp sidor för sidblob.

Returer

Promise<PageBlobUploadPagesResponse>

Svarsdata för åtgärden Sidblobuppladdningssidor.

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

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

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

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 ögonblicksbilden. Ange "" tar bort ögonblicksbilden och returnerar en klient till basbloben.

function withSnapshot(snapshot: string): PageBlobClient

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.

Ärvd 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 Avbruten blobkopiering från URL.

Returer

Promise<BlobAbortCopyFromURLResponse>

Ärvd frånBlobClient.abortCopyFromURL

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.

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 (standardvärdet är 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 kopiering:

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 Starta blobkopiering från URL.

Returer

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Ärvd frånBlobClient.beginCopyFromURL

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

Returer

Promise<BlobCreateSnapshotResponse>

Ärvd frånBlobClient.createSnapshot

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>

Ärvd frånBlobClient.delete

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>

Ärvd frånBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Ta bort principen för immutablility på bloben.

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

Parametrar

options
BlobDeleteImmutabilityPolicyOptions

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

Returer

Promise<BlobDeleteImmutabilityPolicyResponse>

Ärvd frånBlobClient.deleteImmutabilityPolicy

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

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>

Ärvd frånBlobClient.download

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 att ladda nedToFile fö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. Laddas ned till slutet när odefinierade skickas

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Returer

Promise<Buffer>

Ärvd frånBlobClient.downloadToBuffer

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 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 att ladda nedToFile.

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. Laddas ned till slutet när odefinierade skickas

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Returer

Promise<Buffer>

Ärvd frånBlobClient.downloadToBuffer

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): 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å odefinierad eftersom dess innehåll redan har lästs och skrivits till en lokal fil på den angivna sökvägen.

Ärvd frånBlobClient.downloadToFile

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

Parametrar

options
BlobExistsOptions

alternativ för åtgärden Finns.

Returer

Promise<boolean>

Ärvd frånBlobClient.exists

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.

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 resursen som representeras av den här klienten, följt av den genererade SAS-token.

Ärvd frånBlobClient.generateSasUrl

getAppendBlobClient()

Skapar ett AppendBlobClient-objekt.

function getAppendBlobClient(): AppendBlobClient

Returer

AppendBlobClient

Ärvd frånBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Hämta en BlobLeaseClient som hanterar lån för 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.

Ärvd frånBlobClient.getBlobLeaseClient

getBlockBlobClient()

Skapar ett BlockBlobClient-objekt.

function getBlockBlobClient(): BlockBlobClient

Returer

BlockBlobClient

Ärvd frånBlobClient.getBlockBlobClient

getPageBlobClient()

Skapar ett PageBlobClient-objekt.

function getPageBlobClient(): PageBlobClient

Returer

PageBlobClient

Ärvd frånBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

VARNING! Objektet metadata som returnerades 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 hjälp av includeMetadata alternativet , 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>

Ärvd frånBlobClient.getProperties

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Parametrar

options
BlobGetTagsOptions

Returer

Promise<BlobGetTagsResponse>

Ärvd frånBlobClient.getTags

setAccessTier(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. En blockblobnivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. 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 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>

Ärvd frånBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Anger systemegenskaper för bloben.

Om inget värde anges, eller inget värde för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-huvuden för blobar utan ett 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 för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-huvuden för blobar 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>

Ärvd frånBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Ange en oföränderlighetsprincip för bloben.

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

Parametrar

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Valfria alternativ för att ange en oföränderlighetsprincip för bloben.

Returer

Promise<BlobSetImmutabilityPolicyResponse>

Ärvd frånBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Ange bevarande av juridiska skäl 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>

Ärvd frånBlobClient.setLegalHold

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.

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>

Ärvd frånBlobClient.setMetadata

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

Ärvd frånBlobClient.setTags

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.

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 att kopiera från, signatur för delad åtkomst (SAS) kanske behövs för autentisering

options
BlobSyncCopyFromURLOptions

Returer

Promise<BlobCopyFromURLResponse>

Ärvd frånBlobClient.syncCopyFromURL

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.

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 att ta bort blobborttagning.

Returer

Promise<BlobUndeleteResponse>

Ärvd frånBlobClient.undelete

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å versionen av den här bloben.

Ärvd frånBlobClient.withVersion