Sdílet prostřednictvím

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

containerName

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

Název objektu blob.

Zděděné vlastnosti

accountName
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.
url

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

Metody

clearPages(number, number, PageBlobClearPagesOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

Vytvoří objekt blob stránky se zadanou délkou. Volání uploadPages pro nahrání dat do objektu blob stránky

Viz https://learn.microsoft.com/rest/api/storageservices/put-blob
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.

Viz https://learn.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
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.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
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.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Vrátí asynchronní iterátor pro seznam rozsahů stránek objektu blob stránky.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() vrátí asynchronní iterátor pro seznam rozsahů stránek objektu blob stránky.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRanges();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Vrátí asynchronní iterátor pro seznam rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob této stránky.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() vrátí asynchronní iterátor pro seznam rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob stránky.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

const offset = 0;
const count = 1024;
const previousSnapshot = "<previous snapshot>";
// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot)) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot);
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
resize(number, PageBlobResizeOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
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.

Viz https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob Zobrazit https://learn.microsoft.com/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
uploadPages(RequestBodyType, 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.

Viz https://learn.microsoft.com/rest/api/storageservices/put-page
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.

Viz https://learn.microsoft.com/rest/api/storageservices/put-page-from-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.

Zděděné 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ší.

Viz https://learn.microsoft.com/rest/api/storageservices/abort-copy-blob
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.

Viz https://learn.microsoft.com/rest/api/storageservices/copy-blob

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

// Example using copy cancellation:
const cancelCopyPoller = await blobClient.beginCopyFromURL("url");
// cancel operation after starting it.
try {
  await cancelCopyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  cancelCopyPoller.getResult();
} catch (err: any) {
  if (err.name === "PollerCancelledError") {
    console.log("The copy was cancelled.");
  }
}
createSnapshot(BlobCreateSnapshotOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/snapshot-blob
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.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-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.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-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.

Viz https://learn.microsoft.com/rest/api/storageservices/get-blob
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 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 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.
generateSasStringToSign(BlobGenerateSasUrlOptions)

K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru 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.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
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.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru 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 vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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 vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)

Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28.

Viz https://learn.microsoft.com/rest/api/storageservices/get-account-information
getAppendBlobClient()

Vytvoří objekt AppendBlobClient.
getBlobLeaseClient(string)

Získejte BlobLeaseClient, který spravuje zapůjčení objektu blob.
getBlockBlobClient()

Vytvoří objekt BlockBlobClient.
getPageBlobClient()

Vytvoří objekt PageBlobClient.
getProperties(BlobGetPropertiesOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami ContainerClient, které vypisují objekty blob pomocí možnosti includeMetadata, což zachová původní velikost velikosti.
getTags(BlobGetTagsOptions)

Získá značky přidružené k podkladovému objektu blob.
setAccessTier(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.

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-tier
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.

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Nastavte zásadu neměnnosti 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.

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
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 ('_') .
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í.

Viz https://learn.microsoft.com/rest/api/storageservices/copy-blob-from-url
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ší.

Viz https://learn.microsoft.com/rest/api/storageservices/undelete-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 adresy URL 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". 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 ale název objektu blob obsahuje? nebo %, název objektu blob musí být kódován v adrese URL. Například objekt blob s názvem "my?blob%", adresa URL by měla býthttps://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

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

Ř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".

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

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

Optional. Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

containerName

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

string containerName

Hodnota vlastnosti

string

name

Název objektu blob.

string name

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

accountName 

accountName: string

Hodnota vlastnosti

string

Zděděno zBlobClient.accountName

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zděděno zBlobClient.credential

url

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

url: string

Hodnota vlastnosti

string

Zděděno zBlobClient.url

Podrobnosti metody

clearPages(number, number, PageBlobClearPagesOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/put-page

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

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

Viz https://learn.microsoft.com/rest/api/storageservices/put-blob

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

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.

Viz https://learn.microsoft.com/rest/api/storageservices/put-blob

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parametry

size

number

velikost objektu blob stránky.

options
PageBlobCreateIfNotExistsOptions

Návraty

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

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.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

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.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

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

listPageRanges(number, number, PageBlobListPageRangesOptions)

Vrátí asynchronní iterátor pro seznam rozsahů stránek objektu blob stránky.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() vrátí asynchronní iterátor pro seznam rozsahů stránek objektu blob stránky.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRanges();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parametry

offset

number

Počáteční umístění bajtů rozsahů stránek

count

number

Počet bajtů, které se mají získat

options
PageBlobListPageRangesOptions

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

Návraty

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Vrátí asynchronní iterátor pro seznam rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob této stránky.

Viz https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() vrátí asynchronní iterátor pro seznam rozsahů stránek, které se liší mezi zadaným snímkem a objektem blob stránky.

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const pageBlobClient = containerClient.getPageBlobClient(blobName);

const offset = 0;
const count = 1024;
const previousSnapshot = "<previous snapshot>";
// Example using `for await` syntax
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot)) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = pageBlobClient.listPageRangesDiff(offset, count, previousSnapshot);
let { value, done } = await iter.next();
while (!done) {
  console.log(`Page range ${i++}: ${value.start} - ${value.end}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 20 })) {
  for (const pageRange of page.pageRange || []) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient
  .listPageRangesDiff(offset, count, previousSnapshot)
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
if (response.pageRange) {
  for (const pageRange of response.pageRange) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parametry

offset

number

Počáteční umístění bajtů rozsahů stránek

count

number

Počet bajtů, které se mají získat

prevSnapshot

string

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

options
PageBlobListPageRangesDiffOptions

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

Návraty

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

resize(number, PageBlobResizeOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

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

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.

Viz https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob Zobrazit https://learn.microsoft.com/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

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

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

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(RequestBodyType, 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.

Viz https://learn.microsoft.com/rest/api/storageservices/put-page

function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

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.

Viz https://learn.microsoft.com/rest/api/storageservices/put-page-from-url

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

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): PageBlobClient

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.

Podrobnosti zděděných metod

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ší.

Viz https://learn.microsoft.com/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

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>

Zděděno zBlobClient.abortCopyFromURL

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.

Viz https://learn.microsoft.com/rest/api/storageservices/copy-blob

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Example using automatic polling
const automaticCopyPoller = await blobClient.beginCopyFromURL("url");
const automaticResult = await automaticCopyPoller.pollUntilDone();

// Example using manual polling
const manualCopyPoller = await blobClient.beginCopyFromURL("url");
while (!manualCopyPoller.isDone()) {
  await manualCopyPoller.poll();
}
const manualResult = manualCopyPoller.getResult();

// Example using progress updates
const progressUpdatesCopyPoller = await blobClient.beginCopyFromURL("url", {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  },
});
const progressUpdatesResult = await progressUpdatesCopyPoller.pollUntilDone();

// Example using a changing polling interval (default 15 seconds)
const pollingIntervalCopyPoller = await blobClient.beginCopyFromURL("url", {
  intervalInMs: 1000, // poll blob every 1 second for copy progress
});
const pollingIntervalResult = await pollingIntervalCopyPoller.pollUntilDone();

// Example using copy cancellation:
const cancelCopyPoller = await blobClient.beginCopyFromURL("url");
// cancel operation after starting it.
try {
  await cancelCopyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  cancelCopyPoller.getResult();
} catch (err: any) {
  if (err.name === "PollerCancelledError") {
    console.log("The copy was cancelled.");
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

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<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Zděděno zBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parametry

options
BlobCreateSnapshotOptions

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

Návraty

Promise<BlobCreateSnapshotResponse>

Zděděno zBlobClient.createSnapshot

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.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Parametry

options
BlobDeleteOptions

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

Návraty

Promise<BlobDeleteResponse>

Zděděno zBlobClient.delete

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.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parametry

options
BlobDeleteOptions

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

Návraty

Promise<BlobDeleteIfExistsResponse>

Zděděno zBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Odstraňte zásadu immutablility v objektu blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Parametry

options
BlobDeleteImmutabilityPolicyOptions

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

Návraty

Promise<BlobDeleteImmutabilityPolicyResponse>

Zděděno zBlobClient.deleteImmutabilityPolicy

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.

Viz https://learn.microsoft.com/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

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

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
const downloadBlockBlobResponse = await blobClient.download();
if (downloadBlockBlobResponse.readableStreamBody) {
  const downloaded = await streamToString(downloadBlockBlobResponse.readableStreamBody);
  console.log(`Downloaded blob content: ${downloaded}`);
}

async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
  const result = await new Promise<Buffer<ArrayBuffer>>((resolve, reject) => {
    const chunks: Buffer[] = [];
    stream.on("data", (data) => {
      chunks.push(Buffer.isBuffer(data) ? data : Buffer.from(data));
    });
    stream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    stream.on("error", reject);
  });
  return result.toString();
}

Příklad použití (prohlížeč):

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blobClient = containerClient.getBlobClient(blobName);

// Get blob content from position 0 to the end
// In browsers, get downloaded data by accessing downloadBlockBlobResponse.blobBody
const downloadBlockBlobResponse = await blobClient.download();
const blobBody = await downloadBlockBlobResponse.blobBody;
if (blobBody) {
  const downloaded = await blobBody.text();
  console.log(`Downloaded blob content: ${downloaded}`);
}

Návraty

Promise<BlobDownloadResponseParsed>

Zděděno zBlobClient.download

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

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

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

BlobDownloadToBufferOptions

Návraty

Promise<Buffer>

Zděděno zBlobClient.downloadToBuffer

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

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

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

BlobDownloadToBufferOptions

Návraty

Promise<Buffer>

Zděděno zBlobClient.downloadToBuffer

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): Promise<BlobDownloadResponseParsed>

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

Zděděno zBlobClient.downloadToFile

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): Promise<boolean>

Parametry

options
BlobExistsOptions

možnosti pro operaci Existuje.

Návraty

Promise<boolean>

Zděděno zBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru 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.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parametry

options
BlobGenerateSasUrlOptions

Volitelné parametry.

Návraty

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.

Zděděno zBlobClient.generateSasStringToSign

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.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

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.

Zděděno zBlobClient.generateSasUrl

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

K dispozici pouze pro objekt BlobClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru 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 vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametry

options
BlobGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey
UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

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.

Zděděno zBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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 vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametry

options
BlobGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey
UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

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.

Zděděno zBlobClient.generateUserDelegationSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

Operace Získat informace o účtu vrátí název skladové položky a druh účtu pro zadaný účet. Operace Získat informace o účtu je k dispozici ve verzích služby od verze 2018-03-28.

Viz https://learn.microsoft.com/rest/api/storageservices/get-account-information

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Parametry

options
BlobGetAccountInfoOptions

Možnosti operace Získání informací o účtu služby

Návraty

Promise<BlobGetAccountInfoResponse>

Data odpovědí pro operaci Získání informací o účtu služby

Zděděno zBlobClient.getAccountInfo

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Návraty

AppendBlobClient

Zděděno zBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Získejte BlobLeaseClient, který spravuje zapůjčení objektu blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

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.

Zděděno zBlobClient.getBlobLeaseClient

getBlockBlobClient()

Vytvoří objekt BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Návraty

BlockBlobClient

Zděděno zBlobClient.getBlockBlobClient

getPageBlobClient()

Vytvoří objekt PageBlobClient.

function getPageBlobClient(): PageBlobClient

Návraty

PageBlobClient

Zděděno zBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

Viz https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami ContainerClient, které vypisují objekty blob pomocí možnosti includeMetadata, což zachová původní velikost velikosti.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parametry

options
BlobGetPropertiesOptions

Volitelné možnosti operace Získání vlastností

Návraty

Promise<BlobGetPropertiesResponse>

Zděděno zBlobClient.getProperties

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Parametry

options
BlobGetTagsOptions

Návraty

Promise<BlobGetTagsResponse>

Zděděno zBlobClient.getTags

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

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parametry

tier

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>

Zděděno zBlobClient.setAccessTier

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.

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHttpHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

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>

Zděděno zBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Nastavte zásadu neměnnosti objektu blob.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Parametry

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

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

Návraty

Promise<BlobSetImmutabilityPolicyResponse>

Zděděno zBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parametry

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

Návraty

Promise<BlobSetLegalHoldResponse>

Zděděno zBlobClient.setLegalHold

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.

Viz https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

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>

Zděděno zBlobClient.setMetadata

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): Promise<BlobSetTagsResponse>

Parametry

tags
Tags
options
BlobSetTagsOptions

Návraty

Promise<BlobSetTagsResponse>

Zděděno zBlobClient.setTags

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

Viz https://learn.microsoft.com/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

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>

Zděděno zBlobClient.syncCopyFromURL

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ší.

Viz https://learn.microsoft.com/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parametry

options
BlobUndeleteOptions

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

Návraty

Promise<BlobUndeleteResponse>

Zděděno zBlobClient.undelete

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): BlobClient

Parametry

versionId

string

Hodnota versionId.

Návraty

BlobClient

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

Zděděno zBlobClient.withVersion