BlockBlobClient class

Referentie

Pakket:: @azure/storage-blob

BlockBlobClient definieert een set bewerkingen die van toepassing zijn op blok-blobs.

Extends: BlobClient

Constructors

BlockBlobClient(string, PipelineLike)	Hiermee maakt u een exemplaar van BlockBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blok-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Hiermee maakt u een exemplaar van BlockBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blok-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Hiermee maakt u een exemplaar van BlockBlobClient.

Eigenschappen

accountName
containerName	De naam van de opslagcontainer waar de blob aan 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 interface TokenCredential 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 behouden. 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.
commitBlockList(string[], BlockBlobCommitBlockListOptions)	Hiermee schrijft u een blob door de lijst met blok-id's op te geven waaruit de blob bestaat. Als u wilt worden geschreven als onderdeel van een blob, moet een blok in een eerdere <xref:stageBlock> bewerking naar de server zijn geschreven. U kunt aanroepen <xref:commitBlockList> om een blob bij te werken door alleen de blokken te uploaden die zijn gewijzigd en vervolgens de nieuwe en bestaande blokken samen door te voeren. Blokken die niet zijn opgegeven in de blokkeringslijst en die permanent zijn verwijderd.
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. Offset en aantal zijn optioneel, geef respectievelijk 0 en undefined 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 door andere clients of toepassingen wordt verwijderd. 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 wordt een SAS-URI (Shared Access Signature) voor Blob Service gegenereerd 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.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Retourneert de lijst met blokken die zijn geüpload als onderdeel van een blok-blob met behulp van het opgegeven filter voor blokkeringslijsten.
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.
getTags(BlobGetTagsOptions)	Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
query(string, BlockBlobQueryOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Snelle query voor een blob met JSON- of CSV-indeling. Voorbeeld van gebruik (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); 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); }); }
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Hiermee stelt u de laag op 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 in op de blob. 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 een 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 metagegevens van de blob 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 ('.'), slash ('/'), dubbele punt (':'), gelijk aan ('='), en onderstrepingsteken ('_') .
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)	Uploadt het opgegeven blok naar het 'faseringsgebied' van de blok-blob om later te worden doorgevoerd door een aanroep naar commitBlockList.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Met de bewerking Faseblok van URL maakt u een nieuw blok dat moet worden doorgevoerd als onderdeel van een blob waarin de inhoud wordt gelezen vanuit een URL. Deze API is beschikbaar vanaf versie 28-03-2018.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Met de synchrone bewerking Kopiëren van URL kopieert u een blob of een internetbron naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als het kopiëren is voltooid.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Hiermee maakt u een nieuwe blok-blob waarin de inhoud van de blob wordt gelezen vanuit een bepaalde URL. Deze API wordt ondersteund vanaf versie 2020-04-08. Gedeeltelijke updates worden niet ondersteund met Put Blob from URL; de inhoud van een bestaande blob wordt overschreven met de inhoud van de nieuwe blob. Als u gedeeltelijke updates wilt uitvoeren voor de inhoud van een blok-blob met behulp van een bron-URL, gebruikt <xref:stageBlockFromURL> u en <xref:commitBlockList>.
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.
upload(HttpRequestBody, number, BlockBlobUploadOptions)	Hiermee maakt u een nieuwe blok-blob of werkt u de inhoud van een bestaande blok-blob bij. Als u een bestaande blok-blob bijwerkt, worden alle bestaande metagegevens op de blob overschreven. Gedeeltelijke updates worden niet ondersteund; de inhoud van de bestaande blob wordt overschreven met de nieuwe inhoud. Als u een gedeeltelijke update van een blok-blob wilt uitvoeren, gebruikt <xref:stageBlock> u en <xref:commitBlockList>. Dit is een niet-parallelle uploadmethode. Gebruik <xref:uploadFile>, <xref:uploadStream> of <xref:uploadBrowserData> voor betere prestaties bij gelijktijdig uploaden.
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	ALLEEN BESCHIKBAAR IN BROWSERS. Hiermee uploadt u een browser-blob-/bestand/ArrayBuffer/ArrayBufferView-object naar blok-blob. Wanneer de bufferlengte kleiner is dan of gelijk is aan 256 MB, gebruikt deze methode 1 upload-aanroep om het uploaden te voltooien. Anders roept <xref:stageBlock> deze methode aan om blokken te uploaden en roept deze ten slotte <xref:commitBlockList> aan om de blokkeringslijst door te voeren. Een veelgebruikte <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> optie om in te stellen is `blobContentType`, waardoor de browser functionaliteit kan bieden op basis van het bestandstype.
uploadData(Buffer \| Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	Uploadt een Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-object naar een BlockBlob. Wanneer de gegevenslengte niet groter is dan de opgegeven <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> waarde (standaard is <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), gebruikt deze methode 1 <xref:upload> aanroep om het uploaden te voltooien. Anders roept <xref:stageBlock> deze methode aan om blokken te uploaden en roept deze ten slotte <xref:commitBlockList> aan om de blokkeringslijst door te voeren. Een veelgebruikte <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> optie om in te stellen is `blobContentType`, waardoor de browser functionaliteit kan bieden op basis van het bestandstype.
uploadFile(string, BlockBlobParallelUploadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een lokaal bestand in blokken naar een blok-blob. Wanneer de bestandsgrootte kleiner is dan of gelijk is aan 256 MB, gebruikt deze methode 1 upload-aanroep om het uploaden te voltooien. Anders roept deze methode stageBlock aan om blokken te uploaden en roept u ten slotte commitBlockList aan om de blokkeringslijst door te voeren.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een Node.js leesbare stroom naar blok-blob. TIPS VOOR PRESTATIEVERBETERING: Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter bufferSize, waardoor buffer.concat() bewerkingen worden voorkomen.
withSnapshot(string)	Hiermee maakt u een nieuw BlockBlobClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname. Geef op om de momentopname te verwijderen en een URL naar de basis-blob te retourneren.
withVersion(string)	Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef op: hiermee wordt de versionId verwijderd en wordt een client geretourneerd naar de basis-blob.

Constructordetails

BlockBlobClient(string, PipelineLike)

Hiermee maakt u een exemplaar van BlockBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blok-blob. De gecodeerde URL-tekenreeks wordt NIET twee keer ge escaped, alleen speciale tekens in het URL-pad worden ge escaped. Als een blobnaam ? of %, moet de blobnaam zijn gecodeerd in de URL.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parameters

url: string

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

pipeline: PipelineLike

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

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

new BlockBlobClient(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 TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options: StoragePipelineOptions

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

BlockBlobClient(string, string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van BlockBlobClient.

new BlockBlobClient(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 kan 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 waar de blob aan 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 interface TokenCredential 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 behouden. Versie 2012-02-12 en hoger.

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

Parameters

copyId: string

Id van de bewerking Copy From 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>>

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Hiermee schrijft u een blob door de lijst met blok-id's op te geven waaruit de blob bestaat. Als u wilt worden geschreven als onderdeel van een blob, moet een blok in een eerdere <xref:stageBlock> bewerking naar de server zijn geschreven. U kunt aanroepen <xref:commitBlockList> om een blob bij te werken door alleen de blokken te uploaden die zijn gewijzigd en vervolgens de nieuwe en bestaande blokken samen door te voeren. Blokken die niet zijn opgegeven in de blokkeringslijst en die permanent zijn verwijderd.

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

Parameters

blocks: string[]

Matrix van een waarde van 64 bytes die base64-gecodeerd is

options: BlockBlobCommitBlockListOptions

Opties voor de bewerking Blok-blobdoorvoeringslijst blokkeren.

Retouren

Promise<BlockBlobCommitBlockListResponse>

Antwoordgegevens voor de bewerking Block Blob Commit Block List.

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

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. Offset en aantal zijn optioneel, geef respectievelijk 0 en undefined 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 undefined wordt doorgegeven.

options: BlobDownloadOptions

Opties voor blobdownloadopties.

Retouren

Promise<BlobDownloadResponseParsed>

De reactiegegevens voor de blobdownloadbewerking, 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 door andere clients of toepassingen wordt verwijderd. 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 samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een SAS-URI (Shared Access Signature) voor Blob Service gegenereerd 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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Retourneert de lijst met blokken die zijn geüpload als onderdeel van een blok-blob met behulp van het opgegeven filter voor blokkeringslijsten.

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

Parameters

listType: BlockListType

Hiermee geeft u op of de lijst met vastgelegde blokken, de lijst met niet-doorgevoerde blokken of beide lijsten samen moet worden geretourneerd.

options: BlockBlobGetBlockListOptions

Opties voor de bewerking Blokbloblijst ophalen.

Retouren

Promise<BlockBlobGetBlockListResponse>

Antwoordgegevens voor de bewerking Blokbloblijst ophalen.

getPageBlobClient()

Hiermee maakt u een PageBlobClient-object.

function getPageBlobClient()

Retouren

PageBlobClient

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>

query(string, BlockBlobQueryOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Snelle query voor een blob met JSON- of CSV-indeling.

Voorbeeld van gebruik (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

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

function query(query: string, options?: BlockBlobQueryOptions)

Parameters

query: string

options: BlockBlobQueryOptions

Retouren

Promise<BlobDownloadResponseModel>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Hiermee stelt u de laag op 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 op de blob. Geldige waarden zijn Dynamisch, Statisch of Archief.

options: BlobSetTierOptions

Optionele opties voor de bewerking Blob-laag instellen.

Retouren

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Hiermee stelt u systeemeigenschappen in op de blob. 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 een 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 een waarde gewist. Een veelgebruikte header die moet worden ingesteld, is blobContentType dat de browser functionaliteit kan bieden op basis van het bestandstype.

options: BlobSetHTTPHeadersOptions

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

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 metagegevens van de blob 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 ('.'), slash ('/'), dubbele punt (':'), gelijk aan ('='), en onderstrepingsteken ('_') .

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

Parameters

tags: Tags

options: BlobSetTagsOptions

Retouren

Promise<BlobSetTagsResponse>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

Uploadt het opgegeven blok naar het 'faseringsgebied' van de blok-blob om later te worden doorgevoerd door een aanroep naar commitBlockList.

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

Parameters

blockId: string

Een waarde van 64 bytes die base64-gecodeerd is

body: HttpRequestBody

Gegevens die moeten worden geüpload naar het faseringsgebied.

contentLength: number

Aantal bytes dat moet worden geüpload.

options: BlockBlobStageBlockOptions

Opties voor de blok-bewerking Blob-fase blokkeren.

Retouren

Promise<BlockBlobStageBlockResponse>

Antwoordgegevens voor de blok-blobfase-bewerking.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Met de bewerking Faseblok van URL maakt u een nieuw blok dat moet worden doorgevoerd als onderdeel van een blob waarin de inhoud wordt gelezen vanuit een URL. Deze API is beschikbaar vanaf versie 28-03-2018.

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

Parameters

blockId: string

Een waarde van 64 bytes die base64-gecodeerd is

sourceURL: string

Hiermee geeft u de URL van de blob op. De waarde kan een URL van maximaal 2 kB zijn die een blob aangeeft. De waarde moet URL-gecodeerd zijn zoals deze wordt weergegeven in een aanvraag-URI. De bron-blob moet openbaar zijn of moet worden geverifieerd via een Shared Access Signature. Als de bron-blob openbaar is, is er geen verificatie vereist om de bewerking uit te voeren. Hier volgen enkele voorbeelden van bronobject-URL's: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

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

Opties voor de bewerking Blok-blobfase blokkeren vanuit URL.

Retouren

Promise<BlockBlobStageBlockFromURLResponse>

Antwoordgegevens voor de bewerking Block Blob Stage Block From URL.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Met de synchrone bewerking Kopiëren van 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 van waaruit u wilt kopiëren, Shared Access Signature (SAS) is mogelijk nodig voor verificatie

options: BlobSyncCopyFromURLOptions

Retouren

Promise<BlobCopyFromURLResponse>

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Hiermee maakt u een nieuwe blok-blob waarin de inhoud van de blob wordt gelezen vanuit een bepaalde URL. Deze API wordt ondersteund vanaf versie 2020-04-08. Gedeeltelijke updates worden niet ondersteund met Put Blob from URL; de inhoud van een bestaande blob wordt overschreven met de inhoud van de nieuwe blob. Als u gedeeltelijke updates wilt uitvoeren voor de inhoud van een blok-blob met behulp van een bron-URL, gebruikt <xref:stageBlockFromURL> u en <xref:commitBlockList>.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

Parameters

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Optionele parameters.

Retouren

Promise<BlockBlobPutBlobFromUrlResponse>

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>

upload(HttpRequestBody, number, BlockBlobUploadOptions)

Hiermee maakt u een nieuwe blok-blob of werkt u de inhoud van een bestaande blok-blob bij. Als u een bestaande blok-blob bijwerkt, worden alle bestaande metagegevens op de blob overschreven. Gedeeltelijke updates worden niet ondersteund; de inhoud van de bestaande blob wordt overschreven met de nieuwe inhoud. Als u een gedeeltelijke update van een blok-blob wilt uitvoeren, gebruikt <xref:stageBlock> u en <xref:commitBlockList>. Dit is een niet-parallelle uploadmethode. Gebruik <xref:uploadFile>, <xref:uploadStream> of <xref:uploadBrowserData> voor betere prestaties bij gelijktijdig uploaden.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parameters

body: HttpRequestBody

Blob, tekenreeks, ArrayBuffer, ArrayBufferView of een functie die een nieuwe leesbare stroom retourneert waarvan de offset afkomstig is van het begin van de gegevensbron.

contentLength: number

Lengte van hoofdtekst in bytes. Gebruik Buffer.byteLength() om de lengte van de hoofdtekst te berekenen voor een tekenreeks, inclusief niet-Base64-/Hex-gecodeerde tekens.

options: BlockBlobUploadOptions

Opties voor de bewerking Uploaden van blob blokkeren.

Retouren

Promise<BlockBlobUploadResponse>

Antwoordgegevens voor de bewerking Uploaden van blokblob.

Gebruiksvoorbeeld:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use <xref:uploadData> instead.

ALLEEN BESCHIKBAAR IN BROWSERS. Hiermee uploadt u een browser-blob-/bestand/ArrayBuffer/ArrayBufferView-object naar blok-blob.

Wanneer de bufferlengte kleiner is dan of gelijk is aan 256 MB, gebruikt deze methode 1 upload-aanroep om het uploaden te voltooien. Anders roept <xref:stageBlock> deze methode aan om blokken te uploaden en roept deze ten slotte <xref:commitBlockList> aan om de blokkeringslijst door te voeren.

Een veelgebruikte <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> optie om in te stellen is blobContentType, waardoor de browser functionaliteit kan bieden op basis van het bestandstype.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parameters

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, Bestand, ArrayBuffer of ArrayBufferView

options: BlockBlobParallelUploadOptions

Opties voor het uploaden van browsergegevens.

Retouren

Promise<BlobUploadCommonResponse>

Antwoordgegevens voor de blobuploadbewerking.

uploadData(Buffer | Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Uploadt een Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-object naar een BlockBlob. Wanneer de gegevenslengte niet groter is dan de opgegeven <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> waarde (standaard is <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), gebruikt deze methode 1 <xref:upload> aanroep om het uploaden te voltooien. Anders roept <xref:stageBlock> deze methode aan om blokken te uploaden en roept deze ten slotte <xref:commitBlockList> aan om de blokkeringslijst door te voeren.

Een veelgebruikte <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> optie om in te stellen is blobContentType, waardoor de browser functionaliteit kan bieden op basis van het bestandstype.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parameters

data: Buffer | Blob | ArrayBuffer | ArrayBufferView

Buffer(Node.js), Blob, ArrayBuffer of ArrayBufferView

options: BlockBlobParallelUploadOptions

Retouren

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een lokaal bestand in blokken naar een blok-blob.

Wanneer de bestandsgrootte kleiner is dan of gelijk is aan 256 MB, gebruikt deze methode 1 upload-aanroep om het uploaden te voltooien. Anders roept deze methode stageBlock aan om blokken te uploaden en roept u ten slotte commitBlockList aan om de blokkeringslijst door te voeren.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

Parameters

filePath: string

Volledig pad van het lokale bestand

options: BlockBlobParallelUploadOptions

Opties voor uploaden naar blok-blobbewerking.

Retouren

Promise<BlobUploadCommonResponse>

Antwoordgegevens voor de blobuploadbewerking.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een Node.js leesbare stroom naar blok-blob.

TIPS VOOR PRESTATIEVERBETERING:

Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter bufferSize, waardoor buffer.concat() bewerkingen worden voorkomen.

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

Parameters

stream: Readable

Node.js leesbare stream

bufferSize: number

Grootte van elke toegewezen buffer, ook de blokgrootte in de geüploade blok-blob. De standaardwaarde is 8 MB

maxConcurrency: number

Maximale gelijktijdigheid geeft het maximum aantal buffers aan dat kan worden toegewezen, een positieve correlatie met maximale gelijktijdigheid van uploaden. De standaardwaarde is 5

options: BlockBlobUploadStreamOptions

Opties voor de bewerking Stream uploaden naar blok-blob.

Retouren

Promise<BlobUploadCommonResponse>

Antwoordgegevens voor de blobuploadbewerking.

withSnapshot(string)

Hiermee maakt u een nieuw BlockBlobClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname. Geef op om de momentopname te verwijderen en een URL naar de basis-blob te retourneren.

function withSnapshot(snapshot: string)

Parameters

snapshot: string

Het tijdstempel van de momentopname.

Retouren

BlockBlobClient

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

withVersion(string)

Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef op: hiermee 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

BlockBlobClient class

Constructors

Eigenschappen

Methoden

Constructordetails

BlockBlobClient(string, PipelineLike)

Parameters

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

Parameters

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

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parameters

Retouren

getPageBlobClient()

Retouren

getProperties(BlobGetPropertiesOptions)

Parameters

Retouren

getTags(BlobGetTagsOptions)

Parameters