BlockBlobClient class

Referentie

Pakket:: @azure/storage-blob

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

Uitbreiding: 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. 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.
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. 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.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Hiermee maakt u een exemplaar van BlockBlobClient.

Eigenschappen

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

Overgenomen eigenschappen

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

Methoden

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 schrijven als onderdeel van een blob, moet een blok zijn geschreven naar de server in een eerdere stageBlock bewerking. U kunt 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. Zie https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Retourneert de lijst met blokken die zijn geüpload als onderdeel van een blok-blob met behulp van het opgegeven bloklijstfilter. Zie https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Uploadt het opgegeven blok naar het faseringsgebied van de blok-blob om later te worden doorgevoerd door een aanroep naar commitBlockList. Zie https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	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. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	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 stageBlockFromURL- en commitBlockList-.
upload(RequestBodyType, 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 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 stageBlock en commitBlockList. Dit is een niet-parallelle uploadmethode. Gebruik uploadFile, uploadStream of uploadBrowserData voor betere prestaties bij gelijktijdige uploading. Zie https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	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 stageBlock aan om blokken te uploaden en roept deze ten slotte commitBlockList aan om de bloklijst door te voeren. Een veelgebruikte blobHTTPHeaders optie is `blobContentType`, waardoor de browser functionaliteit kan bieden op basis van bestandstype.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Uploadt een buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-object naar een BlockBlob. Wanneer de gegevenslengte niet meer is dan de opgegeven maxSingleShotSize- (standaard is <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), gebruikt deze methode 1 uploaden aanroep om het uploaden te voltooien. Anders roept deze methode stageBlock aan om blokken te uploaden en roept deze ten slotte commitBlockList aan om de bloklijst door te voeren. Een veelgebruikte blobHTTPHeaders optie is `blobContentType`, waardoor de browser functionaliteit kan bieden op basis van bestandstype.
uploadFile(string, BlockBlobParallelUploadOptions)	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.
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 vermeden.
withSnapshot(string)	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.

Overgenomen methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Hiermee wordt een asynchrone kopieerblobbewerking afgebroken en blijft een doel-blob met de lengte nul en volledige metagegevens achter. Versie 2012-02-12 en hoger. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Kopieert asynchroon een blob naar een bestemming in het opslagaccount. Deze methode retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het kopiëren is voltooid. U kunt een kopie ook annuleren voordat deze is voltooid door `cancelOperation` aan te roepen in de poller. Houd er rekening mee dat de callback onProgress niet wordt aangeroepen als de bewerking in de eerste aanvraag is voltooid en een voltooide kopie probeert te annuleren, resulteert in een fout. In versie 2012-02-12 en hoger kan de bron voor een kopieer-blobbewerking een vastgelegde blob zijn in elk Azure-opslagaccount. Vanaf versie 2015-02-21 kan de bron voor een kopieer-blobbewerking een Azure-bestand zijn in elk Azure-opslagaccount. Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan de kopieer-blobbewerking toe vanuit een ander opslagaccount. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Voorbeeld van automatische polling: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Voorbeeld van handmatige polling: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Voorbeeld van voortgangsupdates: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Voorbeeld van een veranderend polling-interval (standaard 15 seconden): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Voorbeeld van het annuleren van kopiëren: `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Hiermee maakt u een alleen-lezen momentopname van een blob. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	Markeert de opgegeven blob of momentopname voor verwijdering. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen ervan verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	Markeert de opgegeven blob of momentopname voor verwijdering als deze bestaat. De blob wordt later verwijderd tijdens de garbagecollection. Als u een blob wilt verwijderen, moet u alle momentopnamen ervan verwijderen. U kunt beide tegelijk verwijderen met de bewerking Blob verwijderen. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Verwijder het immutablility-beleid op de blob.
download(number, number, BlobDownloadOptions)	Leest of downloadt een blob van het systeem, inclusief de metagegevens en eigenschappen. U kunt ook Get Blob aanroepen om een momentopname te lezen. In Node.jsworden gegevens geretourneerd in een leesbare stream readableStreamBody In browsers worden gegevens geretourneerd in een promise blobBody Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een Azure Blob parallel gedownload naar een buffer. Offset en aantal zijn optioneel, downloadt de hele blob als deze niet zijn opgegeven. Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u downloadToFileoverwegen.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een Azure Blob parallel gedownload naar een buffer. Offset en aantal zijn optioneel, downloadt de hele blob als deze niet zijn opgegeven. Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor blobs die groter zijn dan deze grootte, kunt u downloadToFileoverwegen.
downloadToFile(string, number, number, BlobDownloadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure Blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om de hele blob te downloaden.
exists(BlobExistsOptions)	Retourneert waar als de Azure-blobresource bestaat die wordt vertegenwoordigd door deze client; anders onwaar. OPMERKING: gebruik deze functie met zorg omdat een bestaande blob kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe blobs worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
generateSasStringToSign(BlobGenerateSasUrlOptions)	Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(BlobGenerateSasUrlOptions)	Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee genereert u een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	Alleen beschikbaar voor BlobClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	Hiermee genereert u een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	De bewerking Accountgegevens ophalen retourneert de SKU-naam en het accounttype voor het opgegeven account. De bewerking Accountgegevens ophalen is beschikbaar in serviceversies vanaf versie 2018-03-28. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()	Hiermee maakt u een AppendBlobClient-object.
getBlobLeaseClient(string)	Haal een BlobLeaseClient- op waarmee leases op de blob worden beheerd.
getBlockBlobClient()	Hiermee maakt u een BlockBlobClient-object.
getPageBlobClient()	Hiermee maakt u een PageBlobClient-object.
getProperties(BlobGetPropertiesOptions)	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard HTTP-eigenschappen en systeemeigenschappen voor de blob. De inhoud van de blob wordt niet geretourneerd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties WAARSCHUWING: het `metadata` object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de methoden van ContainerClient die blobs vermelden met behulp van de optie `includeMetadata`, die hun oorspronkelijke behuizing behouden.
getTags(BlobGetTagsOptions)	Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
setAccessTier(string, BlobSetTierOptions)	Hiermee stelt u de laag in op een blob. De bewerking is toegestaan op een pagina-blob in een Premium Storage-account en op een blok-blob in een blobopslagaccount (alleen lokaal redundante opslag). De laag van een Premium-pagina-blob bepaalt de toegestane grootte, IOPS en bandbreedte van de blob. De laag van een blok-blob bepaalt dynamisch/statisch/archiefopslagtype. Met deze bewerking wordt de ETag van de blob niet bijgewerkt. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Hiermee stelt u systeemeigenschappen in de blob in. Als er geen waarde is opgegeven of er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Beleid voor onveranderbaarheid instellen voor de blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Juridische bewaring instellen voor de blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor de opgegeven blob in als een of meer naam-waardeparen. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van de blob verwijderd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	Hiermee stelt u tags in op de onderliggende blob. Een blob kan maximaal 10 tags bevatten. Tagsleutels moeten tussen 1 en 128 tekens zijn. Tagwaarden moeten tussen 0 en 256 tekens zijn. Geldige tagsleutel en waardetekens zijn kleine letters en hoofdletters, cijfers (0-9), spatie (' '), plus ('+'), min ('-'), punt ('.'), slash ('/'), dubbele punt (':'), is gelijk aan ('='), en onderstrepingsteken ('_').
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Met de synchrone kopieerbewerking van een URL wordt een blob of een internetresource gekopieerd naar een nieuwe blob. Er wordt pas een antwoord geretourneerd als de kopie is voltooid. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Hiermee herstelt u de inhoud en metagegevens van voorlopig verwijderde blob en eventuele gekoppelde voorlopig verwijderde momentopnamen. Verwijderen van blob ongedaan maken wordt alleen ondersteund op versie 2017-07-29 of hoger. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)	Hiermee maakt u een nieuw BlobClient-object dat verwijst naar een versie van deze blob. Geef '' op, verwijdert de versionId en retourneert een client naar de basis-blob.

Constructordetails

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

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. Gecodeerde URL-tekenreeks wordt NIET tweemaal escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam echter wel een naam bevat? of %, moet de blobnaam in de URL worden gecodeerd. Zoals een blob met de naam 'my?blob%', moet de URLhttps://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"zijn.

pipeline: PipelineLike

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

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

options: StoragePipelineOptions

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

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

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

Containernaam.

blobName: string

Blobnaam.

options: StoragePipelineOptions

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

Eigenschapdetails

containerName

De naam van de opslagcontainer waarmee de blob is gekoppeld.

string containerName

Waarde van eigenschap

string

name

De naam van de blob.

string name

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName

accountName: string

Waarde van eigenschap

string

overgenomen vanBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

overgenomen vanBlobClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen vanBlobClient.url

Methodedetails

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 schrijven als onderdeel van een blob, moet een blok zijn geschreven naar de server in een eerdere stageBlock bewerking. U kunt 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.

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

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parameters

blocks: string[]

Matrix van 64-bytewaarde die base64-gecodeerd is

options: BlockBlobCommitBlockListOptions

Opties voor de blok-blobdoorvoerlijstbewerking.

Retouren

Promise<BlockBlobCommitBlockListResponse>

Antwoordgegevens voor de blok-blobdoorvoerlijstbewerking.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

Zie https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

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 blok-blob- en bloklijstbewerking ophalen.

Retouren

Promise<BlockBlobGetBlockListResponse>

Antwoordgegevens voor de blok-blob- en bloklijstbewerking ophalen.

query(string, BlockBlobQueryOptions)

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

Parameters

query: string

options: BlockBlobQueryOptions

Retouren

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

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

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

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parameters

blockId: string

Een waarde van 64 bytes die is gecodeerd met base64

body: HttpRequestBody

Gegevens die moeten worden geüpload naar het faseringsgebied.

contentLength: number

Aantal te uploaden bytes.

options: BlockBlobStageBlockOptions

Opties voor de blokbewerking blok-blobfase.

Retouren

Promise<BlockBlobStageBlockResponse>

Antwoordgegevens voor de blok-blobfasebewerking.

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

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.

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Parameters

blockId: string

Een waarde van 64 bytes die is gecodeerd met base64

sourceURL: string

Hiermee geeft u de URL van de blob. 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 moeten worden geverifieerd via een handtekening voor gedeelde toegang. Als de bron-blob openbaar is, is er geen verificatie vereist om de bewerking uit te voeren. Hier volgen enkele voorbeelden van URL's voor bronobjecten: - 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 moeten worden gedownload, groter dan 0. Wordt naar het einde gedownload wanneer deze niet is gedefinieerd

options: BlockBlobStageBlockFromURLOptions

Opties voor het blok-blobfaseblok vanuit URL-bewerking.

Retouren

Promise<BlockBlobStageBlockFromURLResponse>

Antwoordgegevens voor blok-blobfase blokkeren vanuit URL-bewerking.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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 stageBlockFromURL- en commitBlockList-.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parameters

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Optionele parameters.

Retouren

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, 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 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 stageBlock en commitBlockList.

Dit is een niet-parallelle uploadmethode. Gebruik uploadFile, uploadStream of uploadBrowserData voor betere prestaties bij gelijktijdige uploading.

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

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

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 blok-blobs.

Retouren

Promise<BlockBlobUploadResponse>

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

Voorbeeldgebruik:

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use uploadData instead.

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 stageBlock aan om blokken te uploaden en roept deze ten slotte commitBlockList aan om de bloklijst door te voeren.

Een veelgebruikte blobHTTPHeaders optie is blobContentType, waardoor de browser functionaliteit kan bieden op basis van bestandstype.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parameters

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer of ArrayBufferView

options: BlockBlobParallelUploadOptions

Opties voor het uploaden van browsergegevens.

Retouren

Promise<BlobUploadCommonResponse>

Antwoordgegevens voor de bewerking Blob Uploaden.

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

Uploadt een buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-object naar een BlockBlob.

Wanneer de gegevenslengte niet meer is dan de opgegeven maxSingleShotSize- (standaard is <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), gebruikt deze methode 1 uploaden aanroep om het uploaden te voltooien. Anders roept deze methode stageBlock aan om blokken te uploaden en roept deze ten slotte commitBlockList aan om de bloklijst door te voeren.

Een veelgebruikte blobHTTPHeaders optie is blobContentType, waardoor de browser functionaliteit kan bieden op basis van bestandstype.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parameters

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

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.

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

Parameters

filePath: string

Volledig pad naar het lokale bestand

options: BlockBlobParallelUploadOptions

Opties voor uploaden naar blok-blobbewerking.

Retouren

Promise<BlobUploadCommonResponse>

Antwoordgegevens voor de bewerking Blob Uploaden.

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

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parameters

stream: Readable

Node.js leesbare stroom

bufferSize: number

De 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, positieve correlatie met maximale gelijktijdigheid van uploaden. De standaardwaarde is 5

options: BlockBlobUploadStreamOptions

Opties voor het uploaden van stream naar blok-blobbewerking.

Retouren

Promise<BlobUploadCommonResponse>

Antwoordgegevens voor de bewerking Blob Uploaden.

withSnapshot(string)

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): BlockBlobClient

Parameters

snapshot: string

De tijdstempel van de momentopname.

Retouren

BlockBlobClient

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

Details overgenomen methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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

Parameters

copyId: string

Id van de bewerking Copy From URL.

options: BlobAbortCopyFromURLOptions

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

Retouren

Promise<BlobAbortCopyFromURLResponse>

overgenomen vanBlobClient.abortCopyFromURL-

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

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

Voorbeeld van automatische polling:

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

Voorbeeld van handmatige polling:

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

Voorbeeld van voortgangsupdates:

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

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

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

Voorbeeld van het annuleren van kopiëren:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Parameters

copySource: string

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

options: BlobBeginCopyFromURLOptions

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

Retouren

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

overgenomen vanBlobClient.beginCopyFromURL-

createSnapshot(BlobCreateSnapshotOptions)

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

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

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

Parameters

options: BlobCreateSnapshotOptions

Optionele opties voor de bewerking Momentopname maken van blob.

Retouren

Promise<BlobCreateSnapshotResponse>

overgenomen vanBlobClient.createSnapshot-

delete(BlobDeleteOptions)

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

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

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

Parameters

options: BlobDeleteOptions

Optionele opties voor de bewerking Blob Verwijderen.

Retouren

Promise<BlobDeleteResponse>

overgenomen vanBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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

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

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

Parameters

options: BlobDeleteOptions

Optionele opties voor de bewerking Blob Verwijderen.

Retouren

Promise<BlobDeleteIfExistsResponse>

overgenomen vanBlobClient.deleteIfExists-

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Verwijder het immutablility-beleid op de blob.

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

Parameters

options: BlobDeleteImmutabilityPolicyOptions

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

Retouren

Promise<BlobDeleteImmutabilityPolicyResponse>

overgenomen vanBlobClient.deleteImmutabilityPolicy-

download(number, number, BlobDownloadOptions)

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

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

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

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

Parameters

offset: number

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

count: number

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

options: BlobDownloadOptions

Optionele opties voor de bewerking Blob downloaden.

Voorbeeldgebruik (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

Voorbeeldgebruik (browser):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Retouren

Promise<BlobDownloadResponseParsed>

overgenomen vanBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

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

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

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

Parameters

buffer: Buffer

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

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retouren

Promise<Buffer>

overgenomen vanBlobClient.downloadToBuffer-

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

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

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

Parameters

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retouren

Promise<Buffer>

overgenomen vanBlobClient.downloadToBuffer-

downloadToFile(string, number, number, BlobDownloadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

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

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

Parameters

filePath: string

offset: number

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

count: number

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

options: BlobDownloadOptions

Opties voor blobdownloadopties.

Retouren

Promise<BlobDownloadResponseParsed>

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

overgenomen vanBlobClient.downloadToFile-

exists(BlobExistsOptions)

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

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

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

Parameters

options: BlobExistsOptions

opties voor bestaat bewerking.

Retouren

Promise<boolean>

overgenomen vanBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

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

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

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parameters

options: BlobGenerateSasUrlOptions

Optionele parameters.

Retouren

string

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

overgenomen vanBlobClient.generateSasStringToSign-

generateSasUrl(BlobGenerateSasUrlOptions)

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

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

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

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

Parameters

options: BlobGenerateSasUrlOptions

Optionele parameters.

Retouren

Promise<string>

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

overgenomen vanBlobClient.generateSasUrl-

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

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

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Blob Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker.

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

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parameters

options: BlobGenerateSasUrlOptions

Optionele parameters.

userDelegationKey: UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

Retouren

string

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

overgenomen vanBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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

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

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parameters

options: BlobGenerateSasUrlOptions

Optionele parameters.

userDelegationKey: UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

Retouren

Promise<string>

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

overgenomen vanBlobClient.generateUserDelegationSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

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

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

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

Parameters

options: BlobGetAccountInfoOptions

Opties voor de bewerking Accountgegevens ophalen van service.

Retouren

Promise<BlobGetAccountInfoResponse>

Antwoordgegevens voor de bewerking Accountgegevens ophalen van service.

overgenomen vanBlobClient.getAccountInfo

getAppendBlobClient()

Hiermee maakt u een AppendBlobClient-object.

function getAppendBlobClient(): AppendBlobClient

Retouren

AppendBlobClient

overgenomen vanBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parameters

proposeLeaseId: string

Oorspronkelijke voorgestelde lease-id.

Retouren

BlobLeaseClient

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

overgenomen vanBlobClient.getBlobLeaseClient

getBlockBlobClient()

Hiermee maakt u een BlockBlobClient-object.

function getBlockBlobClient(): BlockBlobClient

Retouren

BlockBlobClient

overgenomen vanBlobClient.getBlockBlobClient

getPageBlobClient()

Hiermee maakt u een PageBlobClient-object.

function getPageBlobClient(): PageBlobClient

Retouren

PageBlobClient

overgenomen vanBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

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

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

Parameters

options: BlobGetPropertiesOptions

Optionele opties voor de bewerking Eigenschappen ophalen.

Retouren

Promise<BlobGetPropertiesResponse>

overgenomen vanBlobClient.getProperties-

getTags(BlobGetTagsOptions)

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

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

Parameters

options: BlobGetTagsOptions

Retouren

Promise<BlobGetTagsResponse>

overgenomen vanBlobClient.getTags-

setAccessTier(string, BlobSetTierOptions)

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

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

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

Parameters

tier: string

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

options: BlobSetTierOptions

Optionele opties voor de bewerking Blob Set Tier.

Retouren

Promise<BlobSetTierResponse>

overgenomen vanBlobClient.setAccessTier-

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Hiermee stelt u systeemeigenschappen in de blob in.

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

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

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

Parameters

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

Retouren

Promise<BlobSetHTTPHeadersResponse>

overgenomen vanBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Beleid voor onveranderbaarheid instellen voor de blob.

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

Parameters

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Retouren

Promise<BlobSetImmutabilityPolicyResponse>

overgenomen vanBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Juridische bewaring instellen voor de blob.

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

Parameters

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Retouren

Promise<BlobSetLegalHoldResponse>

overgenomen vanBlobClient.setLegalHold-

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

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

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

Parameters

metadata: Metadata

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

options: BlobSetMetadataOptions

Optionele opties voor het instellen van metagegevensbewerking.

Retouren

Promise<BlobSetMetadataResponse>

overgenomen vanBlobClient.setMetadata-

setTags(Tags, BlobSetTagsOptions)

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

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

Parameters

tags: Tags

options: BlobSetTagsOptions

Retouren

Promise<BlobSetTagsResponse>

overgenomen vanBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

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

Parameters

copySource: string

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

options: BlobSyncCopyFromURLOptions

Retouren

Promise<BlobCopyFromURLResponse>

overgenomen vanBlobClient.syncCopyFromURL-

undelete(BlobUndeleteOptions)

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

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

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

Parameters

options: BlobUndeleteOptions

Optionele opties voor de bewerking Blob Ongedaan maken.

Retouren

Promise<BlobUndeleteResponse>

overgenomen vanBlobClient.undelete

withVersion(string)

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

function withVersion(versionId: string): BlobClient

Parameters

versionId: string

De versionId.

Retouren

BlobClient

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

overgenomen vanBlobClient.withVersion-

Delen via

BlockBlobClient class

Constructors

Eigenschappen

Overgenomen eigenschappen

Methoden

Overgenomen methoden

Constructordetails

BlockBlobClient(string, PipelineLike)

Parameters

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

Parameters

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parameters

Eigenschapdetails

containerName

Waarde van eigenschap

name

Waarde van eigenschap

Details van overgenomen eigenschap

accountName

Waarde van eigenschap

credential

Waarde van eigenschap

url

Waarde van eigenschap

Methodedetails

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parameters

Retouren

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parameters

Retouren

query(string, BlockBlobQueryOptions)

Parameters

Retouren

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parameters

Retouren

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

Parameters

Retouren

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parameters

Retouren

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parameters

Retouren

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parameters

Retouren

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

Parameters

Retouren

uploadFile(string, BlockBlobParallelUploadOptions)

Parameters

Retouren

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parameters

Retouren

withSnapshot(string)

Parameters

Retouren

Details overgenomen methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parameters

Retouren

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parameters

Retouren

createSnapshot(BlobCreateSnapshotOptions)

Parameters

Retouren

delete(BlobDeleteOptions)

Parameters

Retouren

deleteIfExists(BlobDeleteOptions)

Parameters

Retouren

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)