BlockBlobClient class

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

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, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parameter

Erstellt eine Instanz von BlockBlobClient.

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

Parameter

accountName: string

Eigenschaftswert

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

string containerName

Eigenschaftswert

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

Der Name des Blobs.

string name

Eigenschaftswert

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

Erstellt eine schreibgeschützte Momentaufnahme eines BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameter

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parameter

Gibt zurück

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

// 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);
});
}

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

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

Gibt zurück

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(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Parameter

Gibt zurück

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

Gibt zurück

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.

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

Gibt zurück

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

Gibt zurück

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

Erstellt ein AppendBlobClient-Objekt.

function getAppendBlobClient()

Gibt zurück

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parameter

Gibt zurück

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

Erstellt ein BlockBlobClient-Objekt.

function getBlockBlobClient()

Gibt zurück

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

Gibt zurück

Antwortdaten für den Vorgang Blockblob Abrufen einer Blockliste.

Erstellt ein PageBlobClient-Objekt.

function getPageBlobClient()

Gibt zurück

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

Gibt zurück

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

function getTags(options?: BlobGetTagsOptions)

Parameter

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Antwortdaten für den Blockblob Stage Block-Vorgang.

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

Gibt zurück

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

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Antwortdaten für den Vorgang Block Blob Upload.

Beispielverwendung:

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

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

Gibt zurück

Antwortdaten für den Blobuploadvorgang.

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

Gibt zurück

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

Gibt zurück

Antwortdaten für den Blobuploadvorgang.

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

Gibt zurück

Antwortdaten für den Blobuploadvorgang.

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

Gibt zurück

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

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

Gibt zurück

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