BlobClient class

Odwołanie

Pakiet:: @azure/storage-blob

Obiekt BlobClient reprezentuje adres URL obiektu blob usługi Azure Storage; obiekt blob może być blokowym obiektem blob, uzupełnialnym obiektem blob lub stronicowym obiektem blob.

Extends: StorageClient

Konstruktory

BlobClient(string, PipelineLike)	Tworzy wystąpienie obiektu BlobClient. 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ą zmienione. Jeśli nazwa obiektu blob zawiera wartość ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Tworzy wystąpienie obiektu BlobClient. 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ą zmienione. Jeśli nazwa obiektu blob zawiera wartość ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL.
BlobClient(string, string, string, StoragePipelineOptions)	Tworzy wystąpienie obiektu BlobClient na podstawie parametrów połączenia.

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 nowsze.
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` 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łem operacji kopiowania obiektu blob może być plik platformy Azure na dowolnym koncie usługi Azure Storage. Tylko konta magazynu utworzone w dniu 7 czerwca 2012 r. zezwalają na kopiowanie kopii obiektu blob z innego konta magazynu lub po tym, jak 7 czerwca 2012 r.
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, należy 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, należy 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ć metodę Pobierz obiekt blob, aby odczytać migawkę. W Node.js dane są zwracane w strumieniu czytelnym do odczytuStreamBody W przeglądarkach dane są zwracane w obiekcie blob Promise
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. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już koń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 zasób obiektu blob platformy Azure reprezentowany przez tego klienta istnieje; 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 usługi Blob Service na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przy użyciu poświadczeń klucza współużytkowanego klienta.
getAppendBlobClient()	Tworzy obiekt AppendBlobClient.
getBlobLeaseClient(string)	Pobierz obiekt , który <xref:BlobLeaseClient> 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.
getTags(BlobGetTagsOptions)	Pobiera tagi skojarzone z bazowym obiektem blob.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Ustawia warstwę obiektu blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie magazynu w warstwie Premium oraz 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 żadna wartość nie zostanie podana lub żadna wartość nie zostanie podana 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 dla obiektu blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Ustaw archiwizację ze względów prawnych dla 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.
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 i wartości tagu 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.
undelete(BlobUndeleteOptions)	Przywraca zawartość i metadane nietrwałego usuniętego obiektu blob oraz wszystkie skojarzone migawki usunięte nietrwale. Cofanie usunięcia obiektu blob jest obsługiwane tylko w wersji 2017-07-29 lub nowszej.
withSnapshot(string)	Tworzy nowy obiekt BlobClient 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

BlobClient(string, PipelineLike)

Tworzy wystąpienie obiektu BlobClient. 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ą zmienione. Jeśli nazwa obiektu blob zawiera wartość ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL.

new BlobClient(url: string, pipeline: PipelineLike)

Parametry

url: string

Ciąg klienta wskazujący usługę obiektów blob usługi Azure Storage, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net?sasString".

pipeline: PipelineLike

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

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

new BlobClient(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 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.

options: StoragePipelineOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

BlobClient(string, string, string, StoragePipelineOptions)

Tworzy wystąpienie obiektu BlobClient na podstawie parametrów połączenia.

new BlobClient(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

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

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

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>

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 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łem operacji kopiowania obiektu blob może być plik platformy Azure na dowolnym koncie usługi Azure Storage. Tylko konta magazynu utworzone w dniu 7 czerwca 2012 r. zezwalają na kopiowanie kopii obiektu blob z innego konta magazynu lub po tym, jak 7 czerwca 2012 r.

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

Parametry

copySource: string

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

options: BlobBeginCopyFromURLOptions

Opcjonalne opcje operacji Rozpocznij kopiowanie z adresu URL obiektu blob.

Zwraca

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

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, należy 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, należy 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ć metodę Pobierz obiekt blob, aby odczytać migawkę.

W Node.js dane są zwracane w strumieniu czytelnym do odczytuStreamBody
W przeglądarkach dane są zwracane w obiekcie blob Promise

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

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>

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

Ilość danych (w bajtach) do pobrania. Pobieranie do końca podczas przekazywania niezdefiniowanych

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

Ilość danych (w bajtach) do pobrania. Pobieranie do końca podczas przekazywania niezdefiniowanych

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. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już koń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)

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 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 zasób obiektu blob platformy Azure reprezentowany przez tego klienta istnieje; 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)

Parametry

options: BlobExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

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 usługi Blob Service na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przy użyciu poświadczeń klucza współużytkowanego 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 do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SYGNATURy dostępu współdzielonego.

getAppendBlobClient()

Tworzy obiekt AppendBlobClient.

function getAppendBlobClient()

Zwraca

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parametry

proposeLeaseId: string

Początkowy identyfikator proponowanej 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

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.

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>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Ustawia warstwę obiektu blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie magazynu w warstwie Premium oraz 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 obiekt blob. Prawidłowe wartości to Gorąca, Chłodna lub Archiwum.

options: BlobSetTierOptions

Opcjonalne opcje operacji Ustaw warstwę obiektu blob.

Zwraca

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Ustawia właściwości systemowe obiektu blob. Jeśli żadna wartość nie zostanie podana lub żadna wartość nie zostanie podana 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 żadna wartość nie zostanie podana lub żadna wartość nie zostanie podana 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 dla obiektu 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 archiwizację ze względów prawnych dla obiektu blob.

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

Parametry

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Zwraca

Promise<BlobSetLegalHoldResponse>

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.

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 i wartości tagu 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)

Parametry

tags: Tags

options: BlobSetTagsOptions

Zwraca

Promise<BlobSetTagsResponse>

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 migawki usunięte nietrwale. Cofanie usunięcia obiektu blob jest obsługiwane tylko w wersji 2017-07-29 lub nowszej.

function undelete(options?: BlobUndeleteOptions)

Parametry

options: BlobUndeleteOptions

Opcjonalne opcje operacji cofania usunięcia obiektu blob.

Zwraca

Promise<BlobUndeleteResponse>

withSnapshot(string)

Tworzy nowy obiekt BlobClient 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

BlobClient

Nowy obiekt BlobClient 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.

Udostępnij za pośrednictwem

BlobClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

BlobClient(string, PipelineLike)

Parametry

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

Parametry

BlobClient(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

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

getProperties(BlobGetPropertiesOptions)

Parametry

Zwraca

getTags(BlobGetTagsOptions)

Parametry

Zwraca

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Parametry

Zwraca

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Parametry