PageBlobClient class

Referenz

Paket:: @azure/storage-blob

PageBlobClient definiert eine Reihe von Vorgängen, die für Seitenblobs gelten.

Extends: BlobClient

Konstruktoren

PageBlobClient(string, PipelineLike)	Erstellt eine Instanz von PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Erstellt eine Instanz von PageBlobClient. 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 enthält? oder %, blobname muss in der URL codiert werden.
PageBlobClient(string, string, string, StoragePipelineOptions)	Erstellt eine Instanz von PageBlobClient.

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 die Kopie abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen ist, indem Sie den 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 committetes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann die Quelle für einen Kopierblobvorgang 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.
clearPages(number, number, PageBlobClearPagesOptions)	Gibt die angegebenen Seiten aus dem Seitenblob frei.
create(number, PageBlobCreateOptions)	Erstellt ein Seitenblob der angegebenen Länge. Rufen Sie uploadPages auf, um Datendaten in ein Seitenblob hochzuladen.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Erstellt ein Seitenblob der angegebenen Länge. Rufen Sie uploadPages auf, um Datendaten in ein Seitenblob hochzuladen. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert.
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, falls 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 Unveränderlichkeitsrichtlinie 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ückgegeben. In Browsern werden Daten in einem Versprechen blobBody zurückgegeben.
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie berücksichtigen <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden. Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie 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.
getPageBlobClient()	Erstellt ein PageBlobClient-Objekt.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Gibt die Liste der gültigen Seitenbereiche für ein Seitenblob oder eine Momentaufnahme eines Seitenblobs zurück.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Ruft die Auflistung von Seitenbereichen ab, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob unterscheiden.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Ruft die Auflistung von Seitenbereichen ab, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob für verwaltete Datenträger unterscheiden.
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.
resize(number, PageBlobResizeOptions)	Ändert die Größe des Seitenblobs auf die angegebene Größe (die ein Vielfaches von 512 sein muss).
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 Unmutablilitätsrichtlinie für das Blob fest.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Legen Sie die aufbewahrungsrechtliche Aufbewahrung 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 sind Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), Minuszeichen ('-), Punkt ('.),Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Startet einen Vorgang, um eine inkrementelle Kopie aus der Momentaufnahme eines Seitenblobs in dieses Seitenblob zu starten. Die Momentaufnahme wird so kopiert, dass nur die differenziellen Änderungen zwischen der zuvor kopierten Momentaufnahme an das Ziel übertragen werden. Die kopierten Momentaufnahmen sind vollständige Kopien der ursprünglichen Momentaufnahme und können wie gewohnt ausgelesen oder kopiert werden.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Der synchrone Kopiervorgang von URL kopiert ein Blob oder eine Internetressource in ein neues Blob. Es wird erst dann eine Antwort zurückgegeben, wenn die Kopie abgeschlossen ist.
undelete(BlobUndeleteOptions)	Stellt den Inhalt und die Metadaten des vorläufig gelöschten Blobs und aller zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Das Rückgängigmachen von Blobs wird nur ab Version 2017-07-29 unterstützt.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Legt die Sequenznummer eines Seitenblobs fest.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Schreibt 1 oder mehr Seiten in das Seitenblob. Die Anfangs- und Endoffsets müssen ein Vielfaches von 512 sein.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Der Vorgang Seiten hochladen schreibt einen Bereich von Seiten in ein Seitenblob, in dem der Inhalt aus einer URL gelesen wird.
withSnapshot(string)	Erstellt ein neues PageBlobClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und einen Client 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

PageBlobClient(string, PipelineLike)

Erstellt eine Instanz von PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parameter

url: string

Eine Clientzeichenfolge, die auf das Azure Storage-Seitenblob verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/pageblob"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"".

pipeline: PipelineLike

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

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

Erstellt eine Instanz von PageBlobClient. 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 enthält? oder %, blobname muss in der URL codiert werden.

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

Dies ist optional. Optionen zum Konfigurieren der HTTP-Pipeline.

PageBlobClient(string, string, string, StoragePipelineOptions)

Erstellt eine Instanz von PageBlobClient.

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

Dies ist 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 die Kopie abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen ist, indem Sie den 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 committetes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann die Quelle für einen Kopierblobvorgang 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 zum Quell-Azure-Blob/-Datei.

options: BlobBeginCopyFromURLOptions

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

Gibt zurück

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages(number, number, PageBlobClearPagesOptions)

Gibt die angegebenen Seiten aus dem Seitenblob frei.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Parameter

offset: number

Startbyteposition der zu löschenden Seiten.

count: number

Anzahl der zu löschenden Bytes.

options: PageBlobClearPagesOptions

Optionen für den Vorgang Seitenblob löschen.

Gibt zurück

Promise<PageBlobClearPagesResponse>

Antwortdaten für den Vorgang Seitenblob löschen.

create(number, PageBlobCreateOptions)

Erstellt ein Seitenblob der angegebenen Länge. Rufen Sie uploadPages auf, um Datendaten in ein Seitenblob hochzuladen.

function create(size: number, options?: PageBlobCreateOptions)

Parameter

size: number

Größe des Seitenblobs.

options: PageBlobCreateOptions

Optionen für den Vorgang "Seitenblob erstellen".

Gibt zurück

Promise<PageBlobCreateResponse>

Antwortdaten für den Vorgang Seitenbloberstellung.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Erstellt ein Seitenblob der angegebenen Länge. Rufen Sie uploadPages auf, um Datendaten in ein Seitenblob hochzuladen. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Parameter

size: number

Größe des Seitenblobs.

options: PageBlobCreateIfNotExistsOptions

Gibt zurück

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Erstellt eine schreibgeschützte Momentaufnahme eines BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameter

options: BlobCreateSnapshotOptions

Optionale Optionen für den Vorgang Bloberstellung momentaufnahme.

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 den Bloblöschvorgang.

Gibt zurück

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Markiert das angegebene Blob oder die angegebene Momentaufnahme zum Löschen, falls 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 den Bloblöschvorgang.

Gibt zurück

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Löschen Sie die Unveränderlichkeitsrichtlinie 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ückgegeben.
In Browsern werden Daten in einem Versprechen blobBody zurückgegeben.

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

Parameter

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

Optionale Optionen für den Blob-Download-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 zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden.

Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie 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 beim Übergeben von undefined an das Ende heruntergeladen.

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 zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden.

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

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

getPageBlobClient()

Erstellt ein PageBlobClient-Objekt.

function getPageBlobClient()

Gibt zurück

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Gibt die Liste der gültigen Seitenbereiche für ein Seitenblob oder eine Momentaufnahme eines Seitenblobs zurück.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Parameter

offset: number

Anfangsbyteposition der Seitenbereiche.

count: number

Anzahl der abzurufenden Bytes.

options: PageBlobGetPageRangesOptions

Optionen für den Vorgang "Seitenblobbereiche abrufen".

Gibt zurück

Promise<PageBlobGetPageRangesResponse>

Antwortdaten für den Vorgang "Seitenblobbereiche abrufen".

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Ruft die Auflistung von Seitenbereichen ab, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob unterscheiden.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Parameter

offset: number

Anfangsbyteposition des Seitenblobs

count: number

Anzahl der Bytes, die zum Abrufen von Bereichsunterschieden verwendet werden sollen.

prevSnapshot: string

Zeitstempel der Momentaufnahme zum Abrufen des Unterschieds.

options: PageBlobGetPageRangesDiffOptions

Optionen für den Vorgang "Page Blob Get Page Ranges Diff".

Gibt zurück

Promise<PageBlobGetPageRangesDiffResponse>

Antwortdaten für den Page Blob Get Page Range Diff-Vorgang.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Ruft die Auflistung von Seitenbereichen ab, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob für verwaltete Datenträger unterscheiden.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Parameter

offset: number

Anfangsbyteposition des Seitenblobs

count: number

Anzahl der Bytes, die zum Abrufen von Bereichsunterschieden verwendet werden sollen.

prevSnapshotUrl: string

URL der Momentaufnahme, um den Unterschied abzurufen.

options: PageBlobGetPageRangesDiffOptions

Optionen für den Vorgang "Page Blob Get Page Ranges Diff".

Gibt zurück

Promise<PageBlobGetPageRangesDiffResponse>

Antwortdaten für den Page Blob Get Page Range Diff-Vorgang.

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>

resize(number, PageBlobResizeOptions)

Ändert die Größe des Seitenblobs auf die angegebene Größe (die ein Vielfaches von 512 sein muss).

function resize(size: number, options?: PageBlobResizeOptions)

Parameter

size: number

Zielgröße

options: PageBlobResizeOptions

Optionen für den Vorgang Zum Ändern der Größe von Seitenblobs.

Gibt zurück

Promise<PageBlobResizeResponse>

Antwortdaten für den Vorgang Zum Ändern der Größe von Seitenblobs.

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 "Heiß", "Kalt" oder "Archiv".

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 gängiger Header, der festgelegt werden muss, ist blobContentType , dass der Browser Funktionen basierend auf dem Dateityp bereitstellt.

options: BlobSetHTTPHeadersOptions

Optionale Optionen zum Blob set HTTP Headers-Vorgang.

Gibt zurück

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

Parameter

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Gibt zurück

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Legen Sie die aufbewahrungsrechtliche Aufbewahrung für das Blob fest.

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

Parameter

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Optionale Optionen zum Festlegen der aufbewahrungsrechtlichen 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 sind Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), Minuszeichen ('-), Punkt ('.),Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Parameter

tags: Tags

options: BlobSetTagsOptions

Gibt zurück

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Startet einen Vorgang, um eine inkrementelle Kopie aus der Momentaufnahme eines Seitenblobs in dieses Seitenblob zu starten. Die Momentaufnahme wird so kopiert, dass nur die differenziellen Änderungen zwischen der zuvor kopierten Momentaufnahme an das Ziel übertragen werden. Die kopierten Momentaufnahmen sind vollständige Kopien der ursprünglichen Momentaufnahme und können wie gewohnt ausgelesen oder kopiert werden.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Parameter

copySource: string

Gibt den Namen der Blobmomentaufnahme der Quellseite an. Zum Beispiel, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options: PageBlobStartCopyIncrementalOptions

Optionen für den Vorgang "Inkrementelles Kopieren von Seitenblobs".

Gibt zurück

Promise<PageBlobCopyIncrementalResponse>

Antwortdaten für den Vorgang Inkrementelles Kopieren von Seitenblobs.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

Parameter

copySource: string

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

options: BlobSyncCopyFromURLOptions

Gibt zurück

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

Parameter

options: BlobUndeleteOptions

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

Gibt zurück

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Legt die Sequenznummer eines Seitenblobs fest.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Parameter

sequenceNumberAction: SequenceNumberActionType

Gibt an, wie der Dienst die Sequenznummer des Blobs ändern soll.

sequenceNumber: number

Erforderlich, wenn sequenceNumberAction max oder update ist

options: PageBlobUpdateSequenceNumberOptions

Optionen für den Vorgang "Seitenblob-Sequenznummer aktualisieren".

Gibt zurück

Promise<PageBlobUpdateSequenceNumberResponse>

Antwortdaten für den Vorgang Seitenblob-Aktualisierungssequenznummer.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Schreibt 1 oder mehr Seiten in das Seitenblob. Die Anfangs- und Endoffsets müssen ein Vielfaches von 512 sein.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Parameter

body: HttpRequestBody

Hochzuladende Daten

offset: number

Offset des Zielseitenblobs

count: number

Inhaltslänge des Textkörpers, auch Anzahl der Bytes, die hochgeladen werden sollen

options: PageBlobUploadPagesOptions

Optionen für den Vorgang Seitenblob hochladen.

Gibt zurück

Promise<PageBlobUploadPagesResponse>

Antwortdaten für den Vorgang Seiten hochladen.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

Der Vorgang Seiten hochladen schreibt einen Bereich von Seiten in ein Seitenblob, in dem der Inhalt aus einer URL gelesen wird.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Parameter

sourceURL: string

Geben Sie eine URL für die Kopierquelle an. Shared Access Signature (SAS) ist möglicherweise für die Authentifizierung erforderlich.

sourceOffset: number

Der Quelloffset, aus dem kopiert werden soll. Übergeben Sie 0, um vom Anfang des Quellseitenblobs zu kopieren.

destOffset: number

Offset des Zielseitenblobs

count: number

Anzahl der Bytes, die aus dem Quellseitenblob hochgeladen werden sollen

options: PageBlobUploadPagesFromURLOptions

Gibt zurück

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

Parameter

snapshot: string

Der Momentaufnahmezeitstempel.

Gibt zurück

PageBlobClient

Ein neues PageBlobClient-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.

Share via

PageBlobClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

PageBlobClient(string, PipelineLike)

Parameter

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

Parameter

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

clearPages(number, number, PageBlobClearPagesOptions)

Parameter

Gibt zurück

create(number, PageBlobCreateOptions)

Parameter

Gibt zurück

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

getPageBlobClient()

Gibt zurück

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parameter