Freigeben über

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. 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.
PageBlobClient(string, string, string, StoragePipelineOptions)

Erstellt eine Instanz von PageBlobClient.

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

clearPages(number, number, PageBlobClearPagesOptions)

Gibt die angegebenen Seiten aus dem Seiten-BLOB frei.

Siehe https://docs.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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.

Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Gibt einen asynchronen iterierbaren Iterator zur Liste der Seitenbereiche für ein Seitenblob zurück.

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() gibt einen asynchronen iterablen Iterator zur Liste der Seitenbereiche für ein Seitenblob zurück.

Beispiel mit for await Syntax:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Beispiel für die Verwendung von iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Beispiel für die Verwendung von byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Beispiel für das Paging mit einer Markierung:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Gibt einen asynchronen iterierbaren Iterator für eine Liste von Seitenbereichen zurück, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob unterscheiden.

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() gibt einen asynchronen iterierbaren Iterator für eine Liste von Seitenbereichen zurück, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob unterscheiden.

Beispiel mit for await Syntax:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Beispiel für die Verwendung von iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Beispiel für die Verwendung von byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Beispiel für das Paging mit einer Markierung:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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.

Siehe https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Siehe https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Legt die Sequenznummer eines Seitenblobs fest.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
withSnapshot(string)

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.

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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Beispiel für die automatische Abfrage:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Beispiel für die manuelle Abfrage:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Beispiel für die Verwendung von Statusaktualisierungen:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Beispiel für die Verwendung eines sich ändernden Abrufintervalls (Standard 15 Sekunden):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Beispiel für die Verwendung des Kopierabbruchs:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}
createSnapshot(BlobCreateSnapshotOptions)

Erstellt eine schreibgeschützte Momentaufnahme eines Blobs.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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

Siehe https://docs.microsoft.com/en-us/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.
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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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

PageBlobClient(string, PipelineLike)

Erstellt eine Instanz von PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parameter

url

string

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

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

url

string

Eine Clientzeichenfolge, die auf den Azure Storage-Seiten-BLOB zeigt, z. B. "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

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

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

Blobname.

options
StoragePipelineOptions

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

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

vonBlobClient.credential geerbt

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

vonBlobClient.url geerbt

Details zur Methode

clearPages(number, number, PageBlobClearPagesOptions)

Gibt die angegebenen Seiten aus dem Seiten-BLOB frei.

Siehe https://docs.microsoft.com/rest/api/storageservices/put-page

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

Parameter

offset

number

Die Byteposition der zu löschenden Seiten wird gestartet.

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 "Page Blob Clear Pages".

create(number, PageBlobCreateOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

Parameter

size

number

Größe des Seitenblobs.

options
PageBlobCreateOptions

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

Gibt zurück

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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.

Siehe https://docs.microsoft.com/rest/api/storageservices/put-blob

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parameter

size

number

Größe des Seitenblobs.

options
PageBlobCreateIfNotExistsOptions

Gibt zurück

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

Parameter

offset

number

Die Byteposition der Seitenbereiche wird gestartet.

count

number

Anzahl der abzurufenden Bytes.

options
PageBlobGetPageRangesOptions

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

Gibt zurück

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parameter

offset

number

Beginnen der Byteposition des Seitenblobs

count

number

Anzahl der Bytes zum Abrufen von Bereichen diff.

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 Seiten-BLOB für verwaltete Datenträger unterscheiden.

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parameter

offset

number

Beginnen der Byteposition des Seitenblobs

count

number

Anzahl der Bytes zum Abrufen von Bereichen diff.

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.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Gibt einen asynchronen iterierbaren Iterator zur Liste der Seitenbereiche für ein Seitenblob zurück.

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() gibt einen asynchronen iterablen Iterator zur Liste der Seitenbereiche für ein Seitenblob zurück.

Beispiel mit for await Syntax:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Beispiel für die Verwendung von iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Beispiel für die Verwendung von byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Beispiel für das Paging mit einer Markierung:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parameter

offset

number

Die Byteposition der Seitenbereiche wird gestartet.

count

number

Anzahl der abzurufenden Bytes.

options
PageBlobListPageRangesOptions

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

Gibt zurück

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Gibt einen asynchronen iterierbaren Iterator für eine Liste von Seitenbereichen zurück, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob unterscheiden.

Siehe https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() gibt einen asynchronen iterierbaren Iterator für eine Liste von Seitenbereichen zurück, die sich zwischen einer angegebenen Momentaufnahme und diesem Seitenblob unterscheiden.

Beispiel mit for await Syntax:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Beispiel für die Verwendung von iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Beispiel für die Verwendung von byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Beispiel für das Paging mit einer Markierung:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parameter

offset

number

Die Byteposition der Seitenbereiche wird gestartet.

count

number

Anzahl der abzurufenden Bytes.

prevSnapshot

string

Zeitstempel der Momentaufnahme zum Abrufen des Unterschieds.

options
PageBlobListPageRangesDiffOptions

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

Gibt zurück

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Ein asyncIterableIterator, der paging unterstützt.

resize(number, PageBlobResizeOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/set-blob-properties

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

Parameter

size

number

Zielgröße

options
PageBlobResizeOptions

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

Gibt zurück

Promise<PageBlobResizeResponse>

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

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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.

Siehe https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Siehe https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

Parameter

copySource

string

Gibt den Namen der Blob-Momentaufnahme der Quellseite an. Beispiel: https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

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

Gibt zurück

Promise<PageBlobCopyIncrementalResponse>

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

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Legt die Sequenznummer eines Seitenblobs fest.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

Parameter

sequenceNumberAction
SequenceNumberActionType

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

sequenceNumber

number

Erforderlich, wenn sequenceNumberAction max oder aktualisiert ist

options
PageBlobUpdateSequenceNumberOptions

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

Gibt zurück

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

Siehe https://docs.microsoft.com/rest/api/storageservices/put-page

function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

Parameter

body
HttpRequestBody

Hochzuladende Daten

offset

number

Offset des Zielseiten-BLOB

count

number

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

options
PageBlobUploadPagesOptions

Optionen für den Vorgang "Seiten-BLOB-Uploadseiten".

Gibt zurück

Promise<PageBlobUploadPagesResponse>

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

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

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

Parameter

sourceURL

string

Angeben einer URL zur Kopierquelle, Shared Access Signature(SAS) möglicherweise für die Authentifizierung erforderlich

sourceOffset

number

Der Quelloffset, aus dem kopiert werden soll. Übergeben von 0 zum Kopieren vom Anfang des Quellseiten-BLOB

destOffset

number

Offset des Zielseiten-BLOB

count

number

Anzahl der Bytes, die vom Quellseiten-BLOB hochgeladen werden sollen

options
PageBlobUploadPagesFromURLOptions

Gibt zurück

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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): PageBlobClient

Parameter

snapshot

string

Der Momentaufnahmezeitstempel.

Gibt zurück

PageBlobClient

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

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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Beispiel für die automatische Abfrage:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Beispiel für die manuelle Abfrage:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Beispiel für die Verwendung von Statusaktualisierungen:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Beispiel für die Verwendung eines sich ändernden Abrufintervalls (Standard 15 Sekunden):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Beispiel für die Verwendung des Kopierabbruchs:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  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 to the source Azure Blob/File.

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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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>

vonBlobClient.delete geerbt

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.

Siehe https://docs.microsoft.com/en-us/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

Siehe https://docs.microsoft.com/en-us/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):

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

vonBlobClient.download geerbt

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.

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

options to Exists operation.

Gibt zurück

Promise<boolean>

Geerbt vonBlobClient.exists

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.

Siehe https://docs.microsoft.com/en-us/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-

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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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>

VonBlobClient.getTags geerbt

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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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>

vonBlobClient.setHTTPHeaders geerbt

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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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.

Siehe https://docs.microsoft.com/en-us/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