AppendBlobClient class
AppendBlobClient mendefinisikan serangkaian operasi yang berlaku untuk menambahkan blob.
- Extends
Konstruktor
Append |
Membuat instans AppendBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob tambahan. String URL yang dikodekan TIDAK akan lolos dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL. |
Append |
Membuat instans AppendBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob tambahan. String URL yang dikodekan TIDAK akan lolos dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL. |
Append |
Membuat instans AppendBlobClient. |
Properti
account |
|
container |
Nama kontainer penyimpanan yang dikaitkan dengan blob. |
credential | Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari |
name | Nama blob. |
url | Nilai string URL yang dikodekan. |
Metode
abort |
Membatalkan operasi Copy Blob asinkron yang tertunda, dan meninggalkan blob tujuan dengan panjang nol dan metadata penuh. Versi 2012-02-12 dan yang lebih baru. |
append |
Menerapkan blok data baru ke akhir blob penambahan yang ada. |
append |
Operasi Tambahkan Blok menerapkan blok data baru ke akhir blob penambahan yang ada di mana konten dibaca dari url sumber. |
begin |
Secara asinkron menyalin blob ke tujuan dalam akun penyimpanan.
Metode ini mengembalikan poller operasi jangka panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga salinan selesai.
Anda juga dapat membatalkan salinan sebelum selesai dengan memanggil |
create(Append |
Membuat blob penampingan 0 panjang. Panggil AppendBlock untuk menambahkan data ke blob tambahan. |
create |
Membuat blob penampingan 0 panjang. Panggil AppendBlock untuk menambahkan data ke blob tambahan. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah. |
create |
Membuat rekam jepret baca-saja dari blob. |
delete(Blob |
Menandai blob atau rekam jepret yang ditentukan untuk dihapus. Blob kemudian dihapus selama pengumpulan sampah. Perhatikan bahwa untuk menghapus blob, Anda harus menghapus semua rekam jepretnya. Anda dapat menghapus keduanya secara bersamaan dengan operasi Hapus Blob. |
delete |
Menandai blob atau rekam jepret yang ditentukan untuk dihapus jika ada. Blob kemudian dihapus selama pengumpulan sampah. Perhatikan bahwa untuk menghapus blob, Anda harus menghapus semua rekam jepretnya. Anda dapat menghapus keduanya secara bersamaan dengan operasi Hapus Blob. |
delete |
Hapus kebijakan immutablility pada blob. |
download(number, number, Blob |
Membaca atau mengunduh blob dari sistem, termasuk metadata dan propertinya. Anda juga dapat memanggil Dapatkan Blob untuk membaca rekam jepret.
|
download |
HANYA TERSEDIA DI RUNTIME NODE.JS. Mengunduh Azure Blob secara paralel dengan buffer. Offset dan hitungan bersifat opsional, mengunduh seluruh blob jika tidak disediakan. Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk blob yang lebih besar dari ukuran ini, pertimbangkan <xref:downloadToFile>. |
download |
HANYA TERSEDIA DI RUNTIME NODE.JS. Mengunduh Azure Blob secara paralel dengan buffer. Offset dan hitungan bersifat opsional, mengunduh seluruh blob jika tidak disediakan. Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk blob yang lebih besar dari ukuran ini, pertimbangkan <xref:downloadToFile>. |
download |
HANYA TERSEDIA DI RUNTIME NODE.JS. Mengunduh Azure Blob ke file lokal. Gagal jika jalur file yang diberikan sudah keluar. Offset dan hitungan bersifat opsional, lulus 0 dan tidak ditentukan masing-masing untuk mengunduh seluruh blob. |
exists(Blob |
Mengembalikan true jika sumber daya blob Azure yang diwakili oleh klien ini ada; false jika tidak. CATATAN: gunakan fungsi ini dengan hati-hati karena blob yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya, blob baru dapat ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai. |
generate |
Hanya tersedia untuk BlobClient yang dibangun dengan kredensial kunci bersama. Menghasilkan URI Tanda Tangan Akses Bersama (SAS) Blob Service berdasarkan properti dan parameter klien yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. |
get |
Membuat objek AppendBlobClient. |
get |
<xref:BlobLeaseClient> Dapatkan yang mengelola sewa pada blob. |
get |
Membuat objek BlockBlobClient. |
get |
Membuat objek PageBlobClient. |
get |
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk blob. Ini tidak mengembalikan konten blob. |
get |
Mendapatkan tag yang terkait dengan blob yang mendasar. |
seal(Append |
Segel blob penampan, membuatnya baca-saja. |
set |
Mengatur tingkat pada blob. Operasi ini diizinkan pada blob halaman di akun penyimpanan premium dan pada blob blok di akun penyimpanan blob (hanya penyimpanan redundan lokal). Tingkat blob halaman premium menentukan ukuran, IOPS, dan bandwidth blob yang diizinkan. Tingkat blob blok menentukan jenis penyimpanan Hot/Cool/Archive. Operasi ini tidak memperbarui ETag blob. |
set |
Mengatur properti sistem di blob. Jika tidak ada nilai yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP blob yang ditentukan, header HTTP blob ini tanpa nilai akan dihapus. |
set |
Tetapkan kebijakan immutablility pada blob. |
set |
Tetapkan penahanan legal pada blob. |
set |
Mengatur metadata yang ditentukan pengguna untuk blob yang ditentukan sebagai satu atau beberapa pasangan nama-nilai. Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter , metadata blob akan dihapus. |
set |
Mengatur tag pada blob yang mendasar. Blob dapat memiliki hingga 10 tag. Kunci tag harus antara 1 dan 128 karakter. Nilai tag harus antara 0 dan 256 karakter. Kunci tag dan karakter nilai yang valid termasuk huruf kecil dan atas, digit (0-9), spasi (' '), plus ('+'), minus ('-'), titik ('.'), garis miring ('/'), titik dua (':'), sama dengan ('='), dan garis bawah ('_') . |
sync |
Operasi Salin Dari URL sinkron menyalin blob atau sumber daya internet ke blob baru. Ini tidak akan mengembalikan respons sampai salinan selesai. |
undelete(Blob |
Memulihkan konten dan metadata blob yang dihapus sementara dan rekam jepret yang dihapus sementara terkait. Batal hapus Blob hanya didukung pada versi 2017-07-29 atau yang lebih baru. |
with |
Membuat objek AppendBlobClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan Klien ke blob dasar. |
with |
Membuat objek BlobClient baru yang menunjuk ke versi blob ini. Berikan "" akan menghapus versionId dan mengembalikan Klien ke blob dasar. |
Detail Konstruktor
AppendBlobClient(string, PipelineLike)
Membuat instans AppendBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob tambahan. String URL yang dikodekan TIDAK akan lolos dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL.
new AppendBlobClient(url: string, pipeline: PipelineLike)
Parameter
- url
-
string
String URL yang menunjuk ke blob tambahan Azure Storage, seperti "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob. String URL yang dikodekan TIDAK akan lolos dua kali, hanya karakter khusus di jalur URL yang akan lolos. Namun, jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL. Seperti blob bernama "my?blob%", URL harus "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline
- PipelineLike
Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Membuat instans AppendBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob tambahan. String URL yang dikodekan TIDAK akan lolos dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL.
new AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parameter
- url
-
string
String URL yang menunjuk ke blob tambahan Azure Storage, seperti "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob. String URL yang dikodekan TIDAK akan lolos dua kali, hanya karakter khusus di jalur URL yang akan lolos. Namun, jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL. Seperti blob bernama "my?blob%", URL harus "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari @azure/identity
paket untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.
- options
- StoragePipelineOptions
Opsional. Opsi untuk mengonfigurasi alur HTTP.
AppendBlobClient(string, string, string, StoragePipelineOptions)
Membuat instans AppendBlobClient.
new AppendBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
Parameter
- connectionString
-
string
String koneksi akun atau string koneksi SAS dari akun penyimpanan Azure.
[ Catatan - String koneksi akun hanya dapat digunakan dalam runtime NODE.JS. ] Contoh string koneksi akun -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Contoh string koneksi SAS - 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
Nama kontainer.
- blobName
-
string
Nama blob.
- options
- StoragePipelineOptions
Opsional. Opsi untuk mengonfigurasi alur HTTP.
Detail Properti
accountName
accountName: string
Nilai Properti
string
containerName
Nama kontainer penyimpanan yang dikaitkan dengan blob.
string containerName
Nilai Properti
string
credential
Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari @azure/identity
paket untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Nilai Properti
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
name
Nama blob.
string name
Nilai Properti
string
url
Nilai string URL yang dikodekan.
url: string
Nilai Properti
string
Detail Metode
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Membatalkan operasi Copy Blob asinkron yang tertunda, dan meninggalkan blob tujuan dengan panjang nol dan metadata penuh. Versi 2012-02-12 dan yang lebih baru.
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)
Parameter
- copyId
-
string
Id operasi Salin Dari URL.
- options
- BlobAbortCopyFromURLOptions
Opsi opsional ke operasi Batalkan Salin Dari URL Blob.
Mengembalikan
Promise<BlobAbortCopyFromURLResponse>
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)
Menerapkan blok data baru ke akhir blob penambahan yang ada.
function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions)
Parameter
- body
-
HttpRequestBody
Data yang akan ditambahkan.
- contentLength
-
number
Panjang tubuh dalam byte.
- options
- AppendBlobAppendBlockOptions
Opsi untuk operasi Tambahkan Blok.
Contoh penggunaan:
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);
Mengembalikan
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
Operasi Tambahkan Blok menerapkan blok data baru ke akhir blob penambahan yang ada di mana konten dibaca dari url sumber.
function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions)
Parameter
- sourceURL
-
string
-
The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
- sourceOffset
-
number
Offset dalam sumber yang akan ditambahkan
- count
-
number
Jumlah byte yang akan ditambahkan sebagai blok
Mengembalikan
Promise<AppendBlobAppendBlockFromUrlResponse>
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Secara asinkron menyalin blob ke tujuan dalam akun penyimpanan.
Metode ini mengembalikan poller operasi jangka panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga salinan selesai.
Anda juga dapat membatalkan salinan sebelum selesai dengan memanggil cancelOperation
pada poller.
Perhatikan bahwa panggilan balik onProgress tidak akan dipanggil jika operasi selesai dalam permintaan pertama, dan mencoba membatalkan salinan yang telah selesai akan mengakibatkan kesalahan dilemparkan.
Dalam versi 2012-02-12 dan yang lebih baru, sumber untuk operasi Salin Blob dapat menjadi blob yang diterapkan di akun penyimpanan Azure mana pun.
Dimulai dengan versi 2015-02-21, sumber untuk operasi Salin Blob dapat menjadi file Azure di akun penyimpanan Azure apa pun.
Hanya akun penyimpanan yang dibuat pada atau setelah 7 Juni 2012 yang mengizinkan operasi Salin Blob untuk disalin dari akun penyimpanan lain.
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)
Parameter
- copySource
-
string
url ke sumber Azure Blob/File.
- options
- BlobBeginCopyFromURLOptions
Opsi opsional ke operasi Mulai Salin Dari URL Blob.
Mengembalikan
Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
create(AppendBlobCreateOptions)
Membuat blob penampingan 0 panjang. Panggil AppendBlock untuk menambahkan data ke blob tambahan.
function create(options?: AppendBlobCreateOptions)
Parameter
- options
- AppendBlobCreateOptions
Opsi untuk operasi Tambahkan Blok Buat.
Contoh penggunaan:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Mengembalikan
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Membuat blob penampingan 0 panjang. Panggil AppendBlock untuk menambahkan data ke blob tambahan. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah.
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions)
Parameter
Mengembalikan
Promise<AppendBlobCreateIfNotExistsResponse>
createSnapshot(BlobCreateSnapshotOptions)
Membuat rekam jepret baca-saja dari blob.
function createSnapshot(options?: BlobCreateSnapshotOptions)
Parameter
- options
- BlobCreateSnapshotOptions
Opsi opsional untuk operasi Buat Rekam Jepret Blob.
Mengembalikan
Promise<BlobCreateSnapshotResponse>
delete(BlobDeleteOptions)
Menandai blob atau rekam jepret yang ditentukan untuk dihapus. Blob kemudian dihapus selama pengumpulan sampah. Perhatikan bahwa untuk menghapus blob, Anda harus menghapus semua rekam jepretnya. Anda dapat menghapus keduanya secara bersamaan dengan operasi Hapus Blob.
function delete(options?: BlobDeleteOptions)
Parameter
- options
- BlobDeleteOptions
Opsi opsional untuk operasi Penghapusan Blob.
Mengembalikan
Promise<BlobDeleteResponse>
deleteIfExists(BlobDeleteOptions)
Menandai blob atau rekam jepret yang ditentukan untuk dihapus jika ada. Blob kemudian dihapus selama pengumpulan sampah. Perhatikan bahwa untuk menghapus blob, Anda harus menghapus semua rekam jepretnya. Anda dapat menghapus keduanya secara bersamaan dengan operasi Hapus Blob.
function deleteIfExists(options?: BlobDeleteOptions)
Parameter
- options
- BlobDeleteOptions
Opsi opsional untuk operasi Penghapusan Blob.
Mengembalikan
Promise<BlobDeleteIfExistsResponse>
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Hapus kebijakan immutablility pada blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)
Parameter
Opsi opsional untuk menghapus kebijakan imutabilitas pada blob.
Mengembalikan
Promise<BlobDeleteImmutabilityPolicyResponse>
download(number, number, BlobDownloadOptions)
Membaca atau mengunduh blob dari sistem, termasuk metadata dan propertinya. Anda juga dapat memanggil Dapatkan Blob untuk membaca rekam jepret.
- Di Node.js, data kembali dalam aliran readableStreamBody
- Di browser, data kembali dalam blobBody janji
function download(offset?: number, count?: number, options?: BlobDownloadOptions)
Parameter
- offset
-
number
Dari posisi blob mana yang akan diunduh, lebih besar dari atau sama dengan 0
- count
-
number
Berapa banyak data yang akan diunduh, lebih besar dari 0. Akan mengunduh ke akhir ketika tidak terdefinis
- options
- BlobDownloadOptions
Opsi opsional untuk operasi Pengunduhan Blob.
Contoh penggunaan (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);
});
}
Contoh penggunaan (browser):
// 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);
});
}
Mengembalikan
Promise<BlobDownloadResponseParsed>
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
HANYA TERSEDIA DI RUNTIME NODE.JS. Mengunduh Azure Blob secara paralel dengan buffer. Offset dan hitungan bersifat opsional, mengunduh seluruh blob jika tidak disediakan.
Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk blob yang lebih besar dari ukuran ini, pertimbangkan <xref:downloadToFile>.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)
Parameter
- buffer
-
Buffer
Buffer yang akan diisi, harus memiliki panjang lebih besar dari hitungan
- offset
-
number
Dari posisi blob blok mana yang akan diunduh(dalam byte)
- count
-
number
Berapa banyak data (dalam byte) yang akan diunduh. Akan mengunduh ke akhir saat melewati tidak terdefinis
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Mengembalikan
Promise<Buffer>
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
HANYA TERSEDIA DI RUNTIME NODE.JS. Mengunduh Azure Blob secara paralel dengan buffer. Offset dan hitungan bersifat opsional, mengunduh seluruh blob jika tidak disediakan.
Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk blob yang lebih besar dari ukuran ini, pertimbangkan <xref:downloadToFile>.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)
Parameter
- offset
-
number
Dari posisi blob blok mana yang akan diunduh(dalam byte)
- count
-
number
Berapa banyak data (dalam byte) yang akan diunduh. Akan mengunduh ke akhir saat melewati tidak terdefinis
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Mengembalikan
Promise<Buffer>
downloadToFile(string, number, number, BlobDownloadOptions)
HANYA TERSEDIA DI RUNTIME NODE.JS. Mengunduh Azure Blob ke file lokal. Gagal jika jalur file yang diberikan sudah keluar. Offset dan hitungan bersifat opsional, lulus 0 dan tidak ditentukan masing-masing untuk mengunduh seluruh blob.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)
Parameter
- filePath
-
string
- offset
-
number
Dari posisi blob blok mana yang akan diunduh.
- count
-
number
Berapa banyak data yang akan diunduh. Akan mengunduh ke akhir saat melewati tidak terdefinis.
- options
- BlobDownloadOptions
Opsi untuk opsi pengunduhan Blob.
Mengembalikan
Promise<BlobDownloadResponseParsed>
Data respons untuk operasi pengunduhan blob, tetapi dengan readableStreamBody diatur ke tidak terdefinisi karena kontennya sudah dibaca dan ditulis ke dalam file lokal di jalur yang ditentukan.
exists(BlobExistsOptions)
Mengembalikan true jika sumber daya blob Azure yang diwakili oleh klien ini ada; false jika tidak. CATATAN: gunakan fungsi ini dengan hati-hati karena blob yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya, blob baru dapat ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.
function exists(options?: BlobExistsOptions)
Parameter
- options
- BlobExistsOptions
opsi untuk operasi Exists.
Mengembalikan
Promise<boolean>
generateSasUrl(BlobGenerateSasUrlOptions)
Hanya tersedia untuk BlobClient yang dibangun dengan kredensial kunci bersama. Menghasilkan URI Tanda Tangan Akses Bersama (SAS) Blob Service berdasarkan properti dan parameter klien yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.
function generateSasUrl(options: BlobGenerateSasUrlOptions)
Parameter
- options
- BlobGenerateSasUrlOptions
Parameter opsional.
Mengembalikan
Promise<string>
URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.
getAppendBlobClient()
getBlobLeaseClient(string)
<xref:BlobLeaseClient> Dapatkan yang mengelola sewa pada blob.
function getBlobLeaseClient(proposeLeaseId?: string)
Parameter
- proposeLeaseId
-
string
Id sewa awal yang diusulkan.
Mengembalikan
Objek BlobLeaseClient baru untuk mengelola sewa pada blob.
getBlockBlobClient()
getPageBlobClient()
getProperties(BlobGetPropertiesOptions)
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk blob. Ini tidak mengembalikan konten blob.
function getProperties(options?: BlobGetPropertiesOptions)
Parameter
- options
- BlobGetPropertiesOptions
Opsi opsional untuk operasi Dapatkan Properti.
Mengembalikan
Promise<BlobGetPropertiesResponse>
getTags(BlobGetTagsOptions)
Mendapatkan tag yang terkait dengan blob yang mendasar.
function getTags(options?: BlobGetTagsOptions)
Parameter
- options
- BlobGetTagsOptions
Mengembalikan
Promise<BlobGetTagsResponse>
seal(AppendBlobSealOptions)
Segel blob penampan, membuatnya baca-saja.
function seal(options?: AppendBlobSealOptions)
Parameter
- options
- AppendBlobSealOptions
Mengembalikan
Promise<AppendBlobAppendBlockResponse>
setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)
Mengatur tingkat pada blob. Operasi ini diizinkan pada blob halaman di akun penyimpanan premium dan pada blob blok di akun penyimpanan blob (hanya penyimpanan redundan lokal). Tingkat blob halaman premium menentukan ukuran, IOPS, dan bandwidth blob yang diizinkan. Tingkat blob blok menentukan jenis penyimpanan Hot/Cool/Archive. Operasi ini tidak memperbarui ETag blob.
function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)
Parameter
- tier
-
BlockBlobTier | PremiumPageBlobTier | string
Tingkat yang akan diatur pada blob. Nilai yang valid adalah Panas, Dingin, atau Arsip.
- options
- BlobSetTierOptions
Opsi opsional untuk operasi Tingkat Set Blob.
Mengembalikan
Promise<BlobSetTierResponse>
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Mengatur properti sistem di blob. Jika tidak ada nilai yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP blob yang ditentukan, header HTTP blob ini tanpa nilai akan dihapus.
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)
Parameter
- blobHTTPHeaders
- BlobHTTPHeaders
Jika tidak ada nilai yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP blob yang ditentukan, header HTTP blob ini tanpa nilai akan dihapus.
Header umum yang akan diatur adalah blobContentType
mengaktifkan browser untuk menyediakan fungsionalitas berdasarkan jenis file.
- options
- BlobSetHTTPHeadersOptions
Opsi opsional untuk operasi Header HTTP Set Blob.
Mengembalikan
Promise<BlobSetHTTPHeadersResponse>
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Tetapkan kebijakan immutablility pada blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)
Parameter
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Opsi opsional untuk mengatur kebijakan imutabilitas pada blob.
Mengembalikan
Promise<BlobSetImmutabilityPolicyResponse>
setLegalHold(boolean, BlobSetLegalHoldOptions)
Tetapkan penahanan legal pada blob.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)
Parameter
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Opsi opsional untuk mengatur penahanan legal pada blob.
Mengembalikan
Promise<BlobSetLegalHoldResponse>
setMetadata(Metadata, BlobSetMetadataOptions)
Mengatur metadata yang ditentukan pengguna untuk blob yang ditentukan sebagai satu atau beberapa pasangan nama-nilai. Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter , metadata blob akan dihapus.
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)
Parameter
- metadata
- Metadata
Ganti metadata yang ada dengan nilai ini. Jika tidak ada nilai yang disediakan, metadata yang ada akan dihapus.
- options
- BlobSetMetadataOptions
Opsi opsional untuk Mengatur operasi Metadata.
Mengembalikan
Promise<BlobSetMetadataResponse>
setTags(Tags, BlobSetTagsOptions)
Mengatur tag pada blob yang mendasar. Blob dapat memiliki hingga 10 tag. Kunci tag harus antara 1 dan 128 karakter. Nilai tag harus antara 0 dan 256 karakter. Kunci tag dan karakter nilai yang valid termasuk huruf kecil dan atas, digit (0-9), spasi (' '), plus ('+'), minus ('-'), titik ('.'), garis miring ('/'), titik dua (':'), sama dengan ('='), dan garis bawah ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions)
Parameter
- tags
- Tags
- options
- BlobSetTagsOptions
Mengembalikan
Promise<BlobSetTagsResponse>
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Operasi Salin Dari URL sinkron menyalin blob atau sumber daya internet ke blob baru. Ini tidak akan mengembalikan respons sampai salinan selesai.
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)
Parameter
- copySource
-
string
URL sumber untuk disalin, Tanda Tangan Akses Bersama (SAS) mungkin diperlukan untuk autentikasi
- options
- BlobSyncCopyFromURLOptions
Mengembalikan
Promise<BlobCopyFromURLResponse>
undelete(BlobUndeleteOptions)
Memulihkan konten dan metadata blob yang dihapus sementara dan rekam jepret yang dihapus sementara terkait. Batal hapus Blob hanya didukung pada versi 2017-07-29 atau yang lebih baru.
function undelete(options?: BlobUndeleteOptions)
Parameter
- options
- BlobUndeleteOptions
Opsi opsional untuk operasi Batal Hapus Blob.
Mengembalikan
Promise<BlobUndeleteResponse>
withSnapshot(string)
Membuat objek AppendBlobClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan Klien ke blob dasar.
function withSnapshot(snapshot: string)
Parameter
- snapshot
-
string
Tanda waktu rekam jepret.
Mengembalikan
Objek AppendBlobClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan.
withVersion(string)
Membuat objek BlobClient baru yang menunjuk ke versi blob ini. Berikan "" akan menghapus versionId dan mengembalikan Klien ke blob dasar.
function withVersion(versionId: string)
Parameter
- versionId
-
string
VersionId.
Mengembalikan
Objek BlobClient baru yang menunjuk ke versi blob ini.
Azure SDK for JavaScript