PageBlobClient class

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 nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován 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 balíčku `@azure/identity` k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. 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í dlouhotrvající operaci poller, která umožňuje čekat na neomezenou dobu, dokud se kopie nedokončí. Kopii můžete také zrušit před dokončením voláním `cancelOperation` na poller. Všimněte si, že zpětné volání onProgress se nevyvolá, 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ších může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure. Od verze 2015-02-21 může být zdrojem operace kopírování objektů blob soubor Azure v jakémkoli účtu úložiště Azure. 7. června 2012 umožňují kopírování z jiného účtu úložiště pouze účty úložiště vytvořené po 7. červnu 2012.
clearPages(number, number, PageBlobClearPagesOptions)	Uvolní zadané stránky z objektu blob stránky.
create(number, PageBlobCreateOptions)	Vytvoří objekt blob stránky se zadanou délkou. Volání uploadPages pro nahrání dat do objektu blob stránky
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Vytvoří objekt blob stránky se zadanou délkou. Volání uploadPages pro nahrání dat 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Odstraňte zásadu immutablility v objektu blob.
download(number, number, BlobDownloadOptions)	Načte nebo stáhne objekt blob ze systému, včetně jeho metadat a vlastností. Můžete také volat Get Blob ke čtení snímku. V Node.jsvrátí data v čitelném streamu readableStreamBody. V prohlížečích se data vrátí do 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 k dispozici, stáhne celý objekt blob. Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. 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 k dispozici, stáhne celý objekt blob. Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. 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é, předání 0 a nedefinované, aby se stáhl celý objekt blob.
exists(BlobExistsOptions)	Vrátí hodnotu true, pokud prostředek objektu blob Azure reprezentovaný tímto klientem existuje. jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové objekty blob naopak přidány jinými klienty nebo aplikacemi.
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 služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.
getAppendBlobClient()	Vytvoří objekt AppendBlobClient.
getBlobLeaseClient(string)	Získejte <xref:BlobLeaseClient>, 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 tímto objektem blob stránky.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Získá kolekci rozsahů stránek, které se liší mezi zadaným snímkem a tímto objektem blob stránky pro spravované disky.
getProperties(BlobGetPropertiesOptions)	Vrátí všechna uživatelsky 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 podkladové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á na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku ETag objektu blob.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Nastaví systémové vlastnosti objektu blob. Pokud není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Nastavte zásady immutablility v objektu blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Nastavte blokování z právních důvodů objektu blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Nastaví uživatelsky definovaná metadata pro zadaný objekt blob jako jeden nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo v parametru nejsou definovaná žádná metadata, odeberou se metadata objektu blob.
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í mít délku 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0–9), mezeru (' '), plus (+'), minus (-'), tečku ('.'), lomítko ('/'), dvojtečku (':'), rovná se ('=') a podtržítko ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Zahájí operaci, která spustí přírůstkovou kopii ze snímku jednoho objektu blob stránky do tohoto objektu blob stránky. Snímek se zkopíruje tak, že se do cíle přenesou pouze rozdílové změny mezi dříve zkopírovaným snímkem. Zkopírované snímky jsou úplné kopie původního snímku a dají se číst nebo kopírovat jako obvykle.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Synchronní operace kopírování z adresy URL zkopíruje objekt blob nebo internetový prostředek do nového objektu blob. Dokud nebude kopie dokončena, odpověď se nevrátí.
undelete(BlobUndeleteOptions)	Obnoví obsah a metadata obnovitelně odstraněného objektu blob a všechny přidružené snímky obnovitelného odstranění. Odstranění objektu blob je podporováno pouze 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 1 nebo více stránek do objektu blob stránky. Počáteční a koncové posuny musí být násobkem 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 čte z adresy URL.
withSnapshot(string)	Vytvoří nový objekt PageBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Zadejte "" 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. Zadejte "" 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 metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.

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

Vytvoří instanci PageBlobClient. Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na objekt blob. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud název objektu blob obsahuje? nebo %, název objektu blob musí být kódován 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 balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

options: StoragePipelineOptions

Volitelný. 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 lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net – 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

Volitelný. 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 Přerušení kopírování objektu blob z adresy URL

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í dlouhotrvající operaci poller, která umožňuje čekat na neomezenou dobu, dokud se kopie nedokončí. Kopii můžete také zrušit před dokončením voláním cancelOperation na poller. Všimněte si, že zpětné volání onProgress se nevyvolá, 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ších může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure. Od verze 2015-02-21 může být zdrojem operace kopírování objektů blob soubor Azure v jakémkoli účtu úložiště Azure. 7. června 2012 umožňují kopírování z jiného účtu úložiště pouze účty úložiště vytvořené po 7. červnu 2012.

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í objektu blob z adresy URL.

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í umístění bajtů stránek, které chcete vymazat.

count: number

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

options: PageBlobClearPagesOptions

Možnosti operace Vymazat stránky objektu blob stránky

Návraty

Promise<PageBlobClearPagesResponse>

Data odpovědí pro operaci Vymazat stránky objektu blob stránky

create(number, PageBlobCreateOptions)

Vytvoří objekt blob stránky se zadanou délkou. Volání uploadPages pro nahrání dat 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ědi pro operaci Vytvoření objektu blob stránky

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Vytvoří objekt blob stránky se zadanou délkou. Volání uploadPages pro nahrání dat 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt 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. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně s operací Odstranit objekt 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ásadu immutablility v objektu blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametry

options: BlobDeleteImmutabilityPolicyOptions

Volitelné možnosti pro odstranění zásad neměnnosti v 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í. Můžete také volat Get Blob ke čtení snímku.

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

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

Parametry

offset: number

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

count: number

Kolik dat se má stáhnout, větší než 0 Po nedefinované verzi se stáhne na konec.

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 k dispozici, stáhne celý objekt blob.

Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. 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ž počet.

offset: number

Ze které pozice objektu blob bloku ke stažení (v bajtech)

count: number

Kolik dat (v bajtech) se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

options: BlobDownloadToBufferOptions

Možnosti 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 k dispozici, stáhne celý objekt blob.

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

Parametry

offset: number

Ze které pozice objektu blob bloku ke stažení (v bajtech)

count: number

Kolik dat (v bajtech) se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

options: BlobDownloadToBufferOptions

Možnosti 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é, předání 0 a nedefinované, aby se stáhl celý objekt 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. Při předání nedefinovaného souboru se stáhne na konec.

options: BlobDownloadOptions

Možnosti stahování objektů blob

Návraty

Promise<BlobDownloadResponseParsed>

Data odpovědi pro operaci stažení objektu blob, ale s parametrem readableStreamBody nastavenou na nedefinovanou, protože jeho 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. jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové objekty blob naopak přidány jinými klienty nebo aplikacemi.

function exists(options?: BlobExistsOptions)

Parametry

options: BlobExistsOptions

možnosti pro operaci 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 služby Blob Service (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient()

Návraty

AppendBlobClient

getBlobLeaseClient(string)

Získejte <xref:BlobLeaseClient>, 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í umístění bajtů rozsahů stránek

count: number

Počet bajtů, které se mají 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ů objektu blob stránky

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

Parametry

offset: number

Počáteční umístění bajtu objektu blob stránky

count: number

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

prevSnapshot: string

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

options: PageBlobGetPageRangesDiffOptions

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

Návraty

Promise<PageBlobGetPageRangesDiffResponse>

Data odpovědí pro operaci Rozdíl rozsahu stránek získání objektu blob stránky

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

Parametry

offset: number

Počáteční umístění bajtu objektu blob stránky

count: number

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

prevSnapshotUrl: string

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

options: PageBlobGetPageRangesDiffOptions

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

Návraty

Promise<PageBlobGetPageRangesDiffResponse>

Data odpovědí pro operaci Rozdíl rozsahu stránek získání objektu blob stránky

getProperties(BlobGetPropertiesOptions)

Vrátí všechna uživatelsky 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ískání vlastností

Návraty

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Získá značky přidružené k podkladové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á na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku 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 Archiv.

options: BlobSetTierOptions

Volitelné možnosti operace vrstvy sady objektů blob.

Návraty

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

Parametry

blobHTTPHeaders: BlobHTTPHeaders

Pokud není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou. Společná hlavička, která se má nastavit, je blobContentType umožňuje prohlížeči poskytovat funkce na základě typu souboru.

options: BlobSetHTTPHeadersOptions

Volitelné možnosti operace nastavení hlaviček HTTP

Návraty

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Nastavte zásady immutablility v objektu blob.

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í z právních důvodů objektu blob.

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

Parametry

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Návraty

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

Parametry

metadata: Metadata

Nahraďte stávající metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata se odeberou.

options: BlobSetMetadataOptions

Volitelné možnosti pro nastavení operace metadat.

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í mít délku 0 až 256 znaků. Platné znaky klíče a hodnoty značky zahrnují malá a velká písmena, číslice (0–9), mezeru (' '), plus (+'), minus (-'), 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>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Zahájí operaci, která spustí přírůstkovou kopii ze snímku jednoho objektu blob stránky do tohoto objektu blob stránky. Snímek se zkopíruje tak, že se do cíle přenesou pouze rozdílové změny mezi dříve zkopírovaným snímkem. Zkopírované snímky jsou úplné kopie původního snímku a dají se čí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. https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= <Například DateTime>

options: PageBlobStartCopyIncrementalOptions

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

Návraty

Promise<PageBlobCopyIncrementalResponse>

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

Parametry

copySource: string

Zdrojová adresa URL pro kopírování ze sdíleného přístupového podpisu (SAS) možná potřebuje k ověření.

options: BlobSyncCopyFromURLOptions

Návraty

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Obnoví obsah a metadata obnovitelně odstraněného objektu blob a všechny přidružené snímky obnovitelného odstranění. Odstranění objektu blob je podporováno pouze 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 má služba upravit pořadové číslo objektu blob.

sequenceNumber: number

Vyžaduje se, pokud je sequenceNumberAction maximální nebo aktualizační.

options: PageBlobUpdateSequenceNumberOptions

Možnosti operace pořadového čísla aktualizace objektu blob stránky

Návraty

Promise<PageBlobUpdateSequenceNumberResponse>

Data odpovědí pro operaci pořadového čísla aktualizace objektu blob stránky

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Zapíše 1 nebo více stránek do objektu blob stránky. Počáteční a koncové posuny musí být násobkem 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 těla, také počet bajtů, které se mají nahrát

options: PageBlobUploadPagesOptions

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

Návraty

Promise<PageBlobUploadPagesResponse>

Data odpovědí pro operaci Nahrání stránek 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 čte 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á potřebovali pro ověření.

sourceOffset: number

Posun zdroje ke kopírování. Předání 0 pro kopírování od začátku zdrojového objektu blob stránky

destOffset: number

Posun objektu blob cílové stránky

count: number

Počet bajtů, které se mají nahrát ze zdrojového objektu blob 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. Zadejte "" 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 shodný 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. Zadejte "" 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.

Váš názor

Byla tato stránka užitečná?

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