Bagikan melalui


BlockBlobClient class

BlockBlobClient mendefinisikan serangkaian operasi yang berlaku untuk blob blok.

Memperluas

Konstruktor

BlockBlobClient(string, PipelineLike)

Membuat instans BlockBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob blok. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob mencakup ? atau %, nama blob harus dikodekan dalam URL.

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

Membuat instans BlockBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob blok. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob mencakup ? atau %, nama blob harus dikodekan dalam URL.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Membuat instans BlockBlobClient.

Properti

containerName

Nama kontainer penyimpanan yang dikaitkan dengan blob.

name

Nama blob.

Properti yang Diwariskan

accountName
credential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

url

Nilai string URL yang dikodekan.

Metode

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Menulis blob dengan menentukan daftar ID blok yang membentuk blob. Untuk ditulis sebagai bagian dari blob, blok harus berhasil ditulis ke server dalam tahap sebelumnyaBlock operasi. Anda dapat memanggil commitBlockList untuk memperbarui blob dengan hanya mengunggah blok yang telah berubah, lalu menerapkan blok baru dan yang sudah ada bersama-sama. Blok apa pun yang tidak ditentukan dalam daftar blokir dan dihapus secara permanen.

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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Mengembalikan daftar blok yang telah diunggah sebagai bagian dari blob blok menggunakan filter daftar blok yang ditentukan.

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

query(string, BlockBlobQueryOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Kueri cepat untuk blob berformat JSON atau CSV.

Contoh penggunaan (Node.js):

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

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Mengunggah blok yang ditentukan ke "area penahapan" blob blok untuk kemudian dilakukan oleh panggilan untuk melakukanBlockList.

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

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

Operasi Blok Tahap Dari URL membuat blok baru yang akan diterapkan sebagai bagian dari blob tempat konten dibaca dari URL. API ini tersedia mulai versi 2018-03-28.

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Membuat Blob Blok baru tempat konten blob dibaca dari URL tertentu. API ini didukung dimulai dengan versi 2020-04-08. Pembaruan parsial tidak didukung dengan Put Blob dari URL; konten blob yang ada ditimpa dengan konten blob baru. Untuk melakukan pembaruan parsial pada konten blob blok menggunakan URL sumber, gunakan stageBlockFromURL dan commitBlockList.

upload(RequestBodyType, number, BlockBlobUploadOptions)

Membuat blob blok baru, atau memperbarui konten blob blok yang ada. Memperbarui blob blok yang ada menimpa metadata yang ada pada blob. Pembaruan parsial tidak didukung; konten blob yang ada ditimpa dengan konten baru. Untuk melakukan pembaruan parsial blob blok, gunakan stageBlock dan commitBlockList.

Ini adalah metode pengunggahan non-paralel, silakan gunakan uploadFile, uploadStream atau uploadBrowserData untuk performa yang lebih baik dengan pengunggahan konkurensi.

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

HANYA TERSEDIA DI BROWSER.

Mengunggah objek Blob/File/ArrayBuffer/ArrayBufferView browser untuk memblokir blob.

Ketika panjang buffer kurang dari atau sama dengan 256MB, metode ini akan menggunakan 1 panggilan unggahan untuk menyelesaikan unggahan. Jika tidak, metode ini akan memanggil stageBlock untuk mengunggah blok, dan akhirnya memanggil commitBlockList untuk menerapkan daftar blokir.

Opsi blobHTTPHeaders umum diatur adalah , memungkinkan browser untuk menyediakan fungsionalitas berdasarkan jenis file.

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

Mengunggah objek Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView ke BlockBlob.

Ketika panjang data tidak lebih dari maxSingleShotSize yang ditentukan (defaultnya adalah <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), metode ini akan menggunakan 1 mengunggah panggilan untuk menyelesaikan unggahan. Jika tidak, metode ini akan memanggil stageBlock untuk mengunggah blok, dan akhirnya memanggil commitBlockList untuk menerapkan daftar blokir.

Opsi blobHTTPHeaders umum diatur adalah , memungkinkan browser untuk menyediakan fungsionalitas berdasarkan jenis file.

uploadFile(string, BlockBlobParallelUploadOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunggah file lokal dalam blok ke blob blok.

Ketika ukuran file kurang dari atau sama dengan 256MB, metode ini akan menggunakan 1 panggilan unggah untuk menyelesaikan unggahan. Jika tidak, metode ini akan memanggil stageBlock untuk mengunggah blok, dan akhirnya memanggil commitBlockList untuk menerapkan daftar blokir.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunggah aliran Node.js dapat dibaca ke dalam blob blok.

TIPS PENINGKATAN PERFORMA:

  • Input stream highWaterMark lebih baik mengatur nilai yang sama dengan parameter bufferSize, yang akan menghindari operasi Buffer.concat().
withSnapshot(string)

Membuat objek BlockBlobClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan URL ke blob dasar.

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

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Menyalin blob secara asinkron ke tujuan dalam akun penyimpanan. Metode ini mengembalikan poller operasi jangka panjang yang memungkinkan Anda untuk 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 Copy 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.');
  }
}
createSnapshot(BlobCreateSnapshotOptions)

Membuat rekam jepret baca-saja dari blob.

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

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

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

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Hapus kebijakan imutablilitas pada blob.

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 yang dapat dibaca ReadableStreamBody
  • Di browser, data kembali dalam blobBody janji

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

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

HANYA TERSEDIA DALAM 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.

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

HANYA TERSEDIA DALAM 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.

downloadToFile(string, number, number, BlobDownloadOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunduh Azure Blob ke file lokal. Gagal jika jalur file yang diberikan sudah keluar. Offset dan hitungan bersifat opsional, pass 0 dan undefined masing-masing untuk mengunduh seluruh blob.

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 mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.

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

getAccountInfo(BlobGetAccountInfoOptions)

Operasi Dapatkan Informasi Akun mengembalikan nama sku dan jenis akun untuk akun yang ditentukan. Operasi Dapatkan Informasi Akun tersedia pada versi layanan yang dimulai dengan versi 2018-03-28.

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

getAppendBlobClient()

Membuat objek AppendBlobClient.

getBlobLeaseClient(string)

Dapatkan BlobLeaseClient yang mengelola sewa pada blob.

getBlockBlobClient()

Membuat objek BlockBlobClient.

getPageBlobClient()

Membuat objek PageBlobClient.

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 opsi includeMetadata, yang akan mempertahankan casing aslinya.

getTags(BlobGetTagsOptions)

Mendapatkan tag yang terkait dengan blob yang mendasar.

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

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Mengatur properti sistem pada 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

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Tetapkan kebijakan kekekalan pada blob.

setLegalHold(boolean, BlobSetLegalHoldOptions)

Tetapkan penahanan legal pada blob.

setMetadata(Metadata, BlobSetMetadataOptions)

Mengatur metadata yang ditentukan pengguna untuk blob yang ditentukan sebagai satu atau beberapa pasangan nilai nama.

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

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 atas, digit (0-9), spasi (' '), plus ('+'), minus ('-'), titik ('.'), garis miring ('/'), titik dua (':'), sama dengan ('='), dan garis bawah ('_') .

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

undelete(BlobUndeleteOptions)

Memulihkan konten dan metadata blob yang dihapus sementara dan rekam jepret yang dihapus sementara terkait. Blob batal penghapusan hanya didukung pada versi 2017-07-29 atau yang lebih baru.

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

withVersion(string)

Membuat objek BlobClient baru yang menunjuk ke versi blob ini. Berikan "" akan menghapus versionId dan mengembalikan Klien ke blob dasar.

Detail Konstruktor

BlockBlobClient(string, PipelineLike)

Membuat instans BlockBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob blok. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob mencakup ? atau %, nama blob harus dikodekan dalam URL.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parameter

url

string

String URL yang menunjuk ke blob blok Azure Storage, seperti "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Namun, jika nama blob mencakup ? 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.

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

Membuat instans BlockBlobClient. Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob blok. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob mencakup ? atau %, nama blob harus dikodekan dalam URL.

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

Parameter

url

string

String URL yang menunjuk ke blob blok Azure Storage, seperti "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke blob. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Namun, jika nama blob mencakup ? 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 paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

options
StoragePipelineOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Membuat instans BlockBlobClient.

new BlockBlobClient(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 - contoh string koneksi SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

Nama kontainer.

blobName

string

Nama blob.

options
StoragePipelineOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

Detail Properti

containerName

Nama kontainer penyimpanan yang dikaitkan dengan blob.

string containerName

Nilai Properti

string

name

Nama blob.

string name

Nilai Properti

string

Detail Properti yang Diwariskan

accountName

accountName: string

Nilai Properti

string

Diwariskan DariBlobClient.accountName

credential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity 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

Diwariskan DariBlobClient.credential

url

Nilai string URL yang dikodekan.

url: string

Nilai Properti

string

Diwarisi DariBlobClient.url

Detail Metode

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Menulis blob dengan menentukan daftar ID blok yang membentuk blob. Untuk ditulis sebagai bagian dari blob, blok harus berhasil ditulis ke server dalam tahap sebelumnyaBlock operasi. Anda dapat memanggil commitBlockList untuk memperbarui blob dengan hanya mengunggah blok yang telah berubah, lalu menerapkan blok baru dan yang sudah ada bersama-sama. Blok apa pun yang tidak ditentukan dalam daftar blokir dan dihapus secara permanen.

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

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

Parameter

blocks

string[]

Array nilai 64 byte yang dikodekan base64

options
BlockBlobCommitBlockListOptions

Opsi untuk operasi Block Blob Commit Block List.

Mengembalikan

Data respons untuk operasi Block Blob Commit Block List.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Mengembalikan daftar blok yang telah diunggah sebagai bagian dari blob blok menggunakan filter daftar blok yang ditentukan.

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

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

Parameter

listType
BlockListType

Menentukan apakah akan mengembalikan daftar blok yang diterapkan, daftar blok yang tidak dikomit, atau kedua daftar bersama-sama.

options
BlockBlobGetBlockListOptions

Opsi untuk operasi Block Blob Get Block List.

Mengembalikan

Data respons untuk operasi Block Blob Get Block List.

query(string, BlockBlobQueryOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Kueri cepat untuk blob berformat JSON atau CSV.

Contoh penggunaan (Node.js):

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

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}
function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Parameter

query

string

Mengembalikan

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Mengunggah blok yang ditentukan ke "area penahapan" blob blok untuk kemudian dilakukan oleh panggilan untuk melakukanBlockList.

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

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

Parameter

blockId

string

Nilai 64 byte yang dikodekan base64

body
HttpRequestBody

Data untuk diunggah ke area penahapan.

contentLength

number

Jumlah byte yang akan diunggah.

options
BlockBlobStageBlockOptions

Opsi untuk operasi Blok Tahap Blob Blok.

Mengembalikan

Data respons untuk operasi Blok Tahap Blob Blok.

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

Operasi Blok Tahap Dari URL membuat blok baru yang akan diterapkan sebagai bagian dari blob tempat konten dibaca dari URL. API ini tersedia mulai versi 2018-03-28.

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

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

Parameter

blockId

string

Nilai 64 byte yang dikodekan base64

sourceURL

string

Menentukan URL blob. Nilainya mungkin url dengan panjang hingga 2 KB yang menentukan blob. Nilai harus dikodekan URL karena akan muncul dalam URI permintaan. Blob sumber harus publik atau harus diautentikasi melalui tanda tangan akses bersama. Jika blob sumber bersifat publik, tidak ada autentikasi yang diperlukan untuk melakukan operasi. Berikut adalah beberapa contoh URL objek sumber: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

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 ditentukan

options
BlockBlobStageBlockFromURLOptions

Opsi untuk operasi BlokIr Tahap Blob Blok dari URL.

Mengembalikan

Data respons untuk operasi Blok Tahap Blok Blob Blok Dari URL.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Membuat Blob Blok baru tempat konten blob dibaca dari URL tertentu. API ini didukung dimulai dengan versi 2020-04-08. Pembaruan parsial tidak didukung dengan Put Blob dari URL; konten blob yang ada ditimpa dengan konten blob baru. Untuk melakukan pembaruan parsial pada konten blob blok menggunakan URL sumber, gunakan stageBlockFromURL dan commitBlockList.

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

Parameter

sourceURL

string

Menentukan URL blob. Nilainya mungkin url dengan panjang hingga 2 KB yang menentukan blob. Nilai harus dikodekan URL karena akan muncul dalam URI permintaan. Blob sumber harus publik atau harus diautentikasi melalui tanda tangan akses bersama. Jika blob sumber bersifat publik, tidak ada autentikasi yang diperlukan untuk melakukan operasi. Berikut adalah beberapa contoh URL objek sumber: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
BlockBlobSyncUploadFromURLOptions

Parameter opsional.

Mengembalikan

upload(RequestBodyType, number, BlockBlobUploadOptions)

Membuat blob blok baru, atau memperbarui konten blob blok yang ada. Memperbarui blob blok yang ada menimpa metadata yang ada pada blob. Pembaruan parsial tidak didukung; konten blob yang ada ditimpa dengan konten baru. Untuk melakukan pembaruan parsial blob blok, gunakan stageBlock dan commitBlockList.

Ini adalah metode pengunggahan non-paralel, silakan gunakan uploadFile, uploadStream atau uploadBrowserData untuk performa yang lebih baik dengan pengunggahan konkurensi.

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

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

Parameter

body
HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView atau fungsi yang mengembalikan aliran Readable baru yang offset-nya berasal dari sumber data yang dimulai.

contentLength

number

Panjang tubuh dalam byte. Gunakan Buffer.byteLength() untuk menghitung panjang isi untuk string termasuk karakter non-Base64/Hex-encoded.

options
BlockBlobUploadOptions

Opsi untuk operasi Unggah Blob Blok.

Mengembalikan

Data respons untuk operasi Unggah Blob Blok.

Contoh penggunaan:

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use uploadData instead.

HANYA TERSEDIA DI BROWSER.

Mengunggah objek Blob/File/ArrayBuffer/ArrayBufferView browser untuk memblokir blob.

Ketika panjang buffer kurang dari atau sama dengan 256MB, metode ini akan menggunakan 1 panggilan unggahan untuk menyelesaikan unggahan. Jika tidak, metode ini akan memanggil stageBlock untuk mengunggah blok, dan akhirnya memanggil commitBlockList untuk menerapkan daftar blokir.

Opsi blobHTTPHeaders umum diatur adalah , memungkinkan browser untuk menyediakan fungsionalitas berdasarkan jenis file.

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

Parameter

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer atau ArrayBufferView

options
BlockBlobParallelUploadOptions

Opsi untuk mengunggah data browser.

Mengembalikan

Data respons untuk operasi Unggah Blob.

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

Mengunggah objek Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView ke BlockBlob.

Ketika panjang data tidak lebih dari maxSingleShotSize yang ditentukan (defaultnya adalah <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), metode ini akan menggunakan 1 mengunggah panggilan untuk menyelesaikan unggahan. Jika tidak, metode ini akan memanggil stageBlock untuk mengunggah blok, dan akhirnya memanggil commitBlockList untuk menerapkan daftar blokir.

Opsi blobHTTPHeaders umum diatur adalah , memungkinkan browser untuk menyediakan fungsionalitas berdasarkan jenis file.

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

Parameter

data

Blob | ArrayBuffer | ArrayBufferView | Buffer

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

Mengembalikan

uploadFile(string, BlockBlobParallelUploadOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunggah file lokal dalam blok ke blob blok.

Ketika ukuran file kurang dari atau sama dengan 256MB, metode ini akan menggunakan 1 panggilan unggah untuk menyelesaikan unggahan. Jika tidak, metode ini akan memanggil stageBlock untuk mengunggah blok, dan akhirnya memanggil commitBlockList untuk menerapkan daftar blokir.

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

Parameter

filePath

string

Jalur lengkap file lokal

options
BlockBlobParallelUploadOptions

Opsi untuk Mengunggah ke operasi Blok Blob.

Mengembalikan

Data respons untuk operasi Unggah Blob.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunggah aliran Node.js dapat dibaca ke dalam blob blok.

TIPS PENINGKATAN PERFORMA:

  • Input stream highWaterMark lebih baik mengatur nilai yang sama dengan parameter bufferSize, yang akan menghindari operasi Buffer.concat().
function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parameter

stream

Readable

aliran yang dapat dibaca Node.js

bufferSize

number

Ukuran setiap buffer yang dialokasikan, juga ukuran blok dalam blob blok yang diunggah. Nilai defaultnya adalah 8MB

maxConcurrency

number

Konkurensi maksimum menunjukkan jumlah maksimum buffer yang dapat dialokasikan, korelasi positif dengan konkurensi pengunggahan maks. Nilai defaultnya adalah 5

options
BlockBlobUploadStreamOptions

Opsi untuk Mengunggah operasi Stream ke Block Blob.

Mengembalikan

Data respons untuk operasi Unggah Blob.

withSnapshot(string)

Membuat objek BlockBlobClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan URL ke blob dasar.

function withSnapshot(snapshot: string): BlockBlobClient

Parameter

snapshot

string

Tanda waktu rekam jepret.

Mengembalikan

Objek BlockBlobClient baru yang 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 untuk operasi Blob Batalkan Salin Dari URL.

Mengembalikan

Diwarisi DariBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Menyalin blob secara asinkron ke tujuan dalam akun penyimpanan. Metode ini mengembalikan poller operasi jangka panjang yang memungkinkan Anda untuk 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 Copy 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 untuk operasi Blob Mulai Salin Dari URL.

Mengembalikan

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 Blob Create Snapshot.

Mengembalikan

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

Diwariskan 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

Diwariskan DariBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Hapus kebijakan imutablilitas pada blob.

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

Parameter

options
BlobDeleteImmutabilityPolicyOptions

Opsi opsional untuk menghapus kebijakan kekekalan pada blob.

Mengembalikan

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.

  • Di Node.js, data kembali dalam aliran yang dapat dibaca 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 ditentukan

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

Diwariskan DariBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

HANYA TERSEDIA DALAM 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 DALAM 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 DALAM RUNTIME NODE.JS.

Mengunduh Azure Blob ke file lokal. Gagal jika jalur file yang diberikan sudah keluar. Offset dan hitungan bersifat opsional, pass 0 dan undefined 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 ditentukan.

options
BlobDownloadOptions

Opsi untuk opsi pengunduhan Blob.

Mengembalikan

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 mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.

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

Parameter

options
BlobExistsOptions

opsi untuk operasi Ada.

Mengembalikan

Promise<boolean>

Diwariskan 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

getAccountInfo(BlobGetAccountInfoOptions)

Operasi Dapatkan Informasi Akun mengembalikan nama sku dan jenis akun untuk akun yang ditentukan. Operasi Dapatkan Informasi Akun tersedia pada versi layanan yang dimulai dengan versi 2018-03-28.

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

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

Parameter

options
BlobGetAccountInfoOptions

Opsi untuk operasi Info Dapatkan Akun Layanan.

Mengembalikan

Data respons untuk operasi Info Akun Get Service.

Diwarisi DariBlobClient.getAccountInfo

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

Diwariskan 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 opsi includeMetadata, yang akan mempertahankan casing aslinya.

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

Parameter

options
BlobGetPropertiesOptions

Opsi opsional untuk operasi Dapatkan Properti.

Mengembalikan

Diwarisi DariBlobClient.getProperties

getTags(BlobGetTagsOptions)

Mendapatkan tag yang terkait dengan blob yang mendasar.

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

Parameter

Mengembalikan

Diwariskan 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

Diwarisi DariBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Mengatur properti sistem pada 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 blobContentType memungkinkan browser menyediakan fungsionalitas berdasarkan jenis file.

options
BlobSetHTTPHeadersOptions

Opsi opsional untuk operasi Header HTTP Set Blob.

Mengembalikan

Diwariskan DariBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Tetapkan kebijakan kekekalan pada blob.

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

Parameter

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Opsi opsional untuk mengatur kebijakan imutabilitas pada blob.

Mengembalikan

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

Diwariskan DariBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Mengatur metadata yang ditentukan pengguna untuk blob yang ditentukan sebagai satu atau beberapa pasangan nilai nama.

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

Diwariskan 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 atas, 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

Mengembalikan

Diwariskan 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 yang akan disalin, Tanda Tangan Akses Bersama (SAS) mungkin diperlukan untuk autentikasi

Mengembalikan

Diwarisi DariBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Memulihkan konten dan metadata blob yang dihapus sementara dan rekam jepret yang dihapus sementara terkait. Blob batal penghapusan 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 Undelete.

Mengembalikan

Diwariskan 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