PageBlobClient class

Referensi

Paket:: @azure/storage-blob

PageBlobClient mendefinisikan serangkaian operasi yang berlaku untuk blob halaman.

Extends: BlobClient

Konstruktor

PageBlobClient(string, PipelineLike)	Membuat instans PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Membuat instans PageBlobClient. 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. Jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL.
PageBlobClient(string, string, string, StoragePipelineOptions)	Membuat instans PageBlobClient.

Properti

accountName
containerName	Nama kontainer penyimpanan yang dikaitkan dengan blob.
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.
name	Nama blob.
url	Nilai string URL yang dikodekan.

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.
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.
clearPages(number, number, PageBlobClearPagesOptions)	Membebaskan halaman yang ditentukan dari blob halaman.
create(number, PageBlobCreateOptions)	Membuat blob halaman dengan panjang yang ditentukan. Panggil uploadPages untuk mengunggah data data ke blob halaman.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Membuat blob halaman dengan panjang yang ditentukan. Panggil uploadPages untuk mengunggah data data ke blob halaman. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah.
createSnapshot(BlobCreateSnapshotOptions)	Membuat rekam jepret baca-saja dari 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.
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.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Hapus kebijakan immutablility 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 readableStreamBody Di browser, data kembali dalam blobBody janji
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>.
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>.
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.
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.
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.
getAppendBlobClient()	Membuat objek AppendBlobClient.
getBlobLeaseClient(string)	<xref:BlobLeaseClient> Dapatkan yang mengelola sewa pada blob.
getBlockBlobClient()	Membuat objek BlockBlobClient.
getPageBlobClient()	Membuat objek PageBlobClient.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Mengembalikan daftar rentang halaman yang valid untuk blob halaman atau rekam jepret blob halaman.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Mendapatkan kumpulan rentang halaman yang berbeda antara rekam jepret tertentu dan blob halaman ini.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Mendapatkan kumpulan rentang halaman yang berbeda antara rekam jepret tertentu dan blob halaman ini untuk disk terkelola.
getProperties(BlobGetPropertiesOptions)	Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk blob. Ini tidak mengembalikan konten blob.
getTags(BlobGetTagsOptions)	Mendapatkan tag yang terkait dengan blob yang mendasar.
resize(number, PageBlobResizeOptions)	Mengubah ukuran blob halaman ke ukuran yang ditentukan (yang harus kelipatan 512).
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.
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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Tetapkan kebijakan immutablility 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 nama-nilai. Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter , metadata blob akan dihapus.
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 ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Memulai operasi untuk memulai salinan bertahap dari rekam jepret blob satu halaman ke blob halaman ini. Rekam jepret disalin sedih sehingga hanya perubahan diferensial antara rekam jepret yang disalin sebelumnya yang ditransfer ke tujuan. Salinan bayangan yang disalin adalah salinan lengkap dari rekam jepret asli dan dapat dibaca atau disalin dari seperti biasa.
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.
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.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Mengatur nomor urut blob halaman.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Menulis 1 halaman atau lebih ke blob halaman. Offset awal dan akhir harus kelipatan 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Operasi Unggah Halaman menulis rentang halaman ke blob halaman tempat konten dibaca dari URL.
withSnapshot(string)	Membuat objek PageBlobClient baru yang identik dengan sumbernya tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan Klien ke blob dasar.
withVersion(string)	Membuat objek BlobClient baru yang menunjuk ke versi blob ini. Berikan "" akan menghapus versionId dan mengembalikan Klien ke blob dasar.

Detail Konstruktor

PageBlobClient(string, PipelineLike)

Membuat instans PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parameter

url: string

String Klien yang menunjuk ke blob halaman Azure Storage, seperti "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

pipeline: PipelineLike

Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

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

Membuat instans PageBlobClient. 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. Jika nama blob menyertakan ? atau %, nama blob harus dikodekan dalam URL.

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

Parameter

url: string

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.

PageBlobClient(string, string, string, StoragePipelineOptions)

Membuat instans PageBlobClient.

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

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>

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

clearPages(number, number, PageBlobClearPagesOptions)

Membebaskan halaman yang ditentukan dari blob halaman.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Parameter

offset: number

Memulai posisi byte halaman untuk menghapus.

count: number

Jumlah byte yang akan dihapus.

options: PageBlobClearPagesOptions

Opsi untuk operasi Halaman Blob Clear Pages.

Mengembalikan

Promise<PageBlobClearPagesResponse>

Data respons untuk operasi Halaman Blob Clear Pages.

create(number, PageBlobCreateOptions)

Membuat blob halaman dengan panjang yang ditentukan. Panggil uploadPages untuk mengunggah data data ke blob halaman.

function create(size: number, options?: PageBlobCreateOptions)

Parameter

size: number

ukuran blob halaman.

options: PageBlobCreateOptions

Opsi ke operasi Buat Blob Halaman.

Mengembalikan

Promise<PageBlobCreateResponse>

Data respons untuk operasi Buat Blob Halaman.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Membuat blob halaman dengan panjang yang ditentukan. Panggil uploadPages untuk mengunggah data data ke blob halaman. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Parameter

size: number

ukuran blob halaman.

options: PageBlobCreateIfNotExistsOptions

Mengembalikan

Promise<PageBlobCreateIfNotExistsResponse>

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

options: BlobDeleteImmutabilityPolicyOptions

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.

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

Membuat objek AppendBlobClient.

function getAppendBlobClient()

Mengembalikan

AppendBlobClient

getBlobLeaseClient(string)

<xref:BlobLeaseClient> Dapatkan yang mengelola sewa pada blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Parameter

proposeLeaseId: string

Id sewa awal yang diusulkan.

Mengembalikan

BlobLeaseClient

Objek BlobLeaseClient baru untuk mengelola sewa pada blob.

getBlockBlobClient()

Membuat objek BlockBlobClient.

function getBlockBlobClient()

Mengembalikan

BlockBlobClient

getPageBlobClient()

Membuat objek PageBlobClient.

function getPageBlobClient()

Mengembalikan

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Mengembalikan daftar rentang halaman yang valid untuk blob halaman atau rekam jepret blob halaman.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Parameter

offset: number

Memulai posisi byte dari rentang halaman.

count: number

Jumlah byte yang akan didapatkan.

options: PageBlobGetPageRangesOptions

Opsi untuk operasi Dapatkan Rentang Blob Halaman.

Mengembalikan

Promise<PageBlobGetPageRangesResponse>

Data respons untuk operasi Dapatkan Rentang Blob Halaman.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Mendapatkan kumpulan rentang halaman yang berbeda antara rekam jepret tertentu dan blob halaman ini.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Parameter

offset: number

Memulai posisi byte dari blob halaman

count: number

Jumlah byte untuk mendapatkan rentang berbeda.

prevSnapshot: string

Tanda waktu rekam jepret untuk mengambil perbedaannya.

options: PageBlobGetPageRangesDiffOptions

Opsi untuk operasi Diff Rentang Halaman Get Blob Halaman.

Mengembalikan

Promise<PageBlobGetPageRangesDiffResponse>

Data respons untuk operasi Diff Rentang Halaman Get Blob Halaman.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Mendapatkan kumpulan rentang halaman yang berbeda antara rekam jepret tertentu dan blob halaman ini untuk disk terkelola.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Parameter

offset: number

Memulai posisi byte dari blob halaman

count: number

Jumlah byte untuk mendapatkan rentang berbeda.

prevSnapshotUrl: string

URL rekam jepret untuk mengambil perbedaannya.

options: PageBlobGetPageRangesDiffOptions

Opsi untuk operasi Diff Rentang Halaman Get Blob Halaman.

Mengembalikan

Promise<PageBlobGetPageRangesDiffResponse>

Data respons untuk operasi Diff Rentang Halaman Get Blob Halaman.

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>

resize(number, PageBlobResizeOptions)

Mengubah ukuran blob halaman ke ukuran yang ditentukan (yang harus kelipatan 512).

function resize(size: number, options?: PageBlobResizeOptions)

Parameter

size: number

Ukuran target

options: PageBlobResizeOptions

Opsi untuk operasi Mengubah Ukuran Blob Halaman.

Mengembalikan

Promise<PageBlobResizeResponse>

Data respons untuk operasi Mengubah Ukuran Blob Halaman.

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>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Memulai operasi untuk memulai salinan bertahap dari rekam jepret blob satu halaman ke blob halaman ini. Rekam jepret disalin sedih sehingga hanya perubahan diferensial antara rekam jepret yang disalin sebelumnya yang ditransfer ke tujuan. Salinan bayangan yang disalin adalah salinan lengkap dari rekam jepret asli dan dapat dibaca atau disalin dari seperti biasa.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Parameter

copySource: string

Menentukan nama rekam jepret blob halaman sumber. Misalnya, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options: PageBlobStartCopyIncrementalOptions

Opsi ke operasi Inkremental Salinan Blob Halaman.

Mengembalikan

Promise<PageBlobCopyIncrementalResponse>

Data respons untuk operasi Inkremental Salinan Blob Halaman.

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>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Mengatur nomor urut blob halaman.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Parameter

sequenceNumberAction: SequenceNumberActionType

Menunjukkan bagaimana layanan harus memodifikasi nomor urut blob.

sequenceNumber: number

Diperlukan jika sequenceNumberAction maksimal atau diperbarui

options: PageBlobUpdateSequenceNumberOptions

Opsi ke operasi Nomor Urutan Pembaruan Blob Halaman.

Mengembalikan

Promise<PageBlobUpdateSequenceNumberResponse>

Data respons untuk operasi Nomor Urutan Pembaruan Blob Halaman.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Menulis 1 halaman atau lebih ke blob halaman. Offset awal dan akhir harus kelipatan 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Parameter

body: HttpRequestBody

Data yang akan diunggah

offset: number

Offset blob halaman tujuan

count: number

Panjang konten isi, juga jumlah byte yang akan diunggah

options: PageBlobUploadPagesOptions

Opsi untuk operasi Halaman Unggah Blob Halaman.

Mengembalikan

Promise<PageBlobUploadPagesResponse>

Data respons untuk operasi Halaman Unggah Blob Halaman.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

Operasi Unggah Halaman menulis rentang halaman ke blob halaman tempat konten dibaca dari URL.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Parameter

sourceURL: string

Tentukan URL ke sumber salinan, Tanda Tangan Akses Bersama (SAS) mungkin diperlukan untuk autentikasi

sourceOffset: number

Offset sumber untuk disalin. Teruskan 0 untuk menyalin dari awal blob halaman sumber

destOffset: number

Offset blob halaman tujuan

count: number

Jumlah byte yang akan diunggah dari blob halaman sumber

options: PageBlobUploadPagesFromURLOptions

Mengembalikan

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Membuat objek PageBlobClient 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)

Parameter

snapshot: string

Tanda waktu rekam jepret.

Mengembalikan

PageBlobClient

Objek PageBlobClient 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

BlobClient

Objek BlobClient baru yang menunjuk ke versi blob ini.

Bagikan melalui

PageBlobClient class

Konstruktor

Properti

Metode

Detail Konstruktor

PageBlobClient(string, PipelineLike)

Parameter

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

Parameter

PageBlobClient(string, string, string, StoragePipelineOptions)

Parameter

Detail Properti

accountName

Nilai Properti

containerName

Nilai Properti

credential

Nilai Properti

name

Nilai Properti

url

Nilai Properti

Detail Metode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parameter

Mengembalikan

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parameter

Mengembalikan

clearPages(number, number, PageBlobClearPagesOptions)

Parameter

Mengembalikan

create(number, PageBlobCreateOptions)

Parameter

Mengembalikan

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Parameter

Mengembalikan

createSnapshot(BlobCreateSnapshotOptions)

Parameter

Mengembalikan

delete(BlobDeleteOptions)

Parameter

Mengembalikan

deleteIfExists(BlobDeleteOptions)

Parameter

Mengembalikan

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parameter

Mengembalikan

download(number, number, BlobDownloadOptions)

Parameter

Mengembalikan

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parameter

Mengembalikan

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parameter

Mengembalikan

downloadToFile(string, number, number, BlobDownloadOptions)

Parameter

Mengembalikan

exists(BlobExistsOptions)

Parameter

Mengembalikan

generateSasUrl(BlobGenerateSasUrlOptions)

Parameter

Mengembalikan

getAppendBlobClient()

Mengembalikan

getBlobLeaseClient(string)

Parameter

Mengembalikan

getBlockBlobClient()

Mengembalikan

getPageBlobClient()

Mengembalikan

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parameter