Mengelola properti blob dan metadata dengan JavaScript

• .NET
• Java
• JavaScript
• Python
• Go

Selain data yang dikandungnya, blob mendukung properti sistem dan metadata yang ditentukan pengguna. Artikel ini menunjukkan cara mengelola properti sistem dan metadata yang ditentukan pengguna dengan Pustaka klien Azure Storage untuk JavaScript.

Prasyarat

• Contoh dalam artikel ini mengasumsikan Anda sudah menyiapkan proyek untuk bekerja dengan pustaka klien Azure Blob Storage untuk JavaScript. Untuk mempelajari tentang menyiapkan proyek Anda, termasuk penginstalan paket, mengimpor modul, dan membuat objek klien resmi untuk bekerja dengan sumber daya data, lihat Mulai menggunakan Azure Blob Storage dan JavaScript.
• Mekanisme otorisasi harus memiliki izin untuk bekerja dengan properti blob atau metadata. Untuk mempelajari lebih lanjut, lihat panduan otorisasi untuk operasi REST API berikut:
  • Set properti Blob
  • Dapatkan Properti di Blob
  • Set Metadata Blob
  • Get Metadata Blob

Tentang properti dan metadata

• Properti sistem: Properti sistem ada di setiap sumber daya penyimpanan Blob. Beberapa dari mereka dapat dibaca atau diatur, sementara yang lain baca-saja. Di bawah sampul, beberapa properti sistem sesuai dengan header HTTP standar tertentu. Pustaka klien Azure Storage untuk JavaScript mengelola properti ini untuk Anda.

• Metadata yang ditentukan pengguna: Metadata yang ditentukan pengguna terdiri dari satu atau beberapa pasangan nama-nilai yang Anda tentukan untuk sumber daya penyimpanan Blob. Anda dapat menggunakan metadata untuk menyimpan nilai tambahan dengan sumber daya. Nilai metadata hanya untuk tujuan Anda sendiri, dan tidak memengaruhi perilaku sumber daya.

  Pasangan nama/nilai metadata adalah header HTTP yang valid dan harus mematuhi semua batasan yang mengatur header HTTP. Untuk informasi selengkapnya tentang persyaratan penamaan metadata, lihat Nama metadata.

Catatan

Tag indeks blob juga menyediakan kemampuan untuk menyimpan atribut kunci/nilai yang ditentukan pengguna bersama sumber daya penyimpanan Azure Blob. Meskipun mirip dengan metadata, hanya tag indeks blob yang secara otomatis diindeks dan dibuat dapat dicari oleh layanan blob asli. Metadata tidak dapat diindeks dan dikueri kecuali Anda menggunakan layanan terpisah seperti Azure Search.

Untuk mempelajari fitur ini selengkapnya, lihat Kelola dan temukan data di penyimpanan Azure Blob dengan indeks blob (pratinjau).

Atur dan ambil properti

Untuk mengatur properti pada blob, gunakan metode berikut:

• BlobClient.setHTTPHeaders

Contoh kode berikut mengatur properti sistem blobContentType dan blobContentLanguage pada blob.

Properti apa pun yang tidak disetel secara eksplisit akan dibersihkan. Contoh kode berikut terlebih dahulu mendapatkan properti yang ada pada blob, lalu menggunakannya untuk mengisi header yang tidak sedang diperbarui.

JavaScript

async function setHTTPHeaders(blobClient, headers) {
  
  // Get existing properties
  const properties = await blobClient.getProperties();

  // Set the blobContentType and blobContentLanguage headers
  // Populate the remaining headers from the existing properties
  blobHeaders = {
    blobContentType: 'text/plain',
    blobContentLanguage: 'en-us',
    blobContentEncoding: properties.contentEncoding,
    blobCacheControl: properties.cacheControl,
    blobContentDisposition: properties.contentDisposition,
    blobContentMD5: properties.contentMD5
  },

  await blobClient.setHTTPHeaders(blobHeaders);
}

TypeScript

async function setHTTPHeaders(
  blobClient: BlobClient
): Promise<void> {

  // Get existing properties
  const properties = await blobClient.getProperties();

  // Set the blobContentType and blobContentLanguage headers
  // Populate the remaining headers from the existing properties
  const blobHeaders: BlobHTTPHeaders = {
    blobContentType: 'text/plain',
    blobContentLanguage: 'en-us',
    blobContentEncoding: properties.contentEncoding,
    blobCacheControl: properties.cacheControl,
    blobContentDisposition: properties.contentDisposition,
    blobContentMD5: properties.contentMD5
  };

  await blobClient.setHTTPHeaders(blobHeaders);
}

Untuk mengambil properti pada blob, gunakan metode berikut:

• getProperties

Contoh kode berikut mendapatkan properti sistem blob dan menampilkan beberapa nilai:

JavaScript

async function getProperties(blobClient) {

  const properties = await blobClient.getProperties();
  
  console.log(`blobType: ${properties.blobType}`);
  console.log(`contentType: ${properties.contentType}`);
  console.log(`contentLength: ${properties.contentLength}`);
  console.log(`lastModified: ${properties.lastModified}`);
}

TypeScript

async function getProperties(
  blobClient: BlobClient
): Promise<void> {
  
  const propertiesResponse: BlobGetPropertiesResponse =
    await blobClient.getProperties();

  console.log(`blobType: ${propertiesResponse.blobType}`);
  console.log(`contentType: ${propertiesResponse.contentType}`);
  console.log(`contentLength: ${propertiesResponse.contentLength}`);
  console.log(`lastModified: ${propertiesResponse.lastModified}`);
}

Atur dan ambil metadata

Anda dapat menentukan metadata sebagai satu atau beberapa pasangan nama-nilai pada sumber daya blob atau kontainer. Untuk mengatur metadata, kirim objek Metadata yang berisi pasangan nama-nilai menggunakan metode berikut:

• BlobClient.setMetadata

Contoh kode berikut menetapkan metadata pada blob:

JavaScript

async function setBlobMetadata(blobClient, metadata) {
  
  metadata = {
    docType: 'text',
    category: 'reference'
  };

  await blobClient.setMetadata(metadata);
}

TypeScript

async function setBlobMetadata(
  blobClient: BlobClient
): Promise<void> {

  const metadata: Metadata = {
    docType: 'text',
    category: 'reference'
  };

  await blobClient.setMetadata(metadata);
}

Untuk mengambil metadata, panggil metode getProperties pada blob Anda untuk mengisi koleksi metadata, lalu baca nilai dari properti metadata . Metode ini getProperties mengambil properti blob dan metadata dengan memanggil Get Blob Properties operasi dan Get Blob Metadata operasi.

Sumber

Untuk mempelajari selengkapnya tentang cara mengelola properti sistem dan metadata yang ditentukan pengguna menggunakan pustaka klien Azure Blob Storage untuk JavaScript, lihat sumber daya berikut ini.

Sampel kode

• Lihat sampel kode JavaScript dan TypeScript dari artikel ini (GitHub)

Operasi REST API

Azure SDK untuk JavaScript berisi pustaka yang dibangun di atas Azure REST API, memungkinkan Anda berinteraksi dengan operasi REST API melalui paradigma JavaScript yang sudah dikenal. Metode pustaka klien untuk mengelola properti sistem dan metadata yang ditentukan pengguna menggunakan operasi REST API berikut:

• Mengatur Properti Blob (REST API)
• Dapatkan Properti Blob (REST API)
• Mengatur Metadata Blob (REST API)
• Dapatkan Metadata Blob (REST API)

Sumber daya pustaka klien

• Dokumentasi referensi pustaka klien
• Kode sumber pustaka klien
• Paket (npm)

Konten terkait

• Artikel ini adalah bagian dari panduan pengembang Blob Storage untuk JavaScript/TypeScript. Untuk mempelajari lebih lanjut, lihat daftar lengkap artikel panduan pengembang di Membangun aplikasi JavaScript/TypeScript Anda.