Delen via

PageBlobClient class

  • Referentie
Pakket:
@azure/storage-blob

PageBlobClient definieert een set bewerkingen die van toepassing zijn op pagina-blobs.

Uitbreiding
BlobClient

Constructors

PageBlobClient(string, PipelineLike)

Hiermee maakt u een exemplaar van PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van PageBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blob. Gecodeerde URL-tekenreeks wordt NIET tweemaal escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam de naam bevat? of %, moet de blobnaam in de URL worden gecodeerd.
PageBlobClient(string, string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van PageBlobClient.

Eigenschappen

containerName

De naam van de opslagcontainer waarmee de blob is gekoppeld.
name

De naam van de blob.

Overgenomen eigenschappen

accountName
credential

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
url

Gecodeerde URL-tekenreekswaarde.

Methoden

clearPages(number, number, PageBlobClearPagesOptions)

Hiermee worden de opgegeven pagina's uit de pagina-blob vrijgemaakt.

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

Hiermee maakt u een pagina-blob van de opgegeven lengte. UploadPages aanroepen om gegevens te uploaden naar een pagina-blob.

Zie https://docs.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Hiermee maakt u een pagina-blob van de opgegeven lengte. UploadPages aanroepen om gegevens te uploaden naar een pagina-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd.

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

Retourneert de lijst met geldige paginabereiken voor een pagina-blob of momentopname van een pagina-blob.

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

Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob.

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

Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob voor beheerde schijven.

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

Hiermee wordt een asynchrone iterator geretourneerd om een lijst met paginabereiken voor een pagina-blob weer te geven.

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

.byPage() retourneert een asynchrone iterator om een lijst met paginabereiken voor een pagina-blob weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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();
}

Voorbeeld van 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}`);
  }
}

Voorbeeld van het gebruik van paging met een markering:

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)

Retourneert een asynchrone iterator voor een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob.

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

.byPage() retourneert een asynchrone iterator voor een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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();
}

Voorbeeld van 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}`);
  }
}

Voorbeeld van het gebruik van paging met een markering:

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)

Hiermee wijzigt u het formaat van de pagina-blob in de opgegeven grootte (dit moet een veelvoud van 512 zijn).

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

Hiermee start u een bewerking om een incrementele kopie te starten van de momentopname van een pagina-blob naar deze pagina-blob. De momentopname wordt gekopieerd zodat alleen de differentiële wijzigingen tussen de eerder gekopieerde momentopname naar het doel worden overgebracht. De gekopieerde momentopnamen zijn volledige kopieën van de oorspronkelijke momentopname en kunnen zoals gebruikelijk worden gelezen of gekopieerd.

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

Hiermee stelt u het volgnummer van een pagina-blob in.

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

Hiermee schrijft u 1 of meer pagina's naar de pagina-blob. De begin- en eind offsets moeten een veelvoud van 512 zijn.

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

De bewerking Pagina's uploaden schrijft een reeks pagina's naar een pagina-blob waar de inhoud wordt gelezen vanuit een URL.

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

Hiermee maakt u een nieuw PageBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen. Geef de momentopname op en retourneert een client naar de basis-blob.

Overgenomen methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Hiermee wordt een asynchrone kopieerblobbewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens achter. Versie 2012-02-12 en hoger.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopieert asynchroon een blob naar een bestemming in het opslagaccount. Deze methode retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid. U kunt een kopie ook annuleren voordat deze is voltooid door cancelOperation aan te roepen in de poller. Houd er rekening mee dat de callback onProgress niet wordt aangeroepen als de bewerking in de eerste aanvraag is voltooid en een voltooide kopie probeert te annuleren, resulteert in een fout.

In versie 2012-02-12 en hoger kan de bron voor een kopieer-blobbewerking een vastgelegde blob zijn in elk Azure-opslagaccount. Vanaf versie 2015-02-21 kan de bron voor een kopieer-blobbewerking een Azure-bestand zijn in elk Azure-opslagaccount. Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan de kopieer-blobbewerking toe vanuit een ander opslagaccount.

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

Voorbeeld van automatische polling:

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

Voorbeeld van handmatige polling:

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

Voorbeeld van voortgangsupdates:

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

Voorbeeld van een veranderend polling-interval (standaard 15 seconden):

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

Voorbeeld van het annuleren van kopiëren:

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)

Hiermee maakt u een alleen-lezen momentopname van een blob.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)

Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen ervan verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)

Markeert de opgegeven blob of momentopname voor verwijdering als deze bestaat. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen ervan verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Verwijder het immutablility-beleid op de blob.
download(number, number, BlobDownloadOptions)

Leest of downloadt een blob van het systeem, inclusief de metagegevens en eigenschappen. U kunt ook Get Blob aanroepen om een momentopname te lezen.

  • In Node.jsworden gegevens geretourneerd in een leesbare stream readableStreamBody
  • In browsers worden gegevens geretourneerd in een promise blobBody

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een Azure Blob parallel gedownload naar een buffer. Offset en aantal zijn optioneel, downloadt de hele blob als deze niet zijn opgegeven.

Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u downloadToFileoverwegen.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een Azure Blob parallel gedownload naar een buffer. Offset en aantal zijn optioneel, downloadt de hele blob als deze niet zijn opgegeven.

Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u downloadToFileoverwegen.
downloadToFile(string, number, number, BlobDownloadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee downloadt u een Azure Blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om de hele blob te downloaden.
exists(BlobExistsOptions)

Retourneert waar als de Azure-blobresource bestaat die wordt vertegenwoordigd door deze client; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaande blob kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
generateSasUrl(BlobGenerateSasUrlOptions)

Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)

De bewerking Accountgegevens ophalen retourneert de SKU-naam en het accounttype voor het opgegeven account. De bewerking Accountgegevens ophalen is beschikbaar in serviceversies vanaf versie 2018-03-28.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()

Hiermee maakt u een AppendBlobClient-object.
getBlobLeaseClient(string)

Haal een BlobLeaseClient- op waarmee leases op de blob worden beheerd.
getBlockBlobClient()

Hiermee maakt u een BlockBlobClient-object.
getPageBlobClient()

Hiermee maakt u een PageBlobClient-object.
getProperties(BlobGetPropertiesOptions)

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard HTTP-eigenschappen en systeemeigenschappen voor de blob. De inhoud van de blob wordt niet geretourneerd.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de methoden van ContainerClient die blobs vermelden met behulp van de optie includeMetadata, die hun oorspronkelijke behuizing behouden.
getTags(BlobGetTagsOptions)

Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
setAccessTier(string, BlobSetTierOptions)

Hiermee stelt u de laag in op een blob. De bewerking is toegestaan op een pagina-blob in een Premium Storage-account en op een blok-blob in een blobopslagaccount (alleen lokaal redundante opslag). De laag van een Premium-pagina-blob bepaalt de toegestane grootte, IOPS en bandbreedte van de blob. De laag van een blok-blob bepaalt dynamisch/statisch/archiefopslagtype. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Hiermee stelt u systeemeigenschappen in de blob in.

Als er geen waarde is opgegeven of er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist.

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

Beleid voor onveranderbaarheid instellen voor de blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)

Juridische bewaring instellen voor de blob.
setMetadata(Metadata, BlobSetMetadataOptions)

Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor de opgegeven blob in als een of meer naam-waardeparen.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de blob verwijderd.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

Hiermee stelt u tags in op de onderliggende blob. Een blob kan maximaal 10 tags bevatten. Tagsleutels moeten tussen 1 en 128 tekens zijn. Tagwaarden moeten tussen 0 en 256 tekens zijn. Geldige tagsleutel en waardetekens zijn kleine letters en hoofdletters, cijfers (0-9), spatie (' '), plus ('+'), min ('-'), punt ('.'), slash ('/'), dubbele punt (':'), is gelijk aan ('='), en onderstrepingsteken ('_').
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Met de synchrone kopieerbewerking van een URL wordt een blob of een internetresource gekopieerd naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als de kopie is voltooid.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)

Hiermee herstelt u de inhoud en metagegevens van voorlopig verwijderde blob en eventuele gekoppelde voorlopig verwijderde momentopnamen. Verwijderen van blob ongedaan maken wordt alleen ondersteund op versie 2017-07-29 of hoger.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)

Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef '' op, verwijdert de versionId en retourneert een client naar de basis-blob.

Constructordetails

PageBlobClient(string, PipelineLike)

Hiermee maakt u een exemplaar van PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parameters

url

string

Een URL-tekenreeks die verwijst naar azure Storage-pagina-blob, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString". Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blob. Gecodeerde URL-tekenreeks wordt NIET tweemaal escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam echter wel een naam bevat? of %, moet de blobnaam in de URL worden gecodeerd. Zoals een blob met de naam 'my?blob%', moet de URLhttps://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"zijn.

pipeline
PipelineLike

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

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

Hiermee maakt u een exemplaar van PageBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blob. Gecodeerde URL-tekenreeks wordt NIET tweemaal escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam de naam bevat? of %, moet de blobnaam in de URL worden gecodeerd.

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

Parameters

url

string

Een clienttekenreeks die verwijst naar azure Storage-pagina-blob, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options
StoragePipelineOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

PageBlobClient(string, string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van PageBlobClient.

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

Parameters

connectionString

string

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - 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

Containernaam.

blobName

string

Blobnaam.

options
StoragePipelineOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

containerName

De naam van de opslagcontainer waarmee de blob is gekoppeld.

string containerName

Waarde van eigenschap

string

name

De naam van de blob.

string name

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

overgenomen vanBlobClient.accountName

credential

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

overgenomen vanBlobClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen vanBlobClient.url

Methodedetails

clearPages(number, number, PageBlobClearPagesOptions)

Hiermee worden de opgegeven pagina's uit de pagina-blob vrijgemaakt.

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

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

Parameters

offset

number

Begin van de bytepositie van de pagina's om te wissen.

count

number

Aantal bytes dat moet worden gewist.

options
PageBlobClearPagesOptions

Opties voor de bewerking Pagina-blob Pagina wissen.

Retouren

Promise<PageBlobClearPagesResponse>

Antwoordgegevens voor de bewerking Pagina-blob Pagina wissen.

create(number, PageBlobCreateOptions)

Hiermee maakt u een pagina-blob van de opgegeven lengte. UploadPages aanroepen om gegevens te uploaden naar een pagina-blob.

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

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

Parameters

size

number

grootte van de pagina-blob.

options
PageBlobCreateOptions

Opties voor de bewerking Pagina-blob maken.

Retouren

Promise<PageBlobCreateResponse>

Antwoordgegevens voor de bewerking Pagina-blob maken.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Hiermee maakt u een pagina-blob van de opgegeven lengte. UploadPages aanroepen om gegevens te uploaden naar een pagina-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd.

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

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

Parameters

size

number

grootte van de pagina-blob.

options
PageBlobCreateIfNotExistsOptions

Retouren

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Retourneert de lijst met geldige paginabereiken voor een pagina-blob of momentopname van een pagina-blob.

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

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

Parameters

offset

number

Begin van de bytepositie van de paginabereiken.

count

number

Aantal te verkrijgen bytes.

options
PageBlobGetPageRangesOptions

Opties voor de bewerking Bereiken van paginablob ophalen.

Retouren

Promise<PageBlobGetPageRangesResponse>

Antwoordgegevens voor de bewerking Bereiken voor paginablob ophalen.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob.

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

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

Parameters

offset

number

De bytepositie van de pagina-blob starten

count

number

Aantal bytes om bereiken te krijgen diff.

prevSnapshot

string

Tijdstempel van momentopname om het verschil op te halen.

options
PageBlobGetPageRangesDiffOptions

Opties voor de bewerking Pagina-blob Paginabereiken ophalen.

Retouren

Promise<PageBlobGetPageRangesDiffResponse>

Antwoordgegevens voor de bewerking Pagina-blob paginabereik ophalen.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob voor beheerde schijven.

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

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

Parameters

offset

number

De bytepositie van de pagina-blob starten

count

number

Aantal bytes om bereiken te krijgen diff.

prevSnapshotUrl

string

URL van momentopname om het verschil op te halen.

options
PageBlobGetPageRangesDiffOptions

Opties voor de bewerking Pagina-blob Paginabereiken ophalen.

Retouren

Promise<PageBlobGetPageRangesDiffResponse>

Antwoordgegevens voor de bewerking Pagina-blob paginabereik ophalen.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Hiermee wordt een asynchrone iterator geretourneerd om een lijst met paginabereiken voor een pagina-blob weer te geven.

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

.byPage() retourneert een asynchrone iterator om een lijst met paginabereiken voor een pagina-blob weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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();
}

Voorbeeld van 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}`);
  }
}

Voorbeeld van het gebruik van paging met een markering:

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>

Parameters

offset

number

Begin van de bytepositie van de paginabereiken.

count

number

Aantal te verkrijgen bytes.

options
PageBlobListPageRangesOptions

Opties voor de bewerking Bereiken van paginablob ophalen.

Retouren

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Een asyncIterableIterator die paging ondersteunt.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Retourneert een asynchrone iterator voor een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob.

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

.byPage() retourneert een asynchrone iterator voor een lijst met paginabereiken die verschillen tussen een opgegeven momentopname en deze pagina-blob.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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();
}

Voorbeeld van 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}`);
  }
}

Voorbeeld van het gebruik van paging met een markering:

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>

Parameters

offset

number

Begin van de bytepositie van de paginabereiken.

count

number

Aantal te verkrijgen bytes.

prevSnapshot

string

Tijdstempel van momentopname om het verschil op te halen.

options
PageBlobListPageRangesDiffOptions

Opties voor de bewerking Bereiken van paginablob ophalen.

Retouren

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Een asyncIterableIterator die paging ondersteunt.

resize(number, PageBlobResizeOptions)

Hiermee wijzigt u het formaat van de pagina-blob in de opgegeven grootte (dit moet een veelvoud van 512 zijn).

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

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

Parameters

size

number

Doelgrootte

options
PageBlobResizeOptions

Opties voor de bewerking Pagina-blobgrootte wijzigen.

Retouren

Promise<PageBlobResizeResponse>

Antwoordgegevens voor de bewerking Pagina-blobgrootte wijzigen.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Hiermee start u een bewerking om een incrementele kopie te starten van de momentopname van een pagina-blob naar deze pagina-blob. De momentopname wordt gekopieerd zodat alleen de differentiële wijzigingen tussen de eerder gekopieerde momentopname naar het doel worden overgebracht. De gekopieerde momentopnamen zijn volledige kopieën van de oorspronkelijke momentopname en kunnen zoals gebruikelijk worden gelezen of gekopieerd.

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

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

Parameters

copySource

string

Hiermee geeft u de naam van de momentopname van de bronpaginablob op. Bijvoorbeeld https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

Opties voor de incrementele bewerking pagina-blob kopiëren.

Retouren

Promise<PageBlobCopyIncrementalResponse>

Antwoordgegevens voor de incrementele bewerking pagina-blob kopiëren.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Hiermee stelt u het volgnummer van een pagina-blob in.

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

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

Parameters

sequenceNumberAction
SequenceNumberActionType

Geeft aan hoe de service het volgnummer van de blob moet wijzigen.

sequenceNumber

number

Vereist als sequenceNumberAction max of update is

options
PageBlobUpdateSequenceNumberOptions

Opties voor de bewerking Pagina-blob-updatereeksnummer.

Retouren

Promise<PageBlobUpdateSequenceNumberResponse>

Antwoordgegevens voor de bewerking Pagina-blob-updatereeksnummer.

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

Hiermee schrijft u 1 of meer pagina's naar de pagina-blob. De begin- en eind offsets moeten een veelvoud van 512 zijn.

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

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

Parameters

body
HttpRequestBody

Te uploaden gegevens

offset

number

Verschuiving van doelpagina-blob

count

number

Inhoudslengte van de hoofdtekst, ook het aantal te uploaden bytes

options
PageBlobUploadPagesOptions

Opties voor de bewerking Pagina-blob-uploadpagina's.

Retouren

Promise<PageBlobUploadPagesResponse>

Antwoordgegevens voor de bewerking Pagina-blob uploadpagina's.

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

De bewerking Pagina's uploaden schrijft een reeks pagina's naar een pagina-blob waar de inhoud wordt gelezen vanuit een URL.

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

Parameters

sourceURL

string

Geef een URL op naar de kopieerbron, sas (Shared Access Signature) die mogelijk nodig is voor verificatie

sourceOffset

number

De bronverschil waaruit moet worden gekopieerd. Geef 0 door om te kopiëren vanaf het begin van de bronpagina-blob

destOffset

number

Verschuiving van doelpagina-blob

count

number

Aantal bytes dat moet worden geüpload vanuit de blob van de bronpagina

options
PageBlobUploadPagesFromURLOptions

Retouren

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Hiermee maakt u een nieuw PageBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen. Geef de momentopname op en retourneert een client naar de basis-blob.

function withSnapshot(snapshot: string): PageBlobClient

Parameters

snapshot

string

De tijdstempel van de momentopname.

Retouren

PageBlobClient

Een nieuw PageBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen.

Details overgenomen methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Hiermee wordt een asynchrone kopieerblobbewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens achter. Versie 2012-02-12 en hoger.

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

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

Parameters

copyId

string

Id van de bewerking Copy From URL.

options
BlobAbortCopyFromURLOptions

Optionele opties voor het afbreken van de blob van de URL-bewerking.

Retouren

Promise<BlobAbortCopyFromURLResponse>

overgenomen vanBlobClient.abortCopyFromURL-

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopieert asynchroon een blob naar een bestemming in het opslagaccount. Deze methode retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid. U kunt een kopie ook annuleren voordat deze is voltooid door cancelOperation aan te roepen in de poller. Houd er rekening mee dat de callback onProgress niet wordt aangeroepen als de bewerking in de eerste aanvraag is voltooid en een voltooide kopie probeert te annuleren, resulteert in een fout.

In versie 2012-02-12 en hoger kan de bron voor een kopieer-blobbewerking een vastgelegde blob zijn in elk Azure-opslagaccount. Vanaf versie 2015-02-21 kan de bron voor een kopieer-blobbewerking een Azure-bestand zijn in elk Azure-opslagaccount. Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan de kopieer-blobbewerking toe vanuit een ander opslagaccount.

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

Voorbeeld van automatische polling:

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

Voorbeeld van handmatige polling:

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

Voorbeeld van voortgangsupdates:

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

Voorbeeld van een veranderend polling-interval (standaard 15 seconden):

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

Voorbeeld van het annuleren van kopiëren:

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

Parameters

copySource

string

url naar de azure-bron-blob/het bronbestand.

options
BlobBeginCopyFromURLOptions

Optionele opties voor het kopiëren van de blob starten vanaf URL-bewerking.

Retouren

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

overgenomen vanBlobClient.beginCopyFromURL-

createSnapshot(BlobCreateSnapshotOptions)

Hiermee maakt u een alleen-lezen momentopname van een blob.

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

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

Parameters

options
BlobCreateSnapshotOptions

Optionele opties voor de bewerking Momentopname maken van blob.

Retouren

Promise<BlobCreateSnapshotResponse>

overgenomen vanBlobClient.createSnapshot-

delete(BlobDeleteOptions)

Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen ervan verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

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

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

Parameters

options
BlobDeleteOptions

Optionele opties voor de bewerking Blob Verwijderen.

Retouren

Promise<BlobDeleteResponse>

overgenomen vanBlobClient.delete

deleteIfExists(BlobDeleteOptions)

Markeert de opgegeven blob of momentopname voor verwijdering als deze bestaat. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen ervan verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

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

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

Parameters

options
BlobDeleteOptions

Optionele opties voor de bewerking Blob Verwijderen.

Retouren

Promise<BlobDeleteIfExistsResponse>

overgenomen vanBlobClient.deleteIfExists-

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Verwijder het immutablility-beleid op de blob.

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

Parameters

options
BlobDeleteImmutabilityPolicyOptions

Optionele opties voor het verwijderen van beleid voor onveranderbaarheid in de blob.

Retouren

Promise<BlobDeleteImmutabilityPolicyResponse>

overgenomen vanBlobClient.deleteImmutabilityPolicy-

download(number, number, BlobDownloadOptions)

Leest of downloadt een blob van het systeem, inclusief de metagegevens en eigenschappen. U kunt ook Get Blob aanroepen om een momentopname te lezen.

  • In Node.jsworden gegevens geretourneerd in een leesbare stream readableStreamBody
  • In browsers worden gegevens geretourneerd in een promise blobBody

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

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

Parameters

offset

number

Vanaf welke positie van de blob moet worden gedownload, groter dan of gelijk aan 0

count

number

Hoeveel gegevens moeten worden gedownload, groter dan 0. Wordt naar het einde gedownload wanneer deze niet is gedefinieerd

options
BlobDownloadOptions

Optionele opties voor de bewerking Blob downloaden.

Voorbeeldgebruik (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);
});
}

Voorbeeldgebruik (browser):

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

Retouren

Promise<BlobDownloadResponseParsed>

overgenomen vanBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een Azure Blob parallel gedownload naar een buffer. Offset en aantal zijn optioneel, downloadt de hele blob als deze niet zijn opgegeven.

Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u downloadToFileoverwegen.

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

Parameters

buffer

Buffer

Buffer die moet worden gevuld, moet een lengte hebben die groter is dan het aantal

offset

number

Vanaf welke positie van de blok-blob moet worden gedownload (in bytes)

count

number

Hoeveel gegevens (in bytes) moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retouren

Promise<Buffer>

overgenomen vanBlobClient.downloadToBuffer-

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een Azure Blob parallel gedownload naar een buffer. Offset en aantal zijn optioneel, downloadt de hele blob als deze niet zijn opgegeven.

Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u downloadToFileoverwegen.

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

Parameters

offset

number

Vanaf welke positie van de blok-blob moet worden gedownload (in bytes)

count

number

Hoeveel gegevens (in bytes) moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retouren

Promise<Buffer>

overgenomen vanBlobClient.downloadToBuffer-

downloadToFile(string, number, number, BlobDownloadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee downloadt u een Azure Blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om de hele blob te downloaden.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parameters

filePath

string

offset

number

Vanaf welke positie van de blok-blob moet worden gedownload.

count

number

Hoeveel gegevens moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven.

options
BlobDownloadOptions

Opties voor blobdownloadopties.

Retouren

Promise<BlobDownloadResponseParsed>

De antwoordgegevens voor de blob-downloadbewerking, maar met readableStreamBody is ingesteld op niet-gedefinieerd omdat de inhoud al is gelezen en naar een lokaal bestand is geschreven op het opgegeven pad.

overgenomen vanBlobClient.downloadToFile-

exists(BlobExistsOptions)

Retourneert waar als de Azure-blobresource bestaat die wordt vertegenwoordigd door deze client; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaande blob kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

function exists(options?: BlobExistsOptions): Promise<boolean>

Parameters

options
BlobExistsOptions

opties voor bestaat bewerking.

Retouren

Promise<boolean>

overgenomen vanBlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

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

Parameters

options
BlobGenerateSasUrlOptions

Optionele parameters.

Retouren

Promise<string>

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

overgenomen vanBlobClient.generateSasUrl-

getAccountInfo(BlobGetAccountInfoOptions)

De bewerking Accountgegevens ophalen retourneert de SKU-naam en het accounttype voor het opgegeven account. De bewerking Accountgegevens ophalen is beschikbaar in serviceversies vanaf versie 2018-03-28.

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

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

Parameters

options
BlobGetAccountInfoOptions

Opties voor de bewerking Accountgegevens ophalen van service.

Retouren

Promise<BlobGetAccountInfoResponse>

Antwoordgegevens voor de bewerking Accountgegevens ophalen van service.

overgenomen vanBlobClient.getAccountInfo

getAppendBlobClient()

Hiermee maakt u een AppendBlobClient-object.

function getAppendBlobClient(): AppendBlobClient

Retouren

AppendBlobClient

overgenomen vanBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Haal een BlobLeaseClient- op waarmee leases op de blob worden beheerd.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parameters

proposeLeaseId

string

Oorspronkelijke voorgestelde lease-id.

Retouren

BlobLeaseClient

Een nieuw BlobLeaseClient-object voor het beheren van leases op de blob.

overgenomen vanBlobClient.getBlobLeaseClient

getBlockBlobClient()

Hiermee maakt u een BlockBlobClient-object.

function getBlockBlobClient(): BlockBlobClient

Retouren

BlockBlobClient

overgenomen vanBlobClient.getBlockBlobClient

getPageBlobClient()

Hiermee maakt u een PageBlobClient-object.

function getPageBlobClient(): PageBlobClient

Retouren

PageBlobClient

overgenomen vanBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard HTTP-eigenschappen en systeemeigenschappen voor de blob. De inhoud van de blob wordt niet geretourneerd.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de methoden van ContainerClient die blobs vermelden met behulp van de optie includeMetadata, die hun oorspronkelijke behuizing behouden.

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

Parameters

options
BlobGetPropertiesOptions

Optionele opties voor de bewerking Eigenschappen ophalen.

Retouren

Promise<BlobGetPropertiesResponse>

overgenomen vanBlobClient.getProperties-

getTags(BlobGetTagsOptions)

Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.

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

Parameters

options
BlobGetTagsOptions

Retouren

Promise<BlobGetTagsResponse>

overgenomen vanBlobClient.getTags-

setAccessTier(string, BlobSetTierOptions)

Hiermee stelt u de laag in op een blob. De bewerking is toegestaan op een pagina-blob in een Premium Storage-account en op een blok-blob in een blobopslagaccount (alleen lokaal redundante opslag). De laag van een Premium-pagina-blob bepaalt de toegestane grootte, IOPS en bandbreedte van de blob. De laag van een blok-blob bepaalt dynamisch/statisch/archiefopslagtype. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.

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

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

Parameters

tier

string

De laag die moet worden ingesteld op de blob. Geldige waarden zijn Dynamisch, Statisch of Archief.

options
BlobSetTierOptions

Optionele opties voor de bewerking Blob Set Tier.

Retouren

Promise<BlobSetTierResponse>

overgenomen vanBlobClient.setAccessTier-

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Hiermee stelt u systeemeigenschappen in de blob in.

Als er geen waarde is opgegeven of er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist.

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

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

Parameters

blobHTTPHeaders
BlobHTTPHeaders

Als er geen waarde is opgegeven of er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist. Een veelgebruikte header die moet worden ingesteld, is blobContentType de browser in staat te stellen functionaliteit te bieden op basis van het bestandstype.

options
BlobSetHTTPHeadersOptions

Optionele opties voor de bewerking HTTP-headers instellen in blob.

Retouren

Promise<BlobSetHTTPHeadersResponse>

overgenomen vanBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Beleid voor onveranderbaarheid instellen voor de blob.

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

Parameters

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Optionele opties voor het instellen van beleid voor onveranderbaarheid op de blob.

Retouren

Promise<BlobSetImmutabilityPolicyResponse>

overgenomen vanBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Juridische bewaring instellen voor de blob.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parameters

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

Optionele opties voor het instellen van juridische bewaring op de blob.

Retouren

Promise<BlobSetLegalHoldResponse>

overgenomen vanBlobClient.setLegalHold-

setMetadata(Metadata, BlobSetMetadataOptions)

Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor de opgegeven blob in als een of meer naam-waardeparen.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de blob verwijderd.

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

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

Parameters

metadata
Metadata

Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.

options
BlobSetMetadataOptions

Optionele opties voor het instellen van metagegevensbewerking.

Retouren

Promise<BlobSetMetadataResponse>

overgenomen vanBlobClient.setMetadata-

setTags(Tags, BlobSetTagsOptions)

Hiermee stelt u tags in op de onderliggende blob. Een blob kan maximaal 10 tags bevatten. Tagsleutels moeten tussen 1 en 128 tekens zijn. Tagwaarden moeten tussen 0 en 256 tekens zijn. Geldige tagsleutel en waardetekens zijn kleine letters en hoofdletters, cijfers (0-9), spatie (' '), plus ('+'), min ('-'), punt ('.'), slash ('/'), dubbele punt (':'), is gelijk aan ('='), en onderstrepingsteken ('_').

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parameters

tags
Tags
options
BlobSetTagsOptions

Retouren

Promise<BlobSetTagsResponse>

overgenomen vanBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Met de synchrone kopieerbewerking van een URL wordt een blob of een internetresource gekopieerd naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als de kopie is voltooid.

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

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

Parameters

copySource

string

De bron-URL waaruit moet worden gekopieerd, sas (Shared Access Signature) is mogelijk nodig voor verificatie

options
BlobSyncCopyFromURLOptions

Retouren

Promise<BlobCopyFromURLResponse>

overgenomen vanBlobClient.syncCopyFromURL-

undelete(BlobUndeleteOptions)

Hiermee herstelt u de inhoud en metagegevens van voorlopig verwijderde blob en eventuele gekoppelde voorlopig verwijderde momentopnamen. Verwijderen van blob ongedaan maken wordt alleen ondersteund op versie 2017-07-29 of hoger.

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

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

Parameters

options
BlobUndeleteOptions

Optionele opties voor de bewerking Blob Ongedaan maken.

Retouren

Promise<BlobUndeleteResponse>

overgenomen vanBlobClient.undelete

withVersion(string)

Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef '' op, verwijdert de versionId en retourneert een client naar de basis-blob.

function withVersion(versionId: string): BlobClient

Parameters

versionId

string

De versionId.

Retouren

BlobClient

Een nieuw BlobClient-object dat verwijst naar de versie van deze blob.

overgenomen vanBlobClient.withVersion-