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

accountName
containerName	Der Name des Speichercontainers, dem das Blob zugeordnet ist.
credential	z. B. 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. Falls nicht angegeben, wird AnonymousCredential verwendet.
name	Der Name des Blobs.
url	Codierter URL-Zeichenfolgenwert.

Methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Bricht einen ausstehenden asynchronen Kopierblobvorgang ab und belässt ein Zielblob mit null Länge und vollständigen Metadaten. Version 2012-02-12 und höher.
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.
commitBlockList(string[], BlockBlobCommitBlockListOptions)	Schreibt ein BLOB, indem die Liste der Block-IDs angegeben wird, aus denen sich das BLOB zusammensetzt. Wenn ein Block als Teil eines BLOB geschrieben werden soll, muss er zuvor erfolgreich in einem <xref:stageBlock>-Vorgang auf den Server geschrieben worden sein. Sie können <xref:commitBlockList> aufrufen, um ein BLOB zu aktualisieren, indem Sie nur die Blöcke mit Änderungen hochladen und anschließend für die neuen und vorhandenen Blöcke einen Commit ausführen. Alle Blöcke, die nicht in der Blockliste angegeben und endgültig gelöscht wurden.
createSnapshot(BlobCreateSnapshotOptions)	Erstellt eine schreibgeschützte Momentaufnahme eines 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.
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.
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.
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob parallel in einen Puffer herunter. Offset und Count sind optional und 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 berücksichtigen <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob parallel in einen Puffer herunter. Offset und Count sind optional und 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 berücksichtigen <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob in eine lokale Datei herunter. Tritt ein Fehler auf, 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. 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 ist.
generateSasUrl(BlobGenerateSasUrlOptions)	Nur für BlobClient verfügbar, der mit anmeldegeschützten Schlüsseln erstellt wurde. Generiert einen SAS-URI (Shared Access Signature) des Blobdiensts basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.
getAppendBlobClient()	Erstellt ein AppendBlobClient-Objekt.
getBlobLeaseClient(string)	Rufen Sie eine ab <xref:BlobLeaseClient> , die Leases für das Blob verwaltet.
getBlockBlobClient()	Erstellt ein BlockBlobClient-Objekt.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Gibt die Liste der Blöcke zurück, die als Teil eines Blockblobs mithilfe des angegebenen Blocklistenfilters hochgeladen wurden.
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.
getTags(BlobGetTagsOptions)	Ruft die Tags ab, die dem zugrunde liegenden Blob zugeordnet sind.
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); }); }
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| 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 (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert.
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.
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.
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 ('_') .
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)	Lädt den angegebenen Block in den "Stagingbereich" des Blockblobs hoch, um ihn später durch einen Aufruf von commitBlockList zu commitBlockList zu verpflichten.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Mit dem Vorgang Stage Block From URL wird ein neuer Block erstellt, 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.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Der synchrone Vorgang "Aus URL kopieren" kopiert ein Blob oder eine Internetressource in ein neues Blob. Es wird erst dann eine Antwort zurückgegeben, wenn die Kopie abgeschlossen ist.
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 <xref:stageBlockFromURL> Sie und <xref:commitBlockList>, um partielle Updates für den Inhalt eines Blockblobs mithilfe einer Quell-URL durchzuführen.
undelete(BlobUndeleteOptions)	Stellt den Inhalt und die Metadaten des vorläufig gelöschten Blobs und aller zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Undelete Blob wird nur ab Version 2017-07-29 unterstützt.
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 <xref:stageBlock> und <xref:commitBlockList>, um eine partielle Aktualisierung eines Blockblobs durchzuführen. Dies ist eine nicht parallele Uploadmethode. Verwenden <xref:uploadFile><xref:uploadStream><xref:uploadBrowserData> Sie oder für eine bessere Leistung beim Parallelitätsuploading.
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	NUR IN BROWSERN VERFÜGBAR. Lädt ein Blob/File/ArrayBuffer/ArrayBufferView-Objekt des Browsers hoch, um Blob 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 auf <xref:stageBlock> , um Blöcke hochzuladen, und ruft schließlich auf <xref:commitBlockList> , um die Blockliste zu committen. Eine gängige <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> Option zum Festlegen ist `blobContentType`, dass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.
uploadData(Buffer \| Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	Lädt ein Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView-Objekt in ein BlockBlob hoch. Wenn die Datenlänge nicht mehr als die angegebene <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (Standardeinstellung) beträgt <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>, verwendet diese Methode 1 <xref:upload> Aufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode auf <xref:stageBlock> , um Blöcke hochzuladen, und ruft schließlich auf <xref:commitBlockList> , um die Blockliste zu committen. Eine gängige <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> Option zum Festlegen ist `blobContentType`, dass 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 ruft schließlich commitBlockList auf, um die Blockliste zu commiten.
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.
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 escaped, 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 nicht codierte URL, die auf ein Blob verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal escaped, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname jedoch enthält? oder %, blobname muss 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

z. B. 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. Falls 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 die Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolgenbeispiel: 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

accountName

accountName: string

Eigenschaftswert

string

containerName

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

string containerName

Eigenschaftswert

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

Der Name des Blobs.

string name

Eigenschaftswert

string

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Details zur Methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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>

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.

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

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<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Schreibt ein BLOB, indem die Liste der Block-IDs angegeben wird, aus denen sich das BLOB zusammensetzt. Wenn ein Block als Teil eines BLOB geschrieben werden soll, muss er zuvor erfolgreich in einem <xref:stageBlock>-Vorgang auf den Server geschrieben worden sein. Sie können <xref:commitBlockList> aufrufen, um ein BLOB zu aktualisieren, indem Sie nur die Blöcke mit Änderungen hochladen und anschließend für die neuen und vorhandenen Blöcke einen Commit ausführen. Alle Blöcke, die nicht in der Blockliste angegeben und endgültig gelöscht wurden.

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

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.

createSnapshot(BlobCreateSnapshotOptions)

Erstellt eine schreibgeschützte Momentaufnahme eines BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameter

options: BlobCreateSnapshotOptions

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

Gibt zurück

Promise<BlobCreateSnapshotResponse>

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.

function delete(options?: BlobDeleteOptions)

Parameter

options: BlobDeleteOptions

Optionale Optionen für blob delete-Vorgang.

Gibt zurück

Promise<BlobDeleteResponse>

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.

function deleteIfExists(options?: BlobDeleteOptions)

Parameter

options: BlobDeleteOptions

Optionale Optionen für blob delete-Vorgang.

Gibt zurück

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parameter

options: BlobDeleteImmutabilityPolicyOptions

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

Gibt zurück

Promise<BlobDeleteImmutabilityPolicyResponse>

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.

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

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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob parallel in einen Puffer herunter. Offset und Count sind optional und 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 berücksichtigen <xref:downloadToFile>.

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

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 bis zum Ende heruntergeladen, wenn undefined übergeben wird

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob parallel in einen Puffer herunter. Offset und Count sind optional und lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden.

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

Parameter

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob in eine lokale Datei herunter. Tritt ein Fehler auf, 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)

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, jedoch mit readableStreamBody, die auf undefiniert festgelegt sind, da der Inhalt bereits am angegebenen Pfad gelesen und in eine lokale Datei geschrieben wird.

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

function exists(options?: BlobExistsOptions)

Parameter

options: BlobExistsOptions

Optionen zum Exists-Vorgang.

Gibt zurück

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Nur für BlobClient verfügbar, der mit anmeldegeschützten Schlüsseln erstellt wurde. Generiert einen SAS-URI (Shared Access Signature) des Blobdiensts basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

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.

getAppendBlobClient()

Erstellt ein AppendBlobClient-Objekt.

function getAppendBlobClient()

Gibt zurück

AppendBlobClient

getBlobLeaseClient(string)

Rufen Sie eine ab <xref:BlobLeaseClient> , die Leases für das Blob verwaltet.

function getBlobLeaseClient(proposeLeaseId?: string)

Parameter

proposeLeaseId: string

Anfängliche vorgeschlagene Lease-ID.

Gibt zurück

BlobLeaseClient

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

getBlockBlobClient()

Erstellt ein BlockBlobClient-Objekt.

function getBlockBlobClient()

Gibt zurück

BlockBlobClient

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

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

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.

getPageBlobClient()

Erstellt ein PageBlobClient-Objekt.

function getPageBlobClient()

Gibt zurück

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

Parameter

options: BlobGetPropertiesOptions

Optionale Optionen zum Abrufen von Eigenschaften.

Gibt zurück

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Parameter

options: BlobGetTagsOptions

Gibt zurück

Promise<BlobGetTagsResponse>

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)

Parameter

query: string

options: BlockBlobQueryOptions

Gibt zurück

Promise<BlobDownloadResponseModel>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | 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 (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert.

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

Parameter

tier: BlockBlobTier | PremiumPageBlobTier | 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>

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.

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

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>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

Parameter

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Gibt zurück

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

Parameter

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Gibt zurück

Promise<BlobSetLegalHoldResponse>

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.

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

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>

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)

Parameter

tags: Tags

options: BlobSetTagsOptions

Gibt zurück

Promise<BlobSetTagsResponse>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

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

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

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 Blockblob Stage Block-Vorgang.

Gibt zurück

Promise<BlockBlobStageBlockResponse>

Antwortdaten für den Blockblob Stage Block-Vorgang.

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

Mit dem Vorgang Stage Block From URL wird ein neuer Block erstellt, 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.

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

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

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

Parameter

copySource: string

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

options: BlobSyncCopyFromURLOptions

Gibt zurück

Promise<BlobCopyFromURLResponse>

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 <xref:stageBlockFromURL> Sie und <xref:commitBlockList>, um partielle Updates für den Inhalt eines Blockblobs mithilfe einer Quell-URL durchzuführen.

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

Parameter

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Optionale Parameter.

Gibt zurück

Promise<BlockBlobPutBlobFromUrlResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

Parameter

options: BlobUndeleteOptions

Optionale Optionen für blob-Undelete-Vorgang.

Gibt zurück

Promise<BlobUndeleteResponse>

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 <xref:stageBlock> und <xref:commitBlockList>, um eine partielle Aktualisierung eines Blockblobs durchzuführen. Dies ist eine nicht parallele Uploadmethode. Verwenden <xref:uploadFile><xref:uploadStream><xref:uploadBrowserData> Sie oder für eine bessere Leistung beim Parallelitätsuploading.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parameter

body: HttpRequestBody

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

contentLength: number

Länge des Textkörpers in Bytes. Verwenden Sie Buffer.byteLength(), um die Textlänge für eine Zeichenfolge zu berechnen, die nicht base64/Hex-codierte Zeichen enthält.

options: BlockBlobUploadOptions

Optionen für den Vorgang "Blobupload blockieren".

Gibt zurück

Promise<BlockBlobUploadResponse>

Antwortdaten für den Vorgang Block Blob Upload.

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 <xref:uploadData> instead.

NUR IN BROWSERN VERFÜGBAR. Lädt ein Blob/File/ArrayBuffer/ArrayBufferView-Objekt des Browsers hoch, um Blob 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 auf <xref:stageBlock> , um Blöcke hochzuladen, und ruft schließlich auf <xref:commitBlockList> , um die Blockliste zu committen.

Eine gängige <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> Option zum Festlegen ist blobContentType, dass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.

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

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(Buffer | Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Lädt ein Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView-Objekt in ein BlockBlob hoch. Wenn die Datenlänge nicht mehr als die angegebene <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (Standardeinstellung) beträgt <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>, verwendet diese Methode 1 <xref:upload> Aufruf, um den Upload abzuschließen. Andernfalls ruft diese Methode auf <xref:stageBlock> , um Blöcke hochzuladen, und ruft schließlich auf <xref:commitBlockList> , um die Blockliste zu committen.

Eine gängige <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> Option zum Festlegen ist blobContentType, dass der Browser Funktionen basierend auf dem Dateityp bereitstellen kann.

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

Parameter

data: Buffer | Blob | ArrayBuffer | ArrayBufferView

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 ruft schließlich commitBlockList auf, um die Blockliste zu commiten.

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

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)

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)

Parameter

snapshot: string

Der Momentaufnahmezeitstempel.

Gibt zurück

BlockBlobClient

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

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)

Parameter

versionId: string

Die versionId.

Gibt zurück

BlobClient

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

Freigeben über

BlockBlobClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

BlockBlobClient(string, PipelineLike)

Parameter

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

Parameter

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parameter

Details zur Eigenschaft

accountName

Eigenschaftswert

containerName

Eigenschaftswert

credential

Eigenschaftswert

name

Eigenschaftswert

url

Eigenschaftswert

Details zur Methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parameter

Gibt zurück

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parameter

Gibt zurück

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parameter

Gibt zurück

createSnapshot(BlobCreateSnapshotOptions)

Parameter

Gibt zurück

delete(BlobDeleteOptions)

Parameter

Gibt zurück

deleteIfExists(BlobDeleteOptions)

Parameter

Gibt zurück

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parameter

Gibt zurück

download(number, number, BlobDownloadOptions)

Parameter

Gibt zurück

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parameter

Gibt zurück

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parameter

Gibt zurück

downloadToFile(string, number, number, BlobDownloadOptions)

Parameter

Gibt zurück

exists(BlobExistsOptions)

Parameter

Gibt zurück

generateSasUrl(BlobGenerateSasUrlOptions)

Parameter

Gibt zurück

getAppendBlobClient()

Gibt zurück

getBlobLeaseClient(string)

Parameter

Gibt zurück

getBlockBlobClient()

Gibt zurück

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parameter

Gibt zurück

getPageBlobClient()

Gibt zurück

getProperties(BlobGetPropertiesOptions)

Parameter

Gibt zurück

getTags(BlobGetTagsOptions)

Parameter