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

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étrehoz egy BlobClient-példányt. Ez a metódus egy blobra mutató kódolt VAGY nem kódolt URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmaz? vagy %, a blob nevét az URL-címben kell kódolni.
BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Létrehoz egy BlobClient-példányt 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

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

Kódolt URL-sztringérték.

Metódusok

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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

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

Lásd: https://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 állapotfrissítések használatával:

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 másolás törlésére:

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örölhető.

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. A Blob törlése művelettel egyszerre mindkettő törölhető.

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)

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

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

Lásd: https://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 egy pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

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

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

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

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

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

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

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

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

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

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

Létrehoz egy AppendBlobClient objektumot.
getBlobLeaseClient(string)

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

Létrehoz egy BlockBlobClient objektumot.
getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.
getProperties(BlobGetPropertiesOptions)

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

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

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

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

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

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

Lásd: https://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ítson be jogi mentességet a blobon.
setMetadata(Metadata, BlobSetMetadataOptions)

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

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

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

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

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

Lásd: https://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 visszaad egy ügyfelet az alapblobba.
withVersion(string)

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

Konstruktor adatai

BlobClient(string, PipelineLike)

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

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

pipeline
PipelineLike

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

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

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

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

Paraméterek

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

BlobClient(string, string, string, StoragePipelineOptions)

Létrehoz egy BlobClient-példányt a kapcsolati sztringből.

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

Paraméterek

connectionString

string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Tároló neve.

blobName

string

Blob neve.

options
StoragePipelineOptions

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

Tulajdonság adatai

containerName

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

string containerName

Tulajdonság értéke

string

name

A blob neve.

string name

Tulajdonság értéke

string

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

accountName 

accountName: string

Tulajdonság értéke

string

örökölt StorageClient.accountName

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

örökölt StorageClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

örökölt StorageClient.url-címről

Metódus adatai

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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

Lásd: https://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 állapotfrissítések használatával:

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 másolás törlésére:

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ímet a forrás Azure Blob/File fájlba.

options
BlobBeginCopyFromURLOptions

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

Válaszok

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

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 művelet választható beállításai.

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örölhető.

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 Delete művelet választható beállításai.

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. A Blob törlése művelettel egyszerre mindkettő törölhető.

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 Delete művelet választható beállításai.

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

Válaszok

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

Lásd: https://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 blob letöltésének helye 0-nál nagyobb vagy egyenlő

count

number

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

options
BlobDownloadOptions

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

Példahasználat (Node.js):

// 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élda a használatra (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 egy pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

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

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

Paraméterek

buffer

Buffer

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

offset

number

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

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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

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

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

Paraméterek

offset

number

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

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

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

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

Paraméterek

filePath

string

offset

number

A blokkblob letöltésének helye.

count

number

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

options
BlobDownloadOptions

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

Válaszok

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

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

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

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

Paraméterek

options
BlobExistsOptions

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

Válaszok

Promise<boolean>

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

Nem kötelező paraméterek.

Válaszok

Promise<string>

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

getAccountInfo(BlobGetAccountInfoOptions)

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

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

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

Paraméterek

options
BlobGetAccountInfoOptions

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

Válaszok

Promise<BlobGetAccountInfoResponse>

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

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient(): AppendBlobClient

Válaszok

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paraméterek

proposeLeaseId

string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

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

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 felhasználó által definiált metaadatait, szabványos HTTP-tulajdonságait és rendszertulajdonságait adja vissza. Nem adja vissza a blob tartalmát.

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

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

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

Paraméterek

options
BlobGetPropertiesOptions

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

Válaszok

Promise<BlobGetPropertiesResponse>

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

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

Válaszok

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

Lásd: https://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écekhez, a blob HTTP-fejlécei érték nélkül törlődnek. Egy gyakran beállítható fejléc blobContentType, amely lehetővé teszi a böngésző számára, hogy fájltípuson alapuló funkciókat biztosítson.

options
BlobSetHTTPHeadersOptions

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

Válaszok

Promise<BlobSetHTTPHeadersResponse>

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ítson be jogi mentességet a blobon.

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

Paraméterek

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

Válaszok

Promise<BlobSetLegalHoldResponse>

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ásának választható beállításai.

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ímkekulcsnak 1 és 128 karakter közöttinek kell lennie. A címke értékeinek 0 és 256 karakter közöttinek kell lenniük. Az érvényes címkekulcs- és értékkarakterek közé tartoznak a kis- és nagybetűk, a számjegyek (0-9), a szóköz (' '), plusz ('+'), a mínusz ('-'), a pont ('.'), az előre perjel ('/'), a kettőspont (':'), az egyenlőség ('=') és az aláhúzás ('_') .

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

Paraméterek

tags
Tags
options
BlobSetTagsOptions

Válaszok

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

Lásd: https://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 forrás URL-cím, a közös hozzáférésű jogosultságkód (SAS)

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 Undelete művelet választható beállításai.

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 visszaad egy ügyfelet az alapblobba.

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 visszaad egy ügyfelet az alapblobba.

function withVersion(versionId: string): BlobClient

Paraméterek

versionId

string

A verzióazonosító.

Válaszok

BlobClient

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