BlockBlobClient class
A BlockBlobClient a blokkblobokra vonatkozó műveletek halmazát határozza meg.
- Extends
Konstruktorok
Block |
Létrehozza a BlockBlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blokkblobra 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. |
Block |
Létrehozza a BlockBlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blokkblobra 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. |
Block |
Létrehozza a BlockBlobClient egy példányát. |
Tulajdonságok
container |
Annak a tárolónak a neve, amelyhez a blob társítva van. |
name | A blob neve. |
Örökölt tulajdonságok
account |
|
credential | Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a |
url | Kódolt URL-sztringérték. |
Metódusok
commit |
Blob írása a blobot alkotó blokkazonosítók listájának megadásával. Ahhoz, hogy egy blob részeként lehessen írni, egy blokkot sikeresen meg kell írni a kiszolgálóra egy korábbi stageBlock műveletben. A commitBlockList meghívásával frissíthet egy blobot úgy, hogy csak azokat a blokkokat tölti fel, amelyek módosultak, majd együtt véglegesíti az új és a meglévő blokkokat. A blokklistában nem szereplő és véglegesen törölt blokkok. Lásd: https://docs.microsoft.com/rest/api/storageservices/put-block-list |
get |
A blokkblob részeként a megadott blokklistaszűrő használatával feltöltött blokkok listáját adja vissza. Lásd: https://docs.microsoft.com/rest/api/storageservices/get-block-list |
query(string, Block |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. JSON- vagy CSV-formátumú blob gyors lekérdezése. Példahasználat (Node.js):
|
stage |
Feltölti a megadott blokkot a blokkblob "előkészítési területére", hogy később véglegesítse a commitBlockList hívása. Lásd: https://docs.microsoft.com/rest/api/storageservices/put-block |
stage |
A Fázisblokk url-címből művelet létrehoz egy új blokkot, amely egy blob részeként lesz véglegesítve, ahol a tartalom egy URL-címről lesz beolvasva. Ez az API a 2018-03-28-es verziótól érhető el. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url |
sync |
Létrehoz egy új blokkblobot, amelyben a blob tartalma egy adott URL-címről lesz beolvasva. Ez az API a 2020.04.08-i verziótól kezdve támogatott. A részleges frissítések nem támogatottak a Put Blob from URL-címmel; egy meglévő blob tartalma felülíródik az új blob tartalmával. Ha egy blokkblob tartalmának részleges frissítését forrás URL-címmel szeretné végrehajtani, használja a stageBlockFromURL és a commitBlockList parancsot. |
upload(Request |
Új blokkblobot hoz létre, vagy frissíti egy meglévő blokkblob tartalmát. Egy meglévő blokkblob frissítése felülírja a blob meglévő metaadatait. A részleges frissítések nem támogatottak; a meglévő blob tartalma felülíródik az új tartalommal. A blokkblobok részleges frissítéséhez használja a stageBlock és a commitBlockList parancsot. Ez egy nem párhuzamos feltöltési módszer. Az egyidejű feltöltés jobb teljesítménye érdekében használja az uploadFile, uploadStream vagy uploadBrowserData metódust. Lásd: https://docs.microsoft.com/rest/api/storageservices/put-blob |
upload |
CSAK BÖNGÉSZŐKBEN ÉRHETŐ EL. Feltölt egy böngészőblobot/fájlt/tömbbuffert/tömbbufferView objektumot a blob blokkolásához. Ha a puffer hossza kisebb vagy egyenlő 256 MB-nál, ez a metódus 1 feltöltési hívást használ a feltöltés befejezéséhez. Ellenkező esetben ez a metódus meghívja a stageBlock metódust blokkok feltöltéséhez, és végül meghívja a commitBlockList metódust a blokklista véglegesítéséhez. A blobHTTPHeaders beállításának egyik gyakori beállítása a |
upload |
Feltölt egy Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView objektumot egy BlockBlobba. Ha az adathossz nem nagyobb, mint a specifiled maxSingleShotSize (alapértelmezés szerint <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), ez a metódus 1 feltöltési hívást használ a feltöltés befejezéséhez. Ellenkező esetben ez a metódus meghívja a stageBlock metódust blokkok feltöltéséhez, és végül meghívja a commitBlockList metódust a blokklista véglegesítéséhez. A blobHTTPHeaders beállításának egyik gyakori beállítása a |
upload |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Blokkokban lévő helyi fájlt tölt fel egy blokkblobba. Ha a fájlméret kisebb vagy egyenlő 256 MB-nál, ez a metódus 1 feltöltési hívást használ a feltöltés befejezéséhez. Ellenkező esetben ez a metódus meghívja a stageBlock metódust blokkok feltöltéséhez, és végül meghívja a commitBlockList metódust a blokklista véglegesítéséhez. |
upload |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Feltölt egy Node.js olvasható streamet blokkblobba. TELJESÍTMÉNYNÖVELÉSI TIPPEK:
|
with |
Létrehoz egy új BlockBlobClient 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 visszaad egy URL-címet az alapblobnak. |
Örökölt metódusok
abort |
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 |
begin |
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 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:
Példa manuális lekérdezésre:
Példa a folyamatfrissítések használatára:
Példa változó lekérdezési időköz használatára (alapértelmezett 15 másodperc):
Példa a másolás megszakítására:
|
create |
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(Blob |
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 |
delete |
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 |
delete |
Törölje a blob immutablility szabályzatát. |
download(number, number, Blob |
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.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
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. |
download |
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. |
download |
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(Blob |
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. |
generate |
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 |
get |
Létrehoz egy AppendBlobClient objektumot. |
get |
Szerezzen be egy BlobLeaseClientet , amely a blob bérleteit kezeli. |
get |
Létrehoz egy BlockBlobClient objektumot. |
get |
Létrehoz egy PageBlobClient objektumot. |
get |
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 |
get |
Lekéri a mögöttes blobhoz társított címkéket. |
set |
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 |
set |
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 |
set |
Állítsa be a nem módosíthatósági szabályzatot a blobon. |
set |
Állítsa be a jogi mentességet a blobra. |
set |
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 |
set |
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 ('_') . |
sync |
A szinkron Másolás URL-címről művelet egy blobot vagy internetes erőforrást másol egy új blobba. Nem ad vissza választ, amíg a másolat be nem fejeződik. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
Visszaállítja a helyreállíthatóan törölt blobok és a kapcsolódó helyreállíthatóan törölt pillanatképek tartalmát és metaadatait. A Blob törlése csak a 2017-07-29-es vagy újabb verzióban támogatott. Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
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
BlockBlobClient(string, PipelineLike)
Létrehozza a BlockBlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blokkblobra 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 BlockBlobClient(url: string, pipeline: PipelineLike)
Paraméterek
- url
-
string
Egy Azure Storage-blokkblobra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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.
BlockBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Létrehozza a BlockBlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blokkblobra 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 BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Paraméterek
- url
-
string
Egy Azure Storage-blokkblobra mutató URL-sztring, például "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sas hozzáfűzhető, ha AnonymousCredential (pl. "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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.
- 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.
BlockBlobClient(string, string, string, StoragePipelineOptions)
Létrehozza a BlockBlobClient egy példányát.
new BlockBlobClient(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
credential
Például AnonymousCredential, StorageSharedKeyCredential vagy bármilyen hitelesítő adat a csomagból a @azure/identity
szolgáltatás felé irányuló kérések hitelesítéséhez. Megadhat egy objektumot is, amely implementálja a TokenCredential felületet. Ha nincs megadva, a rendszer AnonymousCredential értéket használ.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tulajdonság értéke
ÖrököltblobClient.credential
url
Metódus adatai
commitBlockList(string[], BlockBlobCommitBlockListOptions)
Blob írása a blobot alkotó blokkazonosítók listájának megadásával. Ahhoz, hogy egy blob részeként lehessen írni, egy blokkot sikeresen meg kell írni a kiszolgálóra egy korábbi stageBlock műveletben. A commitBlockList meghívásával frissíthet egy blobot úgy, hogy csak azokat a blokkokat tölti fel, amelyek módosultak, majd együtt véglegesíti az új és a meglévő blokkokat. A blokklistában nem szereplő és véglegesen törölt blokkok.
Lásd: https://docs.microsoft.com/rest/api/storageservices/put-block-list
function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>
Paraméterek
- blocks
-
string[]
64 bájtos, base64 kódolású tömb
- options
- BlockBlobCommitBlockListOptions
A Blokkblob véglegesítési blokklista műveletének beállításai.
Válaszok
Promise<BlockBlobCommitBlockListResponse>
Válaszadatok a Blokkblob véglegesítési blokklista műveletéhez.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)
A blokkblob részeként a megadott blokklistaszűrő használatával feltöltött blokkok listáját adja vissza.
Lásd: https://docs.microsoft.com/rest/api/storageservices/get-block-list
function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>
Paraméterek
- listType
- BlockListType
Meghatározza, hogy a véglegesített blokkok listáját, a nem véglegesített blokkok listáját vagy mindkét listát együtt szeretné-e visszaadni.
- options
- BlockBlobGetBlockListOptions
A Blokkblobok blokklista beolvasása művelet beállításai.
Válaszok
Promise<BlockBlobGetBlockListResponse>
A Blokkblobok blokklista beolvasása művelet válaszadatai.
query(string, BlockBlobQueryOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
JSON- vagy CSV-formátumú blob gyors lekérdezése.
Példahasználat (Node.js):
// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);
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);
});
}
function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>
Paraméterek
- query
-
string
- options
- BlockBlobQueryOptions
Válaszok
Promise<BlobDownloadResponseModel>
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)
Feltölti a megadott blokkot a blokkblob "előkészítési területére", hogy később véglegesítse a commitBlockList hívása.
Lásd: https://docs.microsoft.com/rest/api/storageservices/put-block
function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>
Paraméterek
- blockId
-
string
Egy base64 kódolású 64 bájtos érték
- body
- HttpRequestBody
Az előkészítési területre feltöltendő adatok.
- contentLength
-
number
Feltöltendő bájtok száma.
- options
- BlockBlobStageBlockOptions
A Blokkblobszakasz blokkolása művelet beállításai.
Válaszok
Promise<BlockBlobStageBlockResponse>
A Blokkblobszakasz blokkolása művelet válaszadatai.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)
A Fázisblokk url-címből művelet létrehoz egy új blokkot, amely egy blob részeként lesz véglegesítve, ahol a tartalom egy URL-címről lesz beolvasva. Ez az API a 2018-03-28-es verziótól érhető el.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>
Paraméterek
- blockId
-
string
Egy base64 kódolású 64 bájtos érték
- sourceURL
-
string
A blob URL-címét adja meg. Az érték legfeljebb 2 KB hosszúságú URL-cím lehet, amely blobot határoz meg. Az értéknek URL-kódolásúnak kell lennie, ahogy az a kérelem URI-jában is megjelenik. A forrásblobnak nyilvánosnak kell lennie, vagy közös hozzáférésű jogosultságkóddal kell hitelesítenie magát. Ha a forrásblob nyilvános, a művelet végrehajtásához nincs szükség hitelesítésre. Íme néhány példa a forrásobjektum URL-címére: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
- 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
A Blobszakasz blokkolása URL-címből művelet beállításai.
Válaszok
Promise<BlockBlobStageBlockFromURLResponse>
A Block Blob Stage Block From URL művelet válaszadatai.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)
Létrehoz egy új blokkblobot, amelyben a blob tartalma egy adott URL-címről lesz beolvasva. Ez az API a 2020.04.08-i verziótól kezdve támogatott. A részleges frissítések nem támogatottak a Put Blob from URL-címmel; egy meglévő blob tartalma felülíródik az új blob tartalmával. Ha egy blokkblob tartalmának részleges frissítését forrás URL-címmel szeretné végrehajtani, használja a stageBlockFromURL és a commitBlockList parancsot.
function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>
Paraméterek
- sourceURL
-
string
A blob URL-címét adja meg. Az érték legfeljebb 2 KB hosszúságú URL-cím lehet, amely blobot határoz meg. Az értéknek URL-kódolásúnak kell lennie, ahogy az a kérelem URI-jában is megjelenik. A forrásblobnak nyilvánosnak kell lennie, vagy közös hozzáférésű jogosultságkóddal kell hitelesítenie magát. Ha a forrásblob nyilvános, a művelet végrehajtásához nincs szükség hitelesítésre. Íme néhány példa a forrásobjektum URL-címére: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Választható paraméterek.
Válaszok
Promise<BlockBlobPutBlobFromUrlResponse>
upload(RequestBodyType, number, BlockBlobUploadOptions)
Új blokkblobot hoz létre, vagy frissíti egy meglévő blokkblob tartalmát. Egy meglévő blokkblob frissítése felülírja a blob meglévő metaadatait. A részleges frissítések nem támogatottak; a meglévő blob tartalma felülíródik az új tartalommal. A blokkblobok részleges frissítéséhez használja a stageBlock és a commitBlockList parancsot.
Ez egy nem párhuzamos feltöltési módszer. Az egyidejű feltöltés jobb teljesítménye érdekében használja az uploadFile, uploadStream vagy uploadBrowserData metódust.
Lásd: https://docs.microsoft.com/rest/api/storageservices/put-blob
function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>
Paraméterek
- body
- HttpRequestBody
Blob, sztring, ArrayBuffer, ArrayBufferView vagy olyan függvény, amely egy új olvasható streamet ad vissza, amelynek eltolása az adatforrás elejéről származik.
- contentLength
-
number
A törzs hossza bájtban. Használja a Buffer.byteLength() függvényt egy sztring törzshosszának kiszámításához, beleértve a nem Base64/Hex kódolású karaktereket is.
- options
- BlockBlobUploadOptions
A Blokkblob feltöltése művelet beállításai.
Válaszok
Promise<BlockBlobUploadResponse>
A Blokkblob feltöltése művelet válaszadatai.
Példahasználat:
const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)
CSAK BÖNGÉSZŐKBEN ÉRHETŐ EL.
Feltölt egy böngészőblobot/fájlt/tömbbuffert/tömbbufferView objektumot a blob blokkolásához.
Ha a puffer hossza kisebb vagy egyenlő 256 MB-nál, ez a metódus 1 feltöltési hívást használ a feltöltés befejezéséhez. Ellenkező esetben ez a metódus meghívja a stageBlock metódust blokkok feltöltéséhez, és végül meghívja a commitBlockList metódust a blokklista véglegesítéséhez.
A blobHTTPHeaders beállításának egyik gyakori beállítása a blobContentType
, amely lehetővé teszi, hogy a böngésző a fájltípus alapján biztosítson funkciókat.
function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Paraméterek
- browserData
-
Blob | ArrayBuffer | ArrayBufferView
Blob, File, ArrayBuffer vagy ArrayBufferView
- options
- BlockBlobParallelUploadOptions
Böngészőadatok feltöltésének lehetőségei.
Válaszok
Promise<BlobUploadCommonResponse>
A Blob feltöltése művelet válaszadatai.
uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)
Feltölt egy Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView objektumot egy BlockBlobba.
Ha az adathossz nem nagyobb, mint a specifiled maxSingleShotSize (alapértelmezés szerint <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), ez a metódus 1 feltöltési hívást használ a feltöltés befejezéséhez. Ellenkező esetben ez a metódus meghívja a stageBlock metódust blokkok feltöltéséhez, és végül meghívja a commitBlockList metódust a blokklista véglegesítéséhez.
A blobHTTPHeaders beállításának egyik gyakori beállítása a blobContentType
, amely lehetővé teszi, hogy a böngésző a fájltípus alapján biztosítson funkciókat.
function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Paraméterek
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
Buffer(Node.js), Blob, ArrayBuffer vagy ArrayBufferView
- options
- BlockBlobParallelUploadOptions
Válaszok
Promise<BlobUploadCommonResponse>
uploadFile(string, BlockBlobParallelUploadOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Blokkokban lévő helyi fájlt tölt fel egy blokkblobba.
Ha a fájlméret kisebb vagy egyenlő 256 MB-nál, ez a metódus 1 feltöltési hívást használ a feltöltés befejezéséhez. Ellenkező esetben ez a metódus meghívja a stageBlock metódust blokkok feltöltéséhez, és végül meghívja a commitBlockList metódust a blokklista véglegesítéséhez.
function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Paraméterek
- filePath
-
string
A helyi fájl teljes elérési útja
- options
- BlockBlobParallelUploadOptions
A Feltöltés blokkblobba művelet beállításai.
Válaszok
Promise<BlobUploadCommonResponse>
A Blob feltöltése művelet válaszadatai.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Feltölt egy Node.js olvasható streamet blokkblobba.
TELJESÍTMÉNYNÖVELÉSI TIPPEK:
- A highWaterMark bemeneti adatfolyam jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Buffer.concat() műveletek.
function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>
Paraméterek
- stream
-
Readable
Node.js olvasható stream
- bufferSize
-
number
Az összes lefoglalt puffer mérete, valamint a feltöltött blokkblob blokkmérete is. Az alapértelmezett érték 8 MB
- maxConcurrency
-
number
A maximális egyidejűség a lefoglalható pufferek maximális számát jelzi, pozitív korrelációt a maximális feltöltési egyidejűséggel. Az alapértelmezett érték 5
- options
- BlockBlobUploadStreamOptions
A Stream feltöltése blokkblobba művelet beállításai.
Válaszok
Promise<BlobUploadCommonResponse>
A Blob feltöltése művelet válaszadatai.
withSnapshot(string)
Létrehoz egy új BlockBlobClient 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 visszaad egy URL-címet az alapblobnak.
function withSnapshot(snapshot: string): BlockBlobClient
Paraméterek
- snapshot
-
string
A pillanatkép időbélyege.
Válaszok
Egy új BlockBlobClient 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
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>
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Törölje a blob immutablility szabályzatát.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Paraméterek
Választható lehetőségek a blob módosíthatatlansá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 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 Node.js/V8 korlátozásai miatt. Az ilyen méretű blobok esetében fontolja meg a downloadToFile fájlt.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Paraméterek
- buffer
-
Buffer
A kitöltendő puffernek a számnál hosszabbnak kell lennie
- offset
-
number
A letöltendő blokkblob pozíciója (bájtban)
- count
-
number
Mennyi adat (bájtban) tölthető le. A letöltés a végéhez ér, amikor nem definiált értéket ad át
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Válaszok
Promise<Buffer>
ÖrököltblobClient.downloadToBuffer
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Egy Azure-blobot tölt le párhuzamosan egy pufferrel. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.
Figyelmeztetés: A pufferek legfeljebb egy gigabájt méretű fájlokat támogatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ilyen méretű blobok esetében fontolja meg a downloadToFile fájlt.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Paraméterek
- offset
-
number
A letöltendő blokkblob pozíciója (bájtban)
- count
-
number
Mennyi adat (bájtban) tölthető le. A letöltés a végéhez ér, amikor nem definiált értéket ad át
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Válaszok
Promise<Buffer>
ÖrököltblobClient.downloadToBuffer
downloadToFile(string, number, number, BlobDownloadOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Letölt egy Azure Blobot egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes blob letöltéséhez adja meg a 0 értéket, illetve a nem definiált értéket.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Paraméterek
- filePath
-
string
- offset
-
number
A blokkblob letöltésének helye.
- count
-
number
Mennyi adatot kell letölteni. A letöltés a végéig történik, amikor nem definiált értéket ad át.
- options
- BlobDownloadOptions
A Blob letöltési beállításai.
Válaszok
Promise<BlobDownloadResponseParsed>
A blobletöltési művelet válaszadatai, de a readableStreamBody értéke nincs meghatározva, mivel a tartalma már be van olvasva, és egy helyi fájlba van írva a megadott elérési úton.
ÖrököltBlobClient.downloadToFile
exists(BlobExistsOptions)
Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; máskülönben hamis.
MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő blobot más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy más ügyfelek vagy alkalmazások új blobokat adnak hozzá a függvény befejezése után.
function exists(options?: BlobExistsOptions): Promise<boolean>
Paraméterek
- options
- BlobExistsOptions
a Exists (Létező) művelet beállításai.
Válaszok
Promise<boolean>
generateSasUrl(BlobGenerateSasUrlOptions)
Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el.
Létrehoz egy Blob Service megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
Paraméterek
- options
- BlobGenerateSasUrlOptions
Választható paraméterek.
Válaszok
Promise<string>
Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.
ÖrököltblobClient.generateSasUrl
getAppendBlobClient()
Létrehoz egy AppendBlobClient objektumot.
function getAppendBlobClient(): AppendBlobClient
Válaszok
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
Egy új BlobLeaseClient objektum a blob bérleteinek kezeléséhez.
getBlockBlobClient()
Létrehoz egy BlockBlobClient objektumot.
function getBlockBlobClient(): BlockBlobClient
Válaszok
getPageBlobClient()
Létrehoz egy PageBlobClient objektumot.
function getPageBlobClient(): PageBlobClient
Válaszok
ÖrököltblobClient.getPageBlobClient
getProperties(BlobGetPropertiesOptions)
A blob összes felhasználó által definiált metaadatát, szabványos HTTP-tulajdonságát és rendszertulajdonságát adja vissza. Nem adja vissza a blob tartalmát.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
FIGYELMEZTETÉS: A metadata
válaszban visszaadott objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ContainerClient metódusai által visszaadott metaadatkulcsoktól, amelyek a lehetőséggel listázják a blobokat, amelyek megőrzik az includeMetadata
eredeti burkolatukat.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Paraméterek
- options
- BlobGetPropertiesOptions
A Tulajdonságok lekérése művelet választható lehetőségei.
Válaszok
Promise<BlobGetPropertiesResponse>
ÖrököltblobClient.getProperties
getTags(BlobGetTagsOptions)
Lekéri a mögöttes blobhoz társított címkéket.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Paraméterek
- options
- BlobGetTagsOptions
Válaszok
Promise<BlobGetTagsResponse>
BlobClient.getTags-tőlörökölt
setAccessTier(string, BlobSetTierOptions)
Beállítja a szintet egy blobon. A művelet egy prémium szintű tárfiók lapblobján és blobtároló-fiók blokkblobján engedélyezett (csak helyileg redundáns tárolás). A prémium szintű lapblobok szintje határozza meg a blob megengedett méretét, IOPS-ját és sávszélességét. A blokkblobok szintje határozza meg a gyakori elérésű/ritka elérésű/archív tárolási típust. Ez a művelet nem frissíti a blob ETagjét.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Paraméterek
- tier
-
string
A blobon beállítani kívánt szint. Az érvényes értékek a gyakori elérésű, a ritka elérésű vagy az archív értékek.
- options
- BlobSetTierOptions
A Blobkészlet rétege művelet választható beállításai.
Válaszok
Promise<BlobSetTierResponse>
BlobClient.setAccessTier-tőlörökölt
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Beállítja a rendszer tulajdonságait a blobon.
Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejléceihez, ezek a blob HTTP-fejlécek érték nélkül törlődnek.
Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Paraméterek
- blobHTTPHeaders
- BlobHTTPHeaders
Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejléceihez, ezek a blob HTTP-fejlécek érték nélkül törlődnek.
Egy gyakran beállított fejléc lehetővé teszi a blobContentType
böngésző számára, hogy fájltípus alapján biztosítson funkciókat.
- options
- BlobSetHTTPHeadersOptions
A BLOB HTTP-fejlécek beállítása művelet választható beállításai.
Válaszok
Promise<BlobSetHTTPHeadersResponse>
ABlobClient.setHTTPHeaderstől örökölt
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Állítsa be a nem módosíthatósági szabályzatot a blobon.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Paraméterek
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Nem kötelező beállítások a blob módosíthatósági szabályzatának beállításához.
Válaszok
Promise<BlobSetImmutabilityPolicyResponse>
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. 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
A hitelesítéshez szükséges forrás URL-cím, amelyből a közös hozzáférésű jogosultságkód (SAS) másolható
- options
- BlobSyncCopyFromURLOptions
Válaszok
Promise<BlobCopyFromURLResponse>
Ö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. A Blob törlése 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>
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 alapblobnak.
function withVersion(versionId: string): BlobClient
Paraméterek
- versionId
-
string
A verzióazonosító.
Válaszok
Egy új BlobClient objektum, amely ennek a blobnak a verziójára mutat.
ÖrököltblobClient.withVersion