BlobClient class

Referencia

Csomag:: @azure/storage-blob

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

Extends: StorageClient

Konstruktorok

BlobClient(string, PipelineLike)	Létrehozza a BlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blobra mutat. A kódolt URL-sztring NEM lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmazza a következőt: ? vagy %, a blob nevét az URL-címben kell kódolni.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Létrehozza a BlobClient egy példányát. Ez a metódus egy kódolt VAGY nem kódolt URL-címet fogad el, amely egy blobra mutat. A kódolt URL-sztring NEM lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha egy blobnév tartalmazza a következőt: ? vagy %, a blob nevét az URL-címben kell kódolni.
BlobClient(string, string, string, StoragePipelineOptions)	Létrehoz egy BlobClient-példányt a kapcsolati sztring.

Tulajdonságok

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

Metódusok

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Megszakít egy függőben lévő aszinkron másolási blobműveletet, és egy célblobot hagy nulla hosszúságú és teljes metaadatokkal. 2012-02-12-es és újabb verzió.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Aszinkron módon másol egy blobot a tárfiókon belüli célhelyre. Ez a metódus egy hosszú ideig futó műveletet ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a másolás befejeződik. A másolatot a lekérdező hívásával `cancelOperation` is megszakíthatja, mielőtt befejeződik. Vegye figyelembe, hogy az onProgress visszahívás nem lesz meghívva, ha a művelet az első kérelemben befejeződik, és a befejezett másolat visszavonásának megkísérlése hibát eredményez. A 2012-02-12-es és újabb verzióban a Másolási blob művelet forrása bármely Azure-tárfiókban véglegesített blob lehet. A 2015-02-21-es verziótól kezdődően a Blob másolása művelet forrása egy Azure-fájl lehet bármely Azure-tárfiókban. Csak a 2012. június 7-én vagy azt követően létrehozott tárfiókok engedélyezik a Blob másolása művelet másolását egy másik tárfiókból.
createSnapshot(BlobCreateSnapshotOptions)	Egy blob írásvédett pillanatképét hozza létre.
delete(BlobDeleteOptions)	Megjelöli a megadott blobot vagy pillanatképet a törléshez. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. Mindkettőt egyszerre törölheti a Blob törlése művelettel.
deleteIfExists(BlobDeleteOptions)	Megjelöli a megadott blobot vagy pillanatképet a törléshez, ha létezik. A blob később törlődik a szemétgyűjtés során. Vegye figyelembe, hogy egy blob törléséhez törölnie kell az összes pillanatképét. Mindkettőt egyszerre törölheti a Blob törlése művelettel.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Törölje az immutablility szabályzatot a blobon.
download(number, number, BlobDownloadOptions)	Egy blobot olvas be vagy tölt le a rendszerből, beleértve annak metaadatait és tulajdonságait. A Pillanatképek olvasásához meghívhatja a Blob lekérése parancsot is. A Node.js az adatok egy olvasható adatfolyamban, olvashatóStreamBody-ban térnek vissza A böngészőkben az adatok egy ígéret blobBody-ban térnek vissza
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Azure-blobot tölt le párhuzamosan egy pufferrel. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva. Figyelmeztetés: A pufferek legfeljebb egy gigabájt méretű fájlokat támogatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ennél nagyobb méretű blobok esetében vegye figyelembe a következőt <xref:downloadToFile>: .
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Azure-blobot tölt le párhuzamosan egy pufferrel. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva. Figyelmeztetés: A pufferek legfeljebb egy gigabájt méretű fájlokat támogatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ennél nagyobb méretű blobok esetében vegye figyelembe a következőt <xref:downloadToFile>: .
downloadToFile(string, number, number, BlobDownloadOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Letölt egy Azure Blobot egy helyi fájlba. Sikertelen, ha a megadott fá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 pass 0 és undefined értéket ad meg.
exists(BlobExistsOptions)	Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő blobot más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy más ügyfelek vagy alkalmazások új blobokat adnak hozzá a függvény befejezése után.
generateSasUrl(BlobGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott BlobClient esetén érhető el. Létrehoz egy Blob Service megosztott hozzáférésű jogosultságkód (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.
getAppendBlobClient()	Létrehoz egy AppendBlobClient objektumot.
getBlobLeaseClient(string)	Szerezzen be egy olyant <xref:BlobLeaseClient> , amely kezeli a blob bérleteit.
getBlockBlobClient()	Létrehoz egy BlockBlobClient objektumot.
getPageBlobClient()	Létrehoz egy PageBlobClient objektumot.
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.
getTags(BlobGetTagsOptions)	Lekéri a mögöttes blobhoz társított címkéket.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| 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.
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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Állítsa be az immutablility 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.
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ékeinek 0 és 256 karakter közöttinek kell lenniük. É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.
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.
withSnapshot(string)	Létrehoz egy új BlobClient 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.
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

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

Paraméterek

url: string

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

pipeline: PipelineLike

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

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

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

Paraméterek

url: string

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. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.

options: StoragePipelineOptions

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

BlobClient(string, string, string, StoragePipelineOptions)

Létrehoz egy BlobClient-példányt a kapcsolati sztring.

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

Paraméterek

connectionString: string

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

containerName: string

Tároló neve.

blobName: string

Blob neve.

options: StoragePipelineOptions

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

Tulajdonság adatai

accountName

accountName: string

Tulajdonság értéke

string

containerName

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

string containerName

Tulajdonság értéke

string

credential

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

name

A blob neve.

string name

Tulajdonság értéke

string

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

Metódus adatai

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

Paraméterek

copyId: string

A Másolás URL-címről művelet azonosítója.

options: BlobAbortCopyFromURLOptions

Az URL-címről történő blobmásolás megszakítása művelet választható beállításai.

Válaszok

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Aszinkron módon másol egy blobot a tárfiókon belüli célhelyre. Ez a metódus egy hosszú ideig futó műveletet ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a másolás befejeződik. A másolatot a lekérdező hívásával cancelOperation is megszakíthatja, mielőtt befejeződik. Vegye figyelembe, hogy az onProgress visszahívás nem lesz meghívva, ha a művelet az első kérelemben befejeződik, és a befejezett másolat visszavonásának megkísérlése hibát eredményez. A 2012-02-12-es és újabb verzióban a Másolási blob művelet forrása bármely Azure-tárfiókban véglegesített blob lehet. A 2015-02-21-es verziótól kezdődően a Blob másolása művelet forrása egy Azure-fájl lehet bármely Azure-tárfiókban. Csak a 2012. június 7-én vagy azt követően létrehozott tárfiókok engedélyezik a Blob másolása művelet másolását egy másik tárfiókból.

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

Paraméterek

copySource: string

url-cím a forrás Azure Blob/Fájl címére.

options: BlobBeginCopyFromURLOptions

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

Válaszok

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Paraméterek

options: BlobCreateSnapshotOptions

A Blob Create Snapshot (Blob létrehozása pillanatkép létrehozása) művelet választható beállításai.

Válaszok

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

Paraméterek

options: BlobDeleteOptions

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

Válaszok

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

Paraméterek

options: BlobDeleteOptions

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

Válaszok

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Paraméterek

options: BlobDeleteImmutabilityPolicyOptions

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

Válaszok

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

A Node.js az adatok egy olvasható adatfolyamban, olvashatóStreamBody-ban térnek vissza
A böngészőkben az adatok egy ígéret blobBody-ban térnek vissza

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

Paraméterek

offset: number

A letölthető blob 0-nál nagyobb vagy egyenlő pozíciója

count: number

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

options: BlobDownloadOptions

A blobletöltési művelet választható lehetőségei.

Példahasználat (Node.js):

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

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

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

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

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

Válaszok

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Azure-blobot tölt le párhuzamosan egy pufferrel. Az eltolás és a darabszám megadása nem kötelező, a teljes blobot letölti, ha nincsenek megadva.

Figyelmeztetés: A pufferek legfeljebb egy gigabájt méretű fájlokat támogatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Az ennél nagyobb méretű blobok esetében vegye figyelembe a következőt <xref:downloadToFile>: .

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

Paraméterek

buffer: Buffer

A kitöltendő puffernek a számnál hosszabbnak kell lennie

offset: number

A letöltendő blokkblob pozíciója (bájtban)

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Paraméterek

offset: number

A letöltendő blokkblob pozíciója (bájtban)

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Válaszok

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Letölt egy Azure Blobot egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes blob letöltéséhez pass 0 és undefined értéket ad meg.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Paraméterek

filePath: string

offset: number

A blokkblob letöltésének helye.

count: number

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

options: BlobDownloadOptions

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

Válaszok

Promise<BlobDownloadResponseParsed>

A blobletöltési művelet válaszadatai, de a readableStreamBody értéke nincs meghatározva, mivel a tartalma már be van olvasva, és egy helyi fájlba van írva a megadott elérési úton.

exists(BlobExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt Azure Blob-erőforrás létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő blobot más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy más ügyfelek vagy alkalmazások új blobokat adnak hozzá a függvény befejezése után.

function exists(options?: BlobExistsOptions)

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Paraméterek

options: BlobGenerateSasUrlOptions

Választható paraméterek.

Válaszok

Promise<string>

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

getAppendBlobClient()

Létrehoz egy AppendBlobClient objektumot.

function getAppendBlobClient()

Válaszok

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

Paraméterek

proposeLeaseId: string

Kezdeti javasolt bérletazonosító.

Válaszok

BlobLeaseClient

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

getBlockBlobClient()

Létrehoz egy BlockBlobClient objektumot.

function getBlockBlobClient()

Válaszok

BlockBlobClient

getPageBlobClient()

Létrehoz egy PageBlobClient objektumot.

function getPageBlobClient()

Válaszok

PageBlobClient

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.

function getProperties(options?: BlobGetPropertiesOptions)

Paraméterek

options: BlobGetPropertiesOptions

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

Válaszok

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Paraméterek

options: BlobGetTagsOptions

Válaszok

Promise<BlobGetTagsResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | 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.

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

Paraméterek

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

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

Válaszok

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

Paraméterek

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

Válaszok

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

Paraméterek

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Válaszok

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

Paraméterek

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Válaszok

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

A megadott blob felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be. Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a blob metaadatai el lesznek távolítva.

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

Paraméterek

metadata: Metadata

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

options: BlobSetMetadataOptions

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

Válaszok

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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ékeinek 0 és 256 karakter közöttinek kell lenniük. É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)

Paraméterek

tags: Tags

options: BlobSetTagsOptions

Válaszok

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

Paraméterek

copySource: string

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

options: BlobSyncCopyFromURLOptions

Válaszok

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

Paraméterek

options: BlobUndeleteOptions

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

Válaszok

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

Paraméterek

snapshot: string

A pillanatkép időbélyege.

Válaszok

BlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

Paraméterek

versionId: string

A verzióazonosító.

Válaszok

BlobClient

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

Share via

BlobClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

BlobClient(string, PipelineLike)

Paraméterek

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

Paraméterek

BlobClient(string, string, string, StoragePipelineOptions)

Paraméterek

Tulajdonság adatai

accountName

Tulajdonság értéke

containerName

Tulajdonság értéke

credential

Tulajdonság értéke

name

Tulajdonság értéke

url

Tulajdonság értéke

Metódus adatai

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Paraméterek

Válaszok

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Paraméterek

Válaszok

createSnapshot(BlobCreateSnapshotOptions)

Paraméterek

Válaszok

delete(BlobDeleteOptions)

Paraméterek

Válaszok

deleteIfExists(BlobDeleteOptions)

Paraméterek

Válaszok

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Paraméterek

Válaszok

download(number, number, BlobDownloadOptions)

Paraméterek

Válaszok

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Paraméterek

Válaszok

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Paraméterek

Válaszok

downloadToFile(string, number, number, BlobDownloadOptions)

Paraméterek

Válaszok

exists(BlobExistsOptions)

Paraméterek

Válaszok

generateSasUrl(BlobGenerateSasUrlOptions)

Paraméterek

Válaszok

getAppendBlobClient()

Válaszok

getBlobLeaseClient(string)

Paraméterek

Válaszok

getBlockBlobClient()

Válaszok

getPageBlobClient()

Válaszok

getProperties(BlobGetPropertiesOptions)

Paraméterek

Válaszok

getTags(BlobGetTagsOptions)

Paraméterek

Válaszok

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Paraméterek

Válaszok

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Paraméterek