AppendBlobClient class

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 diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob mencakup ? atau %, nama blob harus dikodekan dalam URL.

new AppendBlobClient(url: string, pipeline: PipelineLike)

Parameter

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 diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Jika nama blob mencakup ? atau %, nama blob harus dikodekan dalam URL.

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

Parameter

Membuat instans AppendBlobClient.

new AppendBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Parameter

Nama kontainer penyimpanan yang dikaitkan dengan blob.

string containerName

Nilai Properti

Nama blob.

string name

Nilai Properti

accountName: string

Nilai Properti

Diwariskan DariBlobClient.accountName

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

Nilai string URL yang dikodekan.

url: string

Nilai Properti

Diwarisi DariBlobClient.url

Menerapkan blok data baru ke akhir blob penambahan yang ada.

Lihat https://learn.microsoft.com/rest/api/storageservices/append-block

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Parameter

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

Operasi Tambahkan Blok menerapkan blok data baru ke akhir blob penambahan yang ada tempat konten dibaca dari url sumber.

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

Parameter

Mengembalikan

Membuat blob tambahan dengan panjang 0. Panggil AppendBlock untuk menambahkan data ke blob tambahan.

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

Parameter

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

Mengembalikan

Membuat blob tambahan dengan panjang 0. Panggil AppendBlock untuk menambahkan data ke blob tambahan. Jika blob dengan nama yang sama sudah ada, konten blob yang ada akan tetap tidak berubah.

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

Parameter

Mengembalikan

Segel blob tambahan, membuatnya baca saja.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

Parameter

Mengembalikan

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

function withSnapshot(snapshot: string): AppendBlobClient

Parameter

Mengembalikan

Objek AppendBlobClient baru identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan.

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://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Parameter

Mengembalikan

Diwarisi DariBlobClient.abortCopyFromURL

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://learn.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

Mengembalikan

Diwarisi DariBlobClient.beginCopyFromURL

Membuat rekam jepret baca-saja dari blob.

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

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parameter

Mengembalikan

Diwarisi DariBlobClient.createSnapshot

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://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Parameter

Mengembalikan

Diwariskan DariBlobClient.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://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parameter

Mengembalikan

Diwariskan DariBlobClient.deleteIfExists

Hapus kebijakan imutablilitas pada blob.

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

Parameter

Mengembalikan

Diwarisi DariBlobClient.deleteImmutabilityPolicy

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://learn.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parameter

// 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(typeof data === "string" ? Buffer.from(data) : data);
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

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

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

Mengembalikan

Diwarisi DariBlobClient.downloadToBuffer

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

Mengembalikan

Diwarisi DariBlobClient.downloadToBuffer

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

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

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

Mengembalikan

Diwariskan DariBlobClient.exists

Hanya tersedia untuk BlobClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk menandatangani URI Tanda Tangan Akses Bersama (SAS) Blob Service berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parameter

Mengembalikan

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Diwarisi DariBlobClient.generateSasStringToSign

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://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Parameter

Mengembalikan

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Diwarisi DariBlobClient.generateSasUrl

Hanya tersedia untuk BlobClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk menandatangani URI Tanda Tangan Akses Bersama (SAS) Blob Service berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.

Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parameter

Mengembalikan

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Diwarisi DariBlobClient.generateUserDelegationSasStringToSign

Menghasilkan URI Tanda Tangan Akses Bersama (SAS) Blob Service berdasarkan properti dan parameter klien yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.

Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parameter

Mengembalikan

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Diwarisi DariBlobClient.generateUserDelegationSasUrl

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://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information

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

Parameter

Mengembalikan

Data respons untuk operasi Info Akun Get Service.

Diwarisi DariBlobClient.getAccountInfo

Membuat objek AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Mengembalikan

Diwarisi DariBlobClient.getAppendBlobClient

Dapatkan BlobLeaseClient yang mengelola sewa pada blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parameter

Mengembalikan

Objek BlobLeaseClient baru untuk mengelola sewa pada blob.

Diwarisi DariBlobClient.getBlobLeaseClient

Membuat objek BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Mengembalikan

Diwariskan DariBlobClient.getBlockBlobClient

Membuat objek PageBlobClient.

function getPageBlobClient(): PageBlobClient

Mengembalikan

Diwarisi DariBlobClient.getPageBlobClient

Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk blob. Ini tidak mengembalikan konten blob.

Lihat https://learn.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

Mengembalikan

Diwarisi DariBlobClient.getProperties

Mendapatkan tag yang terkait dengan blob yang mendasar.

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

Parameter

Mengembalikan

Diwariskan DariBlobClient.getTags

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://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parameter

Mengembalikan

Diwarisi DariBlobClient.setAccessTier

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://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Parameter

Mengembalikan

Diwariskan DariBlobClient.setHTTPHeaders

Tetapkan kebijakan kekekalan pada blob.

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

Parameter

Mengembalikan

Diwarisi DariBlobClient.setImmutabilityPolicy

Tetapkan penahanan legal pada blob.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parameter

Mengembalikan

Diwariskan DariBlobClient.setLegalHold

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://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Parameter

Mengembalikan

Diwariskan DariBlobClient.setMetadata

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

Mengembalikan

Diwariskan DariBlobClient.setTags

Operasi Salin Dari URL sinkron menyalin blob atau sumber daya internet ke blob baru. Ini tidak akan mengembalikan respons sampai salinan selesai.

Lihat https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Parameter

Mengembalikan

Diwarisi DariBlobClient.syncCopyFromURL

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://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parameter

Mengembalikan

Diwariskan DariBlobClient.undelete

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

Mengembalikan

Objek BlobClient baru yang menunjuk ke versi blob ini.

Diwarisi DariBlobClient.withVersion