AppendBlobClient class

Referencia

Csomag:: @azure/storage-blob

A AppendBlobClient a hozzáfűző blobokra vonatkozó műveletek halmazát határozza meg.

Extends: BlobClient

Konstruktorok

AppendBlobClient(string, PipelineLike)	Létrehozza a AppendBlobClient egy példányát. Ez a metódus egy hozzáfűző blobra mutató kódolt URL-címet 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.
AppendBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Létrehozza a AppendBlobClient egy példányát. Ez a metódus egy hozzáfűző blobra mutató kódolt URL-címet 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.
AppendBlobClient(string, string, string, StoragePipelineOptions)	Létrehozza a AppendBlobClient egy példányát.

Tulajdonságok

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

Örökölt tulajdonságok

accountName
credential	Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a 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.
url	Kódolt URL-sztringérték.

Metódusok

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)	Új adatblokkot véglegesíti a meglévő hozzáfűző blob végéig. Lásd: https://docs.microsoft.com/rest/api/storageservices/append-block
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	A Hozzáfűzési blokk művelet egy új adatblokkot véglegesíti egy meglévő hozzáfűző blob végéhez, ahol a tartalom egy forrás URL-címről lesz beolvasva. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
create(AppendBlobCreateOptions)	Létrehoz egy 0 hosszúságú hozzáfűző blobot. Hívja meg a AppendBlock parancsot, ha adatokat szeretne hozzáfűzni egy hozzáfűző blobhoz. Lásd: https://docs.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	Létrehoz egy 0 hosszúságú hozzáfűző blobot. Hívja meg a AppendBlock parancsot, ha adatokat szeretne hozzáfűzni egy hozzáfűző blobhoz. Ha az azonos nevű blob már létezik, a meglévő blob tartalma változatlan marad. Lásd: https://docs.microsoft.com/rest/api/storageservices/put-blob
seal(AppendBlobSealOptions)	Lezárja a hozzáfűző blobot, így csak olvasható.
withSnapshot(string)	Létrehoz egy új AppendBlobClient objektumot, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel. Adja meg a "" lehetőséget, amely eltávolítja a pillanatképet, és egy ügyfelet ad vissza az alapblobba.

Örökölt 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 a blob immutablility szabályzatát.
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 Get Blob (Blob lekérése) parancsot is. A Node.js az adatok olvasható streamelhetőStreamBody formátumban 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 /V8 Node.jskorlátozásai miatt. Ennél nagyobb blobok esetén 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 /V8 Node.jskorlátozásai miatt. Ennél nagyobb blobok esetén 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á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á. 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 kezeli a blob bérleteit.
getBlockBlobClient()	Létrehoz egy BlockBlobClient objektumot.
getPageBlobClient()	Létrehoz egy PageBlobClient objektumot.
getProperties(BlobGetPropertiesOptions)	A blob összes felhasználó által definiált metaadatát, szabványos HTTP-tulajdonságát és rendszertulajdonságát adja vissza. Nem adja vissza a blob tartalmát. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties FIGYELMEZTETÉS: A `metadata` válaszban visszaadott objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ContainerClient metódusai által visszaadott metaadatkulcsoktól, amelyek a lehetőséggel listázják a blobokat, amelyek megőrzik az `includeMetadata` eredeti burkolatukat.
getTags(BlobGetTagsOptions)	Lekéri a mögöttes blobhoz társított címkéket.
setAccessTier(string, BlobSetTierOptions)	Beállítja a szintet egy blobon. A művelet egy prémium szintű tárfiók lapblobján és blobtároló-fiók blokkblobján engedélyezett (csak helyileg redundáns tárolás). A prémium szintű lapblobok szintje határozza meg a blob megengedett méretét, IOPS-ját és sávszélességét. A blokkblobok szintje határozza meg a gyakori elérésű/ritka elérésű/archív tárolási típust. Ez a művelet nem frissíti a blob ETagjét. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Beállítja a rendszer tulajdonságait a blobon. Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejléceihez, ezek a blob HTTP-fejlécek érték nélkül törlődnek. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Állítsa be a nem módosíthatósági szabályzatot a blobon.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Állítsa be a jogi mentességet a blobra.
setMetadata(Metadata, BlobSetMetadataOptions)	A megadott blob felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be. Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a blob metaadatai el lesznek távolítva. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	Címkéket állít be a mögöttes blobon. Egy blob legfeljebb 10 címkével rendelkezhet. A címkebillentyűknek 1 és 128 karakter közöttinek kell lenniük. A címkeértékek 0 és 256 karakter közöttiek lehetnek. Érvényes címkekulcs- és értékkarakterek: kis- és nagybetűk, számjegyek (0-9), szóköz (' '), plusz ('+'), mínusz ('-'), pont ('.'), perjel ('/'), kettőspont (':'), egyenlőség ('=') és aláhúzás ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	A szinkron másolás URL-címről művelet egy blobot vagy internetes erőforrást másol egy új blobba. Addig nem ad vissza választ, amíg a másolat be nem fejeződik. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Visszaállítja a helyreállíthatóan törölt blobok és a kapcsolódó helyreállíthatóan törölt pillanatképek tartalmát és metaadatait. Az Undelete Blob csak a 2017-07-29-es vagy újabb verzióban támogatott. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)	Létrehoz egy új BlobClient objektumot, amely ennek a blobnak egy verziójára mutat. A "" megadása eltávolítja a versionId azonosítót, és egy ügyfelet ad vissza az alapblobba.

Konstruktor adatai

AppendBlobClient(string, PipelineLike)

Létrehozza a AppendBlobClient egy példányát. Ez a metódus egy hozzáfűző blobra mutató kódolt URL-címet 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 AppendBlobClient(url: string, pipeline: PipelineLike)

Paraméterek

url: string

Az Azure Storage hozzáfűző blobra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net/mycontainer/appendblob?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.

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

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

Paraméterek

url: string

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.

AppendBlobClient(string, string, string, StoragePipelineOptions)

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

new AppendBlobClient(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

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

credential

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ÖrököltblobClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

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

Metódus adatai

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)

Új adatblokkot véglegesíti a meglévő hozzáfűző blob végéig.

Lásd: https://docs.microsoft.com/rest/api/storageservices/append-block

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Paraméterek

body: HttpRequestBody

A hozzáfűzendő adatok.

contentLength: number

A törzs hossza bájtban.

options: AppendBlobAppendBlockOptions

A Hozzáfűzési blokk művelet beállításai.

Példahasználat:

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

Válaszok

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

A Hozzáfűzési blokk művelet egy új adatblokkot véglegesíti egy meglévő hozzáfűző blob végéhez, ahol a tartalom egy forrás URL-címről lesz beolvasva.

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

Paraméterek

sourceURL: string

A másolat forrásaként használt blob URL-címe. Az ugyanabban a tárfiókban lévő forrásblobok közös kulccsal hitelesíthetők. Ha azonban a forrás egy másik fiókban található blob, a forrásblobnak nyilvánosnak kell lennie, vagy közös hozzáférésű jogosultságkóddal kell hitelesítenie. Ha a forrásblob nyilvános, a művelet végrehajtásához nincs szükség hitelesítésre.

sourceOffset: number

Eltolás a hozzáfűzendő forrásban

count: number

Blokkként hozzáfűzendő bájtok száma

options: AppendBlobAppendBlockFromURLOptions

Válaszok

Promise<AppendBlobAppendBlockFromUrlResponse>

create(AppendBlobCreateOptions)

Létrehoz egy 0 hosszúságú hozzáfűző blobot. Hívja meg a AppendBlock parancsot, ha adatokat szeretne hozzáfűzni egy hozzáfűző blobhoz.

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

Paraméterek

options: AppendBlobCreateOptions

A Hozzáfűzési blokk létrehozása művelet beállításai.

Példahasználat:

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

Válaszok

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

Létrehoz egy 0 hosszúságú hozzáfűző blobot. Hívja meg a AppendBlock parancsot, ha adatokat szeretne hozzáfűzni egy hozzáfűző blobhoz. Ha az azonos nevű blob már létezik, a meglévő blob tartalma változatlan marad.

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

Paraméterek

options: AppendBlobCreateIfNotExistsOptions

Válaszok

Promise<AppendBlobCreateIfNotExistsResponse>

seal(AppendBlobSealOptions)

Lezárja a hozzáfűző blobot, így csak olvasható.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

Paraméterek

options: AppendBlobSealOptions

Válaszok

Promise<AppendBlobAppendBlockResponse>

withSnapshot(string)

Létrehoz egy új AppendBlobClient objektumot, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel. Adja meg a "" lehetőséget, amely eltávolítja a pillanatképet, és egy ügyfelet ad vissza az alapblobba.

function withSnapshot(snapshot: string): AppendBlobClient

Paraméterek

snapshot: string

A pillanatkép időbélyege.

Válaszok

AppendBlobClient

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Megszakít egy függőben lévő aszinkron 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>

ÖrököltblobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Aszinkron módon másol egy blobot a tárfiókon belüli célhelyre. Ez a metódus egy hosszú ideig futó műveletet ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a másolás befejeződik. A 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>>

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

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>

ÖrököltblobClient.createSnapshot

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>

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

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>

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

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Törölje a blob immutablility szabályzatát.

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

Paraméterek

options: BlobDeleteImmutabilityPolicyOptions

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

Válaszok

Promise<BlobDeleteImmutabilityPolicyResponse>

ÖrököltblobClient.deleteImmutabilityPolicy

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 Get Blob (Blob lekérése) parancsot is.

A Node.js az adatok olvasható streamelhetőStreamBody formátumban 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öltendő blob 0-nál nagyobb vagy egyenlő pozíciója

count: number

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

options: BlobDownloadOptions

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

Példahasználat (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

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

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Válaszok

Promise<BlobDownloadResponseParsed>

ÖrököltBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

Figyelmeztetés: A pufferek legfeljebb egy gigabájt méretű fájlokat támogatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a /V8 Node.jskorlátozásai miatt. Ennél nagyobb blobok esetén 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ő puffer hossza nagyobb lehet, mint a darabszám

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>

ÖrököltblobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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

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. Le fog tölteni a végéig, amikor nem definiált állapotot ad át

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

ÖrököltblobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

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

Letölt egy Azure-blobot egy helyi fájlba. Sikertelen, ha a megadott fá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): 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

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.

ÖrököltblobClient.downloadToFile

exists(BlobExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; 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): Promise<boolean>

Paraméterek

options: BlobExistsOptions

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

Válaszok

Promise<boolean>

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

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

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, majd a létrehozott SAS-jogkivonatot tartalmazó SAS URI.

ÖrököltblobClient.generateSasUrl

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient(): AppendBlobClient

Válaszok

AppendBlobClient

ÖrököltblobClient.getAppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paraméterek

proposeLeaseId: string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

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

ÖrököltblobClient.getBlobLeaseClient

getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.

function getBlockBlobClient(): BlockBlobClient

Válaszok

BlockBlobClient

ÖrököltblobClient.getBlockBlobClient

getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.

function getPageBlobClient(): PageBlobClient

Válaszok

PageBlobClient

ÖrököltblobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

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

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

Paraméterek

options: BlobGetPropertiesOptions

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

Válaszok

Promise<BlobGetPropertiesResponse>

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

getTags(BlobGetTagsOptions)

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

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

Paraméterek

options: BlobGetTagsOptions

Válaszok

Promise<BlobGetTagsResponse>

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

setAccessTier(string, BlobSetTierOptions)

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

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

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

Paraméterek

tier: string

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

options: BlobSetTierOptions

A Blobkészlet rétege művelet választható beállításai.

Válaszok

Promise<BlobSetTierResponse>

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

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

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

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

Paraméterek

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

Válaszok

Promise<BlobSetHTTPHeadersResponse>

ABlobClient.setHTTPHeaderstől örökölt

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

Paraméterek

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Válaszok

Promise<BlobSetImmutabilityPolicyResponse>

ÖrököltblobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

Paraméterek

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Válaszok

Promise<BlobSetLegalHoldResponse>

BlobClient.setLegalHoldtólörökölt

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

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

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

Paraméterek

metadata: Metadata

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

options: BlobSetMetadataOptions

A Metaadat-művelet beállítása nem kötelező.

Válaszok

Promise<BlobSetMetadataResponse>

ÖrököltblobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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

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

Paraméterek

tags: Tags

options: BlobSetTagsOptions

Válaszok

Promise<BlobSetTagsResponse>

BlobClient.setTagsöröklődve

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

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

Paraméterek

copySource: string

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

options: BlobSyncCopyFromURLOptions

Válaszok

Promise<BlobCopyFromURLResponse>

ÖrököltblobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

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

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

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

Paraméterek

options: BlobUndeleteOptions

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

Válaszok

Promise<BlobUndeleteResponse>

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

withVersion(string)

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

function withVersion(versionId: string): BlobClient

Paraméterek

versionId: string

A verzióazonosító.

Válaszok

BlobClient

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

ÖrököltBlobClient.withVersion

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

AppendBlobClient class

Konstruktorok

Tulajdonságok

Örökölt tulajdonságok

Metódusok

Örökölt metódusok

Konstruktor adatai

AppendBlobClient(string, PipelineLike)

Paraméterek

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

Paraméterek

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

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)

Paraméterek

Válaszok

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Paraméterek

Válaszok

create(AppendBlobCreateOptions)

Paraméterek

Válaszok

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

Paraméterek

Válaszok

seal(AppendBlobSealOptions)

Paraméterek

Válaszok

withSnapshot(string)

Paraméterek

Válaszok

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

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)