PageBlobClient class

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

Extends

Konstruktoren

PageBlobClient(string, PipelineLike)

Erstellt eine Instanz von PageBlobClient.

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

Erstellt eine Instanz von PageBlobClient. Diese Methode akzeptiert eine codierte URL oder nicht codierte URL, die auf ein Blob verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal escaped, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname enthält? oder %, blobname muss in der URL codiert werden.

PageBlobClient(string, string, string, StoragePipelineOptions)

Erstellt eine Instanz von PageBlobClient.

Eigenschaften

containerName

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

name

Der Name des Blobs.

Geerbte Eigenschaften

accountName
credential

Beispielsweise 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. Wenn nicht angegeben, wird AnonymousCredential verwendet.

url

Codierter URL-Zeichenfolgenwert.

Methoden

clearPages(number, number, PageBlobClearPagesOptions)

Gibt die angegebenen Seiten aus dem Seitenblob frei.

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

create(number, PageBlobCreateOptions)

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

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

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 Seitenblob 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 für die Liste der Seitenbereiche für ein Seitenblob zurück.

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

.byPage() gibt einen asynchronen iterierbaren Iterator für eine Liste von Seitenbereichen 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 die Verwendung von Paging mit einem Marker:

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 die Verwendung von Paging mit einem Marker:

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 (die ein Vielfaches von 512 sein muss).

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

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(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Schreibt 1 oder mehr Seiten in das Seitenblob. 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 Bereich von Seiten 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, 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.

Geerbte Methoden

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopiert ein Blob asynchron in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Kopie abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen ist, indem Sie den Poller aufrufen cancelOperation . Beachten Sie, dass der onProgress-Rückruf nicht aufgerufen wird, wenn der Vorgang in der ersten Anforderung abgeschlossen ist und der Versuch, eine abgeschlossene Kopie abzubrechen, zu einem Fehler führt.

In Version 2012-02-12 und höher kann die Quelle für einen Kopierblobvorgang ein committetes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann die Quelle für einen Kopierblobvorgang eine Azure-Datei in einem beliebigen Azure-Speicherkonto sein. Das Kopieren aus einem anderen Speicherkonto durch den Copy Blob-Vorgang wird jedoch nur für Speicherkonten unterstützt, die ab dem 7. Juni 2012 erstellt wurden.

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

Beispiel für automatische Abrufe:

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

Beispiel für manuelle Abfragen:

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

Beispiel für Die Verwendung von Statusupdates:

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

Beispiel für ein sich änderndes Abrufintervall (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 den Kopierabbruch:

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

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

delete(BlobDeleteOptions)

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

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

deleteIfExists(BlobDeleteOptions)

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

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

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

download(number, number, BlobDownloadOptions)

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

  • In Node.js werden Daten in einem lesbaren Stream zurückgegeben.
  • In Browsern werden Daten in einem Versprechen blobBody zurückgegeben.

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 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 downloadToFile in Betracht ziehen.

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt ein Azure Blob parallel zu einem Puffer herunter. Offset und Count sind optional. Lädt das gesamte Blob herunter, wenn sie nicht bereitgestellt werden.

Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Blobs, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.

downloadToFile(string, number, number, BlobDownloadOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

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

exists(BlobExistsOptions)

Gibt true zurück, wenn die von diesem Client dargestellte Azure-Blobressource vorhanden ist. Andernfalls false.

HINWEIS: Verwenden Sie diese Funktion mit Bedacht, da ein vorhandenes Blob möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Blobs von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

generateSasUrl(BlobGenerateSasUrlOptions)

Nur für BlobClient verfügbar, der mit anmeldegeschützten Schlüsseln erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) des Blobdiensts basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

getAppendBlobClient()

Erstellt ein AppendBlobClient-Objekt.

getBlobLeaseClient(string)

Rufen Sie einen BlobLeaseClient ab, der Leases für das Blob verwaltet.

getBlockBlobClient()

Erstellt ein BlockBlobClient-Objekt.

getPageBlobClient()

Erstellt ein PageBlobClient-Objekt.

getProperties(BlobGetPropertiesOptions)

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften 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 metadata in der Antwort zurückgegebene Objekt weist seine 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 zurückgegeben werden, die Blobs mithilfe der includeMetadata Option auflisten, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.

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

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

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Legt Systemeigenschaften für den Blob fest.

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

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

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

setMetadata(Metadata, BlobSetMetadataOptions)

Legt benutzerdefinierte Metadaten für das angegebene Blob als mindestens ein Name-Wert-Paar fest.

Wenn keine Option oder keine im Parameter definierten Metadaten angegeben sind, werden die Blobmetadaten entfernt.

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. 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 ('_') .

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

undelete(BlobUndeleteOptions)

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

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

withVersion(string)

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

Details zum Konstruktor

PageBlobClient(string, PipelineLike)

Erstellt eine Instanz von PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parameter

url

string

Eine URL-Zeichenfolge, die auf das Azure Storage-Seitenblob verweist, z. B. "https://myaccount.blob.core.windows.net/mycontainer/pageblob"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"". 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 jedoch enthält? oder %, blobname muss 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. Die codierte URL-Zeichenfolge wird NICHT zweimal escaped, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn ein Blobname enthält? oder %, blobname muss in der URL codiert werden.

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

Parameter

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

PageBlobClient(string, string, string, StoragePipelineOptions)

Erstellt eine Instanz von PageBlobClient.

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

Parameter

connectionString

string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für die Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolgenbeispiel: BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Der Containername.

blobName

string

Blobname.

options
StoragePipelineOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Eigenschaft

containerName

Der Name des Speichercontainers, dem das Blob zugeordnet ist.

string containerName

Eigenschaftswert

string

name

Der Name des Blobs.

string name

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName

accountName: string

Eigenschaftswert

string

Geerbt vonBlobClient.accountName

credential

Beispielsweise 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. Wenn nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

Geerbt vonBlobClient.credential

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt vonBlobClient.url

Details zur Methode

clearPages(number, number, PageBlobClearPagesOptions)

Gibt die angegebenen Seiten aus dem Seitenblob frei.

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

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

Parameter

offset

number

Anfangsbyteposition der zu löschenden Seiten.

count

number

Anzahl der zu löschenden Bytes.

options
PageBlobClearPagesOptions

Optionen für den Vorgang Seitenblob löschen.

Gibt zurück

Antwortdaten für den Vorgang Seitenblob löschen.

create(number, PageBlobCreateOptions)

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

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 Zum Erstellen von Seitenblobs.

Gibt zurück

Antwortdaten für den Vorgang Seitenbloberstellung.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

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.

Gibt zurück

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

Anfangsbyteposition der Seitenbereiche.

count

number

Anzahl der abzurufenden Bytes.

options
PageBlobGetPageRangesOptions

Optionen für den Vorgang "Seitenblobbereiche abrufen".

Gibt zurück

Antwortdaten für den Vorgang "Seitenblobbereiche abrufen".

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

Anfangsbyteposition des Seitenblobs

count

number

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

prevSnapshot

string

Zeitstempel der Momentaufnahme zum Abrufen des Unterschieds.

options
PageBlobGetPageRangesDiffOptions

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

Gibt zurück

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

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

Anfangsbyteposition des Seitenblobs

count

number

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

prevSnapshotUrl

string

URL der Momentaufnahme, um den Unterschied abzurufen.

options
PageBlobGetPageRangesDiffOptions

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

Gibt zurück

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

listPageRanges(number, number, PageBlobListPageRangesOptions)

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

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

.byPage() gibt einen asynchronen iterierbaren Iterator für eine Liste von Seitenbereichen 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 die Verwendung von Paging mit einem Marker:

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

Anfangsbyteposition der Seitenbereiche.

count

number

Anzahl der abzurufenden Bytes.

options
PageBlobListPageRangesOptions

Optionen für den Vorgang "Seitenblobbereiche abrufen".

Gibt zurück

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 die Verwendung von Paging mit einem Marker:

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

Anfangsbyteposition der Seitenbereiche.

count

number

Anzahl der abzurufenden Bytes.

prevSnapshot

string

Zeitstempel der Momentaufnahme zum Abrufen des Unterschieds.

options
PageBlobListPageRangesDiffOptions

Optionen für den Vorgang "Seitenblobbereiche abrufen".

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

resize(number, PageBlobResizeOptions)

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

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 Zum Ändern der Größe von Seitenblobs.

Gibt zurück

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

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

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 Blobmomentaufnahme der Quellseite an. Zum Beispiel, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

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

Gibt zurück

Antwortdaten für den Vorgang Inkrementelles Kopieren von Seitenblobs.

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 update ist

options
PageBlobUpdateSequenceNumberOptions

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

Gibt zurück

Antwortdaten für den Vorgang Seitenblob-Aktualisierungssequenznummer.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

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

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

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

Parameter

body
HttpRequestBody

Hochzuladende Daten

offset

number

Offset des Zielseitenblobs

count

number

Inhaltslänge des Texts, auch Anzahl der hochzuladenden Bytes

options
PageBlobUploadPagesOptions

Optionen für den Vorgang Seitenblob hochladen.

Gibt zurück

Antwortdaten für den Vorgang Seitenblob hochladen.

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

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

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

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

sourceOffset

number

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

destOffset

number

Offset des Zielseitenblobs

count

number

Anzahl der Bytes, die aus dem Quellseitenblob hochgeladen werden sollen

Gibt zurück

withSnapshot(string)

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

function withSnapshot(snapshot: string): PageBlobClient

Parameter

snapshot

string

Der Momentaufnahmezeitstempel.

Gibt zurück

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

Details zur geerbten Methode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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 "Aus URL kopieren".

options
BlobAbortCopyFromURLOptions

Optionale Optionen für den Vorgang Blobabbruch kopieren von URL.

Gibt zurück

Geerbt vonBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Kopiert ein Blob asynchron in ein Ziel innerhalb des Speicherkontos. Diese Methode gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Kopie abgeschlossen ist. Sie können eine Kopie auch abbrechen, bevor sie abgeschlossen ist, indem Sie den Poller aufrufen cancelOperation . Beachten Sie, dass der onProgress-Rückruf nicht aufgerufen wird, wenn der Vorgang in der ersten Anforderung abgeschlossen ist und der Versuch, eine abgeschlossene Kopie abzubrechen, zu einem Fehler führt.

In Version 2012-02-12 und höher kann die Quelle für einen Kopierblobvorgang ein committetes Blob in einem beliebigen Azure-Speicherkonto sein. Ab Version 2015-02-21 kann die Quelle für einen Kopierblobvorgang eine Azure-Datei in einem beliebigen Azure-Speicherkonto sein. Das Kopieren aus einem anderen Speicherkonto durch den Copy Blob-Vorgang wird jedoch nur für Speicherkonten unterstützt, die ab dem 7. Juni 2012 erstellt wurden.

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

Beispiel für automatische Abrufe:

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

Beispiel für manuelle Abfragen:

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

Beispiel für Die Verwendung von Statusupdates:

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

Beispiel für ein sich änderndes Abrufintervall (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 den Kopierabbruch:

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 zum Quell-Azure-Blob/-Datei.

options
BlobBeginCopyFromURLOptions

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

Gibt zurück

Geerbt vonBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Erstellt eine schreibgeschützte Momentaufnahme eines BLOB.

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 Vorgang Bloberstellung momentaufnahme.

Gibt zurück

Geerbt vonBlobClient.createSnapshot

delete(BlobDeleteOptions)

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

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

Gibt zurück

Geerbt vonBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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

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

Gibt zurück

Geerbt vonBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Löschen Sie die Unveränderlichkeitsrichtlinie 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

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

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 herunterzuladenden Blobs größer oder gleich 0

count

number

Wie viele Daten heruntergeladen werden sollen, größer als 0. Wird bis zum Ende heruntergeladen, wenn nicht definiert

options
BlobDownloadOptions

Optionale Optionen für den Blob-Download-Vorgang.

Beispielverwendung (Node.js):

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

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

Beispielverwendung (Browser):

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

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

Gibt zurück

Geerbt vonBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

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

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

Parameter

buffer

Buffer

Puffer, der gefüllt werden soll, muss eine Länge haben, die größer als die Anzahl ist

offset

number

Von welcher Position des Blockblobs heruntergeladen werden soll (in Bytes)

count

number

Wie viele Daten (in Bytes) heruntergeladen werden sollen. Wird beim Übergeben von undefined an das Ende heruntergeladen.

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

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 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 downloadToFile in Betracht ziehen.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parameter

offset

number

Von welcher Position des Blockblobs heruntergeladen werden soll (in Bytes)

count

number

Wie viele Daten (in Bytes) heruntergeladen werden sollen. Wird bis zum Ende heruntergeladen, wenn undefined übergeben wird

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

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. 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): Promise<BlobDownloadResponseParsed>

Parameter

filePath

string

offset

number

Von welcher Position des Blockblobs heruntergeladen werden soll.

count

number

Wie viele Daten heruntergeladen werden sollen. Wird bis zum Ende heruntergeladen, wenn undefined übergeben wird.

options
BlobDownloadOptions

Optionen für Blobdownloadoptionen.

Gibt zurück

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.

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

function exists(options?: BlobExistsOptions): Promise<boolean>

Parameter

options
BlobExistsOptions

Optionen zum Exists-Vorgang.

Gibt zurück

Promise<boolean>

Geerbt vonBlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

Nur für BlobClient verfügbar, der mit anmeldegeschützten Schlüsseln erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) des Blobdiensts basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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 von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.

Geerbt vonBlobClient.generateSasUrl

getAppendBlobClient()

Erstellt ein AppendBlobClient-Objekt.

function getAppendBlobClient(): AppendBlobClient

Gibt zurück

Geerbt vonBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Rufen Sie einen BlobLeaseClient ab, der Leases für das Blob verwaltet.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parameter

proposeLeaseId

string

Anfängliche vorgeschlagene Lease-ID.

Gibt zurück

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

Geerbt vonBlobClient.getBlockBlobClient

getPageBlobClient()

Erstellt ein PageBlobClient-Objekt.

function getPageBlobClient(): PageBlobClient

Gibt zurück

Geerbt vonBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften 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 metadata in der Antwort zurückgegebene Objekt weist seine 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 zurückgegeben werden, die Blobs mithilfe der includeMetadata Option auflisten, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parameter

options
BlobGetPropertiesOptions

Optionale Optionen zum Abrufen von Eigenschaften.

Gibt zurück

Geerbt vonBlobClient.getProperties

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Parameter

Gibt zurück

Geerbt vonBlobClient.getTags

setAccessTier(string, BlobSetTierOptions)

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

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

options
BlobSetTierOptions

Optionale Optionen für den Vorgang Blobsatzebene.

Gibt zurück

Geerbt vonBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Legt Systemeigenschaften für den Blob fest.

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

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 oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne Wert gelöscht. Ein gängiger Header, der festgelegt werden muss, ist blobContentType , dass der Browser Funktionen basierend auf dem Dateityp bereitstellt.

options
BlobSetHTTPHeadersOptions

Optionale Optionen zum Blob set HTTP Headers-Vorgang.

Gibt zurück

Geerbt vonBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Legen Sie die Unmutablilitätsrichtlinie 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

Geerbt vonBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parameter

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

Optionale Optionen zum Festlegen der aufbewahrungsrechtlichen Aufbewahrung für das Blob.

Gibt zurück

Geerbt vonBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Legt benutzerdefinierte Metadaten für das angegebene Blob als mindestens ein Name-Wert-Paar fest.

Wenn keine Option oder keine im Parameter definierten Metadaten angegeben sind, werden die Blobmetadaten entfernt.

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 angegeben ist, werden die vorhandenen Metadaten entfernt.

options
BlobSetMetadataOptions

Optionale Optionen zum Festlegen des Metadatenvorgangs.

Gibt zurück

Geerbt vonBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Legt Tags für das zugrunde liegende Blob fest. Ein Blob kann bis zu 10 Tags aufweisen. Tagschlüssel müssen zwischen 1 und 128 Zeichen lang sein. Tagwerte müssen zwischen 0 und 256 Zeichen lang sein. Gültige Tagschlüssel- und Wertzeichen sind Klein- und Großbuchstaben, Ziffern (0-9), Leerzeichen (' '), Pluszeichen ('+'), Minuszeichen ('-), Punkt ('.),Schrägstrich ('/'), Doppelpunkt (':'), gleich ('=') und Unterstrich ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parameter

tags
Tags

Gibt zurück

Geerbt vonBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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. Shared Access Signature (SAS) wird möglicherweise für die Authentifizierung benötigt.

Gibt zurück

Geerbt vonBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

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

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 den Vorgang "Blob Wiederherstellen".

Gibt zurück

Geerbt vonBlobClient.undelete

withVersion(string)

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

function withVersion(versionId: string): BlobClient

Parameter

versionId

string

Die versionId.

Gibt zurück

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

Geerbt vonBlobClient.withVersion