AppendBlobClient class
AppendBlobClient definiuje zestaw operacji mających zastosowanie do dołączania obiektów blob.
- Extends
Konstruktory
Append |
Tworzy wystąpienie elementu AppendBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący uzupełnialne obiekty 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. |
Append |
Tworzy wystąpienie elementu AppendBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący uzupełnialne obiekty 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. |
Append |
Tworzy wystąpienie elementu AppendBlobClient. |
Właściwości
container |
Nazwa kontenera magazynu, z który jest skojarzony obiekt blob. |
name | Nazwa obiektu blob. |
Właściwości dziedziczone
account |
|
credential | Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z |
url | Zakodowana wartość ciągu adresu URL. |
Metody
append |
Zatwierdza nowy blok danych na końcu istniejącego uzupełnionego obiektu blob. Zobacz https://docs.microsoft.com/rest/api/storageservices/append-block |
append |
Operacja Dołączanie bloku zatwierdza nowy blok danych na końcu istniejącego uzupełnionego obiektu blob, w którym zawartość jest odczytywana z źródłowego adresu URL. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url |
create(Append |
Tworzy obiekt blob dołączania o długości 0. Wywołaj funkcję AppendBlock, aby dołączyć dane do uzupełnialnych obiektów blob. Zobacz https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Tworzy obiekt blob dołączania o długości 0. Wywołaj funkcję AppendBlock, aby dołączyć dane do uzupełnialnych obiektów blob. Jeśli obiekt blob o tej samej nazwie już istnieje, zawartość istniejącego obiektu blob pozostanie niezmieniona. Zobacz https://docs.microsoft.com/rest/api/storageservices/put-blob |
seal(Append |
Uszczelnia dołączany obiekt blob, co czyni go tylko do odczytu. |
with |
Tworzy nowy obiekt AppendBlobClient 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. |
Metody dziedziczone
abort |
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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
begin |
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 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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Przykład użycia automatycznego sondowania:
Przykład użycia ręcznego sondowania:
Przykład użycia aktualizacji postępu:
Przykład użycia zmieniającego się interwału sondowania (domyślnie 15 sekund):
Przykład użycia anulowania kopiowania:
|
create |
Tworzy migawkę obiektu blob tylko do odczytu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob |
delete(Blob |
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 |
delete |
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 |
delete |
Usuń zasady niezmienności w obiekcie blob. |
download(number, number, Blob |
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ę.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
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 rozważ pobranie pliku DownloadToFile. |
download |
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 rozważ pobranie pliku DownloadToFile. |
download |
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(Blob |
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. |
generate |
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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Tworzy obiekt AppendBlobClient. |
get |
Pobierz obiekt BlobLeaseClient , który zarządza dzierżawami obiektu blob. |
get |
Tworzy obiekt BlockBlobClient. |
get |
Tworzy obiekt PageBlobClient. |
get |
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: |
get |
Pobiera tagi skojarzone z bazowym obiektem blob. |
set |
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 |
set |
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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Ustaw zasady niezmienności w obiekcie blob. |
set |
Ustaw blokadę prawną obiektu blob. |
set |
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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
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 ('_') . |
sync |
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(Blob |
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. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
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
AppendBlobClient(string, PipelineLike)
Tworzy wystąpienie elementu AppendBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący uzupełnialne obiekty 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 AppendBlobClient(url: string, pipeline: PipelineLike)
Parametry
- url
-
string
Ciąg adresu URL wskazujący obiekt blob dołączania usługi Azure Storage, taki jak "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". 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 jednak nazwa obiektu blob zawiera wartość ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL. Taki jak 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.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Tworzy wystąpienie elementu AppendBlobClient. Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący uzupełnialne obiekty 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 AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametry
- url
-
string
Ciąg adresu URL wskazujący obiekt blob dołączania usługi Azure Storage, taki jak "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". 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 jednak nazwa obiektu blob zawiera wartość ? lub %, nazwa obiektu blob musi być zakodowana w adresie URL. Taki jak obiekt blob o nazwie "my?blob%", adres URL powinien mieć wartość "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"".
- 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.
AppendBlobClient(string, string, string, StoragePipelineOptions)
Tworzy wystąpienie elementu AppendBlobClient.
new AppendBlobClient(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
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
credential
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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Wartość właściwości
Dziedziczone zobiektu BlobClient.credential
url
Zakodowana wartość ciągu adresu URL.
url: string
Wartość właściwości
string
Dziedziczone zobiektu BlobClient.url
Szczegóły metody
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)
Zatwierdza nowy blok danych na końcu istniejącego uzupełnionego obiektu blob.
Zobacz https://docs.microsoft.com/rest/api/storageservices/append-block
function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>
Parametry
- body
- HttpRequestBody
Dane do dołączenia.
- contentLength
-
number
Długość ciała w bajtach.
- options
- AppendBlobAppendBlockOptions
Opcje operacji Dołączanie bloku.
Przykład użycia:
const content = "Hello World!";
// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);
// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);
Zwraca
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
Operacja Dołączanie bloku zatwierdza nowy blok danych na końcu istniejącego uzupełnionego obiektu blob, w którym zawartość jest odczytywana z źródłowego adresu URL.
Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>
Parametry
- sourceURL
-
string
Adres URL obiektu blob, który będzie źródłem kopii. Źródłowy obiekt blob na tym samym koncie magazynu można uwierzytelnić za pośrednictwem klucza współdzielonego. Jeśli jednak źródło jest obiektem blob na innym koncie, ź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 uwierzytelnianie.
- sourceOffset
-
number
Przesunięcie w źródle do dołączenia
- count
-
number
Liczba bajtów, które mają być dołączane jako blok
Zwraca
Promise<AppendBlobAppendBlockFromUrlResponse>
create(AppendBlobCreateOptions)
Tworzy obiekt blob dołączania o długości 0. Wywołaj funkcję AppendBlock, aby dołączyć dane do uzupełnialnych obiektów blob.
Zobacz https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>
Parametry
- options
- AppendBlobCreateOptions
Opcje operacji Dołączanie bloku tworzenia.
Przykład użycia:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Zwraca
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Tworzy obiekt blob dołączania o długości 0. Wywołaj funkcję AppendBlock, aby dołączyć dane do uzupełnialnych obiektów blob. Jeśli obiekt blob o tej samej nazwie już istnieje, zawartość istniejącego obiektu blob pozostanie niezmieniona.
Zobacz https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>
Parametry
Zwraca
Promise<AppendBlobCreateIfNotExistsResponse>
seal(AppendBlobSealOptions)
Uszczelnia dołączany obiekt blob, co czyni go tylko do odczytu.
function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>
Parametry
- options
- AppendBlobSealOptions
Zwraca
Promise<AppendBlobAppendBlockResponse>
withSnapshot(string)
Tworzy nowy obiekt AppendBlobClient 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): AppendBlobClient
Parametry
- snapshot
-
string
Sygnatura czasowa migawki.
Zwraca
Nowy obiekt AppendBlobClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki.
Szczegóły metody dziedziczonej
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.
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 zobiektu BlobClient.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
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.
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 do źródłowego obiektu blob/pliku platformy Azure.
- options
- BlobBeginCopyFromURLOptions
Opcjonalne opcje operacji Rozpocznij kopiowanie z adresu URL obiektu blob.
Zwraca
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Dziedziczone zobiektu BlobClient.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 zobiektu BlobClient.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 zobiektu BlobClient.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 zobiektu BlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Usuń zasady niezmienności w obiekcie blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parametry
Opcjonalne opcje usuwania zasad niezmienności w obiekcie blob.
Zwraca
Promise<BlobDeleteImmutabilityPolicyResponse>
Dziedziczone zobiektu BlobClient.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ę 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
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 zobiektu BlobClient.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: 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 rozważ pobranie pliku 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. Pobieranie do końca podczas przekazywania niezdefiniowanych
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Zwraca
Promise<Buffer>
Dziedziczone zobiektu BlobClient.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.
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 rozważ pobranie pliku DownloadToFile.
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. Pobieranie do końca podczas przekazywania niezdefiniowanych
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Zwraca
Promise<Buffer>
Dziedziczone zobiektu BlobClient.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ż 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): 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 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.
Dziedziczone zobiektu BlobClient.downloadToFile
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): Promise<boolean>
Parametry
- options
- BlobExistsOptions
opcje operacji Istnieje.
Zwraca
Promise<boolean>
Dziedziczone zobiektu BlobClient.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 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.
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 SYGNATURy dostępu współdzielonego.
Dziedziczone zobiektu BlobClient.generateSasUrl
getAppendBlobClient()
Tworzy obiekt AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Zwraca
Dziedziczone zobiektu BlobClient.getAppendBlobClient
getBlobLeaseClient(string)
Pobierz obiekt BlobLeaseClient , który zarządza dzierżawami obiektu blob.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parametry
- proposeLeaseId
-
string
Początkowy identyfikator proponowanej dzierżawy.
Zwraca
Nowy obiekt BlobLeaseClient do zarządzania dzierżawami w obiekcie blob.
Dziedziczone zobiektu BlobClient.getBlobLeaseClient
getBlockBlobClient()
Tworzy obiekt BlockBlobClient.
function getBlockBlobClient(): BlockBlobClient
Zwraca
Dziedziczone zobiektu BlobClient.getBlockBlobClient
getPageBlobClient()
Tworzy obiekt PageBlobClient.
function getPageBlobClient(): PageBlobClient
Zwraca
Dziedziczone zobiektu BlobClient.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: metadata
Obiekt zwrócony w odpowiedzi będzie miał swoje klucze małymi literami, 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 includeMetadata
opcji , 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 zobiektu BlobClient.getProperties
getTags(BlobGetTagsOptions)
Pobiera tagi skojarzone z bazowym obiektem blob.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parametry
- options
- BlobGetTagsOptions
Zwraca
Promise<BlobGetTagsResponse>
Dziedziczone zobiektu BlobClient.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 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>
Dziedziczone zobiektu BlobClient.setAccessTier
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.
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 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>
Dziedziczone zobiektu BlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Ustaw zasady niezmienności w obiekcie 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 zobiektu BlobClient.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 blokady prawnej obiektu blob.
Zwraca
Promise<BlobSetLegalHoldResponse>
Dziedziczone zobiektu BlobClient.setLegalHold
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.
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 z obiektuBlobClient.setMetadata
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): Promise<BlobSetTagsResponse>
Parametry
- tags
- Tags
- options
- BlobSetTagsOptions
Zwraca
Promise<BlobSetTagsResponse>
Dziedziczone zobiektu BlobClient.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 zobiektu BlobClient.syncCopyFromURL
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.
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 operacji cofania obiektu blob.
Zwraca
Promise<BlobUndeleteResponse>
Dziedziczone zobiektu BlobClient.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
Nowy obiekt BlobClient wskazujący wersję tego obiektu blob.
Dziedziczone zobiektu BlobClient.withVersion