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

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

z. B. AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Falls nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

Der Name des Blobs.

string name

Eigenschaftswert

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

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

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

Parameter

Gibt zurück

Kopiert ein Blob asynchron in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis 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

Gibt zurück

Gibt die angegebenen Seiten aus dem Seitenblob frei.

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang Seitenblob löschen.

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

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

Parameter

Gibt zurück

Antwortdaten für den Vorgang Seitenbloberstellung.

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

Gibt zurück

Erstellt eine schreibgeschützte Momentaufnahme eines BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parameter

Gibt zurück

Markiert das angegebene Blob oder die angegebene Momentaufnahme zum Löschen. Das BLOB wird später während der automatischen Speicherbereinigung gelöscht. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig mit dem Vorgang Blob löschen löschen.

function delete(options?: BlobDeleteOptions)

Parameter

Gibt zurück

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

Gibt zurück

Löschen Sie die Unveränderlichkeitsrichtlinie für das Blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parameter

Gibt zurück

Liest oder lädt ein Blob aus dem System herunter, einschließlich seiner Metadaten und Eigenschaften. Sie können auch Get Blob aufrufen, um eine Momentaufnahme zu lesen.

• In Node.js werden Daten in einem lesbaren Stream zurückgegeben.
• In Browsern werden Daten in einem Versprechen 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 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

Gibt zurück

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

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob in eine lokale Datei herunter. Tritt ein Fehler auf, wenn der angegebene Dateipfad bereits beendet wird. Offset und Count sind optional, übergeben 0 bzw. undefiniert, um das gesamte Blob herunterzuladen.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Parameter

Gibt zurück

Die Antwortdaten für den Blobdownloadvorgang, jedoch mit readableStreamBody, die auf undefiniert festgelegt sind, da der Inhalt bereits am angegebenen Pfad gelesen und in eine lokale Datei geschrieben wird.

Gibt true zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. Andernfalls false. HINWEIS: Verwenden Sie diese Funktion mit Bedacht, da ein vorhandenes Blob möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Blobs von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

function exists(options?: BlobExistsOptions)

Parameter

Gibt zurück

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parameter

Gibt zurück

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

Erstellt ein AppendBlobClient-Objekt.

function getAppendBlobClient()

Gibt zurück

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parameter

Gibt zurück

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

Erstellt ein BlockBlobClient-Objekt.

function getBlockBlobClient()

Gibt zurück

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 "Seitenblobbereiche abrufen".

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 Seitenblob 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, HTTP-Standardeigenschaften und Systemeigenschaften für das BLOB zurück. Der Inhalt des BLOB wird nicht zurückgegeben.

function getProperties(options?: BlobGetPropertiesOptions)

Parameter

Gibt zurück

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

function getTags(options?: BlobGetTagsOptions)

Parameter

Gibt zurück

Ä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

Gibt zurück

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

Legt die Ebene für ein Blob fest. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert.

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

Parameter

Gibt zurück

Legt Systemeigenschaften für den Blob fest. Wenn kein Wert oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne Wert gelöscht.

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Legt benutzerdefinierte Metadaten für das angegebene Blob als mindestens ein Name-Wert-Paar fest. Wenn keine Option oder keine im Parameter definierten Metadaten angegeben sind, werden die Blobmetadaten entfernt.

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

Parameter

Gibt zurück

Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein. Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen 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

Gibt zurück

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

Gibt zurück

Antwortdaten für den Vorgang Inkrementelles Kopieren von Seitenblobs.

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

Gibt zurück

Stellt den Inhalt und die Metadaten des vorläufig gelöschten Blobs und aller zugeordneten vorläufig gelöschten Momentaufnahmen wieder her. Das Rückgängigmachen von Blobs wird nur ab Version 2017-07-29 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 Seitenblob-Aktualisierungssequenznummer.

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

Gibt zurück

Antwortdaten für den Vorgang Seiten hochladen.

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

Gibt zurück

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

Gibt zurück

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

Erstellt ein neues BlobClient-Objekt, das auf eine Version dieses Blobs verweist. Geben Sie "" an, um die versionId zu entfernen und einen Client an das Basisblob zurückzugeben.

function withVersion(versionId: string)

Parameter

Gibt zurück

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