AppendBlobClient class

Paket:: @azure/storage-blob

AppendBlobClient definiert eine Reihe von Vorgängen, die für das Anfügen von Blobs gelten.

Extends: BlobClient

Konstruktoren

AppendBlobClient(string, PipelineLike)	Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-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.
AppendBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-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.
AppendBlobClient(string, string, string, StoragePipelineOptions)	Erstellt eine Instanz von AppendBlobClient.

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

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)	Führt einen Commit für einen neuen Datenblock an das Ende des vorhandenen Anfügeblobs aus. Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/append-block.
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	Mit dem Append Block-Vorgang wird ein neuer Datenblock am Ende eines vorhandenen Anfüge-Blobs ausgeführt, in dem der Inhalt aus einer Quell-URL gelesen wird. Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/append-block-from-url.
create(AppendBlobCreateOptions)	Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb. Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/put-blob.
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert. Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/put-blob.
seal(AppendBlobSealOptions)	Versiegelt den Anfügebb, sodass er schreibgeschützt ist.
withSnapshot(string)	Erstellt ein neues AppendBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" entfernt die Momentaufnahme und gibt einen Client an das Basis-Blob zurück.

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://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/copy-blob. import { BlobServiceClient } from "@azure/storage-blob"; import { DefaultAzureCredential } from "@azure/identity"; const account = "<account>"; const blobServiceClient = new BlobServiceClient( `https://${account}.blob.core.windows.net`, new DefaultAzureCredential(), ); const containerName = "<container name>"; const blobName = "<blob name>"; const containerClient = blobServiceClient.getContainerClient(containerName); const blobClient = containerClient.getBlobClient(blobName); // Example using automatic polling const automaticCopyPoller = await blobClient.beginCopyFromURL("url"); const automaticResult = await automaticCopyPoller.pollUntilDone(); // Example using manual polling const manualCopyPoller = await blobClient.beginCopyFromURL("url"); while (!manualCopyPoller.isDone()) { await manualCopyPoller.poll(); } const manualResult = manualCopyPoller.getResult(); // Example using progress updates const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); }, }); const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone(); // Example using a changing polling interval (default 15 seconds) const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", { intervalInMs: 1000, // poll blob every 1 second for copy progress }); const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone(); // Example using copy cancellation: const cancelCopyPoller = await blobClient.beginCopyFromURL("url"); // cancel operation after starting it. try { await cancelCopyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError cancelCopyPoller.getResult(); } catch (err: any) { if (err.name === "PollerCancelledError") { console.log("The copy was cancelled."); } }
createSnapshot(BlobCreateSnapshotOptions)	Erstellt eine schreibgeschützte Momentaufnahme eines Blobs. Informationen finden Sie unter https://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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

AppendBlobClient(string, PipelineLike)

Erstellt eine Instanz von AppendBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Anfüge-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 AppendBlobClient(url: string, pipeline: PipelineLike)

Parameter

url: string

Eine URL-Zeichenfolge, die auf das Anfüge-BLOB von Azure Storage verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/appendblob?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.

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

new AppendBlobClient(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

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

AppendBlobClient(string, string, string, StoragePipelineOptions)

Erstellt eine Instanz von AppendBlobClient.

new AppendBlobClient(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

Name des Blobs.

options: StoragePipelineOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Eigenschaft

containerName

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

string containerName

Eigenschaftswert

string

name

Der Name des Blobs.

string name

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName

accountName: string

Eigenschaftswert

string

Geerbt vonBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Geerbt vonBlobClient.credential

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt vonBlobClient.url

Details zur Methode

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)

Führt einen Commit für einen neuen Datenblock an das Ende des vorhandenen Anfügeblobs aus.

Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/append-block.

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Parameter

body: HttpRequestBody

Daten, die angefügt werden sollen.

contentLength: number

Länge des Textkörpers in Byte.

options: AppendBlobAppendBlockOptions

Optionen für den Anfügeblock-Vorgang.

Beispielverwendung:

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient(blobName);
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient(blobName);
await existingAppendBlobClient.appendBlock(content, content.length);

Gibt zurück

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Mit dem Append Block-Vorgang wird ein neuer Datenblock am Ende eines vorhandenen Anfüge-Blobs ausgeführt, in dem der Inhalt aus einer Quell-URL gelesen wird.

Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/append-block-from-url.

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

Parameter

sourceURL: string

Die URL zum Blob, die die Quelle der Kopie ist. Ein Quell-BLOB im selben Speicherkonto kann über freigegebenen Schlüssel authentifiziert werden. Wenn die Quelle jedoch ein Blob in einem anderen Konto ist, muss das Quell-BLOB 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.

sourceOffset: number

Offset in der Quelle, die angefügt werden soll

count: number

Anzahl der Bytes, die als Block angefügt werden sollen

options: AppendBlobAppendBlockFromURLOptions

Gibt zurück

Promise<AppendBlobAppendBlockFromUrlResponse>

create(AppendBlobCreateOptions)

Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb.

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

Parameter

options: AppendBlobCreateOptions

Optionen für den Vorgang zum Anfügen von Blockerstellung.

Beispielverwendung:

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);

const appendBlobClient = containerClient.getAppendBlobClient(blobName);
await appendBlobClient.create();

Gibt zurück

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

Erstellt einen 0-längen Anfüge-BLOB. Aufrufen von AppendBlock zum Anfügen von Daten an ein Anfügebb. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert.

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

Parameter

options: AppendBlobCreateIfNotExistsOptions

Gibt zurück

Promise<AppendBlobCreateIfNotExistsResponse>

seal(AppendBlobSealOptions)

Versiegelt den Anfügebb, sodass er schreibgeschützt ist.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

Parameter

options: AppendBlobSealOptions

Gibt zurück

Promise<AppendBlobAppendBlockResponse>

withSnapshot(string)

Erstellt ein neues AppendBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" entfernt die Momentaufnahme und gibt einen Client an das Basis-Blob zurück.

function withSnapshot(snapshot: string): AppendBlobClient

Parameter

snapshot: string

Der Momentaufnahmezeitstempel.

Gibt zurück

AppendBlobClient

Ein neues AppendBlobClient -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://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/copy-blob.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

// Example using copy cancellation:
const cancelCopyPoller = await blobClient.beginCopyFromURL("url");
// cancel operation after starting it.
try {
  await cancelCopyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  cancelCopyPoller.getResult();
} catch (err: any) {
  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 zum Azure-Quellblob/zur Azure-Quelldatei.

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://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/delete-blob.

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

Parameter

options: BlobDeleteOptions

Optionale Optionen für blob Delete-Vorgang.

Gibt zurück

Promise<BlobDeleteResponse>

Geerbt vonBlobClient.delete

deleteIfExists(BlobDeleteOptions)

Markiert 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://learn.microsoft.com/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://learn.microsoft.com/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):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
const downloadBlockBlobResponse = await blobClient.download();
if (downloadBlockBlobResponse.readableStreamBody) {
  const downloaded = await streamToString(downloadBlockBlobResponse.readableStreamBody);
  console.log(`Downloaded blob content: ${downloaded}`);
}

async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
  const result = await new Promise<Buffer<ArrayBuffer>>((resolve, reject) => {
    const chunks: Buffer[] = [];
    stream.on("data", (data) => {
      chunks.push(Buffer.isBuffer(data) ? data : Buffer.from(data));
    });
    stream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    stream.on("error", reject);
  });
  return result.toString();
}

Beispielverwendung (Browser):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
const downloadBlockBlobResponse = await blobClient.download();
const blobBody = await downloadBlockBlobResponse.blobBody;
if (blobBody) {
  const downloaded = await blobBody.text();
  console.log(`Downloaded blob content: ${downloaded}`);
}

Gibt zurück

Promise<BlobDownloadResponseParsed>

Geerbt vonBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und 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

Optionen für den Betrieb Exists.

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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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>

Geerbt vonBlobClient.getTags

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://learn.microsoft.com/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://learn.microsoft.com/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>

Geerbt vonBlobClient.setHTTPHeaders

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://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/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

AppendBlobClient class

Konstruktoren

Eigenschaften

Geerbte Eigenschaften

Methoden

Geerbte Methoden

Details zum Konstruktor

AppendBlobClient(string, PipelineLike)

Parameter

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

Parameter

AppendBlobClient(string, string, string, StoragePipelineOptions)

Parameter

Details zur Eigenschaft

containerName

Eigenschaftswert

name

Eigenschaftswert

Geerbte Eigenschaftsdetails

accountName

Eigenschaftswert

credential

Eigenschaftswert

url

Eigenschaftswert

Details zur Methode

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)

Parameter

Gibt zurück

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Parameter

Gibt zurück

create(AppendBlobCreateOptions)

Parameter

Gibt zurück

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

Parameter

Gibt zurück

seal(AppendBlobSealOptions)

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)

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

generateSasStringToSign(BlobGenerateSasUrlOptions)