BlockBlobClient class

Referenz

Paket:: @azure/storage-blob

BlockBlobClient definiert eine Reihe von Vorgängen, die für Blockblobs gelten.

Extends: BlobClient

Konstruktoren

BlockBlobClient(string, PipelineLike)	Erstellt eine Instanz von BlockBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blockblob verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal mit Escapezeichen versehen, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname enthält? oder %, Blobname muss in der URL codiert werden.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Erstellt eine Instanz von BlockBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blockblob verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal mit Escapezeichen versehen, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname enthält? oder %, Blobname muss in der URL codiert werden.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Erstellt eine Instanz von BlockBlobClient.

Eigenschaften

containerName	Der Name des Speichercontainers, dem das Blob zugeordnet ist.
name	Der Name des Blobs.

Geerbte Eigenschaften

accountName
credential	Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem `@azure/identity` Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.
url	Codierter URL-Zeichenfolgenwert.

Methoden

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Schreibt ein BLOB, indem die Liste der Block-IDs angegeben wird, aus denen sich das BLOB zusammensetzt. Um als Teil eines Blobs geschrieben zu werden, muss ein Block in einem vorherigen stageBlock-Vorgang erfolgreich auf den Server geschrieben worden sein. Sie können commitBlockList aufrufen, um ein Blob zu aktualisieren, indem Sie nur die geänderten Blöcke hochladen und dann die neuen und vorhandenen Blöcke gemeinsam committen. Alle Blöcke, die nicht in der Blockliste angegeben und endgültig gelöscht wurden. Siehe https://docs.microsoft.com/rest/api/storageservices/put-block-list.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Gibt die Liste der Blöcke zurück, die als Teil eines Blockblobs mithilfe des angegebenen Blocklistenfilters hochgeladen wurden. Siehe https://docs.microsoft.com/rest/api/storageservices/get-block-list.
query(string, BlockBlobQueryOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Schnelle Abfrage für ein JSON- oder CSV-formatiertes Blob. Beispielverwendung (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, HttpRequestBody, number, BlockBlobStageBlockOptions)	Lädt den angegebenen Block in den "Stagingbereich" des Blockblobs hoch, um später durch einen Aufruf von commitBlockList committet zu werden. Siehe https://docs.microsoft.com/rest/api/storageservices/put-block.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Der Vorgang Stage Block From URL erstellt einen neuen Block, der als Teil eines Blobs committet werden soll, in dem der Inhalt aus einer URL gelesen wird. Diese API ist ab Version 2018-03-28 verfügbar. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Erstellt ein neues Blockblob, in dem der Inhalt des Blobs aus einer bestimmten URL gelesen wird. Diese API wird ab version 2020-04-08 unterstützt. Partielle Updates werden mit Put Blob from URL nicht unterstützt. Der Inhalt eines vorhandenen Blobs wird mit dem Inhalt des neuen Blobs überschrieben. Verwenden Sie stageBlockFromURL und commitBlockList, um partielle Aktualisierungen des Inhalts eines Blockblobs mithilfe einer Quell-URL durchzuführen.
upload(HttpRequestBody, number, BlockBlobUploadOptions)	Erstellt ein neues Blockblob oder aktualisiert den Inhalt eines vorhandenen Blockblobs. Beim Aktualisieren eines vorhandenen Block-BLOB werden alle vorhandenen Metadaten im BLOB überschrieben. Partielle Updates werden nicht unterstützt. Der Inhalt des vorhandenen Blobs wird mit dem neuen Inhalt überschrieben. Verwenden Sie stageBlock und commitBlockList, um eine partielle Aktualisierung eines Blockblobs durchzuführen. Dies ist eine nicht parallele Uploadmethode. Verwenden Sie uploadFile, uploadStream oder uploadBrowserData , um eine bessere Leistung bei Parallelitätsuploads zu erzielen. Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob.
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	NUR IN BROWSERN VERFÜGBAR. Lädt ein Browser-Blob/File/ArrayBuffer/ArrayBufferView-Objekt hoch, um blobs zu blockieren. Wenn die Pufferlänge kleiner als oder gleich 256 MB ist, verwendet diese Methode 1 Uploadaufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock auf, um Blöcke hochzuladen, und schließlich ruft commitBlockList auf, um die Blockliste zu committen. Eine gängige blobHTTPHeaders-Option , die festgelegt werden soll, ist `blobContentType`, sodass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Lädt ein Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-Objekt in ein BlockBlob hoch. Wenn die Datenlänge nicht größer als die angegebene maxSingleShotSize ist (Standardeinstellung <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), verwendet diese Methode 1 Upload-Aufruf , um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock auf, um Blöcke hochzuladen, und schließlich ruft commitBlockList auf, um die Blockliste zu committen. Eine gängige blobHTTPHeaders-Option , die festgelegt werden soll, ist `blobContentType`, sodass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.
uploadFile(string, BlockBlobParallelUploadOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt eine lokale Datei in Blöcken in ein Blockblob hoch. Wenn die Dateigröße kleiner als oder gleich 256 MB ist, verwendet diese Methode 1 Uploadaufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock auf, um Blöcke hochzuladen, und schließlich ruft commitBlockList auf, um die Blockliste zu committen.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt einen Node.js lesbaren Stream in Blockblob hoch. TIPPS ZUR LEISTUNGSVERBESSERUNG: Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem parameter bufferSize festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.
withSnapshot(string)	Erstellt ein neues BlockBlobClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und eine URL an das Basisblob zurückzugeben.

Geerbte Methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Bricht einen ausstehenden asynchronen Kopierblobvorgang ab und belässt ein Zielblob mit der Länge null und vollständigen Metadaten. Version 2012-02-12 und höher. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Kopiert ein Blob asynchron in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis der Kopiervorgang abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen ist, indem Sie auf dem Poller aufrufen `cancelOperation` . Beachten Sie, dass der onProgress-Rückruf nicht aufgerufen wird, wenn der Vorgang in der ersten Anforderung abgeschlossen ist und der Versuch, eine abgeschlossene Kopie abzubrechen, zu einem Fehler führt. In Version 2012-02-12 und höher kann die Quelle für einen Kopierblobvorgang ein Commitblob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann die Quelle für einen Kopiervorgang blob eine Azure-Datei in einem beliebigen Azure-Speicherkonto sein. Das Kopieren aus einem anderen Speicherkonto durch den Copy Blob-Vorgang wird jedoch nur für Speicherkonten unterstützt, die ab dem 7. Juni 2012 erstellt wurden. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob. Beispiel für automatische Abrufe: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Beispiel für manuelle Abrufe: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Beispiel für Statusaktualisierungen: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Beispiel für die Verwendung eines sich ändernden Abrufintervalls (Standard 15 Sekunden): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Beispiel für die Verwendung des Kopierabbruchs: `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)	Erstellt eine schreibgeschützte Momentaufnahme eines BLOB. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob.
delete(BlobDeleteOptions)	Markiert das angegebene Blob oder die angegebene Momentaufnahme zum Löschen. Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang Blob löschen löschen. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
deleteIfExists(BlobDeleteOptions)	Markiert das angegebene Blob oder die angegebene Momentaufnahme zum Löschen, sofern vorhanden. Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang Blob löschen löschen. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Löschen Sie die Unmutablilitätsrichtlinie für das Blob.
download(number, number, BlobDownloadOptions)	Liest oder lädt ein Blob aus dem System herunter, einschließlich seiner Metadaten und Eigenschaften. Sie können auch Get Blob aufrufen, um eine Momentaufnahme zu lesen. In Node.js werden Daten in einem lesbaren Stream zurückgegebenStreamBody In Browsern werden Daten in einer Zusage blobBody zurückgegeben. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob.
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.
downloadToFile(string, number, number, BlobDownloadOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob in eine lokale Datei herunter. Schlägt fehl, wenn der angegebene Dateipfad bereits beendet wird. Offset und Count sind optional, übergeben 0 bzw. undefiniert, um das gesamte Blob herunterzuladen.
exists(BlobExistsOptions)	Gibt true zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. false andernfalls. HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, da ein vorhandenes Blob möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Blobs von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.
generateSasUrl(BlobGenerateSasUrlOptions)	Nur für BlobClient verfügbar, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde. Generiert einen SAS-URI (Shared Access Signature, Shared Access Signature) von Blob Service basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getAppendBlobClient()	Erstellt ein AppendBlobClient-Objekt.
getBlobLeaseClient(string)	Rufen Sie einen BlobLeaseClient ab, der Leases für das Blob verwaltet.
getBlockBlobClient()	Erstellt ein BlockBlobClient-Objekt.
getPageBlobClient()	Erstellt ein PageBlobClient-Objekt.
getProperties(BlobGetPropertiesOptions)	Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für das BLOB zurück. Der Inhalt des BLOB wird nicht zurückgegeben. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties. WARNUNG: Das `metadata` in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden von ContainerClient zurückgegeben werden, die Blobs mithilfe der `includeMetadata` Option auflisten, die ihre ursprüngliche Groß- und Kleinschreibung beibehalten.
getTags(BlobGetTagsOptions)	Ruft die Tags ab, die dem zugrunde liegenden Blob zugeordnet sind.
setAccessTier(string, BlobSetTierOptions)	Legt die Ebene für ein Blob fest. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp Hot/Cool/Archive. Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Legt Systemeigenschaften für den Blob fest. Wenn kein Wert oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne Wert gelöscht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Legen Sie die Richtlinie für die Unmutablilität für das Blob fest.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Legen Sie den rechtlichen Halteraum für das Blob fest.
setMetadata(Metadata, BlobSetMetadataOptions)	Legt benutzerdefinierte Metadaten für das angegebene Blob als mindestens ein Name-Wert-Paar fest. Wenn keine Option oder keine im Parameter definierten Metadaten angegeben sind, werden die Blobmetadaten entfernt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.
setTags(Tags, BlobSetTagsOptions)	Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein. Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen umfassen Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), plus ('+'), Minuszeichen ('-'), Punkt ('.'), Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Der synchrone Kopiervorgang von URL kopiert ein Blob oder eine Internetressource in ein neues Blob. Es wird erst dann eine Antwort zurückgegeben, wenn die Kopie abgeschlossen ist. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url.
undelete(BlobUndeleteOptions)	Stellt den Inhalt und die Metadaten des vorläufig gelöschten Blobs und aller zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Das Rückgängigmachen von Blobs wird nur ab Version 2017-07-29 unterstützt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.
withVersion(string)	Erstellt ein neues BlobClient-Objekt, das auf eine Version dieses Blobs verweist. Geben Sie "" an, um die versionId zu entfernen und einen Client an das Basisblob zurückzugeben.

Details zum Konstruktor

BlockBlobClient(string, PipelineLike)

Erstellt eine Instanz von BlockBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blockblob verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal mit Escapezeichen versehen, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname enthält? oder %, Blobname muss in der URL codiert werden.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parameter

url: string

Eine URL-Zeichenfolge, die auf das Azure Storage-Blockblob verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/blockblob"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Diese Methode akzeptiert eine codierte URL oder eine nicht codierte URL, die auf ein Blob verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal mit Escapezeichen versehen, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname jedoch enthält? oder %, Blobname muss in der URL codiert werden. z. B. ein Blob mit dem Namen "my?blob%", sollte die URL "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" sein.

pipeline: PipelineLike

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen, oder stellen Sie eine benutzerdefinierte Pipeline bereit.

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

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

Parameter

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

options: StoragePipelineOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Erstellt eine Instanz von BlockBlobClient.

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

Parameter

connectionString: string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für eine Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Beispiel für eine SAS-Verbindungszeichenfolge: 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

Der Containername.

blobName: string

Blobname.

options: StoragePipelineOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Eigenschaft

containerName

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

string containerName

Eigenschaftswert

string

name

Der Name des Blobs.

string name

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName

accountName: string

Eigenschaftswert

string

Geerbt vonBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Geerbt vonBlobClient.credential

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt vonBlobClient.url

Details zur Methode

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Schreibt ein BLOB, indem die Liste der Block-IDs angegeben wird, aus denen sich das BLOB zusammensetzt. Um als Teil eines Blobs geschrieben zu werden, muss ein Block in einem vorherigen stageBlock-Vorgang erfolgreich auf den Server geschrieben worden sein. Sie können commitBlockList aufrufen, um ein Blob zu aktualisieren, indem Sie nur die geänderten Blöcke hochladen und dann die neuen und vorhandenen Blöcke gemeinsam committen. Alle Blöcke, die nicht in der Blockliste angegeben und endgültig gelöscht wurden.

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

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

Parameter

blocks: string[]

Array mit einem 64-Byte-Wert, der base64-codiert ist

options: BlockBlobCommitBlockListOptions

Optionen für den Vorgang Block Blob Commit Block List.

Gibt zurück

Promise<BlockBlobCommitBlockListResponse>

Antwortdaten für den Vorgang Block Blob Commit Block List.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Gibt die Liste der Blöcke zurück, die als Teil eines Blockblobs mithilfe des angegebenen Blocklistenfilters hochgeladen wurden.

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

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

Parameter

listType: BlockListType

Gibt an, ob die Liste der Blöcke mit ausgeführtem Commit, die Liste der Blöcke ohne ausgeführten Commit oder beide Listen zusammen zurückgegeben werden.

options: BlockBlobGetBlockListOptions

Optionen für den Vorgang Block Blob Get Block List.

Gibt zurück

Promise<BlockBlobGetBlockListResponse>

Antwortdaten für den Vorgang Blockblob Abrufen einer Blockliste.

query(string, BlockBlobQueryOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Schnelle Abfrage für ein JSON- oder CSV-formatiertes Blob.

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

Parameter

query: string

options: BlockBlobQueryOptions

Gibt zurück

Promise<BlobDownloadResponseModel>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

Lädt den angegebenen Block in den "Stagingbereich" des Blockblobs hoch, um später durch einen Aufruf von commitBlockList committet zu werden.

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

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

Parameter

blockId: string

Ein 64-Byte-Wert, der base64-codiert ist

body: HttpRequestBody

Daten, die in den Stagingbereich hochgeladen werden sollen.

contentLength: number

Anzahl der hochzuladenden Bytes.

options: BlockBlobStageBlockOptions

Optionen für den Blockvorgang Block der Blobphase.

Gibt zurück

Promise<BlockBlobStageBlockResponse>

Antwortdaten für den Blockvorgang Block der Blobphase.

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

Der Vorgang Stage Block From URL erstellt einen neuen Block, der als Teil eines Blobs committet werden soll, in dem der Inhalt aus einer URL gelesen wird. Diese API ist ab Version 2018-03-28 verfügbar.

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

Parameter

blockId: string

Ein 64-Byte-Wert, der base64-codiert ist

sourceURL: string

Gibt die URL des Blobs an. Der Wert kann eine URL mit einer Länge von bis zu 2 KB sein, die ein Blob angibt. Der Wert sollte so URL-codiert sein, wie er in einem Anforderungs-URI verwendet wird. Das Quellblob muss entweder öffentlich sein oder über eine Shared Access Signature authentifiziert werden. Wenn das Quellblob öffentlich ist, ist keine Authentifizierung erforderlich, um den Vorgang auszuführen. Hier sind einige Beispiele für Quellobjekt-URLs: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

Ab welcher Position des herunterzuladenden Blobs größer oder gleich 0

count: number

Wie viele Daten heruntergeladen werden sollen, größer als 0. Wird bis zum Ende heruntergeladen, wenn nicht definiert

options: BlockBlobStageBlockFromURLOptions

Optionen für den Vorgang Block Blob Stage Block From URL.

Gibt zurück

Promise<BlockBlobStageBlockFromURLResponse>

Antwortdaten für den Vorgang Block Blob Stage Block From URL.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Erstellt ein neues Blockblob, in dem der Inhalt des Blobs aus einer bestimmten URL gelesen wird. Diese API wird ab version 2020-04-08 unterstützt. Partielle Updates werden mit Put Blob from URL nicht unterstützt. Der Inhalt eines vorhandenen Blobs wird mit dem Inhalt des neuen Blobs überschrieben. Verwenden Sie stageBlockFromURL und commitBlockList, um partielle Aktualisierungen des Inhalts eines Blockblobs mithilfe einer Quell-URL durchzuführen.

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

Parameter

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Optionale Parameter.

Gibt zurück

Promise<BlockBlobPutBlobFromUrlResponse>

upload(HttpRequestBody, number, BlockBlobUploadOptions)

Erstellt ein neues Blockblob oder aktualisiert den Inhalt eines vorhandenen Blockblobs. Beim Aktualisieren eines vorhandenen Block-BLOB werden alle vorhandenen Metadaten im BLOB überschrieben. Partielle Updates werden nicht unterstützt. Der Inhalt des vorhandenen Blobs wird mit dem neuen Inhalt überschrieben. Verwenden Sie stageBlock und commitBlockList, um eine partielle Aktualisierung eines Blockblobs durchzuführen.

Dies ist eine nicht parallele Uploadmethode. Verwenden Sie uploadFile, uploadStream oder uploadBrowserData , um eine bessere Leistung bei Parallelitätsuploads zu erzielen.

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

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

Parameter

body: HttpRequestBody

Blob, String, ArrayBuffer, ArrayBufferView oder eine Funktion, die einen neuen lesbaren Datenstrom zurückgibt, dessen Offset vom Anfang der Datenquelle stammt.

contentLength: number

Länge des Texts in Bytes. Verwenden Sie Buffer.byteLength(), um die Länge des Texts für eine Zeichenfolge zu berechnen, einschließlich nicht base64/Hex-codierter Zeichen.

options: BlockBlobUploadOptions

Optionen für den Vorgang Blobupload blockieren.

Gibt zurück

Promise<BlockBlobUploadResponse>

Antwortdaten für den Vorgang Blobupload blockieren.

Beispielverwendung:

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Warnung

Diese API ist nun veraltet.

Use uploadData instead.

NUR IN BROWSERN VERFÜGBAR.

Lädt ein Browser-Blob/File/ArrayBuffer/ArrayBufferView-Objekt hoch, um blobs zu blockieren.

Wenn die Pufferlänge kleiner als oder gleich 256 MB ist, verwendet diese Methode 1 Uploadaufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock auf, um Blöcke hochzuladen, und schließlich ruft commitBlockList auf, um die Blockliste zu committen.

Eine gängige blobHTTPHeaders-Option , die festgelegt werden soll, ist blobContentType, sodass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.

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

Parameter

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer oder ArrayBufferView

options: BlockBlobParallelUploadOptions

Optionen zum Hochladen von Browserdaten.

Gibt zurück

Promise<BlobUploadCommonResponse>

Antwortdaten für den Blobuploadvorgang.

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

Lädt ein Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView-Objekt in ein BlockBlob hoch.

Wenn die Datenlänge nicht größer als die angegebene maxSingleShotSize ist (Standardeinstellung <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), verwendet diese Methode 1 Upload-Aufruf , um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock auf, um Blöcke hochzuladen, und schließlich ruft commitBlockList auf, um die Blockliste zu committen.

Eine gängige blobHTTPHeaders-Option , die festgelegt werden soll, ist blobContentType, sodass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.

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

Parameter

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

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

options: BlockBlobParallelUploadOptions

Gibt zurück

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt eine lokale Datei in Blöcken in ein Blockblob hoch.

Wenn die Dateigröße kleiner als oder gleich 256 MB ist, verwendet diese Methode 1 Uploadaufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock auf, um Blöcke hochzuladen, und schließlich ruft commitBlockList auf, um die Blockliste zu committen.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parameter

filePath: string

Vollständiger Pfad der lokalen Datei

options: BlockBlobParallelUploadOptions

Optionen zum Upload to Block Blob-Vorgang.

Gibt zurück

Promise<BlobUploadCommonResponse>

Antwortdaten für den Blobuploadvorgang.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt einen Node.js lesbaren Stream in Blockblob hoch.

TIPPS ZUR LEISTUNGSVERBESSERUNG:

Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem parameter bufferSize festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.

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

Parameter

stream: Readable

Node.js lesbarer Stream

bufferSize: number

Größe jedes zugeordneten Puffers, auch die Blockgröße im hochgeladenen Blockblob. Der Standardwert ist 8 MB.

maxConcurrency: number

Maximale Parallelität gibt die maximale Anzahl von Puffern an, die zugeordnet werden können, positive Korrelation mit maximaler Upload-Parallelität. Standardwert ist 5

options: BlockBlobUploadStreamOptions

Optionen zum Hochladen von Stream to Block Blob-Vorgängen.

Gibt zurück

Promise<BlobUploadCommonResponse>

Antwortdaten für den Blobuploadvorgang.

withSnapshot(string)

Erstellt ein neues BlockBlobClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und eine URL an das Basisblob zurückzugeben.

function withSnapshot(snapshot: string): BlockBlobClient

Parameter

snapshot: string

Der Momentaufnahmezeitstempel.

Gibt zurück

BlockBlobClient

Ein neues BlockBlobClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel.

Details zur geerbten Methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Bricht einen ausstehenden asynchronen Kopierblobvorgang ab und belässt ein Zielblob mit der Länge null und vollständigen Metadaten. Version 2012-02-12 und höher.

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

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

Parameter

copyId: string

ID des Vorgangs "Aus URL kopieren".

options: BlobAbortCopyFromURLOptions

Optionale Optionen für den Vorgang Blobabbruch kopieren von URL.

Gibt zurück

Promise<BlobAbortCopyFromURLResponse>

Geerbt vonBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopiert ein Blob asynchron in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis der Kopiervorgang abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen ist, indem Sie auf dem Poller aufrufen cancelOperation . Beachten Sie, dass der onProgress-Rückruf nicht aufgerufen wird, wenn der Vorgang in der ersten Anforderung abgeschlossen ist und der Versuch, eine abgeschlossene Kopie abzubrechen, zu einem Fehler führt.

In Version 2012-02-12 und höher kann die Quelle für einen Kopierblobvorgang ein Commitblob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann die Quelle für einen Kopiervorgang blob eine Azure-Datei in einem beliebigen Azure-Speicherkonto sein. Das Kopieren aus einem anderen Speicherkonto durch den Copy Blob-Vorgang wird jedoch nur für Speicherkonten unterstützt, die ab dem 7. Juni 2012 erstellt wurden.

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

Beispiel für automatische Abrufe:

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

Beispiel für manuelle Abrufe:

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

Beispiel für Statusaktualisierungen:

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

Beispiel für die Verwendung eines sich ändernden Abrufintervalls (Standard 15 Sekunden):

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

Beispiel für die Verwendung des Kopierabbruchs:

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

Parameter

copySource: string

url zur Azure Blob/File-Quelle.

options: BlobBeginCopyFromURLOptions

Optionale Optionen für den Vorgang BlobStart Copy From URL( Blob Start Copy From URL).

Gibt zurück

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

Geerbt vonBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Erstellt eine schreibgeschützte Momentaufnahme eines BLOB.

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

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

Parameter

options: BlobCreateSnapshotOptions

Optionale Optionen für den Vorgang "Blobmomentaufnahme erstellen".

Gibt zurück

Promise<BlobCreateSnapshotResponse>

Geerbt vonBlobClient.createSnapshot

delete(BlobDeleteOptions)

Markiert das angegebene Blob oder die angegebene Momentaufnahme zum Löschen. Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang Blob löschen löschen.

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

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

Parameter

options: BlobDeleteOptions

Optionale Optionen für blob delete-Vorgang.

Gibt zurück

Promise<BlobDeleteResponse>

Geerbt vonBlobClient.delete

deleteIfExists(BlobDeleteOptions)

Markiert das angegebene Blob oder die angegebene Momentaufnahme zum Löschen, sofern vorhanden. Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang Blob löschen löschen.

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

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

Parameter

options: BlobDeleteOptions

Optionale Optionen für blob delete-Vorgang.

Gibt zurück

Promise<BlobDeleteIfExistsResponse>

Geerbt vonBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Löschen Sie die Unmutablilitätsrichtlinie für das Blob.

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

Parameter

options: BlobDeleteImmutabilityPolicyOptions

Optionale Optionen zum Löschen der Unveränderlichkeitsrichtlinie für das Blob.

Gibt zurück

Promise<BlobDeleteImmutabilityPolicyResponse>

Geerbt vonBlobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

Liest oder lädt ein Blob aus dem System herunter, einschließlich seiner Metadaten und Eigenschaften. Sie können auch Get Blob aufrufen, um eine Momentaufnahme zu lesen.

In Node.js werden Daten in einem lesbaren Stream zurückgegebenStreamBody
In Browsern werden Daten in einer Zusage blobBody zurückgegeben.

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

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

Parameter

offset: number

Ab welcher Position des herunterzuladenden Blobs größer oder gleich 0

count: number

Wie viele Daten heruntergeladen werden sollen, größer als 0. Wird bis zum Ende heruntergeladen, wenn nicht definiert

options: BlobDownloadOptions

Optionale Optionen für blobdownload-Vorgang.

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

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

Gibt zurück

Promise<BlobDownloadResponseParsed>

Geerbt vonBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden.

Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.

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

Parameter

buffer: Buffer

Puffer, der gefüllt werden soll, muss eine Länge haben, die größer als die Anzahl ist

offset: number

Von welcher Position des Blockblobs heruntergeladen werden soll (in Bytes)

count: number

Wie viele Daten (in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined an das Ende heruntergeladen.

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

Geerbt vonBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden.

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

Parameter

offset: number

Von welcher Position des Blockblobs heruntergeladen werden soll (in Bytes)

count: number

Wie viele Daten (in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined an das Ende heruntergeladen.

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

Geerbt vonBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt ein Azure Blob in eine lokale Datei herunter. Schlägt fehl, wenn der angegebene Dateipfad bereits beendet wird. Offset und Count sind optional, übergeben 0 bzw. undefiniert, um das gesamte Blob herunterzuladen.

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

Parameter

filePath: string

offset: number

Von welcher Position des Blockblobs heruntergeladen werden soll.

count: number

Wie viele Daten heruntergeladen werden sollen. Wird bis zum Ende heruntergeladen, wenn undefined übergeben wird.

options: BlobDownloadOptions

Optionen für Blobdownloadoptionen.

Gibt zurück

Promise<BlobDownloadResponseParsed>

Die Antwortdaten für den Blobdownloadvorgang, aber mit readableStreamBody, der auf undefined festgelegt ist, da der Inhalt bereits gelesen und im angegebenen Pfad in eine lokale Datei geschrieben wird.

Geerbt vonBlobClient.downloadToFile

exists(BlobExistsOptions)

Gibt true zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. false andernfalls.

HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, da ein vorhandenes Blob möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Blobs von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

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

Parameter

options: BlobExistsOptions

Options to Exists-Vorgang.

Gibt zurück

Promise<boolean>

Geerbt vonBlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

Nur für BlobClient verfügbar, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature, Shared Access Signature) von Blob Service basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

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

Parameter

options: BlobGenerateSasUrlOptions

Optionale Parameter.

Gibt zurück

Promise<string>

Der SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.

Geerbt vonBlobClient.generateSasUrl

getAppendBlobClient()

Erstellt ein AppendBlobClient-Objekt.

function getAppendBlobClient(): AppendBlobClient

Gibt zurück

AppendBlobClient

Geerbt vonBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Rufen Sie einen BlobLeaseClient ab, der Leases für das Blob verwaltet.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parameter

proposeLeaseId: string

Anfänglich vorgeschlagene Lease-ID.

Gibt zurück

BlobLeaseClient

Ein neues BlobLeaseClient-Objekt zum Verwalten von Leases für das Blob.

Geerbt vonBlobClient.getBlobLeaseClient

getBlockBlobClient()

Erstellt ein BlockBlobClient-Objekt.

function getBlockBlobClient(): BlockBlobClient

Gibt zurück

BlockBlobClient

Geerbt vonBlobClient.getBlockBlobClient

getPageBlobClient()

Erstellt ein PageBlobClient-Objekt.

function getPageBlobClient(): PageBlobClient

Gibt zurück

PageBlobClient

Geerbt vonBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für das BLOB zurück. Der Inhalt des BLOB wird nicht zurückgegeben.

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

WARNUNG: Das metadata in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden von ContainerClient zurückgegeben werden, die Blobs mithilfe der includeMetadata Option auflisten, die ihre ursprüngliche Groß- und Kleinschreibung beibehalten.

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

Parameter

options: BlobGetPropertiesOptions

Optionale Optionen für den Vorgang "Eigenschaften abrufen".

Gibt zurück

Promise<BlobGetPropertiesResponse>

Geerbt vonBlobClient.getProperties

getTags(BlobGetTagsOptions)

Ruft die Tags ab, die dem zugrunde liegenden Blob zugeordnet sind.

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

Parameter

options: BlobGetTagsOptions

Gibt zurück

Promise<BlobGetTagsResponse>

Geerbt vonBlobClient.getTags

setAccessTier(string, BlobSetTierOptions)

Legt die Ebene für ein Blob fest. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp Hot/Cool/Archive. Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert.

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

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

Parameter

tier: string

Die Ebene, die für das Blob festgelegt werden soll. Gültige Werte sind Hot, Cool oder Archive.

options: BlobSetTierOptions

Optionale Optionen für den Vorgang Blobsatzebene.

Gibt zurück

Promise<BlobSetTierResponse>

Geerbt vonBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Legt Systemeigenschaften für den Blob fest.

Wenn kein Wert oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne Wert gelöscht.

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

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

Parameter

blobHTTPHeaders: BlobHTTPHeaders

Wenn kein Wert oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne Wert gelöscht. Ein allgemeiner Header, der festgelegt werden soll, ist blobContentType es dem Browser zu ermöglichen, Funktionen basierend auf dem Dateityp bereitzustellen.

options: BlobSetHTTPHeadersOptions

Optionale Optionen für den Vorgang Blobsatz-HTTP-Header.

Gibt zurück

Promise<BlobSetHTTPHeadersResponse>

Geerbt vonBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Legen Sie die Richtlinie für die Unmutablilität für das Blob fest.

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

Parameter

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Optionale Optionen zum Festlegen einer Unveränderlichkeitsrichtlinie für das Blob.

Gibt zurück

Promise<BlobSetImmutabilityPolicyResponse>

Geerbt vonBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Legen Sie den rechtlichen Halteraum für das Blob fest.

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

Parameter

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Optionale Optionen zum Festlegen der rechtlichen Aufbewahrung für das Blob.

Gibt zurück

Promise<BlobSetLegalHoldResponse>

Geerbt vonBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Legt benutzerdefinierte Metadaten für das angegebene Blob als mindestens ein Name-Wert-Paar fest.

Wenn keine Option oder keine im Parameter definierten Metadaten angegeben sind, werden die Blobmetadaten entfernt.

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

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

Parameter

metadata: Metadata

Ersetzen Sie vorhandene Metadaten durch diesen Wert. Wenn kein Wert angegeben ist, werden die vorhandenen Metadaten entfernt.

options: BlobSetMetadataOptions

Optionale Optionen zum Festlegen des Metadatenvorgangs.

Gibt zurück

Promise<BlobSetMetadataResponse>

Geerbt vonBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein. Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen umfassen Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), plus ('+'), Minuszeichen ('-'), Punkt ('.'), Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_') .

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

Parameter

tags: Tags

options: BlobSetTagsOptions

Gibt zurück

Promise<BlobSetTagsResponse>

Geerbt vonBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Der synchrone Kopiervorgang von URL kopiert ein Blob oder eine Internetressource in ein neues Blob. Es wird erst dann eine Antwort zurückgegeben, wenn die Kopie abgeschlossen ist.

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

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

Parameter

copySource: string

Die Quell-URL, aus der kopiert werden soll. Shared Access Signature (SAS) wird möglicherweise für die Authentifizierung benötigt.

options: BlobSyncCopyFromURLOptions

Gibt zurück

Promise<BlobCopyFromURLResponse>

Geerbt vonBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Stellt den Inhalt und die Metadaten des vorläufig gelöschten Blobs und aller zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Das Rückgängigmachen von Blobs wird nur ab Version 2017-07-29 unterstützt.

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

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

Parameter

options: BlobUndeleteOptions

Optionale Optionen für den Vorgang "Blob Wiederherstellen".

Gibt zurück

Promise<BlobUndeleteResponse>

Geerbt vonBlobClient.undelete

withVersion(string)

Erstellt ein neues BlobClient-Objekt, das auf eine Version dieses Blobs verweist. Geben Sie "" an, um die versionId zu entfernen und einen Client an das Basisblob zurückzugeben.

function withVersion(versionId: string): BlobClient

Parameter

versionId: string

Die versionId.

Gibt zurück

BlobClient

Ein neues BlobClient-Objekt, das auf die Version dieses Blobs verweist.

Geerbt vonBlobClient.withVersion