PageBlobClient class

Referentie

Pakket:: @azure/storage-blob

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

Extends: 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 ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam bevat? of %, moet de blobnaam zijn gecodeerd in de URL.
PageBlobClient(string, string, string, StoragePipelineOptions)	Hiermee maakt u een exemplaar van PageBlobClient.

Eigenschappen

accountName
containerName	De naam van de opslagcontainer waarmee de blob is gekoppeld.
credential	Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit 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.
name	De naam van de blob.
url	Gecodeerde URL-tekenreekswaarde.

Methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Hiermee wordt een in behandeling zijnde asynchrone copy blob-bewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens over. Versie 2012-02-12 en hoger.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Een blob wordt asynchroon gekopieerd naar een doel in het opslagaccount. Deze methode retourneert een langlopende bewerking poller waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid. U kunt een kopie ook annuleren voordat deze is voltooid door aan te roepen `cancelOperation` op de poller. Houd er rekening mee dat de callback onProgress niet wordt aangeroepen als de bewerking in de eerste aanvraag is voltooid. Als u een voltooide kopie probeert te annuleren, wordt er een fout gegenereerd. In versie 2012-02-12 en hoger kan de bron voor een Blob-kopieerbewerking een vastgelegde blob in elk Azure-opslagaccount zijn. Vanaf versie 2015-02-21 kan de bron voor een blob-kopieerbewerking een Azure-bestand in elk Azure-opslagaccount zijn. Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan toe dat de blob kopiërenbewerking vanuit een ander opslagaccount kan worden gekopieerd.
clearPages(number, number, PageBlobClearPagesOptions)	Hiermee worden de opgegeven pagina's van de pagina-blob vrijgemaakt.
create(number, PageBlobCreateOptions)	Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd.
createSnapshot(BlobCreateSnapshotOptions)	Hiermee maakt u een alleen-lezen momentopname van een blob.
delete(BlobDeleteOptions)	Hiermee markeert u 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 verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.
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 verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Verwijder het beleid immutablility op de blob.
download(number, number, BlobDownloadOptions)	Leest of downloadt een blob uit het systeem, inclusief de metagegevens en eigenschappen. U kunt ook Blob ophalen aanroepen om een momentopname te lezen. In Node.js worden gegevens geretourneerd in een leesbare stream die kan worden gelezenStreamBody In browsers worden gegevens geretourneerd in een promise-blobBody
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel aan een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet zijn opgegeven. Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte 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 overwegen <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel aan een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet zijn opgegeven. Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte 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 overwegen <xref:downloadToFile>.
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 true als de Azure-blobresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig omdat een bestaande blob mogelijk wordt 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 gemaakt met een gedeelde sleutelreferentie. Genereert een SAS-URI (Shared Access Signature) voor Blob Service op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.
getAppendBlobClient()	Hiermee maakt u een AppendBlobClient-object.
getBlobLeaseClient(string)	Haal een <xref:BlobLeaseClient> op die leases op de blob beheert.
getBlockBlobClient()	Hiermee maakt u een BlockBlobClient-object.
getPageBlobClient()	Hiermee maakt u een PageBlobClient-object.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Retourneert de lijst met geldige paginabereiken voor een pagina-blob of momentopname van een pagina-blob.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Hiermee haalt u de verzameling paginabereiken op die verschillen tussen een opgegeven momentopname en deze pagina-blob.
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.
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.
getTags(BlobGetTagsOptions)	Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
resize(number, PageBlobResizeOptions)	Hiermee wijzigt u de grootte van de pagina-blob in de opgegeven grootte (dit moet een veelvoud van 512 zijn).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Hiermee stelt u de laag voor een blob in. De bewerking is toegestaan op een pagina-blob in een Premium-opslagaccount en op een blok-blob in een blob-opslagaccount (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 het opslagtype Dynamisch/Statisch/Archief. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Hiermee stelt u systeemeigenschappen voor de blob in. Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Stel immutablility-beleid in op de blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Stel juridische bewaring in 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 blobmetagegevens verwijderd.
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 en hoofdletters, cijfers (0-9), spatie (' ), plusteken ('+'), minteken ('-'), punt ('.'), schuine streep ('/'), dubbele punt (':'), is gelijk aan ('='), en onderstrepingsteken ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Hiermee start u een bewerking om een incrementele kopie van de momentopname van een pagina-blob naar deze pagina-blob te starten. De momentopname wordt zodanig gekopieerd dat alleen de differentiële wijzigingen tussen de eerder gekopieerde momentopname worden overgebracht naar de bestemming. De gekopieerde momentopnamen zijn volledige kopieën van de oorspronkelijke momentopname en kunnen zoals gewoonlijk worden gelezen of gekopieerd.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Met de synchrone bewerking Copy From URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid.
undelete(BlobUndeleteOptions)	Herstelt de inhoud en metagegevens van voorlopig verwijderde blob en eventuele bijbehorende voorlopig verwijderde momentopnamen. Verwijderen van blob ongedaan maken wordt alleen ondersteund op versie 29-07-2017 of hoger.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Hiermee stelt u het volgnummer van een pagina-blob in.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Hiermee worden 1 of meer pagina's naar de pagina-blob geschreven. De begin- en eindverschuivingen moeten een veelvoud van 512 zijn.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Met de bewerking Pagina's uploaden wordt een reeks pagina's naar een pagina-blob geschreven waar de inhoud wordt gelezen vanuit een URL.
withSnapshot(string)	Hiermee maakt u een nieuw PageBlobClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel van de momentopname. Als u opgeeft, wordt de momentopname verwijderd en wordt een client geretourneerd naar de basis-blob.
withVersion(string)	Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Als u opgeeft, wordt de versionId verwijderd en wordt een client geretourneerd 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 clienttekenreeks die verwijst naar de blob van de Azure Storage-pagina, 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".

pipeline: PipelineLike

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

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 ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam bevat? of %, moet de blobnaam zijn gecodeerd in de URL.

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

Parameters

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

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

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kunnen alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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

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

Eigenschapdetails

accountName

accountName: string

Waarde van eigenschap

string

containerName

De naam van de opslagcontainer waarmee de blob is gekoppeld.

string containerName

Waarde van eigenschap

string

credential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit 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

name

De naam van de blob.

string name

Waarde van eigenschap

string

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Methodedetails

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Hiermee wordt een in behandeling zijnde asynchrone copy blob-bewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens over. Versie 2012-02-12 en hoger.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Parameters

copyId: string

Id van de bewerking Kopiëren van URL.

options: BlobAbortCopyFromURLOptions

Optionele opties voor de bewerking Blob Copy From URL afbreken.

Retouren

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Een blob wordt asynchroon gekopieerd naar een doel in het opslagaccount. Deze methode retourneert een langlopende bewerking poller waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid. U kunt een kopie ook annuleren voordat deze is voltooid door aan te roepen cancelOperation op de poller. Houd er rekening mee dat de callback onProgress niet wordt aangeroepen als de bewerking in de eerste aanvraag is voltooid. Als u een voltooide kopie probeert te annuleren, wordt er een fout gegenereerd. In versie 2012-02-12 en hoger kan de bron voor een Blob-kopieerbewerking een vastgelegde blob in elk Azure-opslagaccount zijn. Vanaf versie 2015-02-21 kan de bron voor een blob-kopieerbewerking een Azure-bestand in elk Azure-opslagaccount zijn. Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan toe dat de blob kopiërenbewerking vanuit een ander opslagaccount kan worden gekopieerd.

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

Parameters

copySource: string

url naar de bron-Azure-blob/-bestand.

options: BlobBeginCopyFromURLOptions

Optionele opties voor de bewerking Blob Kopiëren vanaf URL starten.

Retouren

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

clearPages(number, number, PageBlobClearPagesOptions)

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

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

Parameters

offset: number

De bytepositie van de pagina's die moeten worden gewist, wordt gestart.

count: number

Aantal bytes dat moet worden gewist.

options: PageBlobClearPagesOptions

Opties voor de bewerking Pagina-blob pagina's wissen.

Retouren

Promise<PageBlobClearPagesResponse>

Antwoordgegevens voor de bewerking Pagina-blob pagina's wissen.

create(number, PageBlobCreateOptions)

Hiermee maakt u een pagina-blob met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob.

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

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 met de opgegeven lengte. Roep uploadPages aan om gegevensgegevens te uploaden naar een pagina-blob. Als de blob met dezelfde naam al bestaat, blijft de inhoud van de bestaande blob ongewijzigd.

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

Parameters

size: number

grootte van de pagina-blob.

options: PageBlobCreateIfNotExistsOptions

Retouren

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameters

options: BlobCreateSnapshotOptions

Optionele opties voor de bewerking Blob Momentopname maken.

Retouren

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Hiermee markeert u 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 verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

function delete(options?: BlobDeleteOptions)

Parameters

options: BlobDeleteOptions

Optionele opties voor de bewerking Blob verwijderen.

Retouren

Promise<BlobDeleteResponse>

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 verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen.

function deleteIfExists(options?: BlobDeleteOptions)

Parameters

options: BlobDeleteOptions

Optionele opties voor de bewerking Blob verwijderen.

Retouren

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Verwijder het beleid immutablility op de blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parameters

options: BlobDeleteImmutabilityPolicyOptions

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

Retouren

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

In Node.js worden gegevens geretourneerd in een leesbare stream die kan worden gelezenStreamBody
In browsers worden gegevens geretourneerd in een promise-blobBody

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

Parameters

offset: number

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

count: number

Hoeveel gegevens er moeten worden gedownload, groter dan 0. Wordt gedownload tot het einde wanneer dit niet is gedefinieerd

options: BlobDownloadOptions

Optionele opties voor de blob-downloadbewerking.

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

Voorbeeld van gebruik (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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel aan een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet zijn opgegeven.

Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte 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 overwegen <xref:downloadToFile>.

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

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 gedownload tot het einde wanneer undefined wordt doorgegeven

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retouren

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-blob parallel aan een buffer. Offset en count zijn optioneel. De volledige blob wordt gedownload als deze niet zijn opgegeven.

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

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 tot het einde gedownload bij het doorgeven van niet-gedefinieerde

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retouren

Promise<Buffer>

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)

Parameters

filePath: string

offset: number

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

count: number

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

options: BlobDownloadOptions

Opties voor blobdownloadopties.

Retouren

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

Retourneert true als de Azure-blobresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig omdat een bestaande blob mogelijk wordt 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)

Parameters

options: BlobExistsOptions

opties voor de bewerking Exists.

Retouren

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Alleen beschikbaar voor BlobClient die is gemaakt met een gedeelde sleutelreferentie. Genereert een SAS-URI (Shared Access Signature) voor Blob Service op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parameters

options: BlobGenerateSasUrlOptions

Optionele parameters.

Retouren

Promise<string>

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

getAppendBlobClient()

Hiermee maakt u een AppendBlobClient-object.

function getAppendBlobClient()

Retouren

AppendBlobClient

getBlobLeaseClient(string)

Haal een <xref:BlobLeaseClient> op die leases op de blob beheert.

function getBlobLeaseClient(proposeLeaseId?: string)

Parameters

proposeLeaseId: string

Initiële voorgestelde lease-id.

Retouren

BlobLeaseClient

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

getBlockBlobClient()

Hiermee maakt u een BlockBlobClient-object.

function getBlockBlobClient()

Retouren

BlockBlobClient

getPageBlobClient()

Hiermee maakt u een PageBlobClient-object.

function getPageBlobClient()

Retouren

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

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

Parameters

offset: number

De bytepositie van de paginabereiken starten.

count: number

Aantal op te halen bytes.

options: PageBlobGetPageRangesOptions

Opties voor de bewerking Bereiken voor pagina-blob ophalen.

Retouren

Promise<PageBlobGetPageRangesResponse>

Antwoordgegevens voor de bewerking Bereiken voor pagina-blob ophalen.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

Parameters

offset: number

Bytepositie van de pagina-blob starten

count: number

Aantal bytes om bereiken op te halen, 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 Page Blob Get Page Range Diff.

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.

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

Parameters

offset: number

Bytepositie van de pagina-blob starten

count: number

Aantal bytes om bereiken op te halen, 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 Page Blob Get Page Range Diff.

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.

function getProperties(options?: BlobGetPropertiesOptions)

Parameters

options: BlobGetPropertiesOptions

Optionele opties voor de bewerking Eigenschappen ophalen.

Retouren

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Parameters

options: BlobGetTagsOptions

Retouren

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

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

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

Parameters

size: number

Doelgrootte

options: PageBlobResizeOptions

Opties voor de bewerking Formaat van paginablob wijzigen.

Retouren

Promise<PageBlobResizeResponse>

Antwoordgegevens voor de bewerking Formaat van paginablob wijzigen.

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Hiermee stelt u de laag voor een blob in. De bewerking is toegestaan op een pagina-blob in een Premium-opslagaccount en op een blok-blob in een blob-opslagaccount (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 het opslagtype Dynamisch/Statisch/Archief. Met deze bewerking wordt de ETag van de blob niet bijgewerkt.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Parameters

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

Optionele opties voor de bewerking Blob-setlaag.

Retouren

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Hiermee stelt u systeemeigenschappen voor de blob in. Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist.

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

Parameters

blobHTTPHeaders: BlobHTTPHeaders

Als er geen waarde is opgegeven of als 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 het inschakelen van de browser om functionaliteit te bieden op basis van het bestandstype.

options: BlobSetHTTPHeadersOptions

Optionele opties voor de bewerking HTTP-headers blob instellen.

Retouren

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Stel immutablility-beleid in op de blob.

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

Parameters

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Retouren

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Stel juridische bewaring in voor de blob.

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

Parameters

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Retouren

Promise<BlobSetLegalHoldResponse>

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 blobmetagegevens verwijderd.

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

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 de bewerking Metagegevens instellen.

Retouren

Promise<BlobSetMetadataResponse>

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 en hoofdletters, cijfers (0-9), spatie (' ), plusteken ('+'), minteken ('-'), punt ('.'), schuine streep ('/'), dubbele punt (':'), is gelijk aan ('='), en onderstrepingsteken ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Parameters

tags: Tags

options: BlobSetTagsOptions

Retouren

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

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

Parameters

copySource: string

Hiermee geeft u de naam van de blobmomentopname van de bronpagina 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-blobkopie.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Met de synchrone bewerking Copy From URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

Parameters

copySource: string

De bron-URL waaruit u wilt kopiëren, Shared Access Signature (SAS) is mogelijk nodig voor verificatie

options: BlobSyncCopyFromURLOptions

Retouren

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

Parameters

options: BlobUndeleteOptions

Optionele opties voor de bewerking Blob ongedaan maken.

Retouren

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

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

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 Reeksnummer pagina-blob bijwerken.

Retouren

Promise<PageBlobUpdateSequenceNumberResponse>

Antwoordgegevens voor de bewerking Reeksnummer pagina-blob bijwerken.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Hiermee worden 1 of meer pagina's naar de pagina-blob geschreven. De begin- en eindverschuivingen moeten een veelvoud van 512 zijn.

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

Parameters

body: HttpRequestBody

Te uploaden gegevens

offset: number

Verschuiving van doelpagina-blob

count: number

Inhoudslengte van de hoofdtekst, ook aantal bytes dat moet worden geüpload

options: PageBlobUploadPagesOptions

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

Retouren

Promise<PageBlobUploadPagesResponse>

Antwoordgegevens voor de bewerking Pagina's uploaden in blob.

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

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

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

Parameters

sourceURL: string

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

sourceOffset: number

De bronverschuiving waaruit u wilt kopiëren. 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 vanaf 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 van de momentopname. Als u opgeeft, wordt de momentopname verwijderd en wordt een client geretourneerd naar de basis-blob.

function withSnapshot(snapshot: string)

Parameters

snapshot: string

De tijdstempel van de momentopname.

Retouren

PageBlobClient

Een nieuw PageBlobClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname.

withVersion(string)

Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Als u opgeeft, wordt de versionId verwijderd en wordt een client geretourneerd naar de basis-blob.

function withVersion(versionId: string)

Parameters

versionId: string

De versionId.

Retouren

BlobClient

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

Delen via

PageBlobClient class

Constructors

Eigenschappen

Methoden

Constructordetails

PageBlobClient(string, PipelineLike)

Parameters

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

Parameters

PageBlobClient(string, string, string, StoragePipelineOptions)

Parameters

Eigenschapdetails

accountName

Waarde van eigenschap

containerName

Waarde van eigenschap

credential

Waarde van eigenschap

name

Waarde van eigenschap

url

Waarde van eigenschap

Methodedetails

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parameters

Retouren

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parameters

Retouren

clearPages(number, number, PageBlobClearPagesOptions)

Parameters

Retouren

create(number, PageBlobCreateOptions)

Parameters

Retouren

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Parameters

Retouren

createSnapshot(BlobCreateSnapshotOptions)

Parameters

Retouren

delete(BlobDeleteOptions)

Parameters

Retouren

deleteIfExists(BlobDeleteOptions)

Parameters

Retouren

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parameters

Retouren

download(number, number, BlobDownloadOptions)

Parameters

Retouren

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parameters

Retouren

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parameters

Retouren

downloadToFile(string, number, number, BlobDownloadOptions)

Parameters

Retouren

exists(BlobExistsOptions)

Parameters

Retouren

generateSasUrl(BlobGenerateSasUrlOptions)

Parameters

Retouren

getAppendBlobClient()

Retouren

getBlobLeaseClient(string)

Parameters

Retouren

getBlockBlobClient()

Retouren

getPageBlobClient()

Retouren

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parameters