Megosztás a következőn keresztül:

PageBlobClient class

Csomag:
@azure/storage-blob

A PageBlobClient a lapblobokra vonatkozó műveletek készletét határozza meg.

Extends
BlobClient

Konstruktorok

PageBlobClient(string, PipelineLike)

Létrehozza a PageBlobClient egy példányát.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehozza a PageBlobClient egy példányát. Ez a metódus egy blobra mutató kódolt VAGY nem kódolt URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.
PageBlobClient(string, string, string, StoragePipelineOptions)

Létrehozza a PageBlobClient egy példányát.

Tulajdonságok

containerName

Annak a tárolónak a neve, amelyhez a blob társítva van.
name

A blob neve.

Örökölt tulajdonságok

accountName
credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
url

Kódolt URL-sztringérték.

Metódusok

clearPages(number, number, PageBlobClearPagesOptions)

Felszabadítja a megadott lapokat a lapblobból.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

A megadott hosszúságú lapblobot hoz létre. Az uploadPages meghívása adatadatok lapblobba való feltöltéséhez.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

A megadott hosszúságú lapblobot hoz létre. Az uploadPages meghívása adatadatok lapblobba való feltöltéséhez. Ha az azonos nevű blob már létezik, a meglévő blob tartalma változatlan marad.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

Egy lapblob érvényes oldaltartományainak vagy egy lapblob pillanatképének listáját adja vissza.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Lekéri a megadott pillanatkép és a lapblob között eltérő oldaltartományok gyűjteményét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Lekéri a megadott pillanatkép és a felügyelt lemezek lapblobja közötti különbséget tartalmazó oldaltartományok gyűjteményét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Egy aszinkron iterátort ad vissza egy lapblob oldaltartományainak listájához.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

A .byPage() egy aszinkron iterátort ad vissza egy lapblob oldaltartományainak listájához.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRanges();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    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
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Egy aszinkron iterátort ad vissza a megadott pillanatkép és a lapblob között különbséget tevő oldaltartományok listájához.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

A .byPage() egy aszinkron iterátort ad vissza a megadott pillanatkép és a lapblob között eltérő oldaltartományok listájához.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

const offset = 0;
const count = 1024;
const previousSnapshot = "<previous snapshot>";
// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot)) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot);
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
resize(number, PageBlobResizeOptions)

Átméretezi a lapblobot a megadott méretre (amelynek 512-es többszörösének kell lennie).

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Elindít egy műveletet, amely elindít egy növekményes másolatot az egyik lapblob pillanatképéből erre a lapblobra. A rendszer úgy másolja a pillanatképet, hogy csak a korábban másolt pillanatkép közötti különbségváltozások kerülnek át a célhelyre. A másolt pillanatképek az eredeti pillanatkép teljes másolatai, és a szokásos módon olvashatók vagy másolhatók.

Lásd: https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob Lásd: https://learn.microsoft.com/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Beállítja egy lapblob sorszámát.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

1 vagy több oldalt ír a lapblobba. A kezdő és a záró eltolásnak az 512 többszörösének kell lennie.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

A Lapok feltöltése művelet oldaltartományt ír egy lapblobba, ahol a tartalom egy URL-címről olvasható.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-page-from-url
withSnapshot(string)

Létrehoz egy új PageBlobClient objektumot, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel. A "" megadása eltávolítja a pillanatképet, és visszaad egy ügyfelet az alapblobba.

Örökölt metódusok

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Megszakít egy függőben lévő aszinkron másolási blobműveletet, és a célblobot nulla hosszúságú és teljes metaadatokkal hagyja el. 2012-02-12-es és újabb verzió.

Lásd: https://learn.microsoft.com/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Aszinkron módon másol egy blobot a tárfiók egyik célhelyére. Ez a metódus egy hosszú ideig futó műveletet ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a másolat befejeződik. A példányt a lekérdező cancelOperation hívásával is megszakíthatja. Vegye figyelembe, hogy az onProgress visszahívás nem lesz meghívva, ha a művelet az első kérelemben befejeződik, és a befejezett másolat visszavonásának megkísérlése hibát eredményez.

A 2012-02-12-es és újabb verziókban a Blob másolása művelet forrása bármely Azure-tárfiókban lekötött blob lehet. A 2015-02-21-es verziótól kezdve a Blob másolása művelet forrása bármely Azure-tárfiókban azure-fájl lehet. Csak a 2012. június 7-én vagy azt követően létrehozott tárfiókok engedélyezik a Blob másolása művelet másolását egy másik tárfiókból.

Lásd: https://learn.microsoft.com/rest/api/storageservices/copy-blob

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

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

Egy blob írásvédett pillanatképét hozza létre.

Lásd: https://learn.microsoft.com/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)

Megjelöli a megadott blobot vagy pillanatképet törlésre. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettő törölhető.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)

Megjelöli a megadott blobot vagy pillanatképet a törléshez, ha létezik. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettő törölhető.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Törölje az immutablility szabályzatot a blobon.
download(number, number, BlobDownloadOptions)

Beolvas vagy letölt egy blobot a rendszerből, beleértve annak metaadatait és tulajdonságait. A Pillanatképek olvasásához meghívhatja a Blob lekérése parancsot is.

  • A Node.jsaz adatok olvasható streamelhetőStreamBody-fájlban térnek vissza
  • A böngészőkben az adatok egy ígéret blobBody-ban térnek vissza

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Egy Azure-blobot egy pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ilyen méretű blobok esetében fontolja meg downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Egy Azure-blobot egy pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ilyen méretű blobok esetében fontolja meg downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Letölt egy Azure-blobot egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes blob letöltéséhez adja meg a 0- és a nem definiált értékeket.
exists(BlobExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő blobot más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új blobokat adnak hozzá.
generateSasStringToSign(BlobGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.

Sztringet hoz létre a blobszolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(BlobGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.

Létrehoz egy Blob Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.

Sztringet hoz létre a blobszolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

Létrehoz egy Blob Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)

A Fiókadatok lekérése művelet a megadott fiók termékváltozatának nevét és típusát adja vissza. A Fiókadatok lekérése művelet a 2018-03-28-es verziójú szolgáltatásverziókban érhető el.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-account-information
getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.
getBlobLeaseClient(string)

Szerezzen be egy BlobLeaseClient, amely kezeli a blob bérleteit.
getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.
getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.
getProperties(BlobGetPropertiesOptions)

A blob felhasználó által definiált metaadatait, szabványos HTTP-tulajdonságait és rendszertulajdonságait adja vissza. Nem adja vissza a blob tartalmát.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ContainerClient által visszaadott metaadatkulcsoktól, amelyek a includeMetadata beállítással sorolják fel a blobokat, amelyek megőrzik az eredeti burkolatukat.
getTags(BlobGetTagsOptions)

Lekéri a mögöttes blobhoz társított címkéket.
setAccessTier(string, BlobSetTierOptions)

Beállítja a réteget egy blobon. A művelet engedélyezett egy prémium szintű tárfiók lapblobján és egy blobtároló fiók blokkblobján (csak helyileg redundáns tárolás esetén). A prémium szintű lapblobok szintje határozza meg a blob engedélyezett méretét, IOPS-ját és sávszélességét. A blokkblobok szintje határozza meg a gyakori elérésű/ritka elérésű/archív tárolási típust. Ez a művelet nem frissíti a blob ETagjét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHttpHeaders, BlobSetHTTPHeadersOptions)

A blob rendszertulajdonságainak beállítása.

Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Állítsa be a nem módosíthatósági szabályzatot a blobon.
setLegalHold(boolean, BlobSetLegalHoldOptions)

Állítson be jogi mentességet a blobon.
setMetadata(Metadata, BlobSetMetadataOptions)

A megadott blob felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a blob metaadatai el lesznek távolítva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

Beállítja a címkéket a mögöttes blobon. Egy blob legfeljebb 10 címkével rendelkezhet. A címkekulcsnak 1 és 128 karakter közöttinek kell lennie. A címke értékeinek 0 és 256 karakter közöttinek kell lenniük. Az érvényes címkekulcs- és értékkarakterek közé tartoznak a kis- és nagybetűk, a számjegyek (0-9), a szóköz (' '), plusz ('+'), a mínusz ('-'), a pont ('.'), az előre perjel ('/'), a kettőspont (':'), az egyenlőség ('=') és az aláhúzás ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A szinkron másolás URL-címről művelet egy blobot vagy egy internetes erőforrást másol egy új blobba. A rendszer nem ad vissza választ, amíg a másolat be nem fejeződik.

Lásd: https://learn.microsoft.com/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)

Visszaállítja a helyreállíthatóan törölt blobok és a kapcsolódó helyreállíthatóan törölt pillanatképek tartalmát és metaadatait. Az Undelete Blob csak a 2017-07-29-es vagy újabb verzióban támogatott.

Lásd: https://learn.microsoft.com/rest/api/storageservices/undelete-blob
withVersion(string)

Létrehoz egy új BlobClient-objektumot, amely ennek a blobnak egy verziójára mutat. A "" megadása eltávolítja a versionId azonosítót, és visszaad egy ügyfelet az alapblobba.

Konstruktor adatai

PageBlobClient(string, PipelineLike)

Létrehozza a PageBlobClient egy példányát.

new PageBlobClient(url: string, pipeline: PipelineLike)

Paraméterek

url

string

Egy Azure Storage-lapblobra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString". Ez a metódus egy blobra mutató kódolt VAGY nem kódolt URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha azonban egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni. Például a "my?blob%" nevű blob url-címének "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline
PipelineLike

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

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

Létrehozza a PageBlobClient egy példányát. Ez a metódus egy blobra mutató kódolt VAGY nem kódolt URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.

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

Paraméterek

url

string

Egy Azure Storage-lapblobra mutató ügyfélsztring, például "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

PageBlobClient(string, string, string, StoragePipelineOptions)

Létrehozza a PageBlobClient egy példányát.

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

Paraméterek

connectionString

string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – 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

Tároló neve.

blobName

string

Blob neve.

options
StoragePipelineOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Tulajdonság adatai

containerName

Annak a tárolónak a neve, amelyhez a blob társítva van.

string containerName

Tulajdonság értéke

string

name

A blob neve.

string name

Tulajdonság értéke

string

Örökölt tulajdonság részletei

accountName 

accountName: string

Tulajdonság értéke

string

A BlobClient.accountNamefelhasználótól örökölt

credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

A BlobClient.credential-tőlörökölve

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

A BlobClient.url-tőlörökölt

Metódus adatai

clearPages(number, number, PageBlobClearPagesOptions)

Felszabadítja a megadott lapokat a lapblobból.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-page

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

Paraméterek

offset

number

A lapok kezdő bájtpozíciója a törléshez.

count

number

A törölni kívánt bájtok száma.

options
PageBlobClearPagesOptions

A Lapblob lap törlése művelet beállításai.

Válaszok

Promise<PageBlobClearPagesResponse>

Válaszadatok a Page Blob Clear Pages művelethez.

create(number, PageBlobCreateOptions)

A megadott hosszúságú lapblobot hoz létre. Az uploadPages meghívása adatadatok lapblobba való feltöltéséhez.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-blob

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

Paraméterek

size

number

az oldalblob mérete.

options
PageBlobCreateOptions

A Lapblob létrehozása művelet beállításai.

Válaszok

Promise<PageBlobCreateResponse>

Válaszadatok a Lapblob létrehozása művelethez.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

A megadott hosszúságú lapblobot hoz létre. Az uploadPages meghívása adatadatok lapblobba való feltöltéséhez. Ha az azonos nevű blob már létezik, a meglévő blob tartalma változatlan marad.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-blob

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

Paraméterek

size

number

az oldalblob mérete.

options
PageBlobCreateIfNotExistsOptions

Válaszok

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Egy lapblob érvényes oldaltartományainak vagy egy lapblob pillanatképének listáját adja vissza.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

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

Paraméterek

offset

number

Az oldaltartományok kezdő bájtpozíciója.

count

number

Lekérendő bájtok száma.

options
PageBlobGetPageRangesOptions

A Page Blob Get Ranges művelet beállításai.

Válaszok

Promise<PageBlobGetPageRangesResponse>

A Page Blob Get Ranges művelet válaszadatai.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Lekéri a megadott pillanatkép és a lapblob között eltérő oldaltartományok gyűjteményét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

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

Paraméterek

offset

number

A lapblob kezdő bájthelyzete

count

number

A tartományok lekéréséhez megadott bájtok száma.

prevSnapshot

string

Pillanatkép időbélyege a különbség lekéréséhez.

options
PageBlobGetPageRangesDiffOptions

A Page Blob Get Page Ranges Diff művelet beállításai.

Válaszok

Promise<PageBlobGetPageRangesDiffResponse>

A Page Blob Get Page Range Diff művelet válaszadatai.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Lekéri a megadott pillanatkép és a felügyelt lemezek lapblobja közötti különbséget tartalmazó oldaltartományok gyűjteményét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

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

Paraméterek

offset

number

A lapblob kezdő bájthelyzete

count

number

A tartományok lekéréséhez megadott bájtok száma.

prevSnapshotUrl

string

A különbség lekéréséhez a pillanatkép URL-címe.

options
PageBlobGetPageRangesDiffOptions

A Page Blob Get Page Ranges Diff művelet beállításai.

Válaszok

Promise<PageBlobGetPageRangesDiffResponse>

A Page Blob Get Page Range Diff művelet válaszadatai.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Egy aszinkron iterátort ad vissza egy lapblob oldaltartományainak listájához.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

A .byPage() egy aszinkron iterátort ad vissza egy lapblob oldaltartományainak listájához.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRanges();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    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
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

Paraméterek

offset

number

Az oldaltartományok kezdő bájtpozíciója.

count

number

Lekérendő bájtok száma.

options
PageBlobListPageRangesOptions

A Page Blob Get Ranges művelet beállításai.

Válaszok

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Lapozást támogató asyncIterableIterator.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Egy aszinkron iterátort ad vissza a megadott pillanatkép és a lapblob között különbséget tevő oldaltartományok listájához.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

A .byPage() egy aszinkron iterátort ad vissza a megadott pillanatkép és a lapblob között eltérő oldaltartományok listájához.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

const offset = 0;
const count = 1024;
const previousSnapshot = "<previous snapshot>";
// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot)) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot);
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

Paraméterek

offset

number

Az oldaltartományok kezdő bájtpozíciója.

count

number

Lekérendő bájtok száma.

prevSnapshot

string

Pillanatkép időbélyege a különbség lekéréséhez.

options
PageBlobListPageRangesDiffOptions

A Page Blob Get Ranges művelet beállításai.

Válaszok

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Lapozást támogató asyncIterableIterator.

resize(number, PageBlobResizeOptions)

Átméretezi a lapblobot a megadott méretre (amelynek 512-es többszörösének kell lennie).

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

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

Paraméterek

size

number

Célméret

options
PageBlobResizeOptions

A lapblob átméretezési műveletének beállításai.

Válaszok

Promise<PageBlobResizeResponse>

Válaszadatok a lapblob átméretezési műveletéhez.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Elindít egy műveletet, amely elindít egy növekményes másolatot az egyik lapblob pillanatképéből erre a lapblobra. A rendszer úgy másolja a pillanatképet, hogy csak a korábban másolt pillanatkép közötti különbségváltozások kerülnek át a célhelyre. A másolt pillanatképek az eredeti pillanatkép teljes másolatai, és a szokásos módon olvashatók vagy másolhatók.

Lásd: https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob Lásd: https://learn.microsoft.com/azure/virtual-machines/windows/incremental-snapshots

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

Paraméterek

copySource

string

Megadja a forrásoldali blob pillanatképének nevét. Például: https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>

options
PageBlobStartCopyIncrementalOptions

A Lapblob másolása növekményes művelet beállításai.

Válaszok

Promise<PageBlobCopyIncrementalResponse>

Válaszadatok a Lapblob másolása növekményes művelethez.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Beállítja egy lapblob sorszámát.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

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

Paraméterek

sequenceNumberAction
SequenceNumberActionType

Azt jelzi, hogy a szolgáltatás hogyan módosítsa a blob sorszámát.

sequenceNumber

number

A sequenceNumberAction maximális vagy frissítési értéke esetén kötelező

options
PageBlobUpdateSequenceNumberOptions

A Page Blob Update Sequence Number művelet beállításai.

Válaszok

Promise<PageBlobUpdateSequenceNumberResponse>

Válaszadatok a Lapblob frissítési sorszám műveletéhez.

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

1 vagy több oldalt ír a lapblobba. A kezdő és a záró eltolásnak az 512 többszörösének kell lennie.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-page

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

Paraméterek

body
HttpRequestBody

Feltöltendő adatok

offset

number

Céloldali blob eltolása

count

number

A törzs tartalomhossza, valamint a feltöltendő bájtok száma

options
PageBlobUploadPagesOptions

A Lapblobok lapfeltöltési műveletének beállításai.

Válaszok

Promise<PageBlobUploadPagesResponse>

Válaszadatok a Page Blob Upload Pages művelethez.

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

A Lapok feltöltése művelet oldaltartományt ír egy lapblobba, ahol a tartalom egy URL-címről olvasható.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-page-from-url

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

Paraméterek

sourceURL

string

Adja meg a másolási forrás URL-címét, a hitelesítéshez esetleg szükséges közös hozzáférésű jogosultságkódot (SAS)

sourceOffset

number

A forrás eltolása, amelyből másolni szeretne. 0 átadása a forrásoldal blobjának elejéről történő másoláshoz

destOffset

number

Céloldali blob eltolása

count

number

A forrásoldali blobból feltöltendő bájtok száma

options
PageBlobUploadPagesFromURLOptions

Válaszok

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Létrehoz egy új PageBlobClient objektumot, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel. A "" megadása eltávolítja a pillanatképet, és visszaad egy ügyfelet az alapblobba.

function withSnapshot(snapshot: string): PageBlobClient

Paraméterek

snapshot

string

A pillanatkép időbélyege.

Válaszok

PageBlobClient

Egy új PageBlobClient objektum, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel.

Örökölt metódus részletei

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Megszakít egy függőben lévő aszinkron másolási blobműveletet, és a célblobot nulla hosszúságú és teljes metaadatokkal hagyja el. 2012-02-12-es és újabb verzió.

Lásd: https://learn.microsoft.com/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Paraméterek

copyId

string

A Másolás URL-címről művelet azonosítója.

options
BlobAbortCopyFromURLOptions

Az URL-címről történő blobok másolásának megszakítása művelet választható beállításai.

Válaszok

Promise<BlobAbortCopyFromURLResponse>

A BlobClient.abortCopyFromURL-tőlörökölt

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Aszinkron módon másol egy blobot a tárfiók egyik célhelyére. Ez a metódus egy hosszú ideig futó műveletet ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a másolat befejeződik. A példányt a lekérdező cancelOperation hívásával is megszakíthatja. Vegye figyelembe, hogy az onProgress visszahívás nem lesz meghívva, ha a művelet az első kérelemben befejeződik, és a befejezett másolat visszavonásának megkísérlése hibát eredményez.

A 2012-02-12-es és újabb verziókban a Blob másolása művelet forrása bármely Azure-tárfiókban lekötött blob lehet. A 2015-02-21-es verziótól kezdve a Blob másolása művelet forrása bármely Azure-tárfiókban azure-fájl lehet. Csak a 2012. június 7-én vagy azt követően létrehozott tárfiókok engedélyezik a Blob másolása művelet másolását egy másik tárfiókból.

Lásd: https://learn.microsoft.com/rest/api/storageservices/copy-blob

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

// Example using copy cancellation:
const cancelCopyPoller = await blobClient.beginCopyFromURL("url");
// cancel operation after starting it.
try {
  await cancelCopyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  cancelCopyPoller.getResult();
} catch (err: any) {
  if (err.name === "PollerCancelledError") {
    console.log("The copy was cancelled.");
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Paraméterek

copySource

string

url-címet a forrás Azure Blob/File fájlba.

options
BlobBeginCopyFromURLOptions

A Blob Start Copy From URL-művelet választható beállításai.

Válaszok

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

A BlobClient.beginCopyFromURL-tőlörökölt

createSnapshot(BlobCreateSnapshotOptions)

Egy blob írásvédett pillanatképét hozza létre.

Lásd: https://learn.microsoft.com/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Paraméterek

options
BlobCreateSnapshotOptions

A Blob Create Snapshot művelet választható beállításai.

Válaszok

Promise<BlobCreateSnapshotResponse>

A BlobClient.createSnapshotfájlból örökölt

delete(BlobDeleteOptions)

Megjelöli a megadott blobot vagy pillanatképet törlésre. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettő törölhető.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Paraméterek

options
BlobDeleteOptions

A Blob Delete művelet választható beállításai.

Válaszok

Promise<BlobDeleteResponse>

A BlobClient.deletefájlból örökölt

deleteIfExists(BlobDeleteOptions)

Megjelöli a megadott blobot vagy pillanatképet a törléshez, ha létezik. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettő törölhető.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Paraméterek

options
BlobDeleteOptions

A Blob Delete művelet választható beállításai.

Válaszok

Promise<BlobDeleteIfExistsResponse>

A BlobClient.deleteIfExistsfájlból örökölt

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Törölje az immutablility szabályzatot a blobon.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Paraméterek

options
BlobDeleteImmutabilityPolicyOptions

Választható lehetőségek a blob nem módosíthatósági szabályzatának törlésére.

Válaszok

Promise<BlobDeleteImmutabilityPolicyResponse>

A BlobClient.deleteImmutabilityPolicywebhelyről örökölt

download(number, number, BlobDownloadOptions)

Beolvas vagy letölt egy blobot a rendszerből, beleértve annak metaadatait és tulajdonságait. A Pillanatképek olvasásához meghívhatja a Blob lekérése parancsot is.

  • A Node.jsaz adatok olvasható streamelhetőStreamBody-fájlban térnek vissza
  • A böngészőkben az adatok egy ígéret blobBody-ban térnek vissza

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Paraméterek

offset

number

A blob letöltésének helye 0-nál nagyobb vagy egyenlő

count

number

A letöltendő adatok száma 0-nál nagyobb. A letöltés a végéhez ér, ha nincs meghatározva

options
BlobDownloadOptions

A blobletöltési művelet választható beállításai.

Példahasználat (Node.js):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
const downloadBlockBlobResponse = await blobClient.download();
if (downloadBlockBlobResponse.readableStreamBody) {
  const downloaded = await streamToString(downloadBlockBlobResponse.readableStreamBody);
  console.log(`Downloaded blob content: ${downloaded}`);
}

async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
  const result = await new Promise<Buffer<ArrayBuffer>>((resolve, reject) => {
    const chunks: Buffer[] = [];
    stream.on("data", (data) => {
      chunks.push(Buffer.isBuffer(data) ? data : Buffer.from(data));
    });
    stream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    stream.on("error", reject);
  });
  return result.toString();
}

Példa a használatra (böngésző):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
const downloadBlockBlobResponse = await blobClient.download();
const blobBody = await downloadBlockBlobResponse.blobBody;
if (blobBody) {
  const downloaded = await blobBody.text();
  console.log(`Downloaded blob content: ${downloaded}`);
}

Válaszok

Promise<BlobDownloadResponseParsed>

A BlobClient.downloadfájlból örökölt

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Egy Azure-blobot egy pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ilyen méretű blobok esetében fontolja meg downloadToFile.

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

Paraméterek

buffer

Buffer

A kitöltéshez szükséges puffernek a darabszámnál nagyobb hosszúságúnak kell lennie

offset

number

A blokkblob letöltésének helye (bájtban)

count

number

Mennyi adat (bájtban) tölthető le. A letöltés a végéhez ér, ha nem definiált állapotot ad át

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

A BlobClient.downloadToBufferfájlból örökölt

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Egy Azure-blobot egy pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ilyen méretű blobok esetében fontolja meg downloadToFile.

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

Paraméterek

offset

number

A blokkblob letöltésének helye (bájtban)

count

number

Mennyi adat (bájtban) tölthető le. A letöltés a végéhez ér, ha nem definiált állapotot ad át

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

A BlobClient.downloadToBufferfájlból örökölt

downloadToFile(string, number, number, BlobDownloadOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Letölt egy Azure-blobot egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes blob letöltéséhez adja meg a 0- és a nem definiált értékeket.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Paraméterek

filePath

string

offset

number

A blokkblob letöltésének helye.

count

number

Mennyi adatot kell letölteni. A letöltés a végéhez ér, amikor nem definiált állapotot ad át.

options
BlobDownloadOptions

A Blob letöltési beállításai.

Válaszok

Promise<BlobDownloadResponseParsed>

A blobletöltési művelet válaszadatai, de az olvashatóStreamBody értéke nincs meghatározva, mivel a tartalom már be van írva egy helyi fájlba a megadott elérési úton.

A BlobClient.downloadToFilefájlból örökölt

exists(BlobExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő blobot más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új blobokat adnak hozzá.

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

Paraméterek

options
BlobExistsOptions

beállítási lehetőségeket a Exists művelethez.

Válaszok

Promise<boolean>

A BlobClient.existsfájlból örökölt

generateSasStringToSign(BlobGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.

Sztringet hoz létre a blobszolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Paraméterek

options
BlobGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

A BlobClient.generateSasStringToSignwebhelyről örökölt

generateSasUrl(BlobGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.

Létrehoz egy Blob Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Paraméterek

options
BlobGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

Promise<string>

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

A BlobClient.generateSasUrl-tőlörökölt

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.

Sztringet hoz létre a blobszolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Paraméterek

options
BlobGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

A BlobClient.generateUserDelegationSasStringToSignwebhelyről örökölt

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

Létrehoz egy Blob Service Megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Paraméterek

options
BlobGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

Válaszok

Promise<string>

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

A BlobClient.generateUserDelegationSasUrl-tőlörökölt

getAccountInfo(BlobGetAccountInfoOptions)

A Fiókadatok lekérése művelet a megadott fiók termékváltozatának nevét és típusát adja vissza. A Fiókadatok lekérése művelet a 2018-03-28-es verziójú szolgáltatásverziókban érhető el.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-account-information

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Paraméterek

options
BlobGetAccountInfoOptions

A Szolgáltatás lekérése fiókinformációs művelet beállításai.

Válaszok

Promise<BlobGetAccountInfoResponse>

A Szolgáltatás lekérése fiókinformációs művelet válaszadatai.

A BlobClient.getAccountInfofájlból örökölt

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient(): AppendBlobClient

Válaszok

AppendBlobClient

A BlobClient.getAppendBlobClient-tőlörökölt

getBlobLeaseClient(string)

Szerezzen be egy BlobLeaseClient, amely kezeli a blob bérleteit.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paraméterek

proposeLeaseId

string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

Új BlobLeaseClient objektum a blob bérleteinek kezeléséhez.

A BlobClient.getBlobLeaseClient-tőlörökölt

getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.

function getBlockBlobClient(): BlockBlobClient

Válaszok

BlockBlobClient

A BlobClient.getBlockBlobClient-tőlörökölt

getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.

function getPageBlobClient(): PageBlobClient

Válaszok

PageBlobClient

A BlobClient.getPageBlobClient-tőlörökölt

getProperties(BlobGetPropertiesOptions)

A blob felhasználó által definiált metaadatait, szabványos HTTP-tulajdonságait és rendszertulajdonságait adja vissza. Nem adja vissza a blob tartalmát.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ContainerClient által visszaadott metaadatkulcsoktól, amelyek a includeMetadata beállítással sorolják fel a blobokat, amelyek megőrzik az eredeti burkolatukat.

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

Paraméterek

options
BlobGetPropertiesOptions

A Tulajdonságok lekérése művelet választható beállításai.

Válaszok

Promise<BlobGetPropertiesResponse>

A BlobClient.getPropertiesfájlból örökölt

getTags(BlobGetTagsOptions)

Lekéri a mögöttes blobhoz társított címkéket.

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

Paraméterek

options
BlobGetTagsOptions

Válaszok

Promise<BlobGetTagsResponse>

A BlobClient.getTags-tőlörökölt

setAccessTier(string, BlobSetTierOptions)

Beállítja a réteget egy blobon. A művelet engedélyezett egy prémium szintű tárfiók lapblobján és egy blobtároló fiók blokkblobján (csak helyileg redundáns tárolás esetén). A prémium szintű lapblobok szintje határozza meg a blob engedélyezett méretét, IOPS-ját és sávszélességét. A blokkblobok szintje határozza meg a gyakori elérésű/ritka elérésű/archív tárolási típust. Ez a művelet nem frissíti a blob ETagjét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Paraméterek

tier

string

A blobon beállítani kívánt szint. Az érvényes értékek a gyakori elérésű, a ritka elérésű vagy az archív értékek.

options
BlobSetTierOptions

A BlobKészletszint művelet választható beállításai.

Válaszok

Promise<BlobSetTierResponse>

A BlobClient.setAccessTierwebhelyről örökölt

setHTTPHeaders(BlobHttpHeaders, BlobSetHTTPHeadersOptions)

A blob rendszertulajdonságainak beállítása.

Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHttpHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Paraméterek

blobHTTPHeaders
BlobHTTPHeaders

Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek. Egy gyakran beállítható fejléc blobContentType, amely lehetővé teszi a böngésző számára, hogy fájltípuson alapuló funkciókat biztosítson.

options
BlobSetHTTPHeadersOptions

A BLOB HTTP-fejlécek beállítása művelet választható beállításai.

Válaszok

Promise<BlobSetHTTPHeadersResponse>

A BlobClient.setHTTPHeaders-tőlörökölt

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Állítsa be a nem módosíthatósági szabályzatot a blobon.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Paraméterek

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Nem kötelező beállítások a blob módosíthatósági szabályzatának beállításához.

Válaszok

Promise<BlobSetImmutabilityPolicyResponse>

A BlobClient.setImmutabilityPolicywebhelyről örökölt

setLegalHold(boolean, BlobSetLegalHoldOptions)

Állítson be jogi mentességet a blobon.

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

Paraméterek

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

Választható lehetőségek a blob jogi célú visszatartására.

Válaszok

Promise<BlobSetLegalHoldResponse>

A BlobClient.setLegalHold-tólörökölt

setMetadata(Metadata, BlobSetMetadataOptions)

A megadott blob felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a blob metaadatai el lesznek távolítva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Paraméterek

metadata
Metadata

Cserélje le a meglévő metaadatokat erre az értékre. Ha nincs megadva érték, a meglévő metaadatok el lesznek távolítva.

options
BlobSetMetadataOptions

A metaadat-művelet beállításának választható beállításai.

Válaszok

Promise<BlobSetMetadataResponse>

A BlobClient.setMetadatafájlból örökölt

setTags(Tags, BlobSetTagsOptions)

Beállítja a címkéket a mögöttes blobon. Egy blob legfeljebb 10 címkével rendelkezhet. A címkekulcsnak 1 és 128 karakter közöttinek kell lennie. A címke értékeinek 0 és 256 karakter közöttinek kell lenniük. Az érvényes címkekulcs- és értékkarakterek közé tartoznak a kis- és nagybetűk, a számjegyek (0-9), a szóköz (' '), plusz ('+'), a mínusz ('-'), a pont ('.'), az előre perjel ('/'), a kettőspont (':'), az egyenlőség ('=') és az aláhúzás ('_') .

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

Paraméterek

tags
Tags
options
BlobSetTagsOptions

Válaszok

Promise<BlobSetTagsResponse>

A BlobClient.setTags fájlbólörökölt

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A szinkron másolás URL-címről művelet egy blobot vagy egy internetes erőforrást másol egy új blobba. A rendszer nem ad vissza választ, amíg a másolat be nem fejeződik.

Lásd: https://learn.microsoft.com/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Paraméterek

copySource

string

Lehetséges, hogy a hitelesítéshez szükséges forrás URL-cím, a közös hozzáférésű jogosultságkód (SAS)

options
BlobSyncCopyFromURLOptions

Válaszok

Promise<BlobCopyFromURLResponse>

A BlobClient.syncCopyFromURL-bőlörökölt

undelete(BlobUndeleteOptions)

Visszaállítja a helyreállíthatóan törölt blobok és a kapcsolódó helyreállíthatóan törölt pillanatképek tartalmát és metaadatait. Az Undelete Blob csak a 2017-07-29-es vagy újabb verzióban támogatott.

Lásd: https://learn.microsoft.com/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Paraméterek

options
BlobUndeleteOptions

A Blob Undelete művelet választható beállításai.

Válaszok

Promise<BlobUndeleteResponse>

A BlobClient.undeletefájlból örökölt

withVersion(string)

Létrehoz egy új BlobClient-objektumot, amely ennek a blobnak egy verziójára mutat. A "" megadása eltávolítja a versionId azonosítót, és visszaad egy ügyfelet az alapblobba.

function withVersion(versionId: string): BlobClient

Paraméterek

versionId

string

A verzióazonosító.

Válaszok

BlobClient

Egy új BlobClient-objektum, amely ennek a blobnak a verziójára mutat.

A BlobClient.withVersionwebhelyről örökölt