Nota
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
En este artículo se muestra cómo usar etiquetas de índice en los blobs para administrar y buscar datos mediante la biblioteca cliente de Azure Storage para JavaScript.
Requisitos previos
- Los ejemplos de este artículo asumen que ya tiene un proyecto configurado para trabajar con la librería cliente Azure Blob Storage para JavaScript. Para obtener más información sobre la configuración del proyecto, incluida la instalación de paquetes, la importación de módulos y la creación de un objeto cliente autorizado para trabajar con recursos de datos, consulte Introducción a Azure Blob Storage y JavaScript.
- El mecanismo de autorización debe tener permisos para trabajar con etiquetas de índice de blob. Para obtener más información, consulte la guía de autorización para las siguientes operaciones de la API de REST:
Escribir etiquetas de índice de blobs
Las etiquetas de índice de blobs clasifican los datos de la cuenta de almacenamiento mediante atributos de etiqueta clave-valor. Estas etiquetas se indexan y se exponen automáticamente como un índice multidimensional que se puede buscar para encontrar fácilmente los datos. En este artículo se muestra cómo establecer, obtener y buscar datos mediante etiquetas de índice de blobs.
Las etiquetas de índice de blobs no se admiten para las cuentas de almacenamiento con el espacio de nombres jerárquico habilitado. Para obtener más información sobre la característica de etiqueta de índice de blobs junto con las limitaciones y los problemas conocidos, consulte Administración y búsqueda de datos de Azure Blob con etiquetas de índice de blobs.
Definición de etiquetas
Puede establecer etiquetas de índice si el código tiene el acceso autorizado a los datos de los blobs mediante uno de los siguientes mecanismos:
- Entidad de seguridad asignada a un rol RBAC de Azure con la acción Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/write. El propietario de datos de blobs de Storage es un rol integrado que incluye esta acción.
- Firma de acceso compartido (SAS) con permiso para acceder a las etiquetas del blob (permiso
t
) - Clave de cuenta
Para más información, vea Configuración de etiquetas de índice de blobs.
Puede establecer etiquetas mediante cualquiera de los métodos siguientes:
Las etiquetas especificadas en este método reemplazan las etiquetas existentes. Si es necesario conservar los valores antiguos, deben descargarse e incluirse en la llamada a este método. En el siguiente ejemplo se muestra cómo establecer etiquetas:
async function setBlobTags(containerClient, blobName) {
const blockBlobClient = await containerClient.getBlockBlobClient(blobName);
const tags = {
'Sealed': 'false',
'Content': 'image',
'Date': '2022-07-18',
}
// Set tags
await blockBlobClient.setTags(tags);
}
Puede eliminar todas las etiquetas pasando un objeto JSON vacío al método setTags
.
Obtener etiquetas
Puede obtener etiquetas de índice si el código tiene el acceso autorizado a los datos de los blobs mediante uno de los siguientes mecanismos:
- Entidad de seguridad asignada a un rol RBAC de Azure con la acción Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/read. El propietario de datos de blobs de Storage es un rol integrado que incluye esta acción.
- Firma de acceso compartido (SAS) con permiso para acceder a las etiquetas del blob (permiso
t
) - Clave de cuenta
Para más información, consulte Obtención y enumeración de etiquetas de índice de blobs.
Puede obtener etiquetas mediante el método siguiente:
En el ejemplo siguiente se muestra cómo recuperar e iterar en las etiquetas del blob.
async function getBlobTags(containerClient, blobName) {
const blockBlobClient = await containerClient.getBlockBlobClient(blobName);
// Get tags
const result = await blockBlobClient.getTags();
for (const tag in result.tags) {
console.log(`TAG: ${tag}: ${result.tags[tag]}`);
}
}
Filtrado y búsqueda de datos con etiquetas de índice de blobs
Puede usar etiquetas de índice para buscar y filtrar datos si el código tiene el acceso autorizado a los datos de los blobs mediante uno de los siguientes mecanismos:
- Entidad de seguridad asignada a un rol RBAC de Azure con la acción Microsoft.Storage/storageAccounts/blobServices/containers/blobs/filter/action. El propietario de datos de blobs de Storage es un rol integrado que incluye esta acción.
- Firma de acceso compartido (SAS) con permiso para filtrar blobs por etiquetas (permiso
f
) - Clave de cuenta
Para más información, consulte Búsqueda de datos mediante etiquetas de índice de blobs.
Nota:
No se pueden utilizar etiquetas de índice para recuperar versiones anteriores. Las etiquetas de las versiones anteriores no se pasan al motor de índices de blobs. Para más información, consulte Condiciones y problemas conocidos.
Los datos se consultan con un objeto JSON enviado como una cadena. Las propiedades no necesitan comillas de cadena adicionales, pero los valores sí.
En la tabla siguiente se muestran algunas cadenas de consulta:
Cadena de consulta para etiquetas (tagOdataQuery) | Descripción |
---|---|
id='1' AND project='billing' |
Filtre los blobs de todos los contenedores en función de estas dos propiedades. |
owner='PhillyProject' AND createdOn >= '2021-12' AND createdOn <= '2022-06' |
Filtre los blobs de todos los contenedores en función del valor de propiedad estricto para owner y el intervalo de fechas para la propiedad createdOn . |
@container = 'my-container' AND createdBy = 'Jill' |
Filtre por contenedor y propiedad específica. En esta consulta, createdBy es una coincidencia de texto y no indica una coincidencia de autorización a través de Active Directory. |
Puede buscar datos mediante los métodos siguientes:
En el ejemplo siguiente se buscan todos los blobs que coinciden con el parámetro tagOdataQuery
.
async function findBlobsByQuery(blobServiceClient, tagOdataQuery) {
// page size
const maxPageSize = 10;
let i = 1;
let marker;
const listOptions = {
includeMetadata: true,
includeSnapshots: false,
includeTags: true,
includeVersions: false
};
let iterator = blobServiceClient.findBlobsByTags(tagOdataQuery, listOptions).byPage({ maxPageSize });
let response = (await iterator.next()).value;
// Prints blob names
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name} - ${JSON.stringify(blob.tags)}`);
}
}
// Gets next marker
marker = response.continuationToken;
// no more blobs
if (!marker) return;
// Passing next marker as continuationToken
iterator = blobServiceClient
.findBlobsByTags(tagOdataQuery, listOptions)
.byPage({ continuationToken: marker, maxPageSize });
response = (await iterator.next()).value;
// Prints blob names
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name} - ${JSON.stringify(blob.tags)}`);
}
}
}
En la salida de ejemplo de esta función se muestran los blobs coincidentes y sus etiquetas, en función del código console.log de la función anterior:
Response |
---|
Blob 1: set-tags-1650565920363-query-by-tag-blob-a-1.txt - {"createdOn":"2022-01","owner":"PhillyProject","project":"set-tags-1650565920363"} |
Recursos
Para más información sobre cómo usar las etiquetas de índice para administrar y buscar datos mediante la biblioteca cliente de Azure Blob Storage para JavaScript, consulte los siguientes recursos.
Ejemplos de código
- Ver JavaScript y ejemplos de código de TypeScript de este artículo (GitHub)
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 biblioteca cliente para administrar y usar etiquetas de índice de blobs usan las siguientes operaciones de la API REST:
- Get Blob Tags (API REST)
- Set Blob Tags (API REST)
- Find Blobs by Tags (API REST)
Recursos de la biblioteca cliente
- Documentación de referencia de la biblioteca cliente
- Código fuente de la biblioteca del cliente
- Paquete (npm)