BlobClient class

Referencia

Csomag:: @azure/storage-blob

A BlobClient egy Azure Storage-blob URL-címét jelöli; A blob lehet blokkblob, hozzáfűző blob vagy lapblob.

Extends: StorageClient

Konstruktorok

BlobClient(string, PipelineLike)	Létrehozza a BlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blobra mutat. 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.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Létrehozza a BlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blobra mutat. 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.
BlobClient(string, string, string, StoragePipelineOptions)	Létrehozza a BlobClient egy példányát a kapcsolati sztringből.

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Megszakít egy függőben lévő aszinkron blobmásolási műveletet, és egy nulla hosszúságú és teljes metaadatokat tartalmazó célblobot hagy. 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 példányt még a befejezés előtt megszakíthatja a poller hívásával `cancelOperation` . Vegye figyelembe, hogy az onProgress visszahívás nem lesz meghívva, ha a művelet befejeződik az első kérelemben, és a befejezett másolat visszavonásának megkísérlése hibát eredményez. A 2012-02-12-es és újabb verziókban a Blob másolása művelet forrása bármely Azure Storage-fió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 bármely Azure-tárfiókban azure-fájl lehet. Csak a 2012. június 7-én vagy azt követően létrehozott tárfiókok engedélyezik a Blob másolása művelet másolását egy másik tárfiókból. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Példa az automatikus lekérdezés használatára: `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ára (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 törlésre. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettőt törölheti. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	Megjelöli a megadott blobot vagy pillanatképet törlésre, ha létezik. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. A Blob törlése művelettel egyszerre mindkettőt törölheti. 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
withSnapshot(string)	Létrehoz egy új BlobClient 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

BlobClient(string, PipelineLike)

Létrehozza a BlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blobra mutat. 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 BlobClient(url: string, pipeline: PipelineLike)

Paraméterek

url: string

Egy Azure Storage-blobra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer/blob". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString") használatával használja. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blobra mutat. 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. A "my?blob%" nevű blobhoz hasonlóan az URL-címnek "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" kell lennie.

pipeline: PipelineLike

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

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

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

Paraméterek

url: string

Az Azure Storage blobszolgáltatásra mutató ügyfélsztring, például "https://myaccount.blob.core.windows.net". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net?sasString") használatával használja.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options: StoragePipelineOptions

Választható. A HTTP-folyamat konfigurálásának lehetőségei.

BlobClient(string, string, string, StoragePipelineOptions)

Létrehozza a BlobClient egy példányát a kapcsolati sztringből.

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

Paraméterek

connectionString: string

Fiók kapcsolati sztringje vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiók kapcsolati sztringje 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 lehetőségei.

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

Örökölt forrás StorageClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Örökölt forrás StorageClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

Örökölt forrás StorageClient.url

Metódus adatai

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Megszakít egy függőben lévő aszinkron blobmásolási műveletet, és egy nulla hosszúságú és teljes metaadatokat tartalmazó célblobot hagy. 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

A Blob megszakítja a másolást URL-címről 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 példányt még a befejezés előtt megszakíthatja a poller hívásával cancelOperation . Vegye figyelembe, hogy az onProgress visszahívás nem lesz meghívva, ha a művelet befejeződik az első kérelemben, és a befejezett másolat visszavonásának megkísérlése hibát eredményez.

A 2012-02-12-es és újabb verziókban a Blob másolása művelet forrása bármely Azure Storage-fió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 bármely Azure-tárfiókban azure-fájl lehet. Csak a 2012. június 7-én vagy azt követően létrehozott tárfiókok engedélyezik a Blob másolása művelet másolását egy másik tárfiókból.

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

Példa az automatikus lekérdezés használatára:

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ára (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/File fájlba.

options: BlobBeginCopyFromURLOptions

A Blob indítása URL-címről művelet választható beállításai.

Válaszok

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

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 pillanatkép létrehozása művelet választható lehetőségei.

Válaszok

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

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>

deleteIfExists(BlobDeleteOptions)

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

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>

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>

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>

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>

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.

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>

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.

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>

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.

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient(): AppendBlobClient

Válaszok

AppendBlobClient

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.

getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.

function getBlockBlobClient(): BlockBlobClient

Válaszok

BlockBlobClient

getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.

function getPageBlobClient(): PageBlobClient

Válaszok

PageBlobClient

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>

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>

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>

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>

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>

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>

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>

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>

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>

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 törlési műveletének választható lehetőségei.

Válaszok

Promise<BlobUndeleteResponse>

withSnapshot(string)

Létrehoz egy új BlobClient 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): BlobClient

Paraméterek

snapshot: string

A pillanatkép időbélyege.

Válaszok

BlobClient

Egy új BlobClient 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): 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.

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

BlobClient class

Konstruktorok

Tulajdonságok

Örökölt tulajdonságok

Metódusok

Konstruktor adatai

BlobClient(string, PipelineLike)

Paraméterek

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

Paraméterek

BlobClient(string, string, string, StoragePipelineOptions)

Paraméterek

Tulajdonság adatai

containerName

Tulajdonság értéke

name

Tulajdonság értéke

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

accountName

Tulajdonság értéke

credential

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

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

getProperties(BlobGetPropertiesOptions)

Paraméterek

Válaszok

getTags(BlobGetTagsOptions)

Paraméterek

Válaszok

setAccessTier(string, BlobSetTierOptions)

Paraméterek

Válaszok