BlockBlobClient class

Odwołanie

Pakiet:: @azure/storage-blob

BlockBlobClient definiuje zestaw operacji mających zastosowanie do blokowych obiektów blob.

Rozszerzenie: BlobClient

Konstruktory

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

Właściwości

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

Właściwości dziedziczone

accountName
credential	Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu `@azure/identity` do uwierzytelniania żą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.
url	Wartość zakodowanego ciągu adresu URL.

Metody

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Zapisuje obiekt blob, określając listę identyfikatorów blokowych, które tworzą obiekt blob. Aby można było zapisać go w ramach obiektu blob, blok musi zostać pomyślnie zapisany na serwerze w poprzedniej operacji stageBlock. Możesz wywołać commitBlockList, aby zaktualizować obiekt blob, przekazując tylko te bloki, które uległy zmianie, a następnie zatwierdzając nowe i istniejące bloki razem. Wszystkie bloki nie zostały określone na liście bloków i trwale usunięte. Zobacz https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Zwraca listę bloków przekazanych w ramach blokowego obiektu blob przy użyciu określonego filtru listy blokowej. Zobacz https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Szybkie zapytanie dotyczące sformatowanego obiektu blob w formacie JSON lub CSV. Przykładowe użycie (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); 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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Przekazuje określony blok do "obszaru przejściowego" blokowego obiektu blob, który zostanie później zatwierdzony przez wywołanie metody commitBlockList. Zobacz https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Operacja bloku etapu od adresu URL tworzy nowy blok, który ma zostać zatwierdzony w ramach obiektu blob, w którym zawartość jest odczytywana z adresu URL. Ten interfejs API jest dostępny od wersji 2018-03-28. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Tworzy nowy blokowy obiekt blob, w którym zawartość obiektu blob jest odczytywana z danego adresu URL. Ten interfejs API jest obsługiwany od wersji 2020-04-08. Aktualizacje częściowe nie są obsługiwane w przypadku funkcji Put Blob z adresu URL; zawartość istniejącego obiektu blob jest zastępowana zawartością nowego obiektu blob. Aby wykonać częściowe aktualizacje zawartości bloku obiektu blob przy użyciu źródłowego adresu URL, użyj stageBlockFromURL i commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Tworzy nowy blokowy obiekt blob lub aktualizuje zawartość istniejącego blokowego obiektu blob. Aktualizowanie istniejącego obiektu blob blokowego zastępuje wszystkie istniejące metadane obiektu blob. Aktualizacje częściowe nie są obsługiwane; zawartość istniejącego obiektu blob jest zastępowana nową zawartością. Aby wykonać częściową aktualizację blokowych obiektów blob, użyj stageBlock i commitBlockList. Jest to metoda przekazywania niezrównanego. Użyj uploadFile, uploadStream lub uploadBrowserData, aby uzyskać lepszą wydajność z przekazywaniem współbieżności. Zobacz https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	DOSTĘPNE TYLKO W PRZEGLĄDARKACH. Przekazuje obiekt Blob/File/ArrayBuffer/ArrayBufferView w przeglądarce, aby zablokować obiekt blob. Jeśli długość buforu jest mniejsza lub równa 256 MB, ta metoda użyje 1 wywołania przekazywania, aby zakończyć przekazywanie. W przeciwnym razie ta metoda wywoła stageBlock w celu przekazania bloków, a na koniec wywoła commitBlockList, aby zatwierdzić listę bloków. Typową opcją blobHTTPHeaders do ustawienia jest `blobContentType`, co umożliwia przeglądarce udostępnianie funkcji na podstawie typu pliku.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Przekazuje obiekt Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView do obiektu BlockBlob. Jeśli długość danych nie przekracza specifiled maxSingleShotSize (wartość domyślna to <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), ta metoda użyje 1 przekazać wywołanie, aby zakończyć przekazywanie. W przeciwnym razie ta metoda wywoła stageBlock w celu przekazania bloków, a na koniec wywoła commitBlockList, aby zatwierdzić listę bloków. Typową opcją blobHTTPHeaders do ustawienia jest `blobContentType`, co umożliwia przeglądarce udostępnianie funkcji na podstawie typu pliku.
uploadFile(string, BlockBlobParallelUploadOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje plik lokalny w blokach do blokowego obiektu blob. Jeśli rozmiar pliku jest mniejszy lub równy 256 MB, ta metoda użyje 1 wywołania przekazywania, aby zakończyć przekazywanie. W przeciwnym razie ta metoda wywoła funkcję stageBlock w celu przekazania bloków, a na koniec wywoła funkcję commitBlockList, aby zatwierdzić listę bloków.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje strumień z możliwością odczytu Node.js do blokowego obiektu blob. PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI: Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().
withSnapshot(string)	Tworzy nowy obiekt BlockBlobClient identyczny ze źródłem, ale z określonym sygnaturą czasową migawki. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie adresu URL do podstawowego obiektu blob.

Metody dziedziczone

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Przerywa oczekującą operację kopiowania asynchronicznego obiektu blob i pozostawia docelowy obiekt blob o zerowej długości i pełnych metadanych. Wersja 2012-02-12 i nowsze. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
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 ukończenia kopiowania. Możesz również anulować kopię przed jej ukończeniem, wywołując `cancelOperation` w okienku. 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łem operacji kopiowania obiektu blob może być plik platformy Azure na dowolnym koncie usługi Azure Storage. Tylko konta magazynu utworzone 7 czerwca 2012 r. zezwalają na kopiowanie obiektów blob z innego konta magazynu lub po tym, jak 7 czerwca 2012 r. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Przykład użycia automatycznego sondowania: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Przykład użycia ręcznego sondowania: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Przykład użycia aktualizacji postępu: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Przykład użycia zmieniającego się interwału sondowania (domyślnie 15 sekund): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Przykład użycia anulowania kopiowania: `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)	Tworzy migawkę obiektu blob tylko do odczytu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
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, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-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, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Usuń zasady niezmienności obiektu 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ć metodę Get Blob, aby odczytać migawkę. W Node.jsdane są zwracane w strumieniu czytelnym do odczytuStreamBody W przeglądarkach dane są zwracane w obiekcie blobBody obietnicy Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
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: 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 rozważyć 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: 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 rozważyć downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera obiekt blob platformy Azure do pliku lokalnego. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już zakończy działanie. 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; w przeciwnym razie wartość false. UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący obiekt blob może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe obiekty blob mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
generateSasUrl(BlobGenerateSasUrlOptions)	Dostępny tylko dla obiektu BlobClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi Blob Service na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	Operacja Pobierz informacje o koncie zwraca nazwę jednostki SKU i rodzaj konta dla określonego konta. Operacja Uzyskiwanie informacji o koncie jest dostępna w wersjach usługi, począwszy od wersji 2018-03-28. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()	Tworzy obiekt AppendBlobClient.
getBlobLeaseClient(string)	Pobierz BlobLeaseClient, który zarządza dzierżawami obiektu blob.
getBlockBlobClient()	Tworzy obiekt BlockBlobClient.
getPageBlobClient()	Tworzy obiekt PageBlobClient.
getProperties(BlobGetPropertiesOptions)	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla obiektu blob. Nie zwraca zawartości obiektu blob. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties OSTRZEŻENIE: Obiekt `metadata` zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody ContainerClient, które wyświetlają listę obiektów blob przy użyciu opcji `includeMetadata`, która zachowa oryginalną wielkość liter.
getTags(BlobGetTagsOptions)	Pobiera tagi skojarzone z bazowym obiektem blob.
setAccessTier(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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Ustawia właściwości systemowe obiektu blob. Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Ustaw zasady niezmienności dla obiektu blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Ustaw blokadę prawną obiektu blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Ustawia metadane zdefiniowane przez użytkownika dla określonego obiektu blob jako co najmniej jedną parę nazwa-wartość. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane obiektu blob zostaną usunięte. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	Ustawia tagi bazowego obiektu 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ówna się ('=') i podkreślenie ('_') .
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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Przywraca zawartość i metadane nietrwałego usuniętego obiektu blob oraz wszystkie skojarzone nietrwałe migawki. Cofanie usunięcia obiektu blob jest obsługiwane tylko w wersji 2017-07-29 lub nowszej. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-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

BlockBlobClient(string, PipelineLike)

Tworzy wystąpienie klasy BlockBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący blokowy obiekt blob. Zakodowany ciąg adresu URL nie zostanie dwukrotnie uniknięci. Tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. Jeśli nazwa obiektu blob zawiera wartość ? lub %nazwa obiektu blob musi być zakodowana w adresie URL.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

Ciąg adresu URL wskazujący blokowy obiekt blob usługi Azure Storage, taki jak "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący obiekt blob. Zakodowany ciąg adresu URL nie zostanie dwukrotnie uniknięci. Tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. Jeśli jednak nazwa obiektu blob zawiera wartość ? lub %nazwa obiektu blob musi być zakodowana w adresie URL. Na przykład obiekt blob o nazwie "my?blob%", adres URL powinien mieć wartość "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

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

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żą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.

options: StoragePipelineOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Tworzy wystąpienie klasy BlockBlobClient.

new BlockBlobClient(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 — przykład parametrów połączenia sygnatury dostępu współdzielonego DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

Nazwa kontenera.

blobName: string

Nazwa obiektu blob.

options: StoragePipelineOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

containerName

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

string containerName

Wartość właściwości

string

name

Nazwa obiektu blob.

string name

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

accountName

accountName: string

Wartość właściwości

string

dziedziczone zBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wartość właściwości

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

dziedziczone zBlobClient.credential

url

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone zBlobClient.url

Szczegóły metody

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Zapisuje obiekt blob, określając listę identyfikatorów blokowych, które tworzą obiekt blob. Aby można było zapisać go w ramach obiektu blob, blok musi zostać pomyślnie zapisany na serwerze w poprzedniej operacji stageBlock. Możesz wywołać commitBlockList, aby zaktualizować obiekt blob, przekazując tylko te bloki, które uległy zmianie, a następnie zatwierdzając nowe i istniejące bloki razem. Wszystkie bloki nie zostały określone na liście bloków i trwale usunięte.

Zobacz https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parametry

blocks: string[]

Tablica wartości 64-bajtowej zakodowanej w formacie base64

options: BlockBlobCommitBlockListOptions

Opcje operacji listy blokowych zatwierdzeń obiektów blob.

Zwraca

Promise<BlockBlobCommitBlockListResponse>

Dane odpowiedzi operacji listy blokowych zatwierdzeń obiektów blob.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Zwraca listę bloków przekazanych w ramach blokowego obiektu blob przy użyciu określonego filtru listy blokowej.

Zobacz https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Parametry

listType: BlockListType

Określa, czy należy zwrócić listę zatwierdzonych bloków, listę niezatwierdzonych bloków, czy obie listy razem.

options: BlockBlobGetBlockListOptions

Opcje operacji Uzyskiwanie listy blokowych obiektów blob.

Zwraca

Promise<BlockBlobGetBlockListResponse>

Dane odpowiedzi dla operacji Uzyskiwanie listy blokowych obiektów blob.

query(string, BlockBlobQueryOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Szybkie zapytanie dotyczące sformatowanego obiektu blob w formacie JSON lub CSV.

Przykładowe użycie (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

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

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Parametry

query: string

options: BlockBlobQueryOptions

Zwraca

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Przekazuje określony blok do "obszaru przejściowego" blokowego obiektu blob, który zostanie później zatwierdzony przez wywołanie metody commitBlockList.

Zobacz https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parametry

blockId: string

Wartość 64-bajtowa zakodowana w formacie base64

body: HttpRequestBody

Dane do przekazania do obszaru przejściowego.

contentLength: number

Liczba bajtów do przekazania.

options: BlockBlobStageBlockOptions

Opcje operacji bloku blokowego obiektu blob.

Zwraca

Promise<BlockBlobStageBlockResponse>

Dane odpowiedzi dla operacji bloku blokowego obiektu blob.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Operacja bloku etapu od adresu URL tworzy nowy blok, który ma zostać zatwierdzony w ramach obiektu blob, w którym zawartość jest odczytywana z adresu URL. Ten interfejs API jest dostępny od wersji 2018-03-28.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Parametry

blockId: string

Wartość 64-bajtowa zakodowana w formacie base64

sourceURL: string

Określa adres URL obiektu blob. Wartość może być adresem URL o długości do 2 KB, który określa obiekt blob. Wartość powinna być zakodowana w adresie URL, tak jak w identyfikatorze URI żądania. Źródłowy obiekt blob musi być publiczny lub musi być uwierzytelniony za pośrednictwem sygnatury dostępu współdzielonego. Jeśli źródłowy obiekt blob jest publiczny, do wykonania operacji nie jest wymagane żadne uwierzytelnianie. Oto kilka przykładów adresów URL obiektów źródłowych: — https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

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

count: number

Ilość danych do pobrania, większa niż 0. Zostanie pobrany na koniec, gdy niezdefiniowany

options: BlockBlobStageBlockFromURLOptions

Opcje operacji Blokuj blokowego etapu obiektu blob z adresu URL.

Zwraca

Promise<BlockBlobStageBlockFromURLResponse>

Dane odpowiedzi dla operacji bloku blokowego etapu obiektu blob z adresu URL.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Tworzy nowy blokowy obiekt blob, w którym zawartość obiektu blob jest odczytywana z danego adresu URL. Ten interfejs API jest obsługiwany od wersji 2020-04-08. Aktualizacje częściowe nie są obsługiwane w przypadku funkcji Put Blob z adresu URL; zawartość istniejącego obiektu blob jest zastępowana zawartością nowego obiektu blob. Aby wykonać częściowe aktualizacje zawartości bloku obiektu blob przy użyciu źródłowego adresu URL, użyj stageBlockFromURL i commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parametry

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Parametry opcjonalne.

Zwraca

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Tworzy nowy blokowy obiekt blob lub aktualizuje zawartość istniejącego blokowego obiektu blob. Aktualizowanie istniejącego obiektu blob blokowego zastępuje wszystkie istniejące metadane obiektu blob. Aktualizacje częściowe nie są obsługiwane; zawartość istniejącego obiektu blob jest zastępowana nową zawartością. Aby wykonać częściową aktualizację blokowych obiektów blob, użyj stageBlock i commitBlockList.

Jest to metoda przekazywania niezrównanego. Użyj uploadFile, uploadStream lub uploadBrowserData, aby uzyskać lepszą wydajność z przekazywaniem współbieżności.

Zobacz https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Parametry

body: HttpRequestBody

Obiekt blob, ciąg, ArrayBuffer, ArrayBufferView lub funkcja zwracająca nowy strumień z możliwością odczytu, którego przesunięcie pochodzi od źródła danych.

contentLength: number

Długość ciała w bajtach. Użyj metody Buffer.byteLength(), aby obliczyć długość treści dla ciągu, w tym niekodowane znaki base64/szesnastkowe.

options: BlockBlobUploadOptions

Opcje operacji przekazywania blokowych obiektów blob.

Zwraca

Promise<BlockBlobUploadResponse>

Dane odpowiedzi dla operacji przekazywania blokowych obiektów blob.

Przykładowe użycie:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use uploadData instead.

DOSTĘPNE TYLKO W PRZEGLĄDARKACH.

Przekazuje obiekt Blob/File/ArrayBuffer/ArrayBufferView w przeglądarce, aby zablokować obiekt blob.

Jeśli długość buforu jest mniejsza lub równa 256 MB, ta metoda użyje 1 wywołania przekazywania, aby zakończyć przekazywanie. W przeciwnym razie ta metoda wywoła stageBlock w celu przekazania bloków, a na koniec wywoła commitBlockList, aby zatwierdzić listę bloków.

Typową opcją blobHTTPHeaders do ustawienia jest blobContentType, co umożliwia przeglądarce udostępnianie funkcji na podstawie typu pliku.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametry

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer lub ArrayBufferView

options: BlockBlobParallelUploadOptions

Opcje przekazywania danych przeglądarki.

Zwraca

Promise<BlobUploadCommonResponse>

Dane odpowiedzi dla operacji przekazywania obiektów blob.

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Przekazuje obiekt Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView do obiektu BlockBlob.

Jeśli długość danych nie przekracza specifiled maxSingleShotSize (wartość domyślna to <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), ta metoda użyje 1 przekazać wywołanie, aby zakończyć przekazywanie. W przeciwnym razie ta metoda wywoła stageBlock w celu przekazania bloków, a na koniec wywoła commitBlockList, aby zatwierdzić listę bloków.

Typową opcją blobHTTPHeaders do ustawienia jest blobContentType, co umożliwia przeglądarce udostępnianie funkcji na podstawie typu pliku.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametry

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), Blob, ArrayBuffer lub ArrayBufferView

options: BlockBlobParallelUploadOptions

Zwraca

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Przekazuje plik lokalny w blokach do blokowego obiektu blob.

Jeśli rozmiar pliku jest mniejszy lub równy 256 MB, ta metoda użyje 1 wywołania przekazywania, aby zakończyć przekazywanie. W przeciwnym razie ta metoda wywoła funkcję stageBlock w celu przekazania bloków, a na koniec wywoła funkcję commitBlockList, aby zatwierdzić listę bloków.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametry

filePath: string

Pełna ścieżka pliku lokalnego

options: BlockBlobParallelUploadOptions

Opcje przekazywania do operacji blokowego obiektu blob.

Zwraca

Promise<BlobUploadCommonResponse>

Dane odpowiedzi dla operacji przekazywania obiektów blob.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Przekazuje strumień z możliwością odczytu Node.js do blokowego obiektu blob.

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parametry

stream: Readable

strumień z możliwością odczytu Node.js

bufferSize: number

Rozmiar każdego przydzielonego buforu, a także rozmiar bloku w przekazanym blokowym obiekcie blob. Wartość domyślna to 8 MB

maxConcurrency: number

Maksymalna współbieżność wskazuje maksymalną liczbę, które można przydzielić, dodatnią korelację z maksymalną współbieżnością przekazywania. Wartość domyślna to 5

options: BlockBlobUploadStreamOptions

Opcje przekazywania strumienia do operacji blokowego obiektu blob.

Zwraca

Promise<BlobUploadCommonResponse>

Dane odpowiedzi dla operacji przekazywania obiektów blob.

withSnapshot(string)

Tworzy nowy obiekt BlockBlobClient identyczny ze źródłem, ale z określonym sygnaturą czasową migawki. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie adresu URL do podstawowego obiektu blob.

function withSnapshot(snapshot: string): BlockBlobClient

Parametry

snapshot: string

Sygnatura czasowa migawki.

Zwraca

BlockBlobClient

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

Szczegóły metody dziedziczonej

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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

Parametry

copyId: string

Identyfikator operacji Kopiuj z adresu URL.

options: BlobAbortCopyFromURLOptions

Opcjonalne opcje operacji Abort Copy From URL (Przerwanie kopiowania z adresu URL) obiektu blob.

Zwraca

Promise<BlobAbortCopyFromURLResponse>

dziedziczone zBlobClient.abortCopyFromURL

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 ukończenia kopiowania. Możesz również anulować kopię przed jej ukończeniem, wywołując cancelOperation w okienku. 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łem operacji kopiowania obiektu blob może być plik platformy Azure na dowolnym koncie usługi Azure Storage. Tylko konta magazynu utworzone 7 czerwca 2012 r. zezwalają na kopiowanie obiektów blob z innego konta magazynu lub po tym, jak 7 czerwca 2012 r.

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

Przykład użycia automatycznego sondowania:

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

Przykład użycia ręcznego sondowania:

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

Przykład użycia aktualizacji postępu:

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

Przykład użycia zmieniającego się interwału sondowania (domyślnie 15 sekund):

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

Przykład użycia anulowania kopiowania:

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

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

options: BlobBeginCopyFromURLOptions

Opcjonalne opcje operacji Uruchom kopiowanie z adresu URL obiektu blob.

Zwraca

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

dziedziczone zBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Tworzy migawkę obiektu blob tylko do odczytu.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

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

Parametry

options: BlobCreateSnapshotOptions

Opcjonalne opcje operacji Tworzenia migawki obiektu blob.

Zwraca

Promise<BlobCreateSnapshotResponse>

dziedziczone zBlobClient.createSnapshot

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, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parametry

options: BlobDeleteOptions

Opcjonalne opcje operacji usuwania obiektów blob.

Zwraca

Promise<BlobDeleteResponse>

dziedziczone zBlobClient.delete

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, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć jednocześnie za pomocą operacji Usuń obiekt blob.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parametry

options: BlobDeleteOptions

Opcjonalne opcje operacji usuwania obiektów blob.

Zwraca

Promise<BlobDeleteIfExistsResponse>

dziedziczone zBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Usuń zasady niezmienności obiektu blob.

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

Parametry

options: BlobDeleteImmutabilityPolicyOptions

Opcjonalne opcje usuwania zasad niezmienności w obiekcie blob.

Zwraca

Promise<BlobDeleteImmutabilityPolicyResponse>

dziedziczone zBlobClient.deleteImmutabilityPolicy

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ć metodę Get Blob, aby odczytać migawkę.

W Node.jsdane są zwracane w strumieniu czytelnym do odczytuStreamBody
W przeglądarkach dane są zwracane w obiekcie blobBody obietnicy

Zobacz 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 której pozycji obiektu blob do pobrania, większe lub równe 0

count: number

Ilość danych do pobrania, większa niż 0. Zostanie pobrany na koniec, gdy niezdefiniowany

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>

dziedziczone zBlobClient.download

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: 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 rozważyć downloadToFile.

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

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

Ilość danych (w bajtach) do pobrania. Zostanie pobrany na koniec po przekazaniu niezdefiniowanego

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Zwraca

Promise<Buffer>

dziedziczone zBlobClient.downloadToBuffer

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.

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

Parametry

offset: number

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

count: number

Ilość danych (w bajtach) do pobrania. Zostanie pobrany na koniec po przekazaniu niezdefiniowanego

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Zwraca

Promise<Buffer>

dziedziczone zBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Pobiera obiekt blob platformy Azure do pliku lokalnego. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już zakończy działanie. 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): Promise<BlobDownloadResponseParsed>

Parametry

filePath: string

offset: number

Z której pozycji blokowego obiektu blob do pobrania.

count: number

Ile danych należy pobrać. Po przekazaniu niezdefiniowanego zostanie pobrany koniec.

options: BlobDownloadOptions

Opcje pobierania obiektów blob.

Zwraca

Promise<BlobDownloadResponseParsed>

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

dziedziczone zBlobClient.downloadToFile

exists(BlobExistsOptions)

Zwraca wartość true, jeśli istnieje zasób obiektu blob platformy Azure reprezentowany przez tego klienta; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący obiekt blob może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe obiekty blob mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

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

Parametry

options: BlobExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

dziedziczone zBlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

Dostępny tylko dla obiektu BlobClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi Blob Service na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parametry

options: BlobGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

Promise<string>

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

dziedziczone zBlobClient.generateSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

Operacja Pobierz informacje o koncie zwraca nazwę jednostki SKU i rodzaj konta dla określonego konta. Operacja Uzyskiwanie informacji o koncie jest dostępna w wersjach usługi, począwszy od wersji 2018-03-28.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

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

Parametry

options: BlobGetAccountInfoOptions

Opcje operacji Uzyskiwanie informacji o koncie w usłudze.

Zwraca

Promise<BlobGetAccountInfoResponse>

Dane odpowiedzi dla operacji Uzyskiwanie informacji o koncie usługi.

dziedziczone zBlobClient.getAccountInfo

getAppendBlobClient()

Tworzy obiekt AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Zwraca

AppendBlobClient

dziedziczone zBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Pobierz BlobLeaseClient, który zarządza dzierżawami obiektu blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametry

proposeLeaseId: string

Początkowy proponowany identyfikator dzierżawy.

Zwraca

BlobLeaseClient

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

dziedziczone zBlobClient.getBlobLeaseClient

getBlockBlobClient()

Tworzy obiekt BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Zwraca

BlockBlobClient

dziedziczone zBlobClient.getBlockBlobClient

getPageBlobClient()

Tworzy obiekt PageBlobClient.

function getPageBlobClient(): PageBlobClient

Zwraca

PageBlobClient

dziedziczone zBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody ContainerClient, które wyświetlają listę obiektów blob przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

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

Parametry

options: BlobGetPropertiesOptions

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

Zwraca

Promise<BlobGetPropertiesResponse>

dziedziczone zBlobClient.getProperties

getTags(BlobGetTagsOptions)

Pobiera tagi skojarzone z bazowym obiektem blob.

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

Parametry

options: BlobGetTagsOptions

Zwraca

Promise<BlobGetTagsResponse>

dziedziczone zBlobClient.getTags

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

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

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

Parametry

tier: string

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

options: BlobSetTierOptions

Opcjonalne opcje operacji Ustawianie warstwy obiektów blob.

Zwraca

Promise<BlobSetTierResponse>

dziedziczone zBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Ustawia właściwości systemowe obiektu blob.

Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone.

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

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

Parametry

blobHTTPHeaders: BlobHTTPHeaders

Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone. Typowym nagłówkiem do ustawienia jest blobContentType włączenie przeglądarki w celu zapewnienia funkcjonalności na podstawie typu pliku.

options: BlobSetHTTPHeadersOptions

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

Zwraca

Promise<BlobSetHTTPHeadersResponse>

dziedziczone zBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Ustaw zasady niezmienności dla obiektu blob.

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

Parametry

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Opcjonalne opcje ustawiania zasad niezmienności w obiekcie blob.

Zwraca

Promise<BlobSetImmutabilityPolicyResponse>

dziedziczone zBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Ustaw blokadę prawną obiektu blob.

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

Parametry

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Opcjonalne opcje ustawiania archiwizacji ze względów prawnych dla obiektu blob.

Zwraca

Promise<BlobSetLegalHoldResponse>

dziedziczone zBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Ustawia metadane zdefiniowane przez użytkownika dla określonego obiektu blob jako co najmniej jedną parę nazwa-wartość.

Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane obiektu blob zostaną usunięte.

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

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

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>

dziedziczone zBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Ustawia tagi bazowego obiektu 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ówna się ('=') i podkreślenie ('_') .

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

Parametry

tags: Tags

options: BlobSetTagsOptions

Zwraca

Promise<BlobSetTagsResponse>

dziedziczone zBlobClient.setTags

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.

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

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

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>

dziedziczone zBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

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

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

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

Parametry

options: BlobUndeleteOptions

Opcjonalne opcje operacji cofania usunięcia obiektu blob.

Zwraca

Promise<BlobUndeleteResponse>

dziedziczone zBlobClient.undelete

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

Parametry

versionId: string

VersionId.

Zwraca

BlobClient

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

dziedziczone zBlobClient.withVersion

Udostępnij za pośrednictwem

BlockBlobClient class

Konstruktory

Właściwości

Właściwości dziedziczone

Metody

Metody dziedziczone

Szczegóły konstruktora

BlockBlobClient(string, PipelineLike)

Parametry

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

Parametry

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parametry

Szczegóły właściwości

containerName

Wartość właściwości

name

Wartość właściwości

Szczegóły właściwości dziedziczonej

accountName

Wartość właściwości

credential

Wartość właściwości

url

Wartość właściwości

Szczegóły metody

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parametry

Zwraca

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parametry

Zwraca

query(string, BlockBlobQueryOptions)

Parametry

Zwraca

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parametry

Zwraca

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Parametry

Zwraca

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parametry

Zwraca

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parametry

Zwraca

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parametry

Zwraca

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Parametry

Zwraca

uploadFile(string, BlockBlobParallelUploadOptions)

Parametry

Zwraca

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parametry

Zwraca

withSnapshot(string)

Parametry

Zwraca

Szczegóły metody dziedziczonej

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametry

Zwraca

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametry

Zwraca

createSnapshot(BlobCreateSnapshotOptions)

Parametry

Zwraca

delete(BlobDeleteOptions)

Parametry

Zwraca

deleteIfExists(BlobDeleteOptions)

Parametry

Zwraca

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)