PageBlobClient class

Reference

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

PageBlobClient definuje sadu operací použitelných pro objekty blob stránky.

Extends: BlobClient

Konstruktory

PageBlobClient(string, PipelineLike)	Vytvoří instanci PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Vytvoří instanci PageBlobClient. 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.
PageBlobClient(string, string, string, StoragePipelineOptions)	Vytvoří instanci PageBlobClient.

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ěř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.
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.
clearPages(number, number, PageBlobClearPagesOptions)	Uvolní zadané stránky z objektu blob stránky.
create(number, PageBlobCreateOptions)	Vytvoří objekt blob stránky o zadané délce. Voláním uploadPages nahrajte datová data do objektu blob stránky.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Vytvoří objekt blob stránky o zadané délce. Voláním uploadPages nahrajte datová data do objektu blob stránky. Pokud objekt blob se stejným názvem již existuje, obsah existujícího objektu blob zůstane beze změny.
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.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Vrátí seznam platných rozsahů stránek pro objekt blob stránky nebo snímek objektu blob stránky.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Získá kolekci rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob této stránky.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Získá kolekci rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob této stránky pro spravované disky.
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.
resize(number, PageBlobResizeOptions)	Změní velikost objektu blob stránky na zadanou velikost (což musí být násobek 512).
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 ETag objektu blob.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Nastaví systémové vlastnosti objektu blob. Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány.
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 jeden 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 v podkladovém 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í být v rozsahu 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žítka ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Spustí operaci, která spustí přírůstkové kopírování ze snímku objektu blob jedné stránky do tohoto objektu blob stránky. Snímek se zkopíruje tak, aby se do cíle přenesly pouze rozdílové změny mezi dříve zkopírovaným snímkem. Zkopírované snímky jsou kompletní kopie původního snímku a je možné je číst nebo kopírovat jako obvykle.
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ého odstraněného objektu blob a všechny přidružené obnovitelné odstraněné snímky. Zrušení odstranění objektu blob se podporuje jenom ve verzi 2017-07-29 nebo novější.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Nastaví pořadové číslo objektu blob stránky.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Zapíše do objektu blob stránky 1 nebo více stránek. Počáteční a koncový posun musí být násobek 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Operace Nahrát stránky zapíše rozsah stránek do objektu blob stránky, kde se obsah načítá z adresy URL.
withSnapshot(string)	Vytvoří nový objekt PageBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Zadání odebere snímek a vrátí klienta do základního objektu blob.
withVersion(string)	Vytvoří nový objekt BlobClient odkazující na verzi tohoto objektu blob. Zadání "" odebere id verze a vrátí klienta do základního objektu blob.

Podrobnosti konstruktoru

PageBlobClient(string, PipelineLike)

Vytvoří instanci PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

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

pipeline: PipelineLike

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

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

Vytvoří instanci PageBlobClient. 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 PageBlobClient(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

PageBlobClient(string, string, string, StoragePipelineOptions)

Vytvoří instanci PageBlobClient.

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

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

clearPages(number, number, PageBlobClearPagesOptions)

Uvolní zadané stránky z objektu blob stránky.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Parametry

offset: number

Počáteční pozice bajtů stránek, které chcete vymazat.

count: number

Počet bajtů, které se mají vymazat.

options: PageBlobClearPagesOptions

Možnosti operace Vymazání stránek v objektu blob stránky

Návraty

Promise<PageBlobClearPagesResponse>

Data odpovědí pro operaci Vymazání stránek v objektu blob stránky.

create(number, PageBlobCreateOptions)

Vytvoří objekt blob stránky o zadané délce. Voláním uploadPages nahrajte datová data do objektu blob stránky.

function create(size: number, options?: PageBlobCreateOptions)

Parametry

size: number

velikost objektu blob stránky.

options: PageBlobCreateOptions

Možnosti operace Vytvoření objektu blob stránky

Návraty

Promise<PageBlobCreateResponse>

Data odpovědí pro operaci Vytvoření objektu blob stránky.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Vytvoří objekt blob stránky o zadané délce. Voláním uploadPages nahrajte datová data do objektu blob stránky. Pokud objekt blob se stejným názvem již existuje, obsah existujícího objektu blob zůstane beze změny.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Parametry

size: number

velikost objektu blob stránky.

options: PageBlobCreateIfNotExistsOptions

Návraty

Promise<PageBlobCreateIfNotExistsResponse>

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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Vrátí seznam platných rozsahů stránek pro objekt blob stránky nebo snímek objektu blob stránky.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Parametry

offset: number

Počáteční pozice bajtů rozsahů stránek.

count: number

Počet bajtů, které chcete získat.

options: PageBlobGetPageRangesOptions

Možnosti operace Získání rozsahů objektu blob stránky

Návraty

Promise<PageBlobGetPageRangesResponse>

Data odpovědí pro operaci Získání rozsahů objektů blob stránky.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Získá kolekci rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob této stránky.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Parametry

offset: number

Počáteční pozice bajtu objektu blob stránky

count: number

Počet bajtů pro získání rozsahů rozdílu

prevSnapshot: string

Časové razítko snímku pro načtení rozdílu

options: PageBlobGetPageRangesDiffOptions

Možnosti operace Rozdílu rozsahů stránek v objektu blob stránky

Návraty

Promise<PageBlobGetPageRangesDiffResponse>

Data odpovědí pro operaci Získání rozdílu rozsahu stránky v objektu blob stránky

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Získá kolekci rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob této stránky pro spravované disky.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Parametry

offset: number

Počáteční pozice bajtu objektu blob stránky

count: number

Počet bajtů pro získání rozsahů rozdílu

prevSnapshotUrl: string

Adresa URL snímku pro načtení rozdílu

options: PageBlobGetPageRangesDiffOptions

Možnosti operace Rozdílu rozsahů stránek v objektu blob stránky

Návraty

Promise<PageBlobGetPageRangesDiffResponse>

Data odpovědí pro operaci Získání rozdílu rozsahu stránky v objektu blob stránky

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>

resize(number, PageBlobResizeOptions)

Změní velikost objektu blob stránky na zadanou velikost (což musí být násobek 512).

function resize(size: number, options?: PageBlobResizeOptions)

Parametry

size: number

Cílová velikost

options: PageBlobResizeOptions

Možnosti operace Změna velikosti objektu blob stránky

Návraty

Promise<PageBlobResizeResponse>

Data odpovědí pro operaci Změna velikosti objektu blob stránky.

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 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 Vrstvy sady objektů blob

Návraty

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Nastaví systémové vlastnosti objektu blob. Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány.

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

Parametry

blobHTTPHeaders: BlobHTTPHeaders

Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány. Běžná hlavička, která se má nastavit, umožňuje blobContentType 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 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 nastavení blokování z právních důvodů pro objekt blob

Návraty

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jeden 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 není zadaná žádná hodnota, stávající metadata budou odebrána.

options: BlobSetMetadataOptions

Volitelné možnosti pro operaci Nastavit metadata

Návraty

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

Nastaví značky v podkladovém 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í být v rozsahu 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žítka ('_') .

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

Parametry

tags: Tags

options: BlobSetTagsOptions

Návraty

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Spustí operaci, která spustí přírůstkové kopírování ze snímku objektu blob jedné stránky do tohoto objektu blob stránky. Snímek se zkopíruje tak, aby se do cíle přenesly pouze rozdílové změny mezi dříve zkopírovaným snímkem. Zkopírované snímky jsou kompletní kopie původního snímku a je možné je číst nebo kopírovat jako obvykle.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Parametry

copySource: string

Určuje název snímku objektu blob zdrojové stránky. Například https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=.

options: PageBlobStartCopyIncrementalOptions

Možnosti přírůstkové operace kopírování objektů blob stránky

Návraty

Promise<PageBlobCopyIncrementalResponse>

Data odpovědí pro přírůstkovou operaci kopírování objektů blob stránky.

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ého odstraněného objektu blob a všechny přidružené obnovitelné odstraněné snímky. 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>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Nastaví pořadové číslo objektu blob stránky.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Parametry

sequenceNumberAction: SequenceNumberActionType

Určuje, jak by služba měla upravit pořadové číslo objektu blob.

sequenceNumber: number

Vyžaduje se, pokud je hodnota sequenceNumberAction maximální nebo update.

options: PageBlobUpdateSequenceNumberOptions

Možnosti operace Pořadové číslo aktualizace objektu blob stránky

Návraty

Promise<PageBlobUpdateSequenceNumberResponse>

Data odpovědí pro operaci Pořadové číslo aktualizace objektu blob stránky.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Zapíše do objektu blob stránky 1 nebo více stránek. Počáteční a koncový posun musí být násobek 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Parametry

body: HttpRequestBody

Data k nahrání

offset: number

Posun objektu blob cílové stránky

count: number

Délka obsahu textu, počet bajtů k nahrání

options: PageBlobUploadPagesOptions

Možnosti operace Nahrání stránek v objektu blob stránky

Návraty

Promise<PageBlobUploadPagesResponse>

Data odpovědí pro operaci Nahrání stránek v objektu blob stránky.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

Operace Nahrát stránky zapíše rozsah stránek do objektu blob stránky, kde se obsah načítá z adresy URL.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Parametry

sourceURL: string

Zadejte adresu URL ke zdroji kopírování. Sdílený přístupový podpis (SAS) možná bude potřeba pro ověřování.

sourceOffset: number

Odsazení zdroje, ze které se má kopírovat. Předání 0 ke zkopírování od začátku objektu blob zdrojové stránky

destOffset: number

Posun objektu blob cílové stránky

count: number

Počet bajtů, které se mají nahrát z objektu blob zdrojové stránky

options: PageBlobUploadPagesFromURLOptions

Návraty

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Vytvoří nový objekt PageBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Zadání odebere snímek a vrátí klienta do základního objektu blob.

function withSnapshot(snapshot: string)

Parametry

snapshot: string

Časové razítko snímku

Návraty

PageBlobClient

Nový objekt PageBlobClient 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. Zadání "" odebere id verze a vrátí klienta do základního objektu blob.

function withVersion(versionId: string)

Parametry

versionId: string

Id verze.

Návraty

BlobClient

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

Sdílet prostřednictvím

PageBlobClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

PageBlobClient(string, PipelineLike)

Parametry

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

Parametry

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

clearPages(number, number, PageBlobClearPagesOptions)

Parametry

Návraty

create(number, PageBlobCreateOptions)

Parametry

Návraty

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parametry