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

accountName
containerName	Annak a tárolónak a neve, amelyhez a blob társítva van.
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.
name	A blob neve.
url	Kódolt URL-sztringérték.

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ó.
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.
clearPages(number, number, PageBlobClearPagesOptions)	Felszabadítja a megadott oldalakat a lapblobból.
create(number, PageBlobCreateOptions)	Létrehoz egy megadott hosszúságú lapblobot. Az uploadPages meghívása adatadatok lapblobba való feltöltéséhez.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Létrehoz egy megadott hosszúságú lapblobot. 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.
createSnapshot(BlobCreateSnapshotOptions)	Egy blob írásvédett pillanatképét hozza létre.
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.
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.
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 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
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 ennél nagyobb méretű blobok esetében vegye figyelembe a következőt <xref:downloadToFile>: .
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 ennél nagyobb méretű blobok esetében vegye figyelembe a következőt <xref: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ájlelérési út 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; hamis egyéb esetben. 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, a függvény befejezése után más ügyfelek vagy alkalmazások új blobokat adhatnak hozzá.
generateSasUrl(BlobGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el. Létrehoz egy Blob Service közös 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á.
getAppendBlobClient()	Létrehoz egy AppendBlobClient objektumot.
getBlobLeaseClient(string)	Szerezzen be egy olyant <xref:BlobLeaseClient> , amely kezeli a blob bérleteit.
getBlockBlobClient()	Létrehoz egy BlockBlobClient objektumot.
getPageBlobClient()	Létrehoz egy PageBlobClient objektumot.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Egy lapblob érvényes oldaltartományainak listáját vagy egy lapblob pillanatképét adja vissza.
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.
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.
getProperties(BlobGetPropertiesOptions)	A blob összes felhasználó által definiált metaadatait, szabványos HTTP-tulajdonságait és rendszertulajdonságait adja vissza. Nem adja vissza a blob tartalmát.
getTags(BlobGetTagsOptions)	Lekéri a mögöttes blobhoz társított címkéket.
resize(number, PageBlobResizeOptions)	Átméretezi a lapblobot a megadott méretre (amelynek az 512 többszörösének kell lennie).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Beállítja a réteget egy blobon. A művelet egy prémium szintű tárfiók lapblobján és egy blobtároló-fiók blokkblobján engedélyezett (csak helyileg redundáns tárolás). A prémium szintű lapblob 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.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Beállítja a blob rendszertulajdonságokat. Ha nincs megadva érték, vagy a megadott blob HTTP-fejléceihez nincs megadva érték, ezek a blob HTTP-fejlécek érték nélkül törlődnek.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Állítsa be az immutablility szabályzatot a blobon.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Jogi célú visszatartás beállítása 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.
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í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. Az érvényes címkekulcs- és értékkarakterek közé tartoznak az alsó és nagybetűk, a számjegyek (0-9), a szóköz (' '), a plusz ('+'), a mínusz ('-'), a pont ('.'), a perjel ('/'), a kettőspont (':'), az egyenlő ('=') és az aláhúzásjel ('_').
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.
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. Nem ad vissza választ, amíg a másolat be nem fejeződik.
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. A Blob törlése csak a 2017-07-29-es vagy újabb verzióban támogatott.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Beállítja egy lapblob sorszámát.
uploadPages(HttpRequestBody, 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.
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.
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.
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 alapblobnak.

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ó ü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".

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

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

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

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

Tulajdonság adatai

accountName

accountName: string

Tulajdonság értéke

string

containerName

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

string containerName

Tulajdonság értéke

string

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

name

A blob neve.

string name

Tulajdonság értéke

string

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

Metódus adatai

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

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

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>

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.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

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<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages(number, number, PageBlobClearPagesOptions)

Felszabadítja a megadott oldalakat a lapblobból.

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

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

Létrehoz egy megadott hosszúságú lapblobot. Az uploadPages meghívása adatadatok lapblobba való feltöltéséhez.

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

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 Page Blob Create művelet válaszadatai.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Létrehoz egy megadott hosszúságú lapblobot. 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.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Paraméterek

size: number

az oldalblob mérete.

options: PageBlobCreateIfNotExistsOptions

Válaszok

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

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>

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.

function delete(options?: BlobDeleteOptions)

Paraméterek

options: BlobDeleteOptions

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

Válaszok

Promise<BlobDeleteResponse>

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.

function deleteIfExists(options?: BlobDeleteOptions)

Paraméterek

options: BlobDeleteOptions

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

Válaszok

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

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>

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

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>

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 ennél nagyobb méretű blobok esetében vegye figyelembe a következőt <xref:downloadToFile>: .

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

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>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Paraméterek

offset: number

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

count: number

Mennyi adat (bájtban) tölthető le. Le fog tölteni a végéig, amikor nem definiált állapotot ad át

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

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ájlelérési út 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)

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

Blobletöltési beállítások.

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.

exists(BlobExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; hamis egyéb esetben. 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, a függvény befejezése után más ügyfelek vagy alkalmazások új blobokat adhatnak hozzá.

function exists(options?: BlobExistsOptions)

Paraméterek

options: BlobExistsOptions

Beállítás a Létező műveletre.

Válaszok

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el. Létrehoz egy Blob Service közös 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á.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Paraméterek

options: BlobGenerateSasUrlOptions

Választható paraméterek.

Válaszok

Promise<string>

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

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient()

Válaszok

AppendBlobClient

getBlobLeaseClient(string)

Szerezzen be egy olyant <xref:BlobLeaseClient> , amely kezeli a blob bérleteit.

function getBlobLeaseClient(proposeLeaseId?: string)

Paraméterek

proposeLeaseId: string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

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

getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.

function getBlockBlobClient()

Válaszok

BlockBlobClient

getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.

function getPageBlobClient()

Válaszok

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

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.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

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.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

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.

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

Paraméterek

options: BlobGetPropertiesOptions

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

Válaszok

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Paraméterek

options: BlobGetTagsOptions

Válaszok

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

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

function resize(size: number, options?: PageBlobResizeOptions)

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.

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Beállítja a réteget egy blobon. A művelet egy prémium szintű tárfiók lapblobján és egy blobtároló-fiók blokkblobján engedélyezett (csak helyileg redundáns tárolás). A prémium szintű lapblob 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.

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

Paraméterek

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

A Blobkészlet rétege művelet választható lehetőségei.

Válaszok

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Beállítja a blob rendszertulajdonságokat. Ha nincs megadva érték, vagy a megadott blob HTTP-fejléceihez nincs megadva érték, ezek a blob HTTP-fejlécek érték nélkül törlődnek.

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

Paraméterek

blobHTTPHeaders: BlobHTTPHeaders

Ha nincs megadva érték, vagy a megadott blob HTTP-fejléceihez nincs megadva érték, ezek a blob HTTP-fejlécek érték nélkül törlődnek. Gyakori beállítási fejléc, ha blobContentType engedélyezi a böngészőnek, hogy fájltípuson alapuló funkciókat biztosítson.

options: BlobSetHTTPHeadersOptions

A Blob beállítása HTTP-fejlécek művelethez választható lehetőségek.

Válaszok

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Állítsa be az immutablility szabályzatot a blobon.

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

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>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Jogi célú visszatartás beállítása a blobon.

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

Paraméterek

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Válaszok

Promise<BlobSetLegalHoldResponse>

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.

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

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>

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í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. Az érvényes címkekulcs- és értékkarakterek közé tartoznak az alsó és nagybetűk, a számjegyek (0-9), a szóköz (' '), a plusz ('+'), a mínusz ('-'), a pont ('.'), a perjel ('/'), a kettőspont (':'), az egyenlő ('=') és az aláhúzásjel ('_').

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Paraméterek

tags: Tags

options: BlobSetTagsOptions

Válaszok

Promise<BlobSetTagsResponse>

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.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

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.

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. Nem ad vissza választ, amíg a másolat be nem fejeződik.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

Paraméterek

copySource: string

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

options: BlobSyncCopyFromURLOptions

Válaszok

Promise<BlobCopyFromURLResponse>

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. A Blob törlése csak a 2017-07-29-es vagy újabb verzióban támogatott.

function undelete(options?: BlobUndeleteOptions)

Paraméterek

options: BlobUndeleteOptions

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

Válaszok

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

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 maximális vagy frissítési érték

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(HttpRequestBody, 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.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

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.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

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)

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.

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

function withVersion(versionId: string)

Paraméterek

versionId: string

A verzióazonosító.

Válaszok

BlobClient

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

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

PageBlobClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

PageBlobClient(string, PipelineLike)

Paraméterek

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

Paraméterek

PageBlobClient(string, string, string, StoragePipelineOptions)

Paraméterek

Tulajdonság adatai

accountName

Tulajdonság értéke

containerName

Tulajdonság értéke

credential

Tulajdonság értéke

name

Tulajdonság értéke

url

Tulajdonság értéke

Metódus adatai

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Paraméterek

Válaszok

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Paraméterek

Válaszok

clearPages(number, number, PageBlobClearPagesOptions)

Paraméterek

Válaszok

create(number, PageBlobCreateOptions)

Paraméterek

Válaszok

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Paraméterek

Válaszok

createSnapshot(BlobCreateSnapshotOptions)

Paraméterek

Válaszok

delete(BlobDeleteOptions)

Paraméterek

Válaszok

deleteIfExists(BlobDeleteOptions)

Paraméterek

Válaszok

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Paraméterek

Válaszok

download(number, number, BlobDownloadOptions)

Paraméterek

Válaszok

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Paraméterek

Válaszok

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Paraméterek

Válaszok

downloadToFile(string, number, number, BlobDownloadOptions)

Paraméterek

Válaszok

exists(BlobExistsOptions)

Paraméterek

Válaszok

generateSasUrl(BlobGenerateSasUrlOptions)

Paraméterek

Válaszok

getAppendBlobClient()

Válaszok

getBlobLeaseClient(string)

Paraméterek

Válaszok

getBlockBlobClient()

Válaszok

getPageBlobClient()

Válaszok

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Paraméterek