Sdílet prostřednictvím

PageBlobClient class

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

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

Extends
BlobClient

Konstruktory

PageBlobClient(string, PipelineLike)

Vytvoří instanci PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Vytvoří instanci PageBlobClient.

Vlastnosti

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 @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.
url

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

Metody

clearPages(number, number, PageBlobClearPagesOptions)

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

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

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

Viz https://docs.microsoft.com/rest/api/storageservices/put-blob.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

Viz https://docs.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://docs.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 objektem blob této stránky.

Viz https://docs.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 objektem blob této stránky pro spravované disky.

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

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

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

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

Příklad použití for await syntaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Příklad použití iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Příklad použití byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Příklad použití stránkování se značkou:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  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
for (const blob of response) {
  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 tímto objektem blob stránky.

Viz https://docs.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 této stránky.

Příklad použití for await syntaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Příklad použití iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Příklad použití byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Příklad použití stránkování se značkou:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  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://docs.microsoft.com/rest/api/storageservices/set-blob-properties.
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

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

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

Viz https://docs.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 načítá z adresy URL.

Viz https://docs.microsoft.com/en-us/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. Poskytnutím příkazu odeberete snímek a vrátíte 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://docs.microsoft.com/en-us/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í dlouho běžící operaci poller, která vám umožní čekat neomezeně dlouho, dokud se kopírování nedokončí. Můžete také zrušit kopii před jejím dokončením zavoláním cancelOperation na poller. Všimněte si, že zpětné volání onProgress nebude vyvoláno, pokud se operace dokončí v prvním požadavku, a pokus o zrušení dokončené kopie způsobí vyvolání chyby.

Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure. Počínaje verzí 2015-02-21 může být zdrojem operace Kopírování objektu blob soubor Azure v libovolném účtu úložiště Azure. Kopírování z jiného účtu úložiště umožňují pouze účty úložiště vytvořené 7. června 2012 nebo později.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob.

Příklad použití automatického dotazování:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Příklad použití ručního dotazování:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Příklad použití aktualizací průběhu:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Příklad použití změny intervalu dotazování (výchozí 15 sekund):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Příklad použití zrušení kopírování:

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

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

Viz https://docs.microsoft.com/en-us/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. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.

Viz https://docs.microsoft.com/en-us/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. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Odstraňte zásady neměnnosti objektu blob.
download(number, number, BlobDownloadOptions)

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

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

Viz https://docs.microsoft.com/en-us/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 zadané, stáhne se celý objekt blob.

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

K DISPOZICI POUZE V NODE.JS RUNTIME.

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

Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat pouze soubory o velikosti přibližně jednoho gigabajtu v 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost 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 pro stažení celého objektu blob volitelné, předání 0 a nedefinované.
exists(BlobExistsOptions)

Vrátí hodnotu true, pokud existuje prostředek objektu blob Azure reprezentovaný tímto klientem. jinak false.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Naopak nové objekty blob můžou po dokončení této funkce přidat jiní klienti nebo aplikace.
generateSasUrl(BlobGenerateSasUrlOptions)

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

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getAppendBlobClient()

Vytvoří objekt AppendBlobClient.
getBlobLeaseClient(string)

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

Vytvoří objekt BlockBlobClient.
getPageBlobClient()

Vytvoří objekt PageBlobClient.
getProperties(BlobGetPropertiesOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.

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

Získá značky přidružené k podkladovému objektu blob.
setAccessTier(string, BlobSetTierOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Nastaví systémové vlastnosti objektu blob.

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

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

Nastavte pro objekt blob zásady neměnnosti.
setLegalHold(boolean, BlobSetLegalHoldOptions)

Nastavte blokování objektu blob z právních důvodů.
setMetadata(Metadata, BlobSetMetadataOptions)

Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jednu nebo více dvojic název-hodnota.

Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata objektu blob se odeberou.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.
setTags(Tags, BlobSetTagsOptions)

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

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url.
undelete(BlobUndeleteOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.
withVersion(string)

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

Podrobnosti konstruktoru

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 nezakódovanou adresu URL odkazující na objekt blob. Zakódovaný řetězec adresy URL nebude uváděn dvakrát, pouze speciální znaky v cestě URL budou řídicím znakem. Pokud ale název objektu blob obsahuje ? nebo %, název objektu blob musí být zakódovaný v adrese URL. Například objekt blob s názvem my?blob%, adresa URL by měla být "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline
PipelineLike

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

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

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

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

Parametry

url

string

Ř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 @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
StoragePipelineOptions

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

PageBlobClient(string, string, string, StoragePipelineOptions)

Vytvoří instanci PageBlobClient.

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

Parametry

connectionString

string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka – Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Příklad připojovacího řetězce SAS – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Název kontejneru.

blobName

string

Název objektu blob.

options
StoragePipelineOptions

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

Podrobnosti vlastnosti

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 z objektuBlobClient.accountName

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zděděno z objektublobClient.credential

url

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

url: string

Hodnota vlastnosti

string

Zděděno zadresy BlobClient.url

Podrobnosti metody

clearPages(number, number, PageBlobClearPagesOptions)

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

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

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

Parametry

offset

number

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

count

number

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

options
PageBlobClearPagesOptions

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

Návraty

Promise<PageBlobClearPagesResponse>

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

create(number, PageBlobCreateOptions)

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

Viz https://docs.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ědí pro operaci Vytvoření objektu blob stránky.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

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

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

Parametry

offset

number

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

count

number

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

options
PageBlobGetPageRangesOptions

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

Návraty

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Viz https://docs.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í pozice bajtu objektu blob stránky

count

number

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

prevSnapshot

string

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

options
PageBlobGetPageRangesDiffOptions

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

Návraty

Promise<PageBlobGetPageRangesDiffResponse>

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

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Viz https://docs.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í pozice bajtu objektu blob stránky

count

number

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

prevSnapshotUrl

string

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

options
PageBlobGetPageRangesDiffOptions

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

Návraty

Promise<PageBlobGetPageRangesDiffResponse>

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

listPageRanges(number, number, PageBlobListPageRangesOptions)

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

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

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

Příklad použití for await syntaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Příklad použití iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Příklad použití byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Příklad použití stránkování se značkou:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  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
for (const blob of response) {
  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í pozice bajtů rozsahů stránek.

count

number

Počet bajtů, které chcete 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 tímto objektem blob stránky.

Viz https://docs.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 této stránky.

Příklad použití for await syntaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Příklad použití iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Příklad použití byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Příklad použití stránkování se značkou:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  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í pozice bajtů rozsahů stránek.

count

number

Počet bajtů, které chcete 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://docs.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 spuštění přírůstkové kopie ze snímku objektu blob jedné stránky do tohoto objektu blob stránky. Snímek se zkopíruje tak, aby se do cíle přenesly pouze rozdílové změny mezi dříve zkopírovaným snímkem. Zkopírované snímky jsou kompletní kopie původního snímku a je možné je číst nebo kopírovat jako obvykle.

Viz https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Viz https://docs.microsoft.com/en-us/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. Například https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=.

options
PageBlobStartCopyIncrementalOptions

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

Návraty

Promise<PageBlobCopyIncrementalResponse>

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

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.

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

Parametry

sequenceNumberAction
SequenceNumberActionType

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

sequenceNumber

number

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

options
PageBlobUpdateSequenceNumberOptions

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

Návraty

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

Viz https://docs.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 textu, počet bajtů k nahrání

options
PageBlobUploadPagesOptions

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

Návraty

Promise<PageBlobUploadPagesResponse>

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

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

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

Viz https://docs.microsoft.com/en-us/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á bude potřeba pro ověřování.

sourceOffset

number

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

destOffset

number

Posun objektu blob cílové stránky

count

number

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

options
PageBlobUploadPagesFromURLOptions

Návraty

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Vytvoří nový objekt PageBlobClient identický se zdrojem, ale se zadaným časovým razítkem snímku. Poskytnutím příkazu odeberete snímek a vrátíte 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 identický 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://docs.microsoft.com/en-us/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 Kopírování z adresy URL objektu blob

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í dlouho běžící operaci poller, která vám umožní čekat neomezeně dlouho, dokud se kopírování nedokončí. Můžete také zrušit kopii před jejím dokončením zavoláním cancelOperation na poller. Všimněte si, že zpětné volání onProgress nebude vyvoláno, pokud se operace dokončí v prvním požadavku, a pokus o zrušení dokončené kopie způsobí vyvolání chyby.

Ve verzi 2012-02-12 a novější může být zdrojem operace kopírování objektů blob potvrzený objekt blob v libovolném účtu úložiště Azure. Počínaje verzí 2015-02-21 může být zdrojem operace Kopírování objektu blob soubor Azure v libovolném účtu úložiště Azure. Kopírování z jiného účtu úložiště umožňují pouze účty úložiště vytvořené 7. června 2012 nebo později.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob.

Příklad použití automatického dotazování:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Příklad použití ručního dotazování:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Příklad použití aktualizací průběhu:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Příklad použití změny intervalu dotazování (výchozí 15 sekund):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Příklad použití zrušení kopírování:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  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í z adresy URL objektu blob

Návraty

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Zděděno zblobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

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

Viz https://docs.microsoft.com/en-us/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 zobjektu BlobClient.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. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.

Viz https://docs.microsoft.com/en-us/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. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně pomocí operace Odstranění objektu blob.

Viz https://docs.microsoft.com/en-us/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 zobjektu BlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

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

Parametry

options
BlobDeleteImmutabilityPolicyOptions

Volitelné možnosti pro odstranění zásad neměnnosti 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í. Pokud chcete přečíst snímek, můžete také volat get blob.

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob.

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

Parametry

offset

number

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

count

number

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

options
BlobDownloadOptions

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

Příklad použití (Node.js):

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

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

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

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

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

Návraty

Promise<BlobDownloadResponseParsed>

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 zadané, stáhne se celý objekt blob.

Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat soubory do maximálně jednoho gigabajtu na 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost 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ž je počet

offset

number

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

count

number

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

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 zadané, stáhne se celý objekt blob.

Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat pouze soubory o velikosti přibližně jednoho gigabajtu v 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. V případě objektů blob větších, než je tato velikost, zvažte možnost downloadToFile.

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

Parametry

offset

number

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

count

number

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

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 pro stažení celého objektu blob volitelné, předání 0 a nedefinované.

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 až do konce.

options
BlobDownloadOptions

Možnosti stažení objektů blob.

Návraty

Promise<BlobDownloadResponseParsed>

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

Zděděno ze souboruBlobClient.downloadToFile

exists(BlobExistsOptions)

Vrátí hodnotu true, pokud existuje prostředek objektu blob Azure reprezentovaný tímto klientem. jinak false.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující objekt blob může být odstraněn jinými klienty nebo aplikacemi. Naopak nové objekty blob můžou po dokončení této funkce přidat jiní klienti nebo aplikace.

function exists(options?: BlobExistsOptions): Promise<boolean>

Parametry

options
BlobExistsOptions

možnosti operace Existuje.

Návraty

Promise<boolean>

Zděděno zobjektu BlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

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

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

Viz https://docs.microsoft.com/en-us/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 sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následného vygenerovaného tokenu SAS.

Zděděno zobjektu BlobClient.generateSasUrl

getAppendBlobClient()

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Návraty

AppendBlobClient

Zděděno zblobClient.getAppendBlobClient

getBlobLeaseClient(string)

Získejte objekt 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 zobjektu blobClient.getBlobLeaseClient

getBlockBlobClient()

Vytvoří objekt BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Návraty

BlockBlobClient

Zděděno zobjektu blobClient.getBlockBlobClient

getPageBlobClient()

Vytvoří objekt PageBlobClient.

function getPageBlobClient(): PageBlobClient

Návraty

PageBlobClient

Zděděno zblobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.

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

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

Parametry

options
BlobGetPropertiesOptions

Volitelné možnosti operace Získat vlastnosti.

Návraty

Promise<BlobGetPropertiesResponse>

Zděděno zobjektu blobClient.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á pro objekt blob stránky v účtu úložiště úrovně Premium a pro objekt blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň premium objektu blob stránky určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje značky ETag objektu blob.

Viz https://docs.microsoft.com/en-us/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 Archivní.

options
BlobSetTierOptions

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

Návraty

Promise<BlobSetTierResponse>

Zděděno zobjektu BlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Nastaví systémové vlastnosti objektu blob.

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.

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

Parametry

blobHTTPHeaders
BlobHTTPHeaders

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

options
BlobSetHTTPHeadersOptions

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

Návraty

Promise<BlobSetHTTPHeadersResponse>

Zděděno zobjektu BlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Nastavte pro objekt blob zásady neměnnosti.

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

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

Parametry

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

Návraty

Promise<BlobSetLegalHoldResponse>

Zděděno zobjektu BlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Nastaví uživatelem definovaná metadata pro zadaný objekt blob jako jednu nebo více dvojic název-hodnota.

Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata objektu blob se odeberou.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.

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

Parametry

metadata
Metadata

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

options
BlobSetMetadataOptions

Volitelné možnosti pro operaci Nastavit metadata.

Návraty

Promise<BlobSetMetadataResponse>

Zděděno zobjektu BlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parametry

tags
Tags
options
BlobSetTagsOptions

Návraty

Promise<BlobSetTagsResponse>

Zděděno zobjektu BlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url.

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

Parametry

copySource

string

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

options
BlobSyncCopyFromURLOptions

Návraty

Promise<BlobCopyFromURLResponse>

Zděděno zblobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

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

Viz https://docs.microsoft.com/en-us/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 zobjektu blobClient.undelete

withVersion(string)

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

function withVersion(versionId: string): BlobClient

Parametry

versionId

string

VersionId.

Návraty

BlobClient

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

Zděděno zobjektu BlobClient.withVersion