PageBlobClient class

Erstellt eine Instanz von PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parameter

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

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

Parameter

Erstellt eine Instanz von PageBlobClient.

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

Parameter

accountName: string

Eigenschaftswert

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

string containerName

Eigenschaftswert

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

Der Name des Blobs.

string name

Eigenschaftswert

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

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.

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

Parameter

Gibt zurück

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.

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

Parameter

Gibt zurück

Gibt die angegebenen Seiten aus dem Seiten-BLOB frei.

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Page Blob Clear Pages".

Erstellt ein Seitenblob der angegebenen Länge. Aufrufen von UploadPages zum Hochladen von Daten in ein Seitenblob.

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Page Blob Create".

Erstellt ein Seitenblob der angegebenen Länge. Aufrufen von UploadPages zum Hochladen von Daten in ein Seitenblob. Wenn das Blob mit demselben Namen bereits vorhanden ist, bleibt der Inhalt des vorhandenen Blobs unverändert.

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

Parameter

Gibt zurück

Erstellt eine schreibgeschützte Momentaufnahme eines Blobs.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameter

Gibt zurück

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.

function delete(options?: BlobDeleteOptions)

Parameter

Gibt zurück

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.

function deleteIfExists(options?: BlobDeleteOptions)

Parameter

Gibt zurück

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parameter

Gibt zurück

Liest oder lädt ein Blob aus dem System herunter, einschließlich seiner Metadaten und Eigenschaften. Sie können 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

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

Parameter

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel 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, <xref:downloadToFile>.

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

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure Blob parallel 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, <xref:downloadToFile>.

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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.

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)

Parameter

Gibt zurück

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.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parameter

Gibt zurück

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

Erstellt ein AppendBlobClient -Objekt.

function getAppendBlobClient()

Gibt zurück

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parameter

Gibt zurück

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

Erstellt ein BlockBlobClient -Objekt.

function getBlockBlobClient()

Gibt zurück

Erstellt ein PageBlobClient -Objekt.

function getPageBlobClient()

Gibt zurück

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

Gibt zurück

Antwortdaten für den Vorgang "Page Blob Get Ranges".

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

Gibt zurück

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

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

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

Parameter

Gibt zurück

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

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

function getProperties(options?: BlobGetPropertiesOptions)

Parameter

Gibt zurück

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

function getTags(options?: BlobGetTagsOptions)

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Seitenblobgröße ändern".

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.

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

Parameter

Gibt zurück

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.

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Legt benutzerdefinierte Metadaten für das angegebene Blob als ein oder mehrere Name-Wert-Paare fest. Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die BLOB-Metadaten entfernt.

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

Parameter

Gibt zurück

Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. 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)

Parameter

Gibt zurück

Startet einen Vorgang, um eine inkrementelle Kopie aus der Momentaufnahme eines Seiten-BLOBs 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 gelesen oder kopiert werden.

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

Parameter

Gibt zurück

Antwortdaten für den inkrementellen Vorgang "Seitenblob kopieren".

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.

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

Parameter

Gibt zurück

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.

function undelete(options?: BlobUndeleteOptions)

Parameter

Gibt zurück

Legt die Sequenznummer eines Seitenblobs fest.

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Page Blob Update Sequence Number".

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

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang "Page Blob Upload Pages".

Der Vorgang "Seiten hochladen" schreibt einen Seitenbereich 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

Gibt zurück

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

function withSnapshot(snapshot: string)

Parameter

Gibt zurück

Ein neues PageBlobClient -Objekt identisch mit der Quelle, aber mit dem angegebenen Snapshot-Zeitstempel.

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)

Parameter

Gibt zurück

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