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
container |
Nama kontainer penyimpanan yang terkait dengan blob. |
name | Nama blob. |
Properti yang Diwariskan
account |
|
credential | Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari |
url | Nilai string URL yang dikodekan. |
Metode
append |
Menerapkan blok data baru ke akhir blob penambahan yang ada. Lihat https://docs.microsoft.com/rest/api/storageservices/append-block |
append |
Operasi Tambahkan Blok menerapkan blok data baru ke akhir blob penambahan yang ada di mana konten dibaca dari url sumber. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url |
create(Append |
Membuat blob tambahan dengan panjang 0. Panggil AppendBlock untuk menambahkan data ke blob penambahan. Lihat https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Membuat blob tambahan dengan panjang 0. Panggil AppendBlock untuk menambahkan data ke blob penambahan. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah. Lihat https://docs.microsoft.com/rest/api/storageservices/put-blob |
seal(Append |
Menyegel blob tambahan, membuatnya baca saja. |
with |
Membuat objek AppendBlobClient baru yang identik dengan sumbernya tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan Klien ke blob dasar. |
Metode yang Diwarisi
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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
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 Dalam versi 2012-02-12 dan yang lebih baru, sumber untuk operasi Salin Blob dapat menjadi blob yang diterapkan di akun penyimpanan Azure apa 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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Contoh menggunakan polling otomatis:
Contoh menggunakan polling manual:
Contoh menggunakan pembaruan kemajuan:
Contoh menggunakan interval polling yang berubah (default 15 detik):
Contoh menggunakan pembatalan penyalinan:
|
create |
Membuat rekam jepret baca-saja dari blob. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/delete-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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/delete-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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
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 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 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 terdefinisi 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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Membuat objek AppendBlobClient. |
get |
Dapatkan BlobLeaseClient 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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties PERINGATAN: Objek |
get |
Mendapatkan tag yang terkait dengan blob yang mendasar. |
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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier |
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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Tetapkan kebijakan imutabilitas 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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
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. Karakter kunci dan nilai tag yang valid termasuk huruf kecil dan huruf besar, 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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
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. Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
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
containerName
Nama kontainer penyimpanan yang terkait dengan blob.
string containerName
Nilai Properti
string
name
Nama blob.
string name
Nilai Properti
string
Detail Properti yang Diwariskan
accountName
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
Diwarisi DariBlobClient.credential
url
Detail Metode
appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)
Menerapkan blok data baru ke akhir blob penambahan yang ada.
Lihat https://docs.microsoft.com/rest/api/storageservices/append-block
function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>
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.
Lihat 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>
Parameter
- sourceURL
-
string
Url ke blob yang akan menjadi sumber salinan. Blob sumber di akun penyimpanan yang sama dapat diautentikasi melalui Kunci Bersama. Namun, jika sumbernya adalah blob di akun lain, blob sumber harus bersifat publik atau harus diautentikasi melalui tanda tangan akses bersama. Jika blob sumber bersifat publik, tidak ada autentikasi yang diperlukan untuk melakukan operasi.
- sourceOffset
-
number
Offset dalam sumber yang akan ditambahkan
- count
-
number
Jumlah byte yang akan ditambahkan sebagai blok
Mengembalikan
Promise<AppendBlobAppendBlockFromUrlResponse>
create(AppendBlobCreateOptions)
Membuat blob tambahan dengan panjang 0. Panggil AppendBlock untuk menambahkan data ke blob penambahan.
Lihat https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>
Parameter
- options
- AppendBlobCreateOptions
Opsi untuk operasi Tambahkan Buat Blok.
Contoh penggunaan:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Mengembalikan
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Membuat blob tambahan dengan panjang 0. Panggil AppendBlock untuk menambahkan data ke blob penambahan. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah.
Lihat https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>
Parameter
Mengembalikan
Promise<AppendBlobCreateIfNotExistsResponse>
seal(AppendBlobSealOptions)
Menyegel blob tambahan, membuatnya baca saja.
function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>
Parameter
- options
- AppendBlobSealOptions
Mengembalikan
Promise<AppendBlobAppendBlockResponse>
withSnapshot(string)
Membuat objek AppendBlobClient baru yang identik dengan sumbernya tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan Klien ke blob dasar.
function withSnapshot(snapshot: string): AppendBlobClient
Parameter
- snapshot
-
string
Tanda waktu rekam jepret.
Mengembalikan
Objek AppendBlobClient baru identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan.
Detail Metode yang Diwarisi
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Parameter
- copyId
-
string
Id operasi Salin Dari URL.
- options
- BlobAbortCopyFromURLOptions
Opsi opsional ke operasi Batalkan Salin Dari URL Blob.
Mengembalikan
Promise<BlobAbortCopyFromURLResponse>
Diwarisi DariBlobClient.abortCopyFromURL
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 apa 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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Contoh menggunakan polling otomatis:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Contoh menggunakan polling manual:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Contoh menggunakan pembaruan kemajuan:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Contoh menggunakan interval polling yang berubah (default 15 detik):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Contoh menggunakan pembatalan penyalinan:
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>>
Parameter
- copySource
-
string
url ke sumber Azure Blob/File.
- options
- BlobBeginCopyFromURLOptions
Opsi opsional ke operasi Mulai Salin Dari URL Blob.
Mengembalikan
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Diwarisi DariBlobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Membuat rekam jepret baca-saja dari blob.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parameter
- options
- BlobCreateSnapshotOptions
Opsi opsional untuk operasi Buat Rekam Jepret Blob.
Mengembalikan
Promise<BlobCreateSnapshotResponse>
Diwarisi DariBlobClient.createSnapshot
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parameter
- options
- BlobDeleteOptions
Opsi opsional untuk operasi Penghapusan Blob.
Mengembalikan
Promise<BlobDeleteResponse>
Diwarisi DariBlobClient.delete
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parameter
- options
- BlobDeleteOptions
Opsi opsional untuk operasi Penghapusan Blob.
Mengembalikan
Promise<BlobDeleteIfExistsResponse>
Diwarisi DariBlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Hapus kebijakan immutablility pada blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parameter
Opsi opsional untuk menghapus kebijakan imutabilitas pada blob.
Mengembalikan
Promise<BlobDeleteImmutabilityPolicyResponse>
Diwarisi DariBlobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Membaca atau mengunduh blob dari sistem, termasuk metadata dan propertinya. Anda juga dapat memanggil Dapatkan Blob untuk membaca rekam jepret.
- Dalam Node.js, data kembali dalam aliran readableStreamBody
- Di browser, data kembali dalam blobBody janji
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
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>
Diwarisi DariBlobClient.download
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 downloadToFile.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parameter
- buffer
-
Buffer
Buffer yang akan diisi, harus memiliki panjang yang 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>
Diwarisi DariBlobClient.downloadToBuffer
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 downloadToFile.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
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>
Diwarisi DariBlobClient.downloadToBuffer
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 terdefinisi masing-masing untuk mengunduh seluruh blob.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
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.
Diwarisi DariBlobClient.downloadToFile
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): Promise<boolean>
Parameter
- options
- BlobExistsOptions
opsi untuk operasi Exists.
Mengembalikan
Promise<boolean>
Diwarisi DariBlobClient.exists
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
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.
Diwarisi DariBlobClient.generateSasUrl
getAppendBlobClient()
Membuat objek AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Mengembalikan
Diwarisi DariBlobClient.getAppendBlobClient
getBlobLeaseClient(string)
Dapatkan BlobLeaseClient yang mengelola sewa pada blob.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parameter
- proposeLeaseId
-
string
Id sewa awal yang diusulkan.
Mengembalikan
Objek BlobLeaseClient baru untuk mengelola sewa pada blob.
Diwarisi DariBlobClient.getBlobLeaseClient
getBlockBlobClient()
Membuat objek BlockBlobClient.
function getBlockBlobClient(): BlockBlobClient
Mengembalikan
Diwarisi DariBlobClient.getBlockBlobClient
getPageBlobClient()
Membuat objek PageBlobClient.
function getPageBlobClient(): PageBlobClient
Mengembalikan
Diwarisi DariBlobClient.getPageBlobClient
getProperties(BlobGetPropertiesOptions)
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk blob. Ini tidak mengembalikan konten blob.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
PERINGATAN: Objek metadata
yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode ContainerClient yang mencantumkan blob menggunakan includeMetadata
opsi , yang akan mempertahankan casing aslinya.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parameter
- options
- BlobGetPropertiesOptions
Opsi opsional untuk operasi Dapatkan Properti.
Mengembalikan
Promise<BlobGetPropertiesResponse>
Diwarisi DariBlobClient.getProperties
getTags(BlobGetTagsOptions)
Mendapatkan tag yang terkait dengan blob yang mendasar.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parameter
- options
- BlobGetTagsOptions
Mengembalikan
Promise<BlobGetTagsResponse>
Diwarisi DariBlobClient.getTags
setAccessTier(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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Parameter
- tier
-
string
Tingkat yang akan diatur pada blob. Nilai yang valid adalah Panas, Dingin, atau Arsip.
- options
- BlobSetTierOptions
Opsi opsional ke operasi Tingkat Set Blob.
Mengembalikan
Promise<BlobSetTierResponse>
Diwarisi DariBlobClient.setAccessTier
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
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>
Diwarisi DariBlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Tetapkan kebijakan imutabilitas pada blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parameter
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Opsi opsional untuk mengatur kebijakan imutabilitas pada blob.
Mengembalikan
Promise<BlobSetImmutabilityPolicyResponse>
Diwarisi DariBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Tetapkan penahanan legal pada blob.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parameter
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Opsi opsional untuk mengatur penahanan legal pada blob.
Mengembalikan
Promise<BlobSetLegalHoldResponse>
Diwarisi DariBlobClient.setLegalHold
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
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>
Diwarisi DariBlobClient.setMetadata
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. Karakter kunci dan nilai tag yang valid termasuk huruf kecil dan huruf besar, digit (0-9), spasi (' '), plus ('+'), minus ('-'), titik ('.'), garis miring ('/'), titik dua (':'), sama dengan ('='), dan garis bawah ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parameter
- tags
- Tags
- options
- BlobSetTagsOptions
Mengembalikan
Promise<BlobSetTagsResponse>
Diwarisi DariBlobClient.setTags
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parameter
- copySource
-
string
URL sumber untuk disalin, Tanda Tangan Akses Bersama (SAS) mungkin diperlukan untuk autentikasi
- options
- BlobSyncCopyFromURLOptions
Mengembalikan
Promise<BlobCopyFromURLResponse>
Diwarisi DariBlobClient.syncCopyFromURL
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.
Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Parameter
- options
- BlobUndeleteOptions
Opsi opsional untuk operasi Blob Batal hapus.
Mengembalikan
Promise<BlobUndeleteResponse>
Diwarisi DariBlobClient.undelete
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): BlobClient
Parameter
- versionId
-
string
VersionId.
Mengembalikan
Objek BlobClient baru yang menunjuk ke versi blob ini.
Diwarisi DariBlobClient.withVersion