BlockBlobClient class

Referenz

Paket:: @azure/storage-blob

BlockBlobClient definiert eine Reihe von Vorgängen, die für Block-Blobs 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 Block-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name 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 Block-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name 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	Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem `@azure/identity`-Paket zum Authentifizieren von Anforderungen an den Dienst. 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 das Blob besteht. Um als Teil eines BLOB geschrieben zu werden, muss ein Block erfolgreich auf den Server in einem vorherigen stageBlock--Vorgang geschrieben worden sein. Sie können commitBlockList- aufrufen, um ein Blob zu aktualisieren, indem Sie nur die Blöcke hochladen, die geändert wurden, und dann das Commit für die neuen und vorhandenen Blöcke zusammen ausführen. Alle Blöcke, die in der Sperrliste nicht angegeben und endgültig gelöscht wurden. Informationen finden Sie unter 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 Block-Blobs mithilfe des angegebenen Blocklistenfilters hochgeladen wurden. Informationen finden Sie unter 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, RequestBodyType, number, BlockBlobStageBlockOptions)	Lädt den angegebenen Block in den "Stagingbereich" des Block-Blobs hoch, der später von einem Aufruf von commitBlockList übernommen wird. Informationen finden Sie unter https://docs.microsoft.com/rest/api/storageservices/put-block.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Der Vorgang "Phasenblock von URL" erstellt einen neuen Block, der als Teil eines Blobs zugesichert wird, in dem der Inhalt aus einer URL gelesen wird. Diese API ist ab Version 2018-03-28 verfügbar. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Erstellt ein neues Block-Blob, in dem der Inhalt des Blobs aus einer bestimmten URL gelesen wird. Diese API wird ab der Version 2020-04-08 unterstützt. Partielle Updates werden mit Put Blob von URL nicht unterstützt; Der Inhalt eines vorhandenen Blobs wird mit dem Inhalt des neuen Blobs überschrieben. Verwenden Sie stageBlockFromURL- und commitBlockList-, um Teilaktualisierungen für den Inhalt eines Block-Blobs mithilfe einer Quell-URL auszuführen.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Erstellt ein neues Block-Blob oder aktualisiert den Inhalt eines vorhandenen Block-Blobs. Beim Aktualisieren eines vorhandenen Block-Blobs 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 teilweise Aktualisierung der Block-Blobs durchzuführen. Dies ist eine nicht parallele Uploadmethode, verwenden Sie bitte uploadFile-, uploadStream- oder uploadBrowserData- für eine bessere Leistung beim Parallelupload. Informationen finden Sie unter 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 blob zu blockieren. Wenn die Pufferlänge kleiner oder gleich 256 MB ist, verwendet diese Methode 1 Uploadaufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock- zum Hochladen von Blöcken auf und rufen schließlich commitBlockList- auf, um die Blockliste zu übernehmen. Eine gängige blobHTTPHeaders Option zum Festlegen ist `blobContentType`, sodass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Lädt einen Puffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView -Objekt in ein BlockBlob hoch. Wenn die Datenlänge nicht mehr als die angegebene maxSingleShotSize ist (Standard ist <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), verwendet diese Methode 1 Upload Aufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock- zum Hochladen von Blöcken auf und rufen schließlich commitBlockList- auf, um die Blockliste zu übernehmen. Eine gängige blobHTTPHeaders Option zum Festlegen 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öcke in ein Block-BLOB hoch. Wenn die Dateigröße kleiner 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 commitBlockList aufrufen, um die Blockliste zu übernehmen.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt einen Node.js lesbaren Datenstrom in block-BLOB hoch. TIPPS ZUR LEISTUNGSVERBESSERUNG: Input stream highWaterMark is better to set a same value with bufferSize parameter, which will avoid Buffer.concat() operations.
withSnapshot(string)	Erstellt ein neues BlockBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Snapshot-Zeitstempel. Stellen Sie "" bereit, um die Momentaufnahme zu entfernen und eine URL zum Basis-Blob zurückzugeben.

Geerbte Methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Bricht einen ausstehenden asynchronen Kopier-Blob-Vorgang ab und belässt ein Ziel-Blob mit null Länge und vollständigen Metadaten. Version 2012-02-12 und höher. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Kopiert asynchron ein BLOB in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Kopie abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen wird, indem Sie `cancelOperation` für den Abrufer aufrufen. 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, führt zu einem Fehler, der ausgelöst wird. In Version 2012-02-12 und höher kann die Quelle für einen Kopier-Blob-Vorgang ein zugesichertes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann es sich bei der Quelle für einen Kopier-BLOB-Vorgang um eine Azure-Datei in einem beliebigen Azure-Speicherkonto handeln. Nur Speicherkonten, die am oder nach dem 7. Juni 2012 erstellt wurden, ermöglichen es dem Kopier-BLOB-Vorgang, aus einem anderen Speicherkonto zu kopieren. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob. Beispiel für die automatische Abfrage: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Beispiel für die manuelle Abfrage: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Beispiel für die Verwendung von 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 Blobs. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob.
delete(BlobDeleteOptions)	Markiert das angegebene Blob oder die angegebene Momentaufnahme für das Löschen. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
deleteIfExists(BlobDeleteOptions)	Markiert den angegebenen Blob oder die angegebene Momentaufnahme für den Löschvorgang, falls vorhanden. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Löschen Sie die Immutablilitä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 get Blob auch aufrufen, um eine Momentaufnahme zu lesen. In Node.jswerden Daten in einem lesbaren Stream lesbarStreamBody zurückgegeben. In Browsern werden Daten in einem Zusage blobBody zurückgegeben Informationen finden Sie unter 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 Anzahl sind optional, lädt das gesamte BLOB herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Anzahl sind optional, lädt das gesamte BLOB herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-.
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 Anzahl sind optional, übergeben 0 und nicht definiert, um das gesamte Blob herunterzuladen.
exists(BlobExistsOptions)	Gibt "true" zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. andernfalls "false". HINWEIS: Verwenden Sie diese Funktion mit Bedacht, 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 wurde.
generateSasStringToSign(BlobGenerateSasUrlOptions)	Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde. Generiert Zeichenfolge zum Signieren für einen SAS-URI (Blob Service Shared Access Signature) basierend auf den clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateSasUrl(BlobGenerateSasUrlOptions)	Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde. Generiert einen SAS-URI (Blob Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde. Generiert Zeichenfolge zum Signieren für einen SAS-URI (Blob Service Shared Access Signature) basierend auf den clienteigenschaften und Parametern, die übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	Generiert einen SAS-URI (Blob Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getAccountInfo(BlobGetAccountInfoOptions)	Der Vorgang "Kontoinformationen abrufen" gibt den SKU-Namen und die Kontoart für das angegebene Konto zurück. Der Vorgang "Kontoinformationen abrufen" ist in Dienstversionen ab Version 2018-03-28 verfügbar. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information.
getAppendBlobClient()	Erstellt ein AppendBlobClient -Objekt.
getBlobLeaseClient(string)	Rufen Sie eine BlobLeaseClient- ab, die Leases für das Blob verwaltet.
getBlockBlobClient()	Erstellt ein BlockBlobClient -Objekt.
getPageBlobClient()	Erstellt ein PageBlobClient -Objekt.
getProperties(BlobGetPropertiesOptions)	Gibt alle benutzerdefinierten Metadaten, Standard-HTTP-Eigenschaften und Systemeigenschaften für das Blob zurück. Der Inhalt des BLOB wird nicht zurückgegeben. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties. WARNUNG: Das in der Antwort zurückgegebene `metadata`-Objekt weist die 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, die Blobs mithilfe der option `includeMetadata` auflisten, die ihre ursprüngliche Groß-/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 in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Legt Systemeigenschaften für das Blob fest. Wenn kein Wert angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Legen Sie die Unveränderlichkeitsrichtlinie für das Blob fest.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Legen Sie den gesetzlichen Halteraum für das Blob fest.
setMetadata(Metadata, BlobSetMetadataOptions)	Legt benutzerdefinierte Metadaten für das angegebene Blob als ein oder mehrere Name-Wert-Paare fest. Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die BLOB-Metadaten entfernt. Informationen finden Sie unter 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. Tagtasten müssen zwischen 1 und 128 Zeichen bestehen. Tagwerte müssen zwischen 0 und 256 Zeichen bestehen. Gültige Tagschlüssel- und Wertzeichen umfassen Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), 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. Sie gibt erst dann eine Antwort zurück, wenn die Kopie abgeschlossen ist. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url.
undelete(BlobUndeleteOptions)	Stellt den Inhalt und die Metadaten eines vorläufig gelöschten Blobs und alle zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Undelete Blob wird nur unter Version 2017-07-29 oder höher unterstützt. Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.
withVersion(string)	Erstellt ein neues BlobClient -Objekt, das auf eine Version dieses Blob zeigt. Geben Sie "" entfernt die versionId und gibt einen Client an das Basis-Blob zurück.

Details zum Konstruktor

BlockBlobClient(string, PipelineLike)

Erstellt eine Instanz von BlockBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Block-Blob zeigt. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name enthält? oder %muss der BLOB-Name in der URL codiert werden.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parameter

url: string

Eine URL-Zeichenfolge, die auf das Azure Storage-Block-Blob verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blob verweist. Codierte URL-Zeichenfolge wird nicht zweimal escapet, es werden nur Sonderzeichen im URL-Pfad escaped. Wenn ein BLOB-Name jedoch enthält? oder %muss der BLOB-Name in der URL codiert werden. Wie 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 eine angepasste Pipeline bereitzustellen.

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

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

Parameter

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

options: StoragePipelineOptions

Wahlfrei. 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 : Kontoverbindungszeichenfolge kann nur in NODE.JS Laufzeit verwendet werden. ] Beispiel für kontoverbindungszeichenfolge - beispiel für DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net 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

Containername.

blobName: string

Blobname.

options: StoragePipelineOptions

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

vonBlobClient.credential geerbt

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

vonBlobClient.url geerbt

Details zur Methode

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Schreibt ein BLOB, indem die Liste der Block-IDs angegeben wird, aus denen das Blob besteht. Um als Teil eines BLOB geschrieben zu werden, muss ein Block erfolgreich auf den Server in einem vorherigen stageBlock--Vorgang geschrieben worden sein. Sie können commitBlockList- aufrufen, um ein Blob zu aktualisieren, indem Sie nur die Blöcke hochladen, die geändert wurden, und dann das Commit für die neuen und vorhandenen Blöcke zusammen ausführen. Alle Blöcke, die in der Sperrliste nicht angegeben und endgültig gelöscht wurden.

Informationen finden Sie unter https://docs.microsoft.com/rest/api/storageservices/put-block-list.

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

Parameter

blocks: string[]

Array von 64-Byte-Werten, die base64-codiert sind

options: BlockBlobCommitBlockListOptions

Optionen für den Block-Blob-Commit-Sperrlistenvorgang.

Gibt zurück

Promise<BlockBlobCommitBlockListResponse>

Antwortdaten für den Block blob Commit-Sperrlistenvorgang.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

Informationen finden Sie unter 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 zugesicherten Blöcke, die Liste der nicht ausgelassenen Blöcke oder beide Listen zusammen zurückgegeben werden soll.

options: BlockBlobGetBlockListOptions

Optionen für den Block blob Get Block List-Vorgang.

Gibt zurück

Promise<BlockBlobGetBlockListResponse>

Antwortdaten für den Block blob Get Block List-Vorgang.

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, RequestBodyType, number, BlockBlobStageBlockOptions)

Lädt den angegebenen Block in den "Stagingbereich" des Block-Blobs hoch, der später von einem Aufruf von commitBlockList übernommen wird.

Informationen finden Sie unter https://docs.microsoft.com/rest/api/storageservices/put-block.

function stageBlock(blockId: string, body: RequestBodyType, 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

Die Anzahl der Bytes, die hochgeladen werden sollen.

options: BlockBlobStageBlockOptions

Optionen für den Blockierungsvorgang für blob-Phasen.

Gibt zurück

Promise<BlockBlobStageBlockResponse>

Antwortdaten für den Block-Blob-Phasenblock-Vorgang.

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

Der Vorgang "Phasenblock von URL" erstellt einen neuen Block, der als Teil eines Blobs zugesichert wird, in dem der Inhalt aus einer URL gelesen wird. Diese API ist ab Version 2018-03-28 verfügbar.

Informationen finden Sie unter 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 von bis zu 2 KB Länge sein, die ein Blob angibt. Der Wert sollte URL-codiert sein, wie er in einem Anforderungs-URI angezeigt wird. Das Quell-BLOB muss entweder öffentlich sein oder über eine freigegebene Zugriffssignatur authentifiziert werden. Wenn das Quell-BLOB ö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

Von welcher Position des blob heruntergeladen werden soll, größer oder gleich 0

count: number

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

options: BlockBlobStageBlockFromURLOptions

Optionen für den Vorgang "Block block from URL" für "Blob-Phase blockieren".

Gibt zurück

Promise<BlockBlobStageBlockFromURLResponse>

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Erstellt ein neues Block-Blob, in dem der Inhalt des Blobs aus einer bestimmten URL gelesen wird. Diese API wird ab der Version 2020-04-08 unterstützt. Partielle Updates werden mit Put Blob von URL nicht unterstützt; Der Inhalt eines vorhandenen Blobs wird mit dem Inhalt des neuen Blobs überschrieben. Verwenden Sie stageBlockFromURL- und commitBlockList-, um Teilaktualisierungen für den Inhalt eines Block-Blobs mithilfe einer Quell-URL auszuführen.

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

Parameter

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Optionale Parameter.

Gibt zurück

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Erstellt ein neues Block-Blob oder aktualisiert den Inhalt eines vorhandenen Block-Blobs. Beim Aktualisieren eines vorhandenen Block-Blobs 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 teilweise Aktualisierung der Block-Blobs durchzuführen.

Dies ist eine nicht parallele Uploadmethode, verwenden Sie bitte uploadFile-, uploadStream- oder uploadBrowserData- für eine bessere Leistung beim Parallelupload.

Informationen finden Sie unter https://docs.microsoft.com/rest/api/storageservices/put-blob.

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

Parameter

body: HttpRequestBody

Blob, Zeichenfolge, ArrayBuffer, ArrayBufferView oder eine Funktion, die einen neuen lesbaren Datenstrom zurückgibt, dessen Offset von Der Datenquelle beginnt.

contentLength: number

Länge des Textkörpers in Byte. Verwenden Sie Buffer.byteLength() zum Berechnen der Textlänge für eine Zeichenfolge, einschließlich nicht base64/Hex-codierter Zeichen.

options: BlockBlobUploadOptions

Optionen für den Vorgang "Blob-Upload blockieren".

Gibt zurück

Promise<BlockBlobUploadResponse>

Antwortdaten für den Vorgang "Blob-Upload 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 blob zu blockieren.

Wenn die Pufferlänge kleiner oder gleich 256 MB ist, verwendet diese Methode 1 Uploadaufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock- zum Hochladen von Blöcken auf und rufen schließlich commitBlockList- auf, um die Blockliste zu übernehmen.

Eine gängige blobHTTPHeaders Option zum Festlegen 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, Datei, ArrayBuffer oder ArrayBufferView

options: BlockBlobParallelUploadOptions

Optionen zum Hochladen von Browserdaten.

Gibt zurück

Promise<BlobUploadCommonResponse>

Antwortdaten für den Blob-Upload-Vorgang.

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

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

Wenn die Datenlänge nicht mehr als die angegebene maxSingleShotSize ist (Standard ist <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), verwendet diese Methode 1 Upload Aufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode stageBlock- zum Hochladen von Blöcken auf und rufen schließlich commitBlockList- auf, um die Blockliste zu übernehmen.

Eine gängige blobHTTPHeaders Option zum Festlegen 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öcke in ein Block-BLOB hoch.

Wenn die Dateigröße kleiner 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 commitBlockList aufrufen, um die Blockliste zu übernehmen.

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

Parameter

filePath: string

Vollständiger Pfad der lokalen Datei

options: BlockBlobParallelUploadOptions

Optionen zum Hochladen zum Blockieren des Blob-Vorgangs.

Gibt zurück

Promise<BlobUploadCommonResponse>

Antwortdaten für den Blob-Upload-Vorgang.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt einen Node.js lesbaren Datenstrom in block-BLOB hoch.

TIPPS ZUR LEISTUNGSVERBESSERUNG:

Input stream highWaterMark is better to set a same value with bufferSize parameter, which will avoid Buffer.concat() operations.

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

Parameter

stream: Readable

Node.js Lesbarer Datenstrom

bufferSize: number

Größe jedes zugeordneten Puffers, auch die Blockgröße im hochgeladenen Block-BLOB. Standardwert ist 8 MB

maxConcurrency: number

Maximale Parallelität gibt die maximale Anzahl von Puffern an, die zugewiesen werden können, positive Korrelation mit der maximalen Uploadkoncurrency. Standardwert ist 5

options: BlockBlobUploadStreamOptions

Optionen zum Hochladen von Stream zum Blockieren des BLOB-Vorgangs.

Gibt zurück

Promise<BlobUploadCommonResponse>

Antwortdaten für den Blob-Upload-Vorgang.

withSnapshot(string)

Erstellt ein neues BlockBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Snapshot-Zeitstempel. Stellen Sie "" bereit, um die Momentaufnahme zu entfernen und eine URL zum Basis-Blob zurückzugeben.

function withSnapshot(snapshot: string): BlockBlobClient

Parameter

snapshot: string

Der Momentaufnahmezeitstempel.

Gibt zurück

BlockBlobClient

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

Details zur geerbten Methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Bricht einen ausstehenden asynchronen Kopier-Blob-Vorgang ab und belässt ein Ziel-Blob mit null Länge und vollständigen Metadaten. Version 2012-02-12 und höher.

Informationen finden Sie unter 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 "Von URL kopieren".

options: BlobAbortCopyFromURLOptions

Optionale Optionen für den Vorgang "BlobAbort Copy From URL".

Gibt zurück

Promise<BlobAbortCopyFromURLResponse>

geerbt vonBlobClient.abortCopyFromURL-

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopiert asynchron ein BLOB in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Kopie abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen wird, indem Sie cancelOperation für den Abrufer aufrufen. 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, führt zu einem Fehler, der ausgelöst wird.

In Version 2012-02-12 und höher kann die Quelle für einen Kopier-Blob-Vorgang ein zugesichertes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann es sich bei der Quelle für einen Kopier-BLOB-Vorgang um eine Azure-Datei in einem beliebigen Azure-Speicherkonto handeln. Nur Speicherkonten, die am oder nach dem 7. Juni 2012 erstellt wurden, ermöglichen es dem Kopier-BLOB-Vorgang, aus einem anderen Speicherkonto zu kopieren.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob.

Beispiel für die automatische Abfrage:

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

Beispiel für die manuelle Abfrage:

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

Beispiel für die Verwendung von 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 to the source Azure Blob/File.

options: BlobBeginCopyFromURLOptions

Optionale Optionen für den Blob Start Copy From URL-Vorgang.

Gibt zurück

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

geerbt vonBlobClient.beginCopyFromURL-

createSnapshot(BlobCreateSnapshotOptions)

Erstellt eine schreibgeschützte Momentaufnahme eines Blobs.

Informationen finden Sie unter 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 Blob Create Snapshot-Vorgang.

Gibt zurück

Promise<BlobCreateSnapshotResponse>

geerbt vonBlobClient.createSnapshot-

delete(BlobDeleteOptions)

Markiert das angegebene Blob oder die angegebene Momentaufnahme für das Löschen. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen.

Informationen finden Sie unter 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>

vonBlobClient.delete geerbt

deleteIfExists(BlobDeleteOptions)

Markiert den angegebenen Blob oder die angegebene Momentaufnahme für den Löschvorgang, falls vorhanden. Das Blob wird später während der Garbage Collection gelöscht. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang "Blob löschen" löschen.

Informationen finden Sie unter 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 Immutablilitä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 get Blob auch aufrufen, um eine Momentaufnahme zu lesen.

In Node.jswerden Daten in einem lesbaren Stream lesbarStreamBody zurückgegeben.
In Browsern werden Daten in einem Zusage blobBody zurückgegeben

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob.

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

Parameter

offset: number

Von welcher Position des blob heruntergeladen werden soll, größer oder gleich 0

count: number

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

options: BlobDownloadOptions

Optionale Optionen für den Blob-Downloadvorgang.

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>

vonBlobClient.download geerbt

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

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

Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Blobs, die größer als diese Größe sind, downloadToFile-.

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

Parameter

buffer: Buffer

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

offset: number

Von welcher Position des Block-Blobs heruntergeladen werden soll(in Bytes)

count: number

Wie viele Daten(in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined auf 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 Anzahl 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 Block-Blobs heruntergeladen werden soll(in Bytes)

count: number

Wie viele Daten(in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined auf 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 Anzahl sind optional, übergeben 0 und nicht definiert, 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 block-Blobs heruntergeladen werden soll.

count: number

Wie viele Daten heruntergeladen werden sollen. Wird beim Übergeben undefiniert auf das Ende heruntergeladen.

options: BlobDownloadOptions

Optionen für Blob-Downloadoptionen.

Gibt zurück

Promise<BlobDownloadResponseParsed>

Die Antwortdaten für den Blob-Downloadvorgang, aber mit "readableStreamBody" auf "undefiniert", da der Inhalt bereits in eine lokale Datei im angegebenen Pfad gelesen und geschrieben wurde.

Geerbt vonBlobClient.downloadToFile-

exists(BlobExistsOptions)

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

HINWEIS: Verwenden Sie diese Funktion mit Bedacht, 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 wurde.

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

Parameter

options: BlobExistsOptions

options to Exists operation.

Gibt zurück

Promise<boolean>

Geerbt vonBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert Zeichenfolge zum Signieren für einen SAS-URI (Blob Service Shared Access Signature) basierend auf den clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parameter

options: BlobGenerateSasUrlOptions

Optionale Parameter.

Gibt zurück

string

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

geerbt vonBlobClient.generateSasStringToSign-

generateSasUrl(BlobGenerateSasUrlOptions)

Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert einen SAS-URI (Blob Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Informationen finden Sie unter 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 Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

geerbt vonBlobClient.generateSasUrl-

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

Nur für BlobClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Parameter

options: BlobGenerateSasUrlOptions

Optionale Parameter.

userDelegationKey: UserDelegationKey

Rückgabewert von blobServiceClient.getUserDelegationKey()

Gibt zurück

string

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

Geerbt vonBlobClient.generateUserDelegationSasStringToSign-

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

Generiert einen SAS-URI (Blob Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Parameter

options: BlobGenerateSasUrlOptions

Optionale Parameter.

userDelegationKey: UserDelegationKey

Rückgabewert von blobServiceClient.getUserDelegationKey()

Gibt zurück

Promise<string>

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

geerbt vonBlobClient.generateUserDelegationSasUrl-

getAccountInfo(BlobGetAccountInfoOptions)

Der Vorgang "Kontoinformationen abrufen" gibt den SKU-Namen und die Kontoart für das angegebene Konto zurück. Der Vorgang "Kontoinformationen abrufen" ist in Dienstversionen ab Version 2018-03-28 verfügbar.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information.

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

Parameter

options: BlobGetAccountInfoOptions

Optionen für den Service Get Account Info-Vorgang.

Gibt zurück

Promise<BlobGetAccountInfoResponse>

Antwortdaten für den Service Get Account Info-Vorgang.

Geerbt vonBlobClient.getAccountInfo

getAppendBlobClient()

Erstellt ein AppendBlobClient -Objekt.

function getAppendBlobClient(): AppendBlobClient

Gibt zurück

AppendBlobClient

geerbt vonBlobClient.getAppendBlobClient-

getBlobLeaseClient(string)

Rufen Sie eine BlobLeaseClient- ab, die 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, Standard-HTTP-Eigenschaften und Systemeigenschaften für das Blob zurück. Der Inhalt des BLOB wird nicht zurückgegeben.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.

WARNUNG: Das in der Antwort zurückgegebene metadata-Objekt weist die 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, die Blobs mithilfe der option includeMetadata auflisten, die ihre ursprüngliche Groß-/Kleinschreibung beibehalten.

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

Parameter

options: BlobGetPropertiesOptions

Optionale Optionen zum Abrufen des Eigenschaftenvorgangs.

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>

VonBlobClient.getTags geerbt

setAccessTier(string, BlobSetTierOptions)

Legt die Ebene für ein Blob fest. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht.

Informationen finden Sie unter 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 Blob Set Tier-Vorgang.

Gibt zurück

Promise<BlobSetTierResponse>

Geerbt vonBlobClient.setAccessTier-

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Legt Systemeigenschaften für das Blob fest.

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

Informationen finden Sie unter 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 angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht. Eine allgemeine Kopfzeile, die festgelegt werden soll, ist blobContentType, die es dem Browser ermöglicht, Funktionen basierend auf dem Dateityp bereitzustellen.

options: BlobSetHTTPHeadersOptions

Optionale Optionen für den VORGANG "BLOB Set HTTP Headers".

Gibt zurück

Promise<BlobSetHTTPHeadersResponse>

vonBlobClient.setHTTPHeaders geerbt

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Legen Sie die Unveränderlichkeitsrichtlinie für das Blob fest.

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

Parameter

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Gibt zurück

Promise<BlobSetImmutabilityPolicyResponse>

Geerbt vonBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

Parameter

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Optionale Optionen zum Festlegen des gesetzlichen Halteraums für das Blob.

Gibt zurück

Promise<BlobSetLegalHoldResponse>

geerbt vonBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Legt benutzerdefinierte Metadaten für das angegebene Blob als ein oder mehrere Name-Wert-Paare fest.

Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die BLOB-Metadaten entfernt.

Informationen finden Sie unter 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 bereitgestellt wird, 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. Tagtasten müssen zwischen 1 und 128 Zeichen bestehen. Tagwerte müssen zwischen 0 und 256 Zeichen bestehen. Gültige Tagschlüssel- und Wertzeichen umfassen Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), 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. Sie gibt erst dann eine Antwort zurück, wenn die Kopie abgeschlossen ist.

Informationen finden Sie unter 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, ist möglicherweise für die Authentifizierung erforderlich.

options: BlobSyncCopyFromURLOptions

Gibt zurück

Promise<BlobCopyFromURLResponse>

geerbt vonBlobClient.syncCopyFromURL-

undelete(BlobUndeleteOptions)

Stellt den Inhalt und die Metadaten eines vorläufig gelöschten Blobs und alle zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Undelete Blob wird nur unter Version 2017-07-29 oder höher unterstützt.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.

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

Parameter

options: BlobUndeleteOptions

Optionale Optionen für blob Undelete-Vorgang.

Gibt zurück

Promise<BlobUndeleteResponse>

geerbt vonBlobClient.undelete

withVersion(string)

Erstellt ein neues BlobClient -Objekt, das auf eine Version dieses Blob zeigt. Geben Sie "" entfernt die versionId und gibt einen Client an das Basis-Blob zurück.

function withVersion(versionId: string): BlobClient

Parameter

versionId: string

Die versionId.

Gibt zurück

BlobClient

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

geerbt vonBlobClient.withVersion

Freigeben über

BlockBlobClient class

Konstruktoren

Eigenschaften

Geerbte Eigenschaften

Methoden

Geerbte Methoden

Details zum Konstruktor

BlockBlobClient(string, PipelineLike)

Parameter

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

Parameter

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parameter

Details zur Eigenschaft

containerName

Eigenschaftswert

name

Eigenschaftswert

Geerbte Eigenschaftsdetails

accountName

Eigenschaftswert

credential

Eigenschaftswert

url

Eigenschaftswert

Details zur Methode

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parameter

Gibt zurück

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parameter

Gibt zurück

query(string, BlockBlobQueryOptions)

Parameter

Gibt zurück

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parameter

Gibt zurück

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parameter

Gibt zurück

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

uploadFile(string, BlockBlobParallelUploadOptions)

Parameter

Gibt zurück

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parameter

Gibt zurück

withSnapshot(string)

Parameter

Gibt zurück

Details zur geerbten Methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parameter

Gibt zurück

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parameter

Gibt zurück

createSnapshot(BlobCreateSnapshotOptions)

Parameter

Gibt zurück

delete(BlobDeleteOptions)

Parameter

Gibt zurück

deleteIfExists(BlobDeleteOptions)

Parameter

Gibt zurück

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)