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

PageBlobClient class

  • Referencia
Csomag:
@azure/storage-blob

A PageBlobClient a lapblobokra alkalmazható műveletek halmazá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 tartalmazza a következőt: ? 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

Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Megadhat egy objektumot is, amely implementálja a TokenCredential felületet. Ha nincs megadva, a rendszer AnonymousCredential értéket használ.
url

Kódolt URL-sztringérték.

Metódusok

clearPages(number, number, PageBlobClearPagesOptions)

Felszabadítja a megadott oldalakat a lapblobból.

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

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

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

Egy 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://docs.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Lásd: https://docs.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://docs.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égeket tartalmazó oldaltartományok gyűjteményét.

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

Egy aszinkron iterálót ad vissza egy lapblob oldaltartományainak listájához.

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

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

Példa szintaxis használatával for await :

// 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}`);
}

Példa a használatával 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();
}

Példa a használatával 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}`);
  }
}

Példa jelölővel ellátott lapozásra:

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)

Egy aszinkron iterálót ad vissza a megadott pillanatkép és a lapblob között eltérő oldaltartományok listájához.

Lásd: https://docs.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.

Példa szintaxis használatával for await :

// 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}`);
}

Példa a használatával 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();
}

Példa a használatával 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}`);
  }
}

Példa jelölővel ellátott lapozásra:

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)

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

Lásd: https://docs.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://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

Lásd: https://docs.microsoft.com/en-us/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://docs.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

Lásd: https://docs.microsoft.com/en-us/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 egy ügyfelet ad vissza az alapblobnak.

Örökölt metódusok

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

Aszinkron módon másol egy blobot a tárfiókon belüli célhelyre. 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ásolás befejeződik. A másolatot a lekérdező hívásával cancelOperation is megszakíthatja, mielőtt befejeződik. 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óban a Másolási blob művelet forrása bármely Azure-tárfiókban véglegesített blob lehet. A 2015-02-21-es verziótól kezdődően a Blob másolása művelet forrása egy Azure-fájl lehet bármely Azure-tárfiókban. 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://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Példa automatikus lekérdezés használatával:

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

Példa manuális lekérdezésre:

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

Példa a folyamatfrissítések használatára:

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

Példa változó lekérdezési időköz használatával (alapértelmezett 15 másodperc):

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

Példa a másolás megszakítására:

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)

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

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

Megjelöli a megadott blobot vagy pillanatképet a törléshez. 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. Mindkettőt egyszerre törölheti a Blob törlése művelettel.

Lásd: https://docs.microsoft.com/en-us/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. Mindkettőt egyszerre törölheti a Blob törlése művelettel.

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

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

Egy blobot olvas be vagy tölt le a rendszerből, beleértve annak metaadatait és tulajdonságait. A Pillanatképek olvasásához meghívhatja a Get Blob (Blob lekérése) parancsot is.

  • A Node.js az adatok egy olvasható adatfolyamban, olvashatóStreamBody-ban térnek vissza
  • A böngészőkben az adatok egy ígéret blobBody-ban térnek vissza

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

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

Egy Azure-blobot tölt le párhuzamosan egy pufferrel. 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ájt méretű fájlokat támogatnak 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 a downloadToFile fájlt.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Egy Azure-blobot tölt le párhuzamosan egy pufferrel. 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ájt méretű fájlokat támogatnak 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 a downloadToFile fájlt.
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 értéket, illetve a nem definiált értéket.
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 más ügyfelek vagy alkalmazások új blobokat adnak hozzá a függvény befejezése után.
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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.
getBlobLeaseClient(string)

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

Létrehoz egy BlockBlobClient objektumot.
getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.
getProperties(BlobGetPropertiesOptions)

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

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

FIGYELMEZTETÉS: A metadata válaszban visszaadott objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ContainerClient metódusai által visszaadott metaadatkulcsoktól, amelyek a lehetőséggel listázják a blobokat, amelyek megőrzik az includeMetadata eredeti burkolatukat.
getTags(BlobGetTagsOptions)

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

Beállítja a szintet egy blobon. A művelet egy prémium szintű tárfiók lapblobján és blobtároló-fiók blokkblobján engedélyezett (csak helyileg redundáns tárolás). A prémium szintű lapblobok szintje határozza meg a blob megengedett 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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Beállítja a rendszer tulajdonságait a blobon.

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

Lásd: https://docs.microsoft.com/en-us/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ítsa be a jogi mentességet a blobra.
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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

Címkéket állít be a mögöttes blobon. Egy blob legfeljebb 10 címkével rendelkezhet. A címkebillentyűknek 1 és 128 karakter közöttinek kell lenniük. A címkeértékek 0 és 256 karakter közöttiek lehetnek. Érvényes címkekulcs- és értékkarakterek: kis- és nagybetűk, számjegyek (0-9), szóköz (' '), plusz ('+'), mínusz ('-'), pont ('.'), perjel ('/'), kettőspont (':'), egyenlőség ('=') és aláhúzás ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

Lásd: https://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/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 egy ügyfelet ad vissza 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". 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 tartalmazza a következőt: ? vagy %, a blob nevét az URL-címben kell kódolni. Például egy "my?blob%" nevű blob esetében az URL-címnek "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" kell lennie.

pipeline
PipelineLike

Hívja meg a newPipeline() parancsot egy alapértelmezett folyamat létrehozásához, vagy adjon meg egy testre szabott folyamatot.

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 tartalmazza a következőt: ? 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". 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 csomag bármely hitelesítő adata a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

Választható. A HTTP-folyamat konfigurálásának beállításai.

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 PÉLDA SAS kapcsolati sztringre – 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

Választható. A HTTP-folyamat konfigurálásának beállításai.

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

BlobClient.accountName-tőlörökölt

credential

Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Megadhat egy objektumot is, amely implementálja a TokenCredential felületet. Ha nincs megadva, a rendszer AnonymousCredential értéket használ.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ÖrököltblobClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

BlobClient.url-címtől örökölt

Metódus adatai

clearPages(number, number, PageBlobClearPagesOptions)

Felszabadítja a megadott oldalakat a lapblobból.

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

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

Paraméterek

offset

number

A lapok bájtos pozíciójától kezdve törölje a jelet.

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>

A Lapblob lap törlése művelet válaszadatai.

create(number, PageBlobCreateOptions)

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

Lásd: https://docs.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>

A Lapblob létrehozása művelet válaszadatai.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Egy 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://docs.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 listáját vagy egy lapblob pillanatképét adja vissza.

Lásd: https://docs.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 Lapblobtartományok beolvasása 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://docs.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ájtpozíciója

count

number

A tartományok eloszlásának 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 Lapblob laptartományok lekérése Diff műveletének 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égeket tartalmazó oldaltartományok gyűjteményét.

Lásd: https://docs.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ájtpozíciója

count

number

A tartományok eloszlásának 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 Lapblob laptartományok lekérése Diff műveletének 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álót ad vissza egy lapblob oldaltartományainak listájához.

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

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

Példa szintaxis használatával for await :

// 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}`);
}

Példa a használatával 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();
}

Példa a használatával 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}`);
  }
}

Példa jelölővel ellátott lapozásra:

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>

Paraméterek

offset

number

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

count

number

Lekérendő bájtok száma.

options
PageBlobListPageRangesOptions

A Lapblobtartományok beolvasása 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álót ad vissza a megadott pillanatkép és a lapblob között eltérő oldaltartományok listájához.

Lásd: https://docs.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.

Példa szintaxis használatával for await :

// 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}`);
}

Példa a használatával 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();
}

Példa a használatával 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}`);
  }
}

Példa jelölővel ellátott lapozásra:

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>

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 Lapblobtartományok beolvasása 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ösnek kell lennie).

Lásd: https://docs.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ése művelet beállításai.

Válaszok

Promise<PageBlobResizeResponse>

Válaszadatok a Lapblob átméretezése művelethez.

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://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

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

Paraméterek

copySource

string

Megadja a forráslap blobpillanatképének nevét. Például: https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

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

Válaszok

Promise<PageBlobCopyIncrementalResponse>

A Lapblob másolása növekményes művelet válaszadatai.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

Lásd: https://docs.microsoft.com/en-us/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ásnak hogyan kell módosítania a blob sorszámát.

sequenceNumber

number

Kötelező, ha a sequenceNumberAction értéke max vagy frissítés

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ának 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://docs.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 egy oldaltartományt ír egy lapblobba, ahol a tartalom egy URL-címről van beolvasva.

Lásd: 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>

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ód (SAS)

sourceOffset

number

A forrás eltolása, amelyből másolni szeretne. A forrásoldali blob elejéről másolandó 0-s szám

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 egy ügyfelet ad vissza az alapblobnak.

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 egy célblobot hagy nulla hosszúságú és teljes metaadatokkal. 2012-02-12-es és újabb verzió.

Lásd: https://docs.microsoft.com/en-us/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ő blobmásolás megszakítása művelet választható beállításai.

Válaszok

Promise<BlobAbortCopyFromURLResponse>

ÖrököltBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Aszinkron módon másol egy blobot a tárfiókon belüli célhelyre. 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ásolás befejeződik. A másolatot a lekérdező hívásával cancelOperation is megszakíthatja, mielőtt befejeződik. 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óban a Másolási blob művelet forrása bármely Azure-tárfiókban véglegesített blob lehet. A 2015-02-21-es verziótól kezdődően a Blob másolása művelet forrása egy Azure-fájl lehet bármely Azure-tárfiókban. 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://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Példa automatikus lekérdezés használatával:

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

Példa manuális lekérdezésre:

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

Példa a folyamatfrissítések használatára:

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

Példa változó lekérdezési időköz használatával (alapértelmezett 15 másodperc):

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

Példa a másolás megszakítására:

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

Paraméterek

copySource

string

url-cím a forrás Azure Blob/Fájl címére.

options
BlobBeginCopyFromURLOptions

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

Válaszok

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

ÖrököltBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

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

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

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

Paraméterek

options
BlobCreateSnapshotOptions

A Blob Create Snapshot (Blob létrehozása pillanatkép létrehozása) művelet választható beállításai.

Válaszok

Promise<BlobCreateSnapshotResponse>

BlobClient.createSnapshottólörökölt

delete(BlobDeleteOptions)

Megjelöli a megadott blobot vagy pillanatképet a törléshez. 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. Mindkettőt egyszerre törölheti a Blob törlése művelettel.

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Paraméterek

options
BlobDeleteOptions

A Blob törlése művelet választható lehetőségei.

Válaszok

Promise<BlobDeleteResponse>

BlobClient.deleteöröklődve

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. Mindkettőt egyszerre törölheti a Blob törlése művelettel.

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Paraméterek

options
BlobDeleteOptions

A Blob törlése művelet választható lehetőségei.

Válaszok

Promise<BlobDeleteIfExistsResponse>

ÖrököltBlobClient.deleteIfExists

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 módosíthatósági szabályzatának törlésére.

Válaszok

Promise<BlobDeleteImmutabilityPolicyResponse>

ÖrököltblobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

Egy blobot olvas be vagy tölt le a rendszerből, beleértve annak metaadatait és tulajdonságait. A Pillanatképek olvasásához meghívhatja a Get Blob (Blob lekérése) parancsot is.

  • A Node.js az adatok egy olvasható adatfolyamban, olvashatóStreamBody-ban térnek vissza
  • A böngészőkben az adatok egy ígéret blobBody-ban térnek vissza

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

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

Paraméterek

offset

number

A letölthető blob 0-nál nagyobb vagy egyenlő pozíciója

count

number

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

options
BlobDownloadOptions

A blobletöltési művelet választható lehetőségei.

Példahasználat (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);
});
}

Példahasználat (böngésző):

// 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);
  });
}

Válaszok

Promise<BlobDownloadResponseParsed>

ÖrököltBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

Egy Azure-blobot tölt le párhuzamosan egy pufferrel. 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ájt méretű fájlokat támogatnak 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 a downloadToFile fájlt.

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

Paraméterek

buffer

Buffer

A kitöltendő puffernek a számnál hosszabbnak kell lennie

offset

number

A letöltendő blokkblob pozíciója (bájtban)

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

ÖrököltblobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Egy Azure-blobot tölt le párhuzamosan egy pufferrel. 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ájt méretű fájlokat támogatnak 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 a downloadToFile fájlt.

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

Paraméterek

offset

number

A letöltendő blokkblob pozíciója (bájtban)

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

ÖrököltblobClient.downloadToBuffer

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 értéket, illetve a nem definiált értéket.

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éig történik, amikor nem definiált értéket 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 a readableStreamBody értéke nincs meghatározva, mivel a tartalma már be van olvasva, és egy helyi fájlba van írva a megadott elérési úton.

ÖrököltBlobClient.downloadToFile

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 más ügyfelek vagy alkalmazások új blobokat adnak hozzá a függvény befejezése után.

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

Paraméterek

options
BlobExistsOptions

a Exists (Létező) művelet beállításai.

Válaszok

Promise<boolean>

ABlobClient-től örökölt.exists

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
BlobGenerateSasUrlOptions

Választható 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.

ÖrököltblobClient.generateSasUrl

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient(): AppendBlobClient

Válaszok

AppendBlobClient

ÖrököltblobClient.getAppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paraméterek

proposeLeaseId

string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

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

ÖrököltblobClient.getBlobLeaseClient

getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.

function getBlockBlobClient(): BlockBlobClient

Válaszok

BlockBlobClient

ÖrököltblobClient.getBlockBlobClient

getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.

function getPageBlobClient(): PageBlobClient

Válaszok

PageBlobClient

ÖrököltblobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

FIGYELMEZTETÉS: A metadata válaszban visszaadott objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ContainerClient metódusai által visszaadott metaadatkulcsoktól, amelyek a lehetőséggel listázják a blobokat, amelyek megőrzik az includeMetadata eredeti burkolatukat.

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

Paraméterek

options
BlobGetPropertiesOptions

A Tulajdonságok lekérése művelet választható lehetőségei.

Válaszok

Promise<BlobGetPropertiesResponse>

ÖrököltblobClient.getProperties

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>

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

setAccessTier(string, BlobSetTierOptions)

Beállítja a szintet egy blobon. A művelet egy prémium szintű tárfiók lapblobján és blobtároló-fiók blokkblobján engedélyezett (csak helyileg redundáns tárolás). A prémium szintű lapblobok szintje határozza meg a blob megengedett 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://docs.microsoft.com/en-us/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észlet rétege művelet választható beállításai.

Válaszok

Promise<BlobSetTierResponse>

BlobClient.setAccessTier-tőlörökölt

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Beállítja a rendszer tulajdonságait a blobon.

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

Lásd: https://docs.microsoft.com/en-us/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éceihez, ezek a blob HTTP-fejlécek érték nélkül törlődnek. Egy gyakran beállított fejléc lehetővé teszi a blobContentType böngésző számára, hogy fájltípus alapján biztosítson funkciókat.

options
BlobSetHTTPHeadersOptions

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

Válaszok

Promise<BlobSetHTTPHeadersResponse>

ABlobClient.setHTTPHeaderstő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>

ÖrököltblobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Állítsa be a jogi mentességet a blobra.

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>

BlobClient.setLegalHoldtó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://docs.microsoft.com/en-us/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ása nem kötelező.

Válaszok

Promise<BlobSetMetadataResponse>

ÖrököltblobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Címkéket állít be a mögöttes blobon. Egy blob legfeljebb 10 címkével rendelkezhet. A címkebillentyűknek 1 és 128 karakter közöttinek kell lenniük. A címkeértékek 0 és 256 karakter közöttiek lehetnek. Érvényes címkekulcs- és értékkarakterek: kis- és nagybetűk, számjegyek (0-9), szóköz (' '), plusz ('+'), mínusz ('-'), pont ('.'), perjel ('/'), kettőspont (':'), egyenlőség ('=') és aláhúzás ('_') .

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

Paraméterek

tags
Tags
options
BlobSetTagsOptions

Válaszok

Promise<BlobSetTagsResponse>

BlobClient.setTagsöröklődve

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

Lásd: https://docs.microsoft.com/en-us/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 a forrás URL-címe, amelyből a közös hozzáférésű jogosultságkód (SAS) másolható

options
BlobSyncCopyFromURLOptions

Válaszok

Promise<BlobCopyFromURLResponse>

ÖrököltblobClient.syncCopyFromURL

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://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

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

Paraméterek

options
BlobUndeleteOptions

A Blob Undelete művelet választható lehetőségei.

Válaszok

Promise<BlobUndeleteResponse>

BlobClient.undelete-tő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 egy ügyfelet ad vissza 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.

ÖrököltBlobClient.withVersion