BlobClient class

Reference

Balíček:: @azure/storage-blob

Objekt BlobClient představuje adresu URL objektu blob služby Azure Storage. objektem blob může být objekt blob bloku, doplňovací objekt blob nebo objekt blob stránky.

Extends: StorageClient

Konstruktory

BlobClient(string, PipelineLike)	Vytvoří instanci BlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud název objektu blob zahrnuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Vytvoří instanci BlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud název objektu blob zahrnuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.
BlobClient(string, string, string, StoragePipelineOptions)	Vytvoří instanci BlobClient z připojovacího řetězce.

Vlastnosti

accountName
containerName	Název kontejneru úložiště, ke které je objekt blob přidružený.
credential	Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z `@azure/identity` balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.
name	Název objektu blob.
url	Zakódovaná hodnota řetězce adresy URL.

Metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Přeruší čekající asynchronní operaci Kopírování objektu blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty. Verze 2012-02-12 a novější.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště. Tato metoda vrátí dlouho běžící operaci poller, která vám umožní čekat neomezeně dlouho, dokud se kopírování nedokončí. Můžete také zrušit kopii před jejím dokončením zavoláním `cancelOperation` na poller. Všimněte si, že zpětné volání onProgress nebude vyvoláno, pokud se operace dokončí v prvním požadavku, a pokus o zrušení dokončené kopie způsobí vyvolání chyby. Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure. Počínaje verzí 2015-02-21 může být zdrojem operace Kopírování objektu blob soubor Azure v libovolném účtu úložiště Azure. Kopírování z jiného účtu úložiště umožňují pouze účty úložiště vytvořené 7. června 2012 nebo později.
createSnapshot(BlobCreateSnapshotOptions)	Vytvoří snímek objektu blob jen pro čtení.
delete(BlobDeleteOptions)	Označí zadaný objekt blob nebo snímek pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
deleteIfExists(BlobDeleteOptions)	Označí zadaný objekt blob nebo snímek pro odstranění, pokud existuje. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Odstraňte zásady neměnnosti objektu blob.
download(number, number, BlobDownloadOptions)	Načte nebo stáhne objekt blob ze systému, včetně jeho metadat a vlastností. Pokud chcete přečíst snímek, můžete také volat get blob. V Node.js vrátí data v čitelném streamu readableStreamBody. V prohlížečích se data vrací v objektu blobBody příslibu.
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob. Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. U objektů blob větších, než je tato velikost, zvažte <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob. Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. U objektů blob větších, než je tato velikost, zvažte <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, pass 0 a undefined pro stažení celého objektu blob.
exists(BlobExistsOptions)	Vrátí hodnotu true, pokud prostředek objektu blob Azure reprezentovaný tímto klientem existuje. v opačném případě false. POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové objekty blob.
generateSasUrl(BlobGenerateSasUrlOptions)	K dispozici pouze pro Objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby Blob Service na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.
getAppendBlobClient()	Vytvoří objekt AppendBlobClient.
getBlobLeaseClient(string)	<xref:BlobLeaseClient> Získejte objekt, který spravuje zapůjčení objektu blob.
getBlockBlobClient()	Vytvoří objekt BlockBlobClient.
getPageBlobClient()	Vytvoří objekt PageBlobClient.
getProperties(BlobGetPropertiesOptions)	Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob.
getTags(BlobGetTagsOptions)	Získá značky přidružené k základnímu objektu blob.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Nastaví úroveň objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje značky ETag objektu blob.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Nastaví systémové vlastnosti objektu blob. Pokud se nezadá žádná hodnota nebo nezadá žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektů blob bez hodnoty se vymažou.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Nastavte pro objekt blob zásady neměnnosti.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Nastavte blokování objektu blob z právních důvodů.
setMetadata(Metadata, BlobSetMetadataOptions)	Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jednu nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata objektu blob se odeberou.
setTags(Tags, BlobSetTagsOptions)	Nastaví značky u základního objektu blob. Objekt blob může mít až 10 značek. Klíče značek musí mít délku 1 až 128 znaků. Hodnoty značek musí mít 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0-9), mezeru (' '), plus ('+'), mínus ('-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítko ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Synchronní operace Kopírovat z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopírování dokončeno, nevrátí odpověď.
undelete(BlobUndeleteOptions)	Obnoví obsah a metadata obnovitelně odstraněného objektu blob a všech přidružených obnovitelně odstraněných snímků. Zrušení odstranění objektu blob se podporuje jenom ve verzi 2017-07-29 nebo novější.
withSnapshot(string)	Vytvoří nový objekt BlobClient, který je shodný se zdrojem, ale se zadaným časovým razítkem snímku. Poskytnutím příkazu odeberete snímek a vrátíte klienta do základního objektu blob.
withVersion(string)	Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Pokud zadáte , odebere se id verze a klient se vrátí do základního objektu blob.

Podrobnosti konstruktoru

BlobClient(string, PipelineLike)

Vytvoří instanci BlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud název objektu blob zahrnuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL.

new BlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

Řetězec klienta odkazující na službu objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".

pipeline: PipelineLike

Voláním příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

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

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options: StoragePipelineOptions

Nepovinný parametr. Možnosti konfigurace kanálu HTTP

BlobClient(string, string, string, StoragePipelineOptions)

Vytvoří instanci BlobClient z připojovacího řetězce.

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

Parametry

connectionString: string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka – Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Příklad připojovacího řetězce SAS – 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

Název kontejneru.

blobName: string

Název objektu blob.

options: StoragePipelineOptions

Nepovinný parametr. Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

accountName

accountName: string

Hodnota vlastnosti

string

containerName

Název kontejneru úložiště, ke které je objekt blob přidružený.

string containerName

Hodnota vlastnosti

string

credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

Název objektu blob.

string name

Hodnota vlastnosti

string

url

Zakódovaná hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Podrobnosti metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Přeruší čekající asynchronní operaci Kopírování objektu blob a ponechá cílový objekt blob s nulovou délkou a úplnými metadaty. Verze 2012-02-12 a novější.

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

Parametry

copyId: string

ID operace Kopírovat z adresy URL.

options: BlobAbortCopyFromURLOptions

Volitelné možnosti operace Kopírování z adresy URL objektu blob

Návraty

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Asynchronně zkopíruje objekt blob do cíle v rámci účtu úložiště. Tato metoda vrátí dlouho běžící operaci poller, která vám umožní čekat neomezeně dlouho, dokud se kopírování nedokončí. Můžete také zrušit kopii před jejím dokončením zavoláním cancelOperation na poller. Všimněte si, že zpětné volání onProgress nebude vyvoláno, pokud se operace dokončí v prvním požadavku, a pokus o zrušení dokončené kopie způsobí vyvolání chyby. Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure. Počínaje verzí 2015-02-21 může být zdrojem operace Kopírování objektu blob soubor Azure v libovolném účtu úložiště Azure. Kopírování z jiného účtu úložiště umožňují pouze účty úložiště vytvořené 7. června 2012 nebo později.

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

Parametry

copySource: string

adresa url zdrojového objektu blob nebo souboru Azure.

options: BlobBeginCopyFromURLOptions

Volitelné možnosti operace Spuštění kopírování z adresy URL objektu blob

Návraty

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

createSnapshot(BlobCreateSnapshotOptions)

Vytvoří snímek objektu blob jen pro čtení.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametry

options: BlobCreateSnapshotOptions

Volitelné možnosti operace Vytvoření snímku objektu blob

Návraty

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Označí zadaný objekt blob nebo snímek pro odstranění. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.

function delete(options?: BlobDeleteOptions)

Parametry

options: BlobDeleteOptions

Volitelné možnosti operace odstranění objektu blob

Návraty

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Označí zadaný objekt blob nebo snímek pro odstranění, pokud existuje. Objekt blob se později odstraní během uvolňování paměti. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.

function deleteIfExists(options?: BlobDeleteOptions)

Parametry

options: BlobDeleteOptions

Volitelné možnosti operace odstranění objektu blob

Návraty

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Odstraňte zásady neměnnosti objektu blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametry

options: BlobDeleteImmutabilityPolicyOptions

Volitelné možnosti pro odstranění zásad neměnnosti objektu blob

Návraty

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

Načte nebo stáhne objekt blob ze systému, včetně jeho metadat a vlastností. Pokud chcete přečíst snímek, můžete také volat get blob.

V Node.js vrátí data v čitelném streamu readableStreamBody.
V prohlížečích se data vrací v objektu blobBody příslibu.

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

Parametry

offset: number

Z jaké pozice objektu blob ke stažení, větší než nebo rovno 0

count: number

Kolik dat se má stáhnout, větší než 0. Bude stahovat až do konce, pokud není definováno

options: BlobDownloadOptions

Volitelné možnosti operace stažení objektu blob

Příklad použití (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říklad použití (prohlížeč):

// 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);
  });
}

Návraty

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob.

Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. U objektů blob větších, než je tato velikost, zvažte <xref:downloadToFile>.

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

Parametry

buffer: Buffer

Vyrovnávací paměť, která se má vyplnit, musí mít délku větší, než je počet

offset: number

Z jaké pozice objektu blob bloku se má stáhnout (v bajtech)

count: number

Kolik dat (v bajtech) se má stáhnout. Bude stahovat až do konce, když předáte nedefinované

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Návraty

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud nejsou zadané, stáhne se celý objekt blob.

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

Parametry

offset: number

Z jaké pozice objektu blob bloku se má stáhnout (v bajtech)

count: number

Kolik dat (v bajtech) se má stáhnout. Bude stahovat až do konce, když předáte nedefinované

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Návraty

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, pass 0 a undefined pro stažení celého objektu blob.

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

Parametry

filePath: string

offset: number

Z jaké pozice objektu blob bloku se má stáhnout.

count: number

Kolik dat se má stáhnout. Stáhne se až do konce, když předáte nedefinované.

options: BlobDownloadOptions

Možnosti stažení objektů blob

Návraty

Promise<BlobDownloadResponseParsed>

Data odpovědi na operaci stažení objektu blob, ale s funkcí readableStreamBody nastavenou na hodnotu undefined, protože její obsah je již přečten a zapsán do místního souboru v zadané cestě.

exists(BlobExistsOptions)

Vrátí hodnotu true, pokud prostředek objektu blob Azure reprezentovaný tímto klientem existuje. v opačném případě false. POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové objekty blob.

function exists(options?: BlobExistsOptions)

Parametry

options: BlobExistsOptions

možnosti operace Existuje.

Návraty

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

K dispozici pouze pro Objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby Blob Service na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parametry

options: BlobGenerateSasUrlOptions

Volitelné parametry.

Návraty

Promise<string>

Identifikátor URI SAS sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následně z vygenerovaného tokenu SAS.

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient()

Návraty

AppendBlobClient

getBlobLeaseClient(string)

<xref:BlobLeaseClient> Získejte objekt, který spravuje zapůjčení objektu blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametry

proposeLeaseId: string

Počáteční navrhované ID zapůjčení

Návraty

BlobLeaseClient

Nový objekt BlobLeaseClient pro správu zapůjčení objektu blob.

getBlockBlobClient()

Vytvoří objekt BlockBlobClient.

function getBlockBlobClient()

Návraty

BlockBlobClient

getPageBlobClient()

Vytvoří objekt PageBlobClient.

function getPageBlobClient()

Návraty

PageBlobClient

getProperties(BlobGetPropertiesOptions)

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti objektu blob. Nevrací obsah objektu blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parametry

options: BlobGetPropertiesOptions

Volitelné možnosti operace Získat vlastnosti

Návraty

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Získá značky přidružené k základnímu objektu blob.

function getTags(options?: BlobGetTagsOptions)

Parametry

options: BlobGetTagsOptions

Návraty

Promise<BlobGetTagsResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Nastaví úroveň objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje značky ETag objektu blob.

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

Parametry

tier: BlockBlobTier | PremiumPageBlobTier | string

Úroveň, která se má nastavit v objektu blob. Platné hodnoty jsou Horká, Studená nebo Archivní.

options: BlobSetTierOptions

Volitelné možnosti pro operaci Úrovně sady objektů blob.

Návraty

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Nastaví systémové vlastnosti objektu blob. Pokud se nezadá žádná hodnota nebo nezadá žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektů blob bez hodnoty se vymažou.

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

Parametry

blobHTTPHeaders: BlobHTTPHeaders

Pokud se nezadá žádná hodnota nebo nezadá žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektů blob bez hodnoty se vymažou. Běžnou hlavičkou, která se má nastavit, je blobContentType umožnit prohlížeči poskytovat funkce na základě typu souboru.

options: BlobSetHTTPHeadersOptions

Volitelné možnosti operace Nastavení hlaviček HTTP objektů blob

Návraty

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Nastavte pro objekt blob zásady neměnnosti.

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

Parametry

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Volitelné možnosti pro nastavení zásad neměnnosti objektu blob

Návraty

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Nastavte blokování objektu blob z právních důvodů.

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

Parametry

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Volitelné možnosti pro nastavení blokování objektu blob z právních důvodů

Návraty

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jednu nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata objektu blob se odeberou.

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

Parametry

metadata: Metadata

Nahraďte existující metadata touto hodnotou. Pokud se nezadá žádná hodnota, existující metadata se odeberou.

options: BlobSetMetadataOptions

Volitelné možnosti pro operaci Nastavit metadata.

Návraty

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

Nastaví značky u základního objektu blob. Objekt blob může mít až 10 značek. Klíče značek musí mít délku 1 až 128 znaků. Hodnoty značek musí mít 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0-9), mezeru (' '), plus ('+'), mínus ('-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítko ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Parametry

tags: Tags

options: BlobSetTagsOptions

Návraty

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Synchronní operace Kopírovat z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopírování dokončeno, nevrátí odpověď.

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

Parametry

copySource: string

Zdrojová adresa URL, ze které se má kopírovat, sdílený přístupový podpis (SAS) možná potřeba pro ověřování

options: BlobSyncCopyFromURLOptions

Návraty

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Obnoví obsah a metadata obnovitelně odstraněného objektu blob a všech přidružených obnovitelně odstraněných snímků. Zrušení odstranění objektu blob se podporuje jenom ve verzi 2017-07-29 nebo novější.

function undelete(options?: BlobUndeleteOptions)

Parametry

options: BlobUndeleteOptions

Volitelné možnosti operace Odstranění objektu blob

Návraty

Promise<BlobUndeleteResponse>

withSnapshot(string)

Vytvoří nový objekt BlobClient, který je shodný se zdrojem, ale se zadaným časovým razítkem snímku. Poskytnutím příkazu odeberete snímek a vrátíte klienta do základního objektu blob.

function withSnapshot(snapshot: string)

Parametry

snapshot: string

Časové razítko snímku.

Návraty

BlobClient

Nový objekt BlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku

withVersion(string)

Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Pokud zadáte , odebere se id verze a klient se vrátí do základního objektu blob.

function withVersion(versionId: string)

Parametry

versionId: string

VersionId.

Návraty

BlobClient

Nový objekt BlobClient odkazující na verzi tohoto objektu blob.

Sdílet prostřednictvím

BlobClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

BlobClient(string, PipelineLike)

Parametry

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

Parametry

BlobClient(string, string, string, StoragePipelineOptions)

Parametry

Podrobnosti vlastnosti

accountName

Hodnota vlastnosti

containerName

Hodnota vlastnosti

credential

Hodnota vlastnosti

name

Hodnota vlastnosti

url

Hodnota vlastnosti

Podrobnosti metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametry

Návraty

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametry

Návraty

createSnapshot(BlobCreateSnapshotOptions)

Parametry

Návraty

delete(BlobDeleteOptions)

Parametry

Návraty

deleteIfExists(BlobDeleteOptions)

Parametry

Návraty

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parametry

Návraty

download(number, number, BlobDownloadOptions)

Parametry

Návraty

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametry

Návraty

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametry

Návraty

downloadToFile(string, number, number, BlobDownloadOptions)

Parametry

Návraty

exists(BlobExistsOptions)

Parametry

Návraty

generateSasUrl(BlobGenerateSasUrlOptions)

Parametry

Návraty

getAppendBlobClient()

Návraty

getBlobLeaseClient(string)

Parametry

Návraty

getBlockBlobClient()

Návraty

getPageBlobClient()

Návraty

getProperties(BlobGetPropertiesOptions)

Parametry

Návraty

getTags(BlobGetTagsOptions)

Parametry

Návraty

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Parametry

Návraty

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Parametry