BlockBlobClient class

Referencia

Paquete:: @azure/storage-blob

BlockBlobClient define un conjunto de operaciones aplicables a blobs en bloques.

Extends: BlobClient

Constructores

BlockBlobClient(string, PipelineLike)	Crea una instancia de BlockBlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob en bloques. 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.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Crea una instancia de BlockBlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob en bloques. 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.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Crea una instancia de BlockBlobClient.

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

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Escribe un blob especificando la lista de identificadores de bloque que componen el blob. Para poder escribirse como parte de un blob, un bloque debe haberse escrito correctamente en el servidor en una operación de stageBlock anterior. Puede llamar a commitBlockList para actualizar un blob cargando solo los bloques que han cambiado y, después, confirmando los bloques nuevos y existentes juntos. Los bloques no especificados en la lista de bloques y eliminados permanentemente. Consulte https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Devuelve la lista de bloques que se han cargado como parte de un blob en bloques mediante el filtro de lista de bloques especificado. Consulte https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Consulta rápida para un blob con formato JSON o CSV. Ejemplo de uso (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); 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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Carga el bloque especificado en el "área de almacenamiento provisional" del blob en bloques para que se confirme posteriormente mediante una llamada a commitBlockList. Consulte https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	La operación Stage Block From URL crea un nuevo bloque que se confirmará como parte de un blob donde el contenido se lee desde una dirección URL. Esta API está disponible a partir de la versión 2018-03-28. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Crea un nuevo blob en bloques donde el contenido del blob se lee desde una dirección URL determinada. Esta API se admite a partir de la versión 2020-04-08. No se admiten actualizaciones parciales con Put Blob desde la dirección URL; El contenido de un blob existente se sobrescribe con el contenido del nuevo blob. Para realizar actualizaciones parciales en el contenido de un blob en bloques mediante una dirección URL de origen, use stageBlockFromURL y commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Crea un nuevo blob en bloques o actualiza el contenido de un blob en bloques existente. Al actualizar un blob en bloques existente, se sobrescriben los metadatos existentes en el blob. No se admiten actualizaciones parciales; el contenido del blob existente se sobrescribe con el nuevo contenido. Para realizar una actualización parcial de un blob en bloques, use stageBlock y commitBlockList. Se trata de un método de carga no paralelo, use uploadFile, uploadStream o uploadBrowserData para mejorar el rendimiento con la carga de simultaneidad. Consulte https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	SOLO ESTÁ DISPONIBLE EN EXPLORADORES. Carga un objeto Blob/File/ArrayBuffer/ArrayBufferView del explorador en blob en bloques. Cuando la longitud del búfer es menor o igual que 256 MB, este método usará 1 llamada de carga para finalizar la carga. De lo contrario, este método llamará a stageBlock para cargar bloques y, por último, llamará a commitBlockList para confirmar la lista de bloqueos. Una opción común blobHTTPHeaders establecer es `blobContentType`, lo que permite al explorador proporcionar funcionalidad basada en el tipo de archivo.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Carga un objeto Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView en un blockBlob. Cuando la longitud de los datos no es superior a la especificada maxSingleShotSize (el valor predeterminado es <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), este método usará 1 carga llamada para finalizar la carga. De lo contrario, este método llamará a stageBlock para cargar bloques y, por último, llamará a commitBlockList para confirmar la lista de bloqueos. Una opción común blobHTTPHeaders establecer es `blobContentType`, lo que permite al explorador proporcionar funcionalidad basada en el tipo de archivo.
uploadFile(string, BlockBlobParallelUploadOptions)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga un archivo local en bloques en un blob en bloques. Cuando el tamaño de archivo sea menor o igual que 256 MB, este método usará 1 llamada de carga para finalizar la carga. De lo contrario, este método llamará a stageBlock para cargar bloques y, por último, llamará a commitBlockList para confirmar la lista de bloqueos.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga un Node.js flujo legible en blob en bloques. SUGERENCIAS PARA MEJORAR EL RENDIMIENTO: HighWaterMark de flujo de entrada es mejor establecer un mismo valor con el parámetro bufferSize, lo que evitará las operaciones Buffer.concat().
withSnapshot(string)	Crea un nuevo objeto BlockBlobClient idéntico al origen, pero con la marca de tiempo de instantánea especificada. Proporcione "" quitará la instantánea y devolverá una dirección URL al blob base.

Métodos heredados

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.
generateSasStringToSign(BlobGenerateSasUrlOptions)	Solo está disponible para BlobClient construido con una credencial de clave compartida. Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de Blob Service en función de 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
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
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	Solo está disponible para BlobClient construido con una credencial de clave compartida. Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de Blob Service en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la clave de delegación de usuario de entrada. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	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 clave de delegación de usuario de entrada. 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
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

BlockBlobClient(string, PipelineLike)

Crea una instancia de BlockBlobClient. Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un blob en bloques. 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 BlockBlobClient(url: string, pipeline: PipelineLike)

Parámetros

url: string

Cadena de dirección URL que apunta al blob en bloques de Azure Storage, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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.

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

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

Parámetros

url: string

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.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Crea una instancia de BlockBlobClient.

new BlockBlobClient(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 deblobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de propiedad

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

heredado deblobClient.credential

url

Valor de cadena de dirección URL codificada.

url: string

Valor de propiedad

string

heredado deblobClient.url

Detalles del método

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Escribe un blob especificando la lista de identificadores de bloque que componen el blob. Para poder escribirse como parte de un blob, un bloque debe haberse escrito correctamente en el servidor en una operación de stageBlock anterior. Puede llamar a commitBlockList para actualizar un blob cargando solo los bloques que han cambiado y, después, confirmando los bloques nuevos y existentes juntos. Los bloques no especificados en la lista de bloques y eliminados permanentemente.

Consulte https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parámetros

blocks: string[]

Matriz de valor de 64 bytes codificado en base64

options: BlockBlobCommitBlockListOptions

Opciones para la operación Block Blob Commit Block List( Lista de bloques de confirmación de blobs).

Devoluciones

Promise<BlockBlobCommitBlockListResponse>

Datos de respuesta para la operación Block Blob Commit Block List.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Devuelve la lista de bloques que se han cargado como parte de un blob en bloques mediante el filtro de lista de bloques especificado.

Consulte https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Parámetros

listType: BlockListType

Especifica si se devuelve la lista de bloques confirmados, la lista de bloques no confirmados o ambas listas juntas.

options: BlockBlobGetBlockListOptions

Opciones para la operación Obtener lista de bloques de blobs en bloques.

Devoluciones

Promise<BlockBlobGetBlockListResponse>

Datos de respuesta para la operación Obtener lista de bloques de blobs en bloques.

query(string, BlockBlobQueryOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Consulta rápida para un blob con formato JSON o CSV.

Ejemplo de uso (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

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

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Parámetros

query: string

options: BlockBlobQueryOptions

Devoluciones

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Carga el bloque especificado en el "área de almacenamiento provisional" del blob en bloques para que se confirme posteriormente mediante una llamada a commitBlockList.

Consulte https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parámetros

blockId: string

Valor de 64 bytes codificado en base64

body: HttpRequestBody

Datos que se van a cargar en el área de ensayo.

contentLength: number

Número de bytes que se van a cargar.

options: BlockBlobStageBlockOptions

Opciones para la operación Block Blob Stage Block.

Devoluciones

Promise<BlockBlobStageBlockResponse>

Datos de respuesta para la operación Block Blob Stage Block.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

La operación Stage Block From URL crea un nuevo bloque que se confirmará como parte de un blob donde el contenido se lee desde una dirección URL. Esta API está disponible a partir de la versión 2018-03-28.

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Parámetros

blockId: string

Valor de 64 bytes codificado en base64

sourceURL: string

Especifica la dirección URL del blob. El valor puede ser una dirección URL de hasta 2 KB de longitud que especifica un blob. El valor debe estar codificado con dirección URL, ya que aparecería en un URI de solicitud. El blob de origen debe ser público o debe autenticarse a través de una firma de acceso compartido. Si el blob de origen es público, no se requiere autenticación para realizar la operación. Estos son algunos ejemplos de direcciones URL de objeto de origen: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

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

Opciones para la operación Block Blob Stage Block From URL (Bloquear fase de blobs en bloques) desde la dirección URL.

Devoluciones

Promise<BlockBlobStageBlockFromURLResponse>

Datos de respuesta para la operación Block Blob Stage Block From URL.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Crea un nuevo blob en bloques donde el contenido del blob se lee desde una dirección URL determinada. Esta API se admite a partir de la versión 2020-04-08. No se admiten actualizaciones parciales con Put Blob desde la dirección URL; El contenido de un blob existente se sobrescribe con el contenido del nuevo blob. Para realizar actualizaciones parciales en el contenido de un blob en bloques mediante una dirección URL de origen, use stageBlockFromURL y commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parámetros

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Parámetros opcionales.

Devoluciones

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Crea un nuevo blob en bloques o actualiza el contenido de un blob en bloques existente. Al actualizar un blob en bloques existente, se sobrescriben los metadatos existentes en el blob. No se admiten actualizaciones parciales; el contenido del blob existente se sobrescribe con el nuevo contenido. Para realizar una actualización parcial de un blob en bloques, use stageBlock y commitBlockList.

Se trata de un método de carga no paralelo, use uploadFile, uploadStream o uploadBrowserData para mejorar el rendimiento con la carga de simultaneidad.

Consulte https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Parámetros

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView o una función que devuelve una nueva secuencia legible cuyo desplazamiento procede del origen de datos.

contentLength: number

Longitud del cuerpo en bytes. Use Buffer.byteLength() para calcular la longitud del cuerpo de una cadena, incluidos caracteres no codificados en Base64/Hexadecimal.

options: BlockBlobUploadOptions

Opciones para la operación de carga de blobs en bloques.

Devoluciones

Promise<BlockBlobUploadResponse>

Datos de respuesta para la operación de carga de blobs en bloques.

Uso de ejemplo:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Advertencia

Esta API ya está en desuso.

Use uploadData instead.

SOLO ESTÁ DISPONIBLE EN EXPLORADORES.

Carga un objeto Blob/File/ArrayBuffer/ArrayBufferView del explorador en blob en bloques.

Cuando la longitud del búfer es menor o igual que 256 MB, este método usará 1 llamada de carga para finalizar la carga. De lo contrario, este método llamará a stageBlock para cargar bloques y, por último, llamará a commitBlockList para confirmar la lista de bloqueos.

Una opción común blobHTTPHeaders establecer es blobContentType, lo que permite al explorador proporcionar funcionalidad basada en el tipo de archivo.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parámetros

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer o ArrayBufferView

options: BlockBlobParallelUploadOptions

Opciones para cargar datos del explorador.

Devoluciones

Promise<BlobUploadCommonResponse>

Datos de respuesta para la operación de carga de blobs.

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Carga un objeto Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView en un blockBlob.

Cuando la longitud de los datos no es superior a la especificada maxSingleShotSize (el valor predeterminado es <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), este método usará 1 carga llamada para finalizar la carga. De lo contrario, este método llamará a stageBlock para cargar bloques y, por último, llamará a commitBlockList para confirmar la lista de bloqueos.

Una opción común blobHTTPHeaders establecer es blobContentType, lo que permite al explorador proporcionar funcionalidad basada en el tipo de archivo.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parámetros

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), Blob, ArrayBuffer o ArrayBufferView

options: BlockBlobParallelUploadOptions

Devoluciones

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Carga un archivo local en bloques en un blob en bloques.

Cuando el tamaño de archivo sea menor o igual que 256 MB, este método usará 1 llamada de carga para finalizar la carga. De lo contrario, este método llamará a stageBlock para cargar bloques y, por último, llamará a commitBlockList para confirmar la lista de bloqueos.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parámetros

filePath: string

Ruta de acceso completa del archivo local

options: BlockBlobParallelUploadOptions

Opciones para cargar en la operación de blob en bloques.

Devoluciones

Promise<BlobUploadCommonResponse>

Datos de respuesta para la operación de carga de blobs.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Carga un Node.js flujo legible en blob en bloques.

SUGERENCIAS PARA MEJORAR EL RENDIMIENTO:

HighWaterMark de flujo de entrada es mejor establecer un mismo valor con el parámetro bufferSize, lo que evitará las operaciones Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parámetros

stream: Readable

Node.js secuencia legible

bufferSize: number

Tamaño de cada búfer asignado, también el tamaño del bloque en el blob en bloques cargado. El valor predeterminado es 8 MB

maxConcurrency: number

La simultaneidad máxima indica el número máximo de búferes que se pueden asignar, correlación positiva con la simultaneidad máxima de carga. El valor predeterminado es 5

options: BlockBlobUploadStreamOptions

Opciones para cargar stream en la operación de blob en bloques.

Devoluciones

Promise<BlobUploadCommonResponse>

Datos de respuesta para la operación de carga de blobs.

withSnapshot(string)

Crea un nuevo objeto BlockBlobClient idéntico al origen, pero con la marca de tiempo de instantánea especificada. Proporcione "" quitará la instantánea y devolverá una dirección URL al blob base.

function withSnapshot(snapshot: string): BlockBlobClient

Parámetros

snapshot: string

Marca de tiempo de la instantánea.

Devoluciones

BlockBlobClient

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

Detalles de los métodos heredados

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>

heredado deBlobClient.abortCopyFromURL

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

heredado deBlobClient.beginCopyFromURL

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>

Heredado deBlobClient.createSnapshot

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>

Heredado deBlobClient.delete

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>

Heredado deBlobClient.deleteIfExists

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>

Heredado deBlobClient.deleteImmutabilityPolicy

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>

heredado deBlobClient.download

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>

heredado deBlobClient.downloadToBuffer

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.

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>

heredado deBlobClient.downloadToBuffer

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.

Heredado deBlobClient.downloadToFile

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>

heredado deBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

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

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de Blob Service en función de 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 generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parámetros

options: BlobGenerateSasUrlOptions

Parámetros opcionales.

Devoluciones

string

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

heredado deBlobClient.generateSasStringToSign

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.

Heredado deBlobClient.generateSasUrl

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

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

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de Blob Service en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la clave de delegación de usuario de entrada.

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

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

Parámetros

options: BlobGenerateSasUrlOptions

Parámetros opcionales.

userDelegationKey: UserDelegationKey

Valor devuelto de blobServiceClient.getUserDelegationKey()

Devoluciones

string

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

Heredado deBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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 clave de delegación de usuario de entrada.

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

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

Parámetros

options: BlobGenerateSasUrlOptions

Parámetros opcionales.

userDelegationKey: UserDelegationKey

Valor devuelto de blobServiceClient.getUserDelegationKey()

Devoluciones

Promise<string>

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

heredado deBlobClient.generateUserDelegationSasUrl

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.

heredado deBlobClient.getAccountInfo

getAppendBlobClient()

Crea un objeto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Devoluciones

AppendBlobClient

Heredado deBlobClient.getAppendBlobClient

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.

Heredado deBlobClient.getBlobLeaseClient

getBlockBlobClient()

Crea un objeto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Devoluciones

BlockBlobClient

Heredado deBlobClient.getBlockBlobClient

getPageBlobClient()

Crea un objeto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Devoluciones

PageBlobClient

Heredado deBlobClient.getPageBlobClient

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>

heredado deBlobClient.getProperties

getTags(BlobGetTagsOptions)

Obtiene las etiquetas asociadas al blob subyacente.

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

Parámetros

options: BlobGetTagsOptions

Devoluciones

Promise<BlobGetTagsResponse>

heredado deBlobClient.getTags

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>

Heredado deBlobClient.setAccessTier

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>

Heredado deBlobClient.setHTTPHeaders

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>

Heredado deBlobClient.setImmutabilityPolicy

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>

Heredado deBlobClient.setLegalHold

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>

heredado deblobClient.setMetadata

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>

Heredado deBlobClient.setTags

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>

heredado deblobClient.syncCopyFromURL

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>

heredado deblobClient.undelete

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.

Heredado deBlobClient.withVersion

Compartir a través de

BlockBlobClient class

Constructores

Propiedades

Propiedades heredadas

Métodos

Métodos heredados

Detalles del constructor

BlockBlobClient(string, PipelineLike)

Parámetros

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

Parámetros

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parámetros

Detalles de las propiedades

containerName

Valor de propiedad

name

Valor de propiedad

Detalles de las propiedades heredadas

accountName

Valor de propiedad

credential

Valor de propiedad

url

Valor de propiedad

Detalles del método

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parámetros

Devoluciones

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parámetros

Devoluciones

query(string, BlockBlobQueryOptions)

Parámetros

Devoluciones

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parámetros

Devoluciones

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Parámetros

Devoluciones

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parámetros

Devoluciones

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parámetros

Devoluciones

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parámetros

Devoluciones

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Parámetros

Devoluciones

uploadFile(string, BlockBlobParallelUploadOptions)

Parámetros

Devoluciones

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parámetros

Devoluciones

withSnapshot(string)

Parámetros

Devoluciones

Detalles de los métodos heredados

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parámetros

Devoluciones

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parámetros

Devoluciones

createSnapshot(BlobCreateSnapshotOptions)

Parámetros

Devoluciones

delete(BlobDeleteOptions)

Parámetros

Devoluciones

deleteIfExists(BlobDeleteOptions)

Parámetros

Devoluciones

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)