BlockBlobClient class

Hiermee maakt u een exemplaar van BlockBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blok-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 BlockBlobClient(url: string, pipeline: PipelineLike)

Parameters

Hiermee maakt u een exemplaar van BlockBlobClient. Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blok-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 BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parameters

Hiermee maakt u een exemplaar van BlockBlobClient.

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

Parameters

accountName: string

Waarde van eigenschap

De naam van de opslagcontainer waarmee de blob is gekoppeld.

string containerName

Waarde van eigenschap

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

De naam van de blob.

string name

Waarde van eigenschap

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

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.

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

Parameters

Retouren

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.

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

Parameters

Retouren

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

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

Parameters

Retouren

Antwoordgegevens voor de blok-blobdoorvoerlijstbewerking.

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameters

Retouren

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.

function delete(options?: BlobDeleteOptions)

Parameters

Retouren

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.

function deleteIfExists(options?: BlobDeleteOptions)

Parameters

Retouren

Verwijder het immutablility-beleid op de blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parameters

Retouren

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

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

Parameters

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

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

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. Overweeg <xref:downloadToFile>voor blobs die groter zijn dan deze grootte.

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

Parameters

Retouren

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. Overweeg <xref:downloadToFile>voor blobs die groter zijn dan deze grootte.

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

Parameters

Retouren

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

Retouren

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.

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)

Parameters

Retouren

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.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parameters

Retouren

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

Hiermee maakt u een AppendBlobClient-object.

function getAppendBlobClient()

Retouren

Haal een <xref:BlobLeaseClient> op waarmee leases op de blob worden beheerd.

function getBlobLeaseClient(proposeLeaseId?: string)

Parameters

Retouren

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

Hiermee maakt u een BlockBlobClient-object.

function getBlockBlobClient()

Retouren

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

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

Parameters

Retouren

Antwoordgegevens voor de blok-blob- en bloklijstbewerking ophalen.

Hiermee maakt u een PageBlobClient-object.

function getPageBlobClient()

Retouren

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

Retouren

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

function getTags(options?: BlobGetTagsOptions)

Parameters

Retouren

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

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

Retouren

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.

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

Parameters

Retouren

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.

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

Parameters

Retouren

Immutablility-beleid instellen op de blob.

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

Parameters

Retouren

Juridische bewaring instellen voor de blob.

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

Parameters

Retouren

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

Retouren

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)

Parameters

Retouren

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

Retouren

Antwoordgegevens voor de blok-blobfasebewerking.

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

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

Parameters

Retouren

Antwoordgegevens voor blok-blobfase blokkeren vanuit URL-bewerking.

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.

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

Parameters

Retouren

Hiermee maakt u een nieuwe blok-blob waarin de inhoud van de blob wordt gelezen op basis van een bepaalde URL. Deze API wordt ondersteund vanaf de versie 2020-04-08. Gedeeltelijke updates worden niet ondersteund met Put Blob van 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 u <xref:stageBlockFromURL> en <xref:commitBlockList>.

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

Parameters

Retouren

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.

function undelete(options?: BlobUndeleteOptions)

Parameters

Retouren

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 in 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 u <xref:stageBlock> 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

Retouren

Antwoordgegevens voor de bewerking Voor het uploaden van blok-blobs.

Voorbeeldgebruik:

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

ALLEEN BESCHIKBAAR IN BROWSERS. Uploadt een browserblob/File/ArrayBuffer/ArrayBufferView-object naar blok-blob.

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

Een veelgebruikte <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> optie die moet worden ingesteld, is blobContentType, waardoor de browser functionaliteit kan bieden op basis van bestandstype.

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

Parameters

Retouren

Antwoordgegevens voor de bewerking Blob Uploaden.

Uploadt een buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-object naar een BlockBlob. Wanneer de gegevenslengte niet meer is dan de opgegeven <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (de standaardwaarde is <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), gebruikt deze methode 1 <xref:upload> aanroep om het uploaden te voltooien. Anders roept deze methode <xref:stageBlock> aan om blokken te uploaden en roept u tot slot <xref:commitBlockList> aan om de bloklijst door te voeren.

Een veelgebruikte <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> optie die moet worden ingesteld, is blobContentType, waardoor de browser functionaliteit kan bieden op basis van bestandstype.

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

Parameters

Retouren

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

Als 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 bloklijst door te voeren.

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

Parameters

Retouren

Antwoordgegevens voor de bewerking Blob Uploaden.

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

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

Parameters

Retouren

Antwoordgegevens voor de bewerking Blob Uploaden.

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

function withSnapshot(snapshot: string)

Parameters

Retouren

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

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)

Parameters

Retouren

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