Compartir a través de

Administración de propiedades y metadatos de blobs con JavaScript

  • Artículo

Además de los datos que contienen, los blobs admiten propiedades del sistema y metadatos definidos por el usuario. En este artículo se muestra cómo administrar propiedades del sistema y metadatos definidos por el usuario con la biblioteca cliente de Azure Storage para JavaScript.

Requisitos previos

Acerca de las propiedades y los metadatos

  • Propiedades del sistema: en cada recurso de almacenamiento de blobs existen propiedades del sistema. Algunas se pueden leer o establecer, mientras que otras son de solo lectura. En segundo plano, algunas propiedades del sistema corresponden a ciertos encabezados HTTP estándar. La biblioteca cliente de Azure Storage para JavaScript mantiene estas propiedades automáticamente.

  • Metadatos definidos por el usuario: los metadatos definidos por el usuario se componen de uno o más pares nombre-valor que especifica para un recurso de almacenamiento de blobs. Puede usar metadatos para almacenar valores adicionales con el recurso. Los valores de metadatos se proporcionan para uso personal y no afectan a cómo se comporta el recurso.

    Los pares de nombre/valor de metadatos son encabezados HTTP válidos y deben cumplir todas las restricciones que gobiernan los encabezados HTTP. Para obtener más información sobre los requisitos de nomenclatura de metadatos, consulte Nombres de metadatos.

Nota:

Las etiquetas del índice de blobs ofrecen la capacidad de almacenar atributos arbitrarios de clave-valor definidas por el usuario junto con un recurso de Azure Blob Storage. De manera similar a los metadatos, solo las etiquetas del índice de blobs se indexan automáticamente y son objeto de búsquedda mediante el Blob service nativo. Los metadatos no se pueden indexar ni consultar, a menos que se use un servicio independiente, como Azure Search.

Para obtener más información sobre esta característica, vea Administración y búsqueda de datos en Azure Blob Storage con el índice de blobs (versión preliminar).

Establecimiento y recuperación de propiedades

Para establecer propiedades en un blob, use el método siguiente:

En el ejemplo de código siguiente se establecen las propiedades del sistema blobContentType y blobContentLanguage en un blob.

Se borran todas las propiedades no establecidas explícitamente. En el siguiente ejemplo de código se obtienen primero las propiedades existentes en el blob y, a continuación, se usan para rellenar los encabezados que no se están actualizando.

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);
}

Para recuperar propiedades en un blob, use el método siguiente:

En el ejemplo de código siguiente se obtienen las propiedades del sistema de un blob y se muestran algunos de los valores:

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}`);
}

Establecimiento y recuperación de metadatos

Puede especificar metadatos como uno o más pares nombre-valor en un recurso de blob o contenedor. Para establecer metadatos, envíe un objeto Metadata que contenga pares nombre-valor con el siguiente método:

El siguiente ejemplo de código establece los metadatos de un blob:

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

  await blobClient.setMetadata(metadata);
}

Para recuperar metadatos, llame al método getProperties en el blob para rellenar la colección de metadatos y, a continuación, lea los valores de la propiedad de metadatos. El getProperties método recupera las propiedades y los metadatos del blob llamando a la Get Blob Properties operación y a la Get Blob Metadata operación.

Recursos

Para obtener más información sobre cómo administrar las propiedades del sistema y los metadatos definidos por el usuario usando la biblioteca cliente de Azure Blob Storage para JavaScript, consulte los siguientes recursos.

Ejemplos de código

Operaciones de API REST

El SDK de Azure para JavaScript contiene bibliotecas que se crean a partir de la API REST de Azure, lo que le permite interactuar con las operaciones de API REST a través de paradigmas conocidos de JavaScript. Los métodos de la biblioteca cliente para administrar las propiedades del sistema y los metadatos definidos por el usuario usan las siguientes operaciones de la API de REST:

Recursos de la biblioteca cliente

Contenido relacionado

  • Este artículo forma parte de la guía para desarrolladores de Blob Storage para JavaScript/Typescript. Para obtener más información, consulte la lista completa de artículos de la guía para desarrolladores en Compilación de la aplicación JavaScript/Typescript.