BlobClient class

  • Referentie
Pakket:
@azure/storage-blob

Een BlobClient vertegenwoordigt een URL naar een Azure Storage-blob; de blob kan een blok-blob, toevoeg-blob of pagina-blob zijn.

Extends

StorageClient

Constructors

BlobClient(string, PipelineLike)

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

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

Hiermee maakt u een exemplaar van BlobClient op basis van connection string.

Eigenschappen

containerName

De naam van de opslagcontainer waar de blob aan is gekoppeld.
name

De naam van de blob.

Overgenomen eigenschappen

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

Gecodeerde URL-tekenreekswaarde.

Methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
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.

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 met een wijzigend 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 opzeggen 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)

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.

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

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
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 downloadToFile overwegen.
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 downloadToFile overwegen.
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.

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

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

Haal een BlobLeaseClient op die leases op de blob beheert.
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, heeft 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 includeMetadata optie, die hun oorspronkelijke hoofdletters behouden.
getTags(BlobGetTagsOptions)

Hiermee haalt u de tags op die zijn gekoppeld aan de onderliggende blob.
setAccessTier(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.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
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.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
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.

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

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
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.

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

Hiermee maakt u een nieuw BlobClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname. Geef op om de momentopname te verwijderen en een client terug te keren naar de basis-blob.
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

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

Parameters

url

string

Een URL-tekenreeks die verwijst naar Azure Storage-blob, zoals 'https://myaccount.blob.core.windows.net/mycontainer/blob". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een blob. Gecodeerde URL-tekenreeks wordt NIET tweemaal ge escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een blobnaam 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.

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

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

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

Parameters

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

BlobClient(string, string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van BlobClient op basis van connection string.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kunnen alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Containernaam.

blobName

string

Blobnaam.

options
StoragePipelineOptions

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

Eigenschapdetails

containerName

De naam van de opslagcontainer waar de blob aan 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 van StorageClient.accountName

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

Overgenomen van StorageClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Overgenomen van StorageClient.url

Methodedetails

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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 Kopiëren van URL.

options
BlobAbortCopyFromURLOptions

Optionele opties voor de bewerking Blob Copy From URL afbreken.

Retouren

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

In versie 2012-02-12 en hoger kan de bron voor een Blob-kopieerbewerking een vastgelegde blob in elk Azure-opslagaccount zijn. Vanaf versie 2015-02-21 kan de bron voor een blob-kopieerbewerking een Azure-bestand in elk Azure-opslagaccount zijn. Alleen opslagaccounts die op of na 7 juni 2012 zijn gemaakt, staan toe dat de blob kopiërenbewerking vanuit een ander opslagaccount kan worden gekopieerd.

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 met een wijzigend 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 opzeggen 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 bron-Azure-blob/-bestand.

options
BlobBeginCopyFromURLOptions

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

Retouren

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

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

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>

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.

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>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Verwijder het beleid immutablility op de blob.

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

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

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

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

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

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

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

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.

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 naar de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

getAppendBlobClient()

Hiermee maakt u een AppendBlobClient-object.

function getAppendBlobClient(): AppendBlobClient

Retouren

AppendBlobClient

getBlobLeaseClient(string)

Haal een BlobLeaseClient op die leases op de blob beheert.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

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

Retouren

BlockBlobClient

getPageBlobClient()

Hiermee maakt u een PageBlobClient-object.

function getPageBlobClient(): PageBlobClient

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.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft 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 includeMetadata optie, die hun oorspronkelijke hoofdletters behouden.

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

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

Parameters

options
BlobGetTagsOptions

Retouren

Promise<BlobGetTagsResponse>

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

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

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

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

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.

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

Parameters

tags
Tags
options
BlobSetTagsOptions

Retouren

Promise<BlobSetTagsResponse>

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.

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

options
BlobSyncCopyFromURLOptions

Retouren

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

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>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

Parameters

snapshot

string

Het tijdstempel van de momentopname.

Retouren

BlobClient

Een nieuw BlobClient-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): BlobClient

Parameters

versionId

string

De versionId.

Retouren

BlobClient

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