BlobClient class

Vytvoří instanci BlobClient. 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 BlobClient(url: string, pipeline: PipelineLike)

Parametry

Vytvoří instanci BlobClient. 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 BlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametry

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

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

Parametry

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

string containerName

Hodnota vlastnosti

Název objektu blob.

string name

Hodnota vlastnosti

accountName: string

Hodnota vlastnosti

zděděno ze StorageClient.accountName

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

zděděné z StorageClient.credential

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

url: string

Hodnota vlastnosti

zděděno ze StorageClient.url

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

Návraty

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://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ěně 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

Návraty

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

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parametry

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parametry

Návraty

Odstraňte zásadu immutablility v objektu blob.

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

Parametry

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

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

Parametry

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

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

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

Návraty

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

Návraty

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

Návraty

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

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

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parametry

Návraty

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.

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://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

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

Parametry

Návraty

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

Vytvoří objekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Návraty

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametry

Návraty

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

Vytvoří objekt BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Návraty

Vytvoří objekt PageBlobClient.

function getPageBlobClient(): PageBlobClient

Návraty

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

Návraty

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

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

Parametry

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

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

Parametry

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

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

Parametry

Návraty

Nastavte zásadu neměnnosti objektu blob.

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

Parametry

Návraty

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

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

Parametry

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

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

Parametry

Návraty

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

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

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

Parametry

Návraty

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://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

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

Parametry

Návraty

Vytvoří nový objekt BlobClient shodný 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): BlobClient

Parametry

Návraty

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

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

Návraty

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