PageBlobClient class

  • Referencia
Paquete:
@azure/storage-blob

PageBlobClient define un conjunto de operaciones aplicables a los blobs en páginas.

Extends
BlobClient

Constructores

PageBlobClient(string, PipelineLike)

Crea una instancia de PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea una instancia de PageBlobClient. 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 url. Si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL.
PageBlobClient(string, string, string, StoragePipelineOptions)

Crea una instancia de PageBlobClient.

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 @azure/identity paquete para autenticar las solicitudes en el 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

clearPages(number, number, PageBlobClearPagesOptions)

Libera las páginas especificadas del blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/put-page.
create(number, PageBlobCreateOptions)

Crea un blob en páginas de la longitud especificada. Llame a uploadPages para cargar datos en un blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/put-blob.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Crea un blob en páginas de la longitud especificada. Llame a uploadPages para cargar datos en un blob en páginas. Si el blob con el mismo nombre ya existe, el contenido del blob existente permanecerá sin cambios.

Consulta https://docs.microsoft.com/rest/api/storageservices/put-blob.
getPageRanges(number, number, PageBlobGetPageRangesOptions)

Devuelve la lista de intervalos de páginas válidos para un blob en páginas o una instantánea de un blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtiene la colección de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtiene la colección de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas para discos administrados.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.
listPageRanges(number, number, PageBlobListPageRangesOptions)

Devuelve un iterador asincrónico a la lista de intervalos de páginas de un blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

.byPage() devuelve un iterador asincrónico a la lista de intervalos de página de un blob en páginas.

Ejemplo de uso de for await la sintaxis:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Ejemplo con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Ejemplo con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Ejemplo de uso de paginación con un marcador:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Devuelve un iterador asincrónico a la lista de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

.byPage() devuelve un iterador asincrónico a la lista de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas.

Ejemplo de uso de for await la sintaxis:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Ejemplo con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Ejemplo con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Ejemplo de uso de paginación con un marcador:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

Cambia el tamaño del blob en páginas al tamaño especificado (que debe ser un múltiplo de 512).

Consulta https://docs.microsoft.com/rest/api/storageservices/set-blob-properties.
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Inicia una operación para iniciar una copia incremental desde la instantánea de un blob en páginas en este blob en páginas. La instantánea se copia de forma que solo se transfieren los cambios diferenciales entre la instantánea copiada anteriormente al destino. Las instantáneas copiadas son copias completas de la instantánea original y se pueden leer o copiar de la forma habitual.

Consulte Ver https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Establece el número de secuencia de un blob en páginas.

Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Escribe 1 o más páginas en el blob en páginas. Los desplazamientos inicial y final deben ser un múltiplo de 512.

Consulta https://docs.microsoft.com/rest/api/storageservices/put-page.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

La operación Cargar páginas escribe un intervalo de páginas en un blob de páginas donde el contenido se lee desde una dirección URL.

Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url.
withSnapshot(string)

Crea un nuevo objeto PageBlobClient 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.

Métodos heredados

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

Consulta 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 cancelOperation a 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 posteriores, el origen de una operación de copia de blobs puede ser un blob confirmado en cualquier cuenta de Almacenamiento de Azure. 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 Almacenamiento de Azure. Las cuentas de almacenamiento creadas desde el 7 de junio de 2012 son las únicas que permiten que la operación Copy Blob copie desde otra cuenta de almacenamiento.

Consulta 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 (el valor predeterminado es 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.

Consulta 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 posteriormente 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.

Consulta 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 posteriormente 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.

Consulta 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 se devuelven en una secuencia legibleStreamBody legible.
  • En los exploradores, los datos se devuelven en un blobBody de promesa.

Consulta 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. Para blobs mayores que este tamaño, considere la posibilidad de descargarToFile.
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 mayores que este tamaño, considere la posibilidad de descargarToFile.
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.

Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
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 de los blobs.

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

ADVERTENCIA: El metadata objeto devuelto en la respuesta tendrá sus claves en minúsculas, incluso si contenían caracteres en mayúsculas originalmente. Esto difiere de las claves de metadatos devueltas por los métodos de ContainerClient que enumeran blobs mediante la includeMetadata opción , que conservarán 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 de 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.

Consulta 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 no se proporciona ningún valor para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán.

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

Establezca la directiva de immutablility 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 de nombre y valor.

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

Consulta 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 de clave y valor válidos 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.

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

Consulta 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

PageBlobClient(string, PipelineLike)

Crea una instancia de PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parámetros

url

string

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

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

Crea una instancia de PageBlobClient. 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 url. Si un nombre de blob incluye ? o %, el nombre del blob debe estar codificado en la dirección URL.

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

Parámetros

url

string

Cadena de cliente que apunta al blob en páginas de Azure Storage, como "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del @azure/identity paquete para autenticar las solicitudes en el 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.

PageBlobClient(string, string, string, StoragePipelineOptions)

Crea una instancia de PageBlobClient.

new PageBlobClient(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:DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Ejemplo de cadena de conexión de SAS: 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

El 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

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del @azure/identity paquete para autenticar las solicitudes en el 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 deBlobClient.credential

url

Valor de cadena de dirección URL codificada.

url: string

Valor de propiedad

string

Heredado deBlobClient.url

Detalles del método

clearPages(number, number, PageBlobClearPagesOptions)

Libera las páginas especificadas del blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/put-page.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

Parámetros

offset

number

Posición inicial de bytes de las páginas que se van a borrar.

count

number

Número de bytes que se van a borrar.

options
PageBlobClearPagesOptions

Opciones para la operación Borrar páginas del blob en páginas.

Devoluciones

Promise<PageBlobClearPagesResponse>

Datos de respuesta para la operación Borrar páginas del blob en páginas.

create(number, PageBlobCreateOptions)

Crea un blob en páginas de la longitud especificada. Llame a uploadPages para cargar datos en un blob en páginas.

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

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

Parámetros

size

number

tamaño del blob en páginas.

options
PageBlobCreateOptions

Opciones para la operación De creación de blobs en páginas.

Devoluciones

Promise<PageBlobCreateResponse>

Datos de respuesta para la operación De creación de blobs en páginas.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Crea un blob en páginas de la longitud especificada. Llame a uploadPages para cargar datos en un blob en páginas. Si el blob con el mismo nombre ya existe, el contenido del blob existente permanecerá sin cambios.

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parámetros

size

number

tamaño del blob en páginas.

options
PageBlobCreateIfNotExistsOptions

Devoluciones

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Devuelve la lista de intervalos de páginas válidos para un blob en páginas o una instantánea de un blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

Parámetros

offset

number

Posición inicial de bytes de los intervalos de página.

count

number

Número de bytes que se van a obtener.

options
PageBlobGetPageRangesOptions

Opciones para la operación Obtener rangos de blobs en páginas.

Devoluciones

Promise<PageBlobGetPageRangesResponse>

Datos de respuesta para la operación Obtener rangos de blobs en páginas.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtiene la colección de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parámetros

offset

number

Posición inicial de bytes del blob en páginas

count

number

Número de bytes para obtener diferencias de intervalos.

prevSnapshot

string

Marca de tiempo de la instantánea para recuperar la diferencia.

options
PageBlobGetPageRangesDiffOptions

Opciones para la operación De diferencias de intervalos de páginas De obtención de intervalos de páginas.

Devoluciones

Promise<PageBlobGetPageRangesDiffResponse>

Datos de respuesta para la operación De diferencias de intervalo de páginas Obtener blob en páginas.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtiene la colección de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas para discos administrados.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parámetros

offset

number

Posición inicial de bytes del blob en páginas

count

number

Número de bytes para obtener diferencias de intervalos.

prevSnapshotUrl

string

Dirección URL de la instantánea para recuperar la diferencia.

options
PageBlobGetPageRangesDiffOptions

Opciones para la operación De diferencias de intervalos de páginas De obtención de intervalos de páginas.

Devoluciones

Promise<PageBlobGetPageRangesDiffResponse>

Datos de respuesta para la operación De diferencias de intervalo de páginas Obtener blob en páginas.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Devuelve un iterador asincrónico a la lista de intervalos de páginas de un blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

.byPage() devuelve un iterador asincrónico a la lista de intervalos de página de un blob en páginas.

Ejemplo de uso de for await la sintaxis:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Ejemplo con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Ejemplo con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Ejemplo de uso de paginación con un marcador:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parámetros

offset

number

Posición inicial de bytes de los intervalos de página.

count

number

Número de bytes que se van a obtener.

options
PageBlobListPageRangesOptions

Opciones para la operación Obtener rangos de blobs en páginas.

Devoluciones

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

AsyncIterableIterator que admite la paginación.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Devuelve un iterador asincrónico a la lista de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas.

Consulta https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

.byPage() devuelve un iterador asincrónico a la lista de intervalos de páginas que difieren entre una instantánea especificada y este blob en páginas.

Ejemplo de uso de for await la sintaxis:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Ejemplo con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Ejemplo con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Ejemplo de uso de paginación con un marcador:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parámetros

offset

number

Posición inicial de bytes de los intervalos de página.

count

number

Número de bytes que se van a obtener.

prevSnapshot

string

Marca de tiempo de la instantánea para recuperar la diferencia.

options
PageBlobListPageRangesDiffOptions

Opciones para la operación Obtener rangos de blobs en páginas.

Devoluciones

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

AsyncIterableIterator que admite la paginación.

resize(number, PageBlobResizeOptions)

Cambia el tamaño del blob en páginas al tamaño especificado (que debe ser un múltiplo de 512).

Consulta https://docs.microsoft.com/rest/api/storageservices/set-blob-properties.

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

Parámetros

size

number

Tamaño de destino

options
PageBlobResizeOptions

Opciones de la operación Cambio de tamaño del blob en páginas.

Devoluciones

Promise<PageBlobResizeResponse>

Datos de respuesta para la operación De cambio de tamaño del blob en páginas.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Inicia una operación para iniciar una copia incremental desde la instantánea de un blob en páginas en este blob en páginas. La instantánea se copia de forma que solo se transfieren los cambios diferenciales entre la instantánea copiada anteriormente al destino. Las instantáneas copiadas son copias completas de la instantánea original y se pueden leer o copiar de la forma habitual.

Consulte Ver https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

Parámetros

copySource

string

Especifica el nombre de la instantánea de blob en páginas de origen. por ejemplo, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

Opciones para la operación Incremental de copia de blobs en páginas.

Devoluciones

Promise<PageBlobCopyIncrementalResponse>

Datos de respuesta para la operación incremental de copia incremental de blobs en páginas.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Establece el número de secuencia de un blob en páginas.

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

Parámetros

sequenceNumberAction
SequenceNumberActionType

Indica cómo debe modificar el servicio el número de secuencia del blob.

sequenceNumber

number

Obligatorio si sequenceNumberAction es max o update

options
PageBlobUpdateSequenceNumberOptions

Opciones para la operación De número de secuencia de actualización de blobs en páginas.

Devoluciones

Promise<PageBlobUpdateSequenceNumberResponse>

Datos de respuesta para la operación Número de secuencia de actualización de blobs en páginas.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Escribe 1 o más páginas en el blob en páginas. Los desplazamientos inicial y final deben ser un múltiplo de 512.

Consulta https://docs.microsoft.com/rest/api/storageservices/put-page.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

Parámetros

body
HttpRequestBody

Datos que se van a cargar

offset

number

Desplazamiento del blob en páginas de destino

count

number

Longitud de contenido del cuerpo, también número de bytes que se van a cargar

options
PageBlobUploadPagesOptions

Opciones para la operación Cargar páginas de blobs en páginas.

Devoluciones

Promise<PageBlobUploadPagesResponse>

Datos de respuesta para la operación De carga de páginas de blobs en páginas.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

La operación Cargar páginas escribe un intervalo de páginas en un blob de páginas donde el contenido se lee desde una dirección URL.

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

Parámetros

sourceURL

string

Especifique una dirección URL para el origen de copia, la firma de acceso compartido (SAS) tal vez sea necesaria para la autenticación.

sourceOffset

number

Desplazamiento de origen desde el que se va a copiar. Pasar 0 para copiar desde el principio del blob en páginas de origen

destOffset

number

Desplazamiento del blob en páginas de destino

count

number

Número de bytes que se van a cargar desde el blob en páginas de origen

options
PageBlobUploadPagesFromURLOptions

Devoluciones

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Crea un nuevo objeto PageBlobClient 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): PageBlobClient

Parámetros

snapshot

string

Marca de tiempo de la instantánea.

Devoluciones

PageBlobClient

Nuevo objeto PageBlobClient 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 longitud cero y metadatos completos. Versión 2012-02-12 y versiones posteriores.

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

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

Parámetros

copyId

string

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

options
BlobAbortCopyFromURLOptions

Opciones opcionales para la operación Desenlazamiento de copia desde la dirección 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 cancelOperation a 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 posteriores, el origen de una operación de copia de blobs puede ser un blob confirmado en cualquier cuenta de Almacenamiento de Azure. 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 Almacenamiento de Azure. Las cuentas de almacenamiento creadas desde el 7 de junio de 2012 son las únicas que permiten que la operación Copy Blob copie desde otra cuenta de almacenamiento.

Consulta 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 (el valor predeterminado es 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.

Consulta 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 blob.

Devoluciones

Promise<BlobCreateSnapshotResponse>

Heredado deBlobClient.createSnapshot

delete(BlobDeleteOptions)

Marca el blob o la instantánea especificados para su eliminación. El blob se elimina posteriormente 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.

Consulta 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 posteriormente 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.

Consulta 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 se devuelven en una secuencia legibleStreamBody legible.
  • En los exploradores, los datos se devuelven en un blobBody de promesa.

Consulta 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 se defina

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

Ejemplo de uso (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. Para blobs mayores que este tamaño, considere la posibilidad de descargarToFile.

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.

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 mayores que este tamaño, considere la posibilidad de descargarToFile.

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 undefined

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

options
BlobDownloadOptions

Opciones para las opciones de descarga de blobs.

Devoluciones

Promise<BlobDownloadResponseParsed>

Los datos de respuesta de la operación de descarga de blobs, pero con readableStreamBody establecido en undefined, ya que su contenido ya se ha 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

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.

Consulta 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 al recurso representado por este cliente, seguido del token de SAS generado.

Heredado deBlobClient.generateSasUrl

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 de los blobs.

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

ADVERTENCIA: El metadata objeto devuelto en la respuesta tendrá sus claves en minúsculas, incluso si contenían caracteres en mayúsculas originalmente. Esto difiere de las claves de metadatos devueltas por los métodos de ContainerClient que enumeran blobs mediante la includeMetadata opción , que conservarán 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 de 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.

Consulta 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 Frecuente, Esporádico o Archivo.

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 no se proporciona ningún valor para los encabezados HTTP de blob especificados, estos encabezados HTTP de blob sin un valor se borrarán.

Consulta 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 no se proporciona ningún valor 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 permite blobContentType al explorador proporcionar 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 immutablility 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 de nombre y valor.

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

Consulta 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 quitará ningún valor proporcionado, 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 de clave y valor válidos 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.

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

Consulta 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