PageBlobClient class

Odwołanie

Pakiet:: @azure/storage-blob

PageBlobClient definiuje zestaw operacji mających zastosowanie do stronicowych obiektów blob.

Extends: BlobClient

Konstruktory

PageBlobClient(string, PipelineLike)	Tworzy wystąpienie elementu PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Tworzy wystąpienie elementu PageBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący obiekt blob. Zakodowany ciąg adresu URL nie zostanie uniknięci dwa razy, tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. Jeśli nazwa obiektu blob zawiera ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL.
PageBlobClient(string, string, string, StoragePipelineOptions)	Tworzy wystąpienie elementu PageBlobClient.

Właściwości

accountName
containerName	Nazwa kontenera magazynu, z który jest skojarzony obiekt blob.
credential	Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w `@azure/identity` celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.
name	Nazwa obiektu blob.
url	Zakodowana wartość ciągu adresu URL.

Metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Przerywa oczekującą asynchroniczną operację kopiowania obiektu blob i pozostawia docelowy obiekt blob o zerowej długości i pełnych metadanych. Wersja 2012-02-12 i nowsza.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Asynchronicznie kopiuje obiekt blob do miejsca docelowego na koncie magazynu. Ta metoda zwraca długotrwałą operację poller, która umożliwia oczekiwanie na czas nieokreślony do momentu ukończenia kopiowania. Możesz również anulować kopię przed jej ukończeniem, wywołując `cancelOperation` narzędzie poller. Należy pamiętać, że wywołanie zwrotne onProgress nie zostanie wywołane, jeśli operacja zakończy się w pierwszym żądaniu, a próba anulowania ukończonej kopii spowoduje zgłoszenie błędu. W wersji 2012-02-12 lub nowszej źródło operacji kopiowania obiektu blob może być zatwierdzonym obiektem blob na dowolnym koncie usługi Azure Storage. Począwszy od wersji 2015-02-21, źródło operacji kopiowania obiektów blob może być plikiem platformy Azure na dowolnym koncie usługi Azure Storage. Tylko konta magazynu utworzone w dniu 7 czerwca 2012 r. zezwalają na kopiowanie kopii obiektów blob z innego konta magazynu lub po tym, jak 7 czerwca 2012 r.
clearPages(number, number, PageBlobClearPagesOptions)	Zwalnia określone strony ze stronicowego obiektu blob.
create(number, PageBlobCreateOptions)	Tworzy stronicowy obiekt blob o określonej długości. Wywołaj metodę uploadPages, aby przekazać dane danych do stronicowego obiektu blob.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Tworzy stronicowy obiekt blob o określonej długości. Wywołaj metodę uploadPages, aby przekazać dane danych do stronicowego obiektu blob. Jeśli obiekt blob o tej samej nazwie już istnieje, zawartość istniejącego obiektu blob pozostanie niezmieniona.
createSnapshot(BlobCreateSnapshotOptions)	Tworzy migawkę obiektu blob tylko do odczytu.
delete(BlobDeleteOptions)	Oznacza określony obiekt blob lub migawkę do usunięcia. Obiekt blob zostanie później usunięty podczas odzyskiwania pamięci. Należy pamiętać, że aby usunąć obiekt blob, musisz usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob.
deleteIfExists(BlobDeleteOptions)	Oznacza określony obiekt blob lub migawkę do usunięcia, jeśli istnieje. Obiekt blob zostanie później usunięty podczas odzyskiwania pamięci. Należy pamiętać, że aby usunąć obiekt blob, musisz usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Usuń zasady niezmienności w obiekcie blob.
download(number, number, BlobDownloadOptions)	Odczytuje lub pobiera obiekt blob z systemu, w tym jego metadane i właściwości. Możesz również wywołać polecenie Pobierz obiekt blob, aby odczytać migawkę. W Node.js dane są zwracane w czytelnym strumieniu ReadableStreamBody W przeglądarkach dane są zwracane w obiekcie blobBody obietnicy
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera obiekt blob platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, pobiera cały obiekt blob, jeśli nie zostały podane. Ostrzeżenie: Bufory mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku obiektów blob większych niż ten rozmiar należy wziąć pod uwagę <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera obiekt blob platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, pobiera cały obiekt blob, jeśli nie zostały podane. Ostrzeżenie: Bufory mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku obiektów blob większych niż ten rozmiar należy wziąć pod uwagę <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera obiekt blob platformy Azure do pliku lokalnego. Nie powiedzie się, jeśli dana ścieżka pliku zostanie już zakończona. Przesunięcie i liczba są opcjonalne, przekaż odpowiednio 0 i niezdefiniowane, aby pobrać cały obiekt blob.
exists(BlobExistsOptions)	Zwraca wartość true, jeśli istnieje zasób obiektu blob platformy Azure reprezentowany przez tego klienta; false w przeciwnym razie. UWAGA: użyj tej funkcji z opieką, ponieważ istniejący obiekt blob może zostać usunięty przez innych klientów lub aplikacji. Na odwrót nowe obiekty blob mogą zostać dodane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
generateSasUrl(BlobGenerateSasUrlOptions)	Jest dostępny tylko dla obiektu BlobClient skonstruowanego przy użyciu poświadczeń klucza współdzielonego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi Blob Service na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.
getAppendBlobClient()	Tworzy obiekt AppendBlobClient.
getBlobLeaseClient(string)	Pobierz obiekt <xref:BlobLeaseClient> blob, który zarządza dzierżawami obiektu blob.
getBlockBlobClient()	Tworzy obiekt BlockBlobClient.
getPageBlobClient()	Tworzy obiekt PageBlobClient.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Pobiera kolekcję zakresów stron, które różnią się między określoną migawką a tym stronicowym obiektem blob.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Pobiera kolekcję zakresów stron, które różnią się między określoną migawką a tym stronicowym obiektem blob dla dysków zarządzanych.
getProperties(BlobGetPropertiesOptions)	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob.
getTags(BlobGetTagsOptions)	Pobiera tagi skojarzone z bazowym obiektem blob.
resize(number, PageBlobResizeOptions)	Zmienia rozmiar stronicowego obiektu blob na określony rozmiar (który musi mieć wielokrotność 512).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Ustawia warstwę obiektu blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie usługi Premium Storage i na blokowym obiekcie blob na koncie magazynu obiektów blob (tylko magazyn lokalnie nadmiarowy). Warstwa stronicowego obiektu blob w warstwie Premium określa dozwolony rozmiar, liczbę operacji we/wy na sekundę i przepustowość obiektu blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Ustawia właściwości systemowe obiektu blob. Jeśli nie podano żadnej wartości lub nie podano żadnej wartości dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Ustaw zasady niezmienności w obiekcie blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Ustaw blokadę prawną obiektu blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Ustawia metadane zdefiniowane przez użytkownika dla określonego obiektu blob jako jedną lub więcej par name-value. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane obiektu blob zostaną usunięte.
setTags(Tags, BlobSetTagsOptions)	Ustawia tagi w bazowym obiekcie blob. Obiekt blob może mieć maksymalnie 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków. Wartości tagów muszą zawierać od 0 do 256 znaków. Prawidłowe znaki klucza tagu i wartości obejmują małe i wielkie litery, cyfry (0–9), spację (' '), plus ('+'), minus ('-'), kropkę ('.'), ukośnik ('/'), dwukropek (':'), równe ('=') i podkreślenie ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Rozpoczyna operację uruchamiania przyrostowej kopii z migawki jednego stronicowego obiektu blob do tego stronicowego obiektu blob. Migawka jest kopiowana tak, że tylko różnicowe zmiany między wcześniej skopiowaną migawką są przenoszone do miejsca docelowego. Skopiowane migawki są pełne kopie oryginalnej migawki i mogą być odczytywane lub kopiowane z jak zwykle.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Synchroniczna operacja kopiowania z adresu URL kopiuje obiekt blob lub zasób internetowy do nowego obiektu blob. Nie zwróci odpowiedzi, dopóki kopia nie zostanie ukończona.
undelete(BlobUndeleteOptions)	Przywraca zawartość i metadane nietrwałego usuniętego obiektu blob oraz wszystkie skojarzone nietrwale usunięte migawki. Cofanie obiektu blob jest obsługiwane tylko w wersji 2017-07-29 lub nowszej.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Ustawia numer sekwencji stronicowego obiektu blob.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Zapisuje 1 lub więcej stron w stronicowym obiekcie blob. Przesunięcia początkowe i końcowe muszą mieć wielokrotność 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Operacja Przekazywania stron zapisuje zakres stron do stronicowego obiektu blob, w którym zawartość jest odczytywana z adresu URL.
withSnapshot(string)	Tworzy nowy obiekt PageBlobClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie klienta do podstawowego obiektu blob.
withVersion(string)	Tworzy nowy obiekt BlobClient wskazujący wersję tego obiektu blob. Podaj wartość "" spowoduje usunięcie identyfikatora versionId i zwrócenie klienta do podstawowego obiektu blob.

Szczegóły konstruktora

PageBlobClient(string, PipelineLike)

Tworzy wystąpienie elementu PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

Ciąg klienta wskazujący obiekt blob stronicowy usługi Azure Storage, taki jak "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz funkcji AnonymousCredential, na przykład "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"".

pipeline: PipelineLike

Wywołaj metodę newPipeline() w celu utworzenia potoku domyślnego lub podaj dostosowany potok.

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

Tworzy wystąpienie elementu PageBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący obiekt blob. Zakodowany ciąg adresu URL nie zostanie uniknięci dwa razy, tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. Jeśli nazwa obiektu blob zawiera ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL.

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z @azure/identity pakietu w celu uwierzytelnienia żądań do usługi. Można również podać obiekt implementujący interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options: StoragePipelineOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

PageBlobClient(string, string, string, StoragePipelineOptions)

Tworzy wystąpienie elementu PageBlobClient.

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

Parametry

connectionString: string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Nazwa kontenera.

blobName: string

Nazwa obiektu blob.

options: StoragePipelineOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

accountName

accountName: string

Wartość właściwości

string

containerName

Nazwa kontenera magazynu, z który jest skojarzony obiekt blob.

string containerName

Wartość właściwości

string

credential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wartość właściwości

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

Nazwa obiektu blob.

string name

Wartość właściwości

string

url

Zakodowana wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Szczegóły metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Przerywa oczekującą asynchroniczną operację kopiowania obiektu blob i pozostawia docelowy obiekt blob o zerowej długości i pełnych metadanych. Wersja 2012-02-12 i nowsza.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Parametry

copyId: string

Identyfikator operacji Kopiuj z adresu URL.

options: BlobAbortCopyFromURLOptions

Opcjonalne opcje operacji Przerwanie kopiowania obiektu blob z adresu URL.

Zwraca

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Asynchronicznie kopiuje obiekt blob do miejsca docelowego na koncie magazynu. Ta metoda zwraca długotrwałą operację poller, która umożliwia oczekiwanie na czas nieokreślony do momentu ukończenia kopiowania. Możesz również anulować kopię przed jej ukończeniem, wywołując cancelOperation narzędzie poller. Należy pamiętać, że wywołanie zwrotne onProgress nie zostanie wywołane, jeśli operacja zakończy się w pierwszym żądaniu, a próba anulowania ukończonej kopii spowoduje zgłoszenie błędu. W wersji 2012-02-12 lub nowszej źródło operacji kopiowania obiektu blob może być zatwierdzonym obiektem blob na dowolnym koncie usługi Azure Storage. Począwszy od wersji 2015-02-21, źródło operacji kopiowania obiektów blob może być plikiem platformy Azure na dowolnym koncie usługi Azure Storage. Tylko konta magazynu utworzone w dniu 7 czerwca 2012 r. zezwalają na kopiowanie kopii obiektów blob z innego konta magazynu lub po tym, jak 7 czerwca 2012 r.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

Parametry

copySource: string

adres URL źródłowego obiektu blob/pliku platformy Azure.

options: BlobBeginCopyFromURLOptions

Opcjonalne opcje operacji Uruchamiania kopiowania z adresu URL obiektu blob.

Zwraca

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages(number, number, PageBlobClearPagesOptions)

Zwalnia określone strony ze stronicowego obiektu blob.

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

Parametry

offset: number

Rozpoczynanie położenia bajtów stron w celu wyczyszczenia.

count: number

Liczba bajtów do wyczyszczenia.

options: PageBlobClearPagesOptions

Opcje operacji Stronicowy obiekt blob Clear Pages.

Zwraca

Promise<PageBlobClearPagesResponse>

Dane odpowiedzi dla operacji stronicowego obiektu blob Clear Pages.

create(number, PageBlobCreateOptions)

Tworzy stronicowy obiekt blob o określonej długości. Wywołaj metodę uploadPages, aby przekazać dane danych do stronicowego obiektu blob.

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

Parametry

size: number

rozmiar stronicowego obiektu blob.

options: PageBlobCreateOptions

Opcje operacji tworzenia stronicowego obiektu blob.

Zwraca

Promise<PageBlobCreateResponse>

Dane odpowiedzi dla operacji tworzenia stronicowego obiektu blob.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Tworzy stronicowy obiekt blob o określonej długości. Wywołaj metodę uploadPages, aby przekazać dane danych do stronicowego obiektu blob. Jeśli obiekt blob o tej samej nazwie już istnieje, zawartość istniejącego obiektu blob pozostanie niezmieniona.

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

Parametry

size: number

rozmiar stronicowego obiektu blob.

options: PageBlobCreateIfNotExistsOptions

Zwraca

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Tworzy migawkę obiektu blob tylko do odczytu.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametry

options: BlobCreateSnapshotOptions

Opcjonalne opcje operacji tworzenia migawki obiektu blob.

Zwraca

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Oznacza określony obiekt blob lub migawkę do usunięcia. Obiekt blob zostanie później usunięty podczas odzyskiwania pamięci. Należy pamiętać, że aby usunąć obiekt blob, musisz usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob.

function delete(options?: BlobDeleteOptions)

Parametry

options: BlobDeleteOptions

Opcjonalne opcje operacji usuwania obiektów blob.

Zwraca

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Oznacza określony obiekt blob lub migawkę do usunięcia, jeśli istnieje. Obiekt blob zostanie później usunięty podczas odzyskiwania pamięci. Należy pamiętać, że aby usunąć obiekt blob, musisz usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob.

function deleteIfExists(options?: BlobDeleteOptions)

Parametry

options: BlobDeleteOptions

Opcjonalne opcje operacji usuwania obiektów blob.

Zwraca

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Usuń zasady niezmienności w obiekcie blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametry

options: BlobDeleteImmutabilityPolicyOptions

Opcjonalne opcje usuwania zasad niezmienności w obiekcie blob.

Zwraca

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

Odczytuje lub pobiera obiekt blob z systemu, w tym jego metadane i właściwości. Możesz również wywołać polecenie Pobierz obiekt blob, aby odczytać migawkę.

W Node.js dane są zwracane w czytelnym strumieniu ReadableStreamBody
W przeglądarkach dane są zwracane w obiekcie blobBody obietnicy

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

Parametry

offset: number

Z której pozycji obiektu blob do pobrania, większe lub równe 0

count: number

Ile danych należy pobrać, więcej niż 0. Spowoduje to pobranie do końca, gdy niezdefiniowane

options: BlobDownloadOptions

Opcjonalne opcje operacji pobierania obiektów blob.

Przykładowe użycie (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);
});
}

Przykładowe użycie (przeglądarka):

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

Zwraca

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera obiekt blob platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, pobiera cały obiekt blob, jeśli nie zostały podane.

Ostrzeżenie: Bufory mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku obiektów blob większych niż ten rozmiar należy wziąć pod uwagę <xref:downloadToFile>.

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

Parametry

buffer: Buffer

Bufor do wypełnienia, musi mieć długość większą niż liczba

offset: number

Z której pozycji blokowego obiektu blob do pobrania (w bajtach)

count: number

Ile danych (w bajtach) ma zostać pobranych. Pobierze na koniec po przekazaniu niezdefiniowanego

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Zwraca

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Parametry

offset: number

Z której pozycji blokowego obiektu blob do pobrania (w bajtach)

count: number

Ile danych (w bajtach) ma zostać pobranych. Pobierze na koniec po przekazaniu niezdefiniowanego

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Zwraca

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera obiekt blob platformy Azure do pliku lokalnego. Nie powiedzie się, jeśli dana ścieżka pliku zostanie już zakończona. Przesunięcie i liczba są opcjonalne, przekaż odpowiednio 0 i niezdefiniowane, aby pobrać cały obiekt blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Parametry

filePath: string

offset: number

Z której pozycji blokowego obiektu blob do pobrania.

count: number

Ile danych należy pobrać. Zostanie pobrany na koniec po przekazaniu niezdefiniowanego.

options: BlobDownloadOptions

Opcje pobierania obiektów blob.

Zwraca

Promise<BlobDownloadResponseParsed>

Dane odpowiedzi dla operacji pobierania obiektów blob, ale z funkcją readableStreamBody ustawioną na niezdefiniowaną, ponieważ jego zawartość jest już odczytywana i zapisywana w pliku lokalnym w określonej ścieżce.

exists(BlobExistsOptions)

Zwraca wartość true, jeśli istnieje zasób obiektu blob platformy Azure reprezentowany przez tego klienta; false w przeciwnym razie. UWAGA: użyj tej funkcji z opieką, ponieważ istniejący obiekt blob może zostać usunięty przez innych klientów lub aplikacji. Na odwrót nowe obiekty blob mogą zostać dodane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

function exists(options?: BlobExistsOptions)

Parametry

options: BlobExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Jest dostępny tylko dla obiektu BlobClient skonstruowanego przy użyciu poświadczeń klucza współdzielonego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi Blob Service na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parametry

options: BlobGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getAppendBlobClient()

Tworzy obiekt AppendBlobClient.

function getAppendBlobClient()

Zwraca

AppendBlobClient

getBlobLeaseClient(string)

Pobierz obiekt <xref:BlobLeaseClient> blob, który zarządza dzierżawami obiektu blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametry

proposeLeaseId: string

Początkowy proponowany identyfikator dzierżawy.

Zwraca

BlobLeaseClient

Nowy obiekt BlobLeaseClient do zarządzania dzierżawami w obiekcie blob.

getBlockBlobClient()

Tworzy obiekt BlockBlobClient.

function getBlockBlobClient()

Zwraca

BlockBlobClient

getPageBlobClient()

Tworzy obiekt PageBlobClient.

function getPageBlobClient()

Zwraca

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Zwraca listę prawidłowych zakresów stron dla stronicowego obiektu blob lub migawki stronicowego obiektu blob.

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

Parametry

offset: number

Pozycja bajtów początkowych zakresów stron.

count: number

Liczba bajtów do pobrania.

options: PageBlobGetPageRangesOptions

Opcje operacji Pobierania zakresów stronicowego obiektu blob.

Zwraca

Promise<PageBlobGetPageRangesResponse>

Dane odpowiedzi dla operacji Pobierania zakresów stronicowych obiektów blob.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Pobiera kolekcję zakresów stron, które różnią się między określoną migawką a tym stronicowym obiektem blob.

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

Parametry

offset: number

Pozycja bajtów początkowych stronicowego obiektu blob

count: number

Liczba bajtów, aby uzyskać różnice zakresów.

prevSnapshot: string

Sygnatura czasowa migawki w celu pobrania różnicy.

options: PageBlobGetPageRangesDiffOptions

Opcje operacji różnicowania stron dla stronicowego obiektu blob Pobierz zakresy stron.

Zwraca

Promise<PageBlobGetPageRangesDiffResponse>

Dane odpowiedzi dotyczące operacji różnicowania zakresu stron dla stronicowego obiektu blob.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Pobiera kolekcję zakresów stron, które różnią się między określoną migawką a tym stronicowym obiektem blob dla dysków zarządzanych.

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

Parametry

offset: number

Pozycja bajtów początkowych stronicowego obiektu blob

count: number

Liczba bajtów, aby uzyskać różnice zakresów.

prevSnapshotUrl: string

Adres URL migawki, aby pobrać różnicę.

options: PageBlobGetPageRangesDiffOptions

Opcje operacji różnicowania stron dla stronicowego obiektu blob Pobierz zakresy stron.

Zwraca

Promise<PageBlobGetPageRangesDiffResponse>

Dane odpowiedzi dotyczące operacji różnicowania zakresu stron dla stronicowego obiektu blob.

getProperties(BlobGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parametry

options: BlobGetPropertiesOptions

Opcjonalne opcje operacji Pobierz właściwości.

Zwraca

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Pobiera tagi skojarzone z bazowym obiektem blob.

function getTags(options?: BlobGetTagsOptions)

Parametry

options: BlobGetTagsOptions

Zwraca

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

Zmienia rozmiar stronicowego obiektu blob na określony rozmiar (który musi mieć wielokrotność 512).

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

Parametry

size: number

Rozmiar docelowy

options: PageBlobResizeOptions

Opcje operacji zmiany rozmiaru stronicowego obiektu blob.

Zwraca

Promise<PageBlobResizeResponse>

Dane odpowiedzi dla operacji zmiany rozmiaru stronicowego obiektu blob.

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Ustawia warstwę obiektu blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie usługi Premium Storage i na blokowym obiekcie blob na koncie magazynu obiektów blob (tylko magazyn lokalnie nadmiarowy). Warstwa stronicowego obiektu blob w warstwie Premium określa dozwolony rozmiar, liczbę operacji we/wy na sekundę i przepustowość obiektu blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Parametry

tier: BlockBlobTier | PremiumPageBlobTier | string

Warstwa, która ma zostać ustawiona na obiekcie blob. Prawidłowe wartości to Gorąca, Chłodna lub Archiwum.

options: BlobSetTierOptions

Opcjonalne opcje operacji Set Tier zestawu obiektów blob.

Zwraca

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Ustawia właściwości systemowe obiektu blob. Jeśli nie podano żadnej wartości lub nie podano żadnej wartości dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone.

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

Parametry

blobHTTPHeaders: BlobHTTPHeaders

Jeśli nie podano żadnej wartości lub nie podano żadnej wartości dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone. Typowy nagłówek do ustawienia umożliwia blobContentType przeglądarce zapewnienie funkcjonalności na podstawie typu pliku.

options: BlobSetHTTPHeadersOptions

Opcjonalne opcje operacji Ustawianie nagłówków HTTP dla obiektu blob.

Zwraca

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Ustaw zasady niezmienności w obiekcie blob.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

Parametry

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Opcjonalne opcje ustawiania zasad niezmienności w obiekcie blob.

Zwraca

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Ustaw blokadę prawną obiektu blob.

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

Parametry

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Opcjonalne opcje ustawiania blokady prawnej obiektu blob.

Zwraca

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Ustawia metadane zdefiniowane przez użytkownika dla określonego obiektu blob jako jedną lub więcej par name-value. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane obiektu blob zostaną usunięte.

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

Parametry

metadata: Metadata

Zastąp istniejące metadane tą wartością. Jeśli żadna wartość nie zostanie podana, istniejące metadane zostaną usunięte.

options: BlobSetMetadataOptions

Opcjonalne opcje ustawiania operacji metadanych.

Zwraca

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

Ustawia tagi w bazowym obiekcie blob. Obiekt blob może mieć maksymalnie 10 tagów. Klucze tagów muszą zawierać od 1 do 128 znaków. Wartości tagów muszą zawierać od 0 do 256 znaków. Prawidłowe znaki klucza tagu i wartości obejmują małe i wielkie litery, cyfry (0–9), spację (' '), plus ('+'), minus ('-'), kropkę ('.'), ukośnik ('/'), dwukropek (':'), równe ('=') i podkreślenie ('_') .

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

Parametry

tags: Tags

options: BlobSetTagsOptions

Zwraca

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Rozpoczyna operację uruchamiania przyrostowej kopii z migawki jednego stronicowego obiektu blob do tego stronicowego obiektu blob. Migawka jest kopiowana tak, że tylko różnicowe zmiany między wcześniej skopiowaną migawką są przenoszone do miejsca docelowego. Skopiowane migawki są pełne kopie oryginalnej migawki i mogą być odczytywane lub kopiowane z jak zwykle.

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

Parametry

copySource: string

Określa nazwę migawki obiektu blob strony źródłowej. Na przykład https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options: PageBlobStartCopyIncrementalOptions

Opcje operacji przyrostowej kopiowania stronicowych obiektów blob.

Zwraca

Promise<PageBlobCopyIncrementalResponse>

Dane odpowiedzi dla operacji przyrostowej kopiowania stronicowych obiektów blob.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Synchroniczna operacja kopiowania z adresu URL kopiuje obiekt blob lub zasób internetowy do nowego obiektu blob. Nie zwróci odpowiedzi, dopóki kopia nie zostanie ukończona.

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

Parametry

copySource: string

Źródłowy adres URL do skopiowania sygnatury dostępu współdzielonego (SAS) może być potrzebny do uwierzytelniania

options: BlobSyncCopyFromURLOptions

Zwraca

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Przywraca zawartość i metadane nietrwałego usuniętego obiektu blob oraz wszystkie skojarzone nietrwale usunięte migawki. Cofanie obiektu blob jest obsługiwane tylko w wersji 2017-07-29 lub nowszej.

function undelete(options?: BlobUndeleteOptions)

Parametry

options: BlobUndeleteOptions

Opcjonalne opcje operacji cofania operacji cofania obiektu blob.

Zwraca

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Ustawia numer sekwencji stronicowego obiektu blob.

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

Parametry

sequenceNumberAction: SequenceNumberActionType

Wskazuje, jak usługa powinna zmodyfikować numer sekwencji obiektu blob.

sequenceNumber: number

Wymagane, jeśli parametr sequenceNumberAction ma wartość maksymalną lub aktualizację

options: PageBlobUpdateSequenceNumberOptions

Opcje operacji numer sekwencji aktualizacji stronicowego obiektu blob.

Zwraca

Promise<PageBlobUpdateSequenceNumberResponse>

Dane odpowiedzi dla operacji numer sekwencji aktualizacji stronicowych obiektów blob.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Zapisuje 1 lub więcej stron w stronicowym obiekcie blob. Przesunięcia początkowe i końcowe muszą mieć wielokrotność 512.

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

Parametry

body: HttpRequestBody

Dane do przekazania

offset: number

Przesunięcie docelowego stronicowego obiektu blob

count: number

Długość treści, również liczba bajtów do przekazania

options: PageBlobUploadPagesOptions

Opcje operacji stronicowego przekazywania stron obiektów blob.

Zwraca

Promise<PageBlobUploadPagesResponse>

Dane odpowiedzi dla operacji przekazywania stron stronicowych obiektów blob.

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

Operacja Przekazywania stron zapisuje zakres stron do stronicowego obiektu blob, w którym zawartość jest odczytywana z adresu URL.

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

Parametry

sourceURL: string

Określ adres URL źródła kopii, sygnaturę dostępu współdzielonego (SAS) może być wymaganą do uwierzytelniania

sourceOffset: number

Przesunięcie źródła do skopiowania. Przekaż 0, aby skopiować od początku źródłowego stronicowego obiektu blob

destOffset: number

Przesunięcie docelowego stronicowego obiektu blob

count: number

Liczba bajtów do przekazania ze źródłowego stronicowego obiektu blob

options: PageBlobUploadPagesFromURLOptions

Zwraca

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Tworzy nowy obiekt PageBlobClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie klienta do podstawowego obiektu blob.

function withSnapshot(snapshot: string)

Parametry

snapshot: string

Sygnatura czasowa migawki.

Zwraca

PageBlobClient

Nowy obiekt PageBlobClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki.

withVersion(string)

Tworzy nowy obiekt BlobClient wskazujący wersję tego obiektu blob. Podaj wartość "" spowoduje usunięcie identyfikatora versionId i zwrócenie klienta do podstawowego obiektu blob.

function withVersion(versionId: string)

Parametry

versionId: string

Identyfikator wersji.

Zwraca

BlobClient

Nowy obiekt BlobClient wskazujący wersję tego obiektu blob.

Share via

PageBlobClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

PageBlobClient(string, PipelineLike)

Parametry

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

Parametry

PageBlobClient(string, string, string, StoragePipelineOptions)

Parametry

Szczegóły właściwości

accountName

Wartość właściwości

containerName

Wartość właściwości

credential

Wartość właściwości

name

Wartość właściwości

url

Wartość właściwości

Szczegóły metody

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametry

Zwraca

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametry

Zwraca

clearPages(number, number, PageBlobClearPagesOptions)

Parametry

Zwraca

create(number, PageBlobCreateOptions)

Parametry

Zwraca

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Parametry

Zwraca

createSnapshot(BlobCreateSnapshotOptions)

Parametry

Zwraca

delete(BlobDeleteOptions)

Parametry

Zwraca

deleteIfExists(BlobDeleteOptions)

Parametry

Zwraca

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parametry

Zwraca

download(number, number, BlobDownloadOptions)

Parametry

Zwraca

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametry

Zwraca

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametry

Zwraca

downloadToFile(string, number, number, BlobDownloadOptions)

Parametry

Zwraca

exists(BlobExistsOptions)

Parametry

Zwraca

generateSasUrl(BlobGenerateSasUrlOptions)

Parametry

Zwraca

getAppendBlobClient()

Zwraca

getBlobLeaseClient(string)

Parametry

Zwraca

getBlockBlobClient()

Zwraca

getPageBlobClient()

Zwraca

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parametry