Compartir a través de

BlobClient class

  • Referencia
Paquete:
@azure/storage-blob

Un BlobClient representa una dirección URL a un blob de Azure Storage; el blob puede ser un blob en bloques, un blob en anexos o un blob en páginas.

Extends

StorageClient

Constructores

BlobClient(string, PipelineLike)

Crea una instancia de BlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob. La cadena de dirección URL codificada NO se escapará dos veces, solo se escaparán los caracteres especiales de la ruta de acceso de dirección URL. Si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL.
BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea una instancia de BlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob. La cadena de dirección URL codificada NO se escapará dos veces, solo se escaparán los caracteres especiales de la ruta de acceso de dirección URL. Si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL.
BlobClient(string, string, string, StoragePipelineOptions)

Crea una instancia de BlobClient a partir de la cadena de conexión.

Propiedades

containerName

Nombre del contenedor de almacenamiento al que está asociado el blob.
name

Nombre del blob.

Propiedades heredadas

accountName
credential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.
url

Valor de cadena de dirección URL codificada.

Métodos

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Anula una operación de copia asincrónica pendiente de blob y deja un blob de destino con una longitud cero y metadatos completos. Versión 2012-02-12 y posteriores.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copia de forma asincrónica un blob en un destino dentro de la cuenta de almacenamiento. Este método devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la copia. También puede cancelar una copia antes de que se complete llamando a cancelOperation en el sondeo. Tenga en cuenta que la devolución de llamada onProgress no se invocará si la operación se completa en la primera solicitud y si se intenta cancelar una copia completada, se producirá un error.

En la versión 2012-02-12 y versiones posteriores, el origen de una operación de copia de blobs puede ser un blob confirmado en cualquier cuenta de Azure Storage. A partir de la versión 2015-02-21, el origen de una operación de copia de blobs puede ser un archivo de Azure en cualquier cuenta de Azure Storage. Solo las cuentas de almacenamiento creadas el 7 de junio de 2012 solo permiten que la operación Copiar blob se copie desde otra cuenta de almacenamiento.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Ejemplo de uso del sondeo automático:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Ejemplo de uso del sondeo manual:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Ejemplo de uso de actualizaciones de progreso:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Ejemplo con un intervalo de sondeo cambiante (valor predeterminado de 15 segundos):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Ejemplo de uso de la cancelación de copia:

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.');
  }
}
createSnapshot(BlobCreateSnapshotOptions)

Crea una instantánea de solo lectura de un blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)

Marca el blob o la instantánea especificados para su eliminación. El blob se elimina más adelante durante la recolección de elementos no utilizados. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo con la operación Eliminar blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)

Marca el blob o la instantánea especificados para su eliminación si existe. El blob se elimina más adelante durante la recolección de elementos no utilizados. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo con la operación Eliminar blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Elimine la directiva de immutablility en el blob.
download(number, number, BlobDownloadOptions)

Lee o descarga un blob del sistema, incluidos sus metadatos y propiedades. También puede llamar a Get Blob para leer una instantánea.

  • En Node.js, los datos devuelven en una secuencia legibleStreamBody legible
  • En los exploradores, los datos se devuelven en un blobBody de promesa

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Descarga un blob de Azure en paralelo a un búfer. El desplazamiento y el recuento son opcionales, descarga todo el blob si no se proporcionan.

Advertencia: los búferes solo pueden admitir archivos de hasta un gigabyte en sistemas de 32 bits o aproximadamente dos gigabytes en sistemas de 64 bits debido a limitaciones de Node.js/V8. En el caso de los blobs de mayor tamaño, considere la posibilidad de downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Descarga un blob de Azure en paralelo a un búfer. El desplazamiento y el recuento son opcionales, descarga todo el blob si no se proporcionan.

Advertencia: los búferes solo pueden admitir archivos de hasta un gigabyte en sistemas de 32 bits o aproximadamente dos gigabytes en sistemas de 64 bits debido a limitaciones de Node.js/V8. En el caso de los blobs de mayor tamaño, considere la posibilidad de downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Descarga un blob de Azure en un archivo local. Se produce un error si la ruta de acceso del archivo especificada ya se cierra. El desplazamiento y el recuento son opcionales, pasan 0 y sin definir respectivamente para descargar todo el blob.
exists(BlobExistsOptions)

Devuelve true si el recurso de blob de Azure representado por este cliente existe; False en caso contrario.

NOTA: Use esta función con cuidado, ya que otros clientes o aplicaciones pueden eliminar un blob existente. Viceversa, es posible que otros clientes o aplicaciones agreguen nuevos blobs después de que se complete esta función.
generateSasUrl(BlobGenerateSasUrlOptions)

Solo está disponible para BlobClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de Blob Service basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)

La operación Obtener información de la cuenta devuelve el nombre de SKU y el tipo de cuenta de la cuenta especificada. La operación Obtener información de la cuenta está disponible en las versiones de servicio a partir de la versión 2018-03-28.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()

Crea un objeto AppendBlobClient.
getBlobLeaseClient(string)

Obtenga un BlobLeaseClient que administre concesiones en el blob.
getBlockBlobClient()

Crea un objeto BlockBlobClient.
getPageBlobClient()

Crea un objeto PageBlobClient.
getProperties(BlobGetPropertiesOptions)

Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el blob. No devuelve el contenido del blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

ADVERTENCIA: El objeto metadata devuelto en la respuesta tendrá sus claves en minúsculas, incluso si originalmente contenían caracteres en mayúsculas. Esto difiere de las claves de metadatos devueltas por los métodos de ContainerClient que enumeran blobs mediante la opción includeMetadata, que conservará su mayúscula y minúscula original.
getTags(BlobGetTagsOptions)

Obtiene las etiquetas asociadas al blob subyacente.
setAccessTier(string, BlobSetTierOptions)

Establece el nivel en un blob. La operación se permite en un blob en páginas en una cuenta de Premium Storage y en un blob en bloques en una cuenta de almacenamiento de blobs (solo almacenamiento con redundancia local). El nivel de un blob en páginas Premium determina el tamaño permitido, las IOPS y el ancho de banda del blob. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Establece las propiedades del sistema en el blob.

Si no se proporciona ningún valor o ningún valor proporcionado para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Establezca la directiva de inmutabilidad en el blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)

Establezca la suspensión legal en el blob.
setMetadata(Metadata, BlobSetMetadataOptions)

Establece los metadatos definidos por el usuario para el blob especificado como uno o varios pares nombre-valor.

Si no se proporciona ninguna opción o ningún metadato definido en el parámetro , se quitarán los metadatos del blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

Establece etiquetas en el blob subyacente. Un blob puede tener hasta 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres. Los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres válidos de clave y valor incluyen letras minúsculas y mayúsculas, dígitos (0-9), espacio (' '), más ('+'), menos ('-'), punto ('.'), barra diagonal ('/'), dos puntos (':'), iguales ('=') y subrayado bajo ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

La operación Copy From URL sincrónica copia un blob o un recurso de Internet en un nuevo blob. No devolverá una respuesta hasta que se complete la copia.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)

Restaura el contenido y los metadatos del blob eliminado temporalmente y las instantáneas eliminadas temporalmente asociadas. Undelete Blob solo se admite en la versión 2017-07-29 o posterior.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withSnapshot(string)

Crea un nuevo objeto BlobClient idéntico al origen, pero con la marca de tiempo de instantánea especificada. Proporcione "" quitará la instantánea y devolverá un cliente al blob base.
withVersion(string)

Crea un nuevo objeto BlobClient que apunta a una versión de este blob. Proporcione "" quitará el versionId y devolverá un cliente al blob base.

Detalles del constructor

BlobClient(string, PipelineLike)

Crea una instancia de BlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob. La cadena de dirección URL codificada NO se escapará dos veces, solo se escaparán los caracteres especiales de la ruta de acceso de dirección URL. Si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL.

new BlobClient(url: string, pipeline: PipelineLike)

Parámetros

url

string

Cadena de dirección URL que apunta al blob de Azure Storage, como "https://myaccount.blob.core.windows.net/mycontainer/blob". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob. La cadena de dirección URL codificada NO se escapará dos veces, solo se escaparán los caracteres especiales de la ruta de acceso de dirección URL. Sin embargo, si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL. Por ejemplo, un blob denominado "my?blob%", la dirección URL debe ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline
PipelineLike

Llame a newPipeline() para crear una canalización predeterminada o proporcionar una canalización personalizada.

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

Crea una instancia de BlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob. La cadena de dirección URL codificada NO se escapará dos veces, solo se escaparán los caracteres especiales de la ruta de acceso de dirección URL. Si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL.

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

Parámetros

url

string

Cadena de cliente que apunta a Azure Storage Blob service, como "https://myaccount.blob.core.windows.net". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

options
StoragePipelineOptions

Opcional. Opciones para configurar la canalización HTTP.

BlobClient(string, string, string, StoragePipelineOptions)

Crea una instancia de BlobClient a partir de la cadena de conexión.

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

Parámetros

connectionString

string

Cadena de conexión de la cuenta o una cadena de conexión saS de una cuenta de almacenamiento de Azure. [ Nota: la cadena de conexión de la cuenta solo se puede usar en NODE.JS tiempo de ejecución. ] Ejemplo de cadena de conexión de cuenta: ejemplo de cadena de conexión saS de DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net: 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

Nombre del contenedor.

blobName

string

Nombre del blob.

options
StoragePipelineOptions

Opcional. Opciones para configurar la canalización HTTP.

Detalles de las propiedades

containerName

Nombre del contenedor de almacenamiento al que está asociado el blob.

string containerName

Valor de propiedad

string

name

Nombre del blob.

string name

Valor de propiedad

string

Detalles de las propiedades heredadas

accountName 

accountName: string

Valor de propiedad

string

Heredado de StorageClient.accountName

credential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de propiedad

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

heredado de StorageClient.credential

url

Valor de cadena de dirección URL codificada.

url: string

Valor de propiedad

string

se hereda de StorageClient.url

Detalles del método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Anula una operación de copia asincrónica pendiente de blob y deja un blob de destino con una longitud cero y metadatos completos. Versión 2012-02-12 y posteriores.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

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

Parámetros

copyId

string

Id. de la operación Copiar desde la dirección URL.

options
BlobAbortCopyFromURLOptions

Opciones opcionales para la operación Anular copia desde url del blob.

Devoluciones

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copia de forma asincrónica un blob en un destino dentro de la cuenta de almacenamiento. Este método devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la copia. También puede cancelar una copia antes de que se complete llamando a cancelOperation en el sondeo. Tenga en cuenta que la devolución de llamada onProgress no se invocará si la operación se completa en la primera solicitud y si se intenta cancelar una copia completada, se producirá un error.

En la versión 2012-02-12 y versiones posteriores, el origen de una operación de copia de blobs puede ser un blob confirmado en cualquier cuenta de Azure Storage. A partir de la versión 2015-02-21, el origen de una operación de copia de blobs puede ser un archivo de Azure en cualquier cuenta de Azure Storage. Solo las cuentas de almacenamiento creadas el 7 de junio de 2012 solo permiten que la operación Copiar blob se copie desde otra cuenta de almacenamiento.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Ejemplo de uso del sondeo automático:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Ejemplo de uso del sondeo manual:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Ejemplo de uso de actualizaciones de progreso:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Ejemplo con un intervalo de sondeo cambiante (valor predeterminado de 15 segundos):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Ejemplo de uso de la cancelación de copia:

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

Parámetros

copySource

string

dirección URL al blob o archivo de Azure de origen.

options
BlobBeginCopyFromURLOptions

Opciones opcionales para la operación Iniciar copia desde la dirección URL del blob.

Devoluciones

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

Crea una instantánea de solo lectura de un blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

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

Parámetros

options
BlobCreateSnapshotOptions

Opciones opcionales para la operación Crear instantánea de blobs.

Devoluciones

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Marca el blob o la instantánea especificados para su eliminación. El blob se elimina más adelante durante la recolección de elementos no utilizados. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo con la operación Eliminar blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parámetros

options
BlobDeleteOptions

Opciones opcionales para la operación De eliminación de blobs.

Devoluciones

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Marca el blob o la instantánea especificados para su eliminación si existe. El blob se elimina más adelante durante la recolección de elementos no utilizados. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo con la operación Eliminar blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

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

Parámetros

options
BlobDeleteOptions

Opciones opcionales para la operación De eliminación de blobs.

Devoluciones

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Elimine la directiva de immutablility en el blob.

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

Parámetros

options
BlobDeleteImmutabilityPolicyOptions

Opciones opcionales para eliminar la directiva de inmutabilidad en el blob.

Devoluciones

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

Lee o descarga un blob del sistema, incluidos sus metadatos y propiedades. También puede llamar a Get Blob para leer una instantánea.

  • En Node.js, los datos devuelven en una secuencia legibleStreamBody legible
  • En los exploradores, los datos se devuelven en un blobBody de promesa

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

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

Parámetros

offset

number

Desde qué posición del blob se va a descargar, mayor o igual que 0

count

number

Cantidad de datos que se van a descargar, mayores que 0. Se descargará al final cuando no esté definido

options
BlobDownloadOptions

Opciones opcionales para la operación de descarga de blobs.

Ejemplo de uso (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);
});
}

Uso de ejemplo (explorador):

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

Devoluciones

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Descarga un blob de Azure en paralelo a un búfer. El desplazamiento y el recuento son opcionales, descarga todo el blob si no se proporcionan.

Advertencia: los búferes solo pueden admitir archivos de hasta un gigabyte en sistemas de 32 bits o aproximadamente dos gigabytes en sistemas de 64 bits debido a limitaciones de Node.js/V8. En el caso de los blobs de mayor tamaño, considere la posibilidad de downloadToFile.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parámetros

buffer

Buffer

El búfer que se va a rellenar debe tener una longitud mayor que el recuento.

offset

number

Desde qué posición del blob en bloques se va a descargar(en bytes)

count

number

Cantidad de datos (en bytes) que se van a descargar. Se descargará al final al pasar sin definir

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluciones

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Descarga un blob de Azure en paralelo a un búfer. El desplazamiento y el recuento son opcionales, descarga todo el blob si no se proporcionan.

Advertencia: los búferes solo pueden admitir archivos de hasta un gigabyte en sistemas de 32 bits o aproximadamente dos gigabytes en sistemas de 64 bits debido a limitaciones de Node.js/V8. En el caso de los blobs de mayor tamaño, considere la posibilidad de downloadToFile.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parámetros

offset

number

Desde qué posición del blob en bloques se va a descargar(en bytes)

count

number

Cantidad de datos (en bytes) que se van a descargar. Se descargará al final al pasar sin definir

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluciones

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Descarga un blob de Azure en un archivo local. Se produce un error si la ruta de acceso del archivo especificada ya se cierra. El desplazamiento y el recuento son opcionales, pasan 0 y sin definir respectivamente para descargar todo el blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parámetros

filePath

string

offset

number

Desde qué posición del blob en bloques se va a descargar.

count

number

Cantidad de datos que se van a descargar. Se descargará al final al pasar sin definir.

options
BlobDownloadOptions

Opciones para las opciones de descarga de blobs.

Devoluciones

Promise<BlobDownloadResponseParsed>

Los datos de respuesta para la operación de descarga de blobs, pero con readableStreamBody establecido en indefinido, ya que su contenido ya está leído y escrito en un archivo local en la ruta de acceso especificada.

exists(BlobExistsOptions)

Devuelve true si el recurso de blob de Azure representado por este cliente existe; False en caso contrario.

NOTA: Use esta función con cuidado, ya que otros clientes o aplicaciones pueden eliminar un blob existente. Viceversa, es posible que otros clientes o aplicaciones agreguen nuevos blobs después de que se complete esta función.

function exists(options?: BlobExistsOptions): Promise<boolean>

Parámetros

options
BlobExistsOptions

opciones para la operación Exists.

Devoluciones

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Solo está disponible para BlobClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de Blob Service basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

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

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

Parámetros

options
BlobGenerateSasUrlOptions

Parámetros opcionales.

Devoluciones

Promise<string>

El URI de SAS que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

getAccountInfo(BlobGetAccountInfoOptions)

La operación Obtener información de la cuenta devuelve el nombre de SKU y el tipo de cuenta de la cuenta especificada. La operación Obtener información de la cuenta está disponible en las versiones de servicio a partir de la versión 2018-03-28.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

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

Parámetros

options
BlobGetAccountInfoOptions

Opciones para la operación Obtener información de la cuenta de servicio.

Devoluciones

Promise<BlobGetAccountInfoResponse>

Datos de respuesta para la operación Obtener información de la cuenta de servicio.

getAppendBlobClient()

Crea un objeto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Devoluciones

AppendBlobClient

getBlobLeaseClient(string)

Obtenga un BlobLeaseClient que administre concesiones en el blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parámetros

proposeLeaseId

string

Identificador de concesión propuesto inicial.

Devoluciones

BlobLeaseClient

Nuevo objeto BlobLeaseClient para administrar concesiones en el blob.

getBlockBlobClient()

Crea un objeto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Devoluciones

BlockBlobClient

getPageBlobClient()

Crea un objeto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Devoluciones

PageBlobClient

getProperties(BlobGetPropertiesOptions)

Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el blob. No devuelve el contenido del blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

ADVERTENCIA: El objeto metadata devuelto en la respuesta tendrá sus claves en minúsculas, incluso si originalmente contenían caracteres en mayúsculas. Esto difiere de las claves de metadatos devueltas por los métodos de ContainerClient que enumeran blobs mediante la opción includeMetadata, que conservará su mayúscula y minúscula original.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parámetros

options
BlobGetPropertiesOptions

Opciones opcionales para la operación Obtener propiedades.

Devoluciones

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Obtiene las etiquetas asociadas al blob subyacente.

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

Parámetros

options
BlobGetTagsOptions

Devoluciones

Promise<BlobGetTagsResponse>

setAccessTier(string, BlobSetTierOptions)

Establece el nivel en un blob. La operación se permite en un blob en páginas en una cuenta de Premium Storage y en un blob en bloques en una cuenta de almacenamiento de blobs (solo almacenamiento con redundancia local). El nivel de un blob en páginas Premium determina el tamaño permitido, las IOPS y el ancho de banda del blob. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

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

Parámetros

tier

string

Nivel que se va a establecer en el blob. Los valores válidos son Hot, Cool o Archive.

options
BlobSetTierOptions

Opciones opcionales para la operación De conjunto de blobs.

Devoluciones

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Establece las propiedades del sistema en el blob.

Si no se proporciona ningún valor o ningún valor proporcionado para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

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

Parámetros

blobHTTPHeaders
BlobHTTPHeaders

Si no se proporciona ningún valor o ningún valor proporcionado para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán. Un encabezado común que se va a establecer es blobContentType permitir que el explorador proporcione funcionalidad basada en el tipo de archivo.

options
BlobSetHTTPHeadersOptions

Opciones opcionales para la operación De encabezados HTTP de conjunto de blobs.

Devoluciones

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Establezca la directiva de inmutabilidad en el blob.

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

Parámetros

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Opciones opcionales para establecer la directiva de inmutabilidad en el blob.

Devoluciones

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Establezca la suspensión legal en el blob.

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

Parámetros

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

Opciones opcionales para establecer la suspensión legal en el blob.

Devoluciones

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Establece los metadatos definidos por el usuario para el blob especificado como uno o varios pares nombre-valor.

Si no se proporciona ninguna opción o ningún metadato definido en el parámetro , se quitarán los metadatos del blob.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

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

Parámetros

metadata
Metadata

Reemplace los metadatos existentes por este valor. Si no se proporciona ningún valor, se quitarán los metadatos existentes.

options
BlobSetMetadataOptions

Opciones opcionales para establecer la operación de metadatos.

Devoluciones

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

Establece etiquetas en el blob subyacente. Un blob puede tener hasta 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres. Los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres válidos de clave y valor incluyen letras minúsculas y mayúsculas, dígitos (0-9), espacio (' '), más ('+'), menos ('-'), punto ('.'), barra diagonal ('/'), dos puntos (':'), iguales ('=') y subrayado bajo ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parámetros

tags
Tags
options
BlobSetTagsOptions

Devoluciones

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

La operación Copy From URL sincrónica copia un blob o un recurso de Internet en un nuevo blob. No devolverá una respuesta hasta que se complete la copia.

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

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

Parámetros

copySource

string

La dirección URL de origen desde la que se va a copiar la firma de acceso compartido (SAS) puede ser necesaria para la autenticación.

options
BlobSyncCopyFromURLOptions

Devoluciones

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Restaura el contenido y los metadatos del blob eliminado temporalmente y las instantáneas eliminadas temporalmente asociadas. Undelete Blob solo se admite en la versión 2017-07-29 o posterior.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

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

Parámetros

options
BlobUndeleteOptions

Opciones opcionales para la operación Recuperar blobs.

Devoluciones

Promise<BlobUndeleteResponse>

withSnapshot(string)

Crea un nuevo objeto BlobClient idéntico al origen, pero con la marca de tiempo de instantánea especificada. Proporcione "" quitará la instantánea y devolverá un cliente al blob base.

function withSnapshot(snapshot: string): BlobClient

Parámetros

snapshot

string

Marca de tiempo de la instantánea.

Devoluciones

BlobClient

Nuevo objeto BlobClient idéntico al origen, pero con la marca de tiempo de instantánea especificada

withVersion(string)

Crea un nuevo objeto BlobClient que apunta a una versión de este blob. Proporcione "" quitará el versionId y devolverá un cliente al blob base.

function withVersion(versionId: string): BlobClient

Parámetros

versionId

string

VersionId.

Devoluciones

BlobClient

Nuevo objeto BlobClient que apunta a la versión de este blob.