Compartir vía


@azure/storage-blob package

Clases

Aborter

Una instancia del anulador implementa la interfaz AbortSignal, puede anular las solicitudes HTTP.

  • Llame a Aborter.none para crear una nueva instancia de Aborter sin tiempo de espera.
  • Llame a Aborter.timeout() para crear una nueva instancia de Aborter con tiempo de espera.

Para un anulador de instancia existente:

  • Llame a aborter.withTimeout() para crear y devolver una instancia de Aborter secundaria con el tiempo de espera.
  • Llame a aborter.withValue(key, value) para crear y devolver una instancia de Aborter secundaria con par clave-valor.
  • Llame a aborter.abort() para anular la instancia actual y todas las instancias secundarias.
  • Llame a aborter.getValue(key) para buscar y obtener el valor con la clave correspondiente del anulador actual a todos los elementos primarios.
AccountSASPermissions

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un AccountSAS. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá permisos para esa operación. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como campo de permisos en un objeto <xref:IAccountSASSignatureValues>. Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la corrección.

AccountSASResourceTypes

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los recursos a los que puede acceder un AccountSAS. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá acceso a ese tipo de recurso. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo resources en un objeto <xref:IAccountSASSignatureValues>. Es posible construir la cadena de recursos sin esta clase, pero el orden de los recursos es concreto y esta clase garantiza la corrección.

AccountSASServices

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que represente los servicios accesibles por accountSAS. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá acceso a ese servicio. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como campo de servicios en un objeto <xref:IAccountSASSignatureValues>. Es posible construir la cadena de servicios sin esta clase, pero el orden de los servicios es particular y esta clase garantiza la corrección.

AppendBlobURL

AppendBlobURL define un conjunto de operaciones aplicables a blobs en anexos.

BatchDeleteRequest

BatchDeleteRequest representa una solicitud de eliminación por lotes, que consta de una o varias operaciones de eliminación.

BatchRequest

BatchRequest representa una clase basada para BatchDeleteRequest y BatchSetTierRequest.

BatchSetTierRequest

BatchSetTierRequest representa una solicitud de nivel de conjunto de lotes, que consta de una o varias operaciones de nivel de conjunto.

InnerBatchRequest

Clase de solicitud por lotes interna que es responsable de ensamblar y serializar sub solicitudes. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#request-body sobre cómo se ensambla la solicitud.

BatchResponseParser

Clase Util para analizar la respuesta por lotes.

BlobSASPermissions

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un ServiceSAS a un blob. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá permisos para esa operación. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo de permisos en un objeto <xref:IBlobSASSignatureValues>. Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la corrección.

BlobURL

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

BlockBlobURL

BlockBlobURL define un conjunto de operaciones aplicables a los blobs en bloques.

BrowserPolicyFactory

BrowserPolicyFactory es una clase de fábrica que ayuda a generar objetos BrowserPolicy.

ContainerSASPermissions

Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un ServiceSAS a un contenedor. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá permisos para esa operación. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo de permisos en un objeto <xref:IBlobSASSignatureValues>. Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la corrección.

ContainerURL

Un ContainerURL representa una dirección URL al contenedor de Azure Storage que le permite manipular sus blobs.

KeepAlivePolicyFactory

KeepAlivePolicyFactory es una clase de fábrica que ayuda a generar objetos KeepAlivePolicy.

LoggingPolicyFactory

LoggingPolicyFactory es una clase de fábrica que ayuda a generar objetos LoggingPolicy.

PageBlobURL

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

Pipeline

Una clase pipeline que contiene directivas de solicitud HTTP. Puede crear una canalización predeterminada llamando a StorageURL.newPipeline(). O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte StorageURL.newPipeline() y las directivas proporcionadas como referencia antes de implementar la canalización personalizada.

RetryPolicyFactory

RetryPolicyFactory es una clase de fábrica que ayuda a generar objetos RetryPolicy.

SASQueryParameters

Representa los componentes que componen los parámetros de consulta de saS de Azure Storage. El usuario no construye directamente este tipo; solo se genera mediante los tipos <xref:IAccountSASSignatureValues> y <xref:IBlobSASSignatureValues>. Una vez generado, se puede codificar en una {@code String} y anexarse directamente a una dirección URL (aunque debe tenerse cuidado aquí en caso de que haya parámetros de consulta existentes, lo que podría afectar a los medios adecuados de anexar estos parámetros de consulta). NOTA: Las instancias de esta clase son inmutables.

ServiceURL

Un ServiceURL representa una dirección URL al servicio Azure Storage Blob que le permite manipular contenedores de blobs.

StorageURL

Un ServiceURL representa una clase de dirección URL basada para ServiceURL, ContainerURL y etc.

TelemetryPolicyFactory

TelemetryPolicyFactory es una clase de fábrica que ayuda a generar objetos TelemetryPolicy.

UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory es una clase de fábrica que ayuda a generar objetos UniqueRequestIDPolicy.

AnonymousCredential

AnonymousCredential proporciona un miembro credentialPolicyCreator que se usa para crear objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy se usa con solicitudes HTTP(S) que leen recursos públicos o que se usan con firmas de acceso compartido (SAS).

Credential

Credential es una clase abstracta para la firma de solicitudes HTTP de Azure Storage. Esta clase hospedará una factoría credentialPolicyCreator que genera CredentialPolicy.

SharedKeyCredential

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. SharedKeyCredential para la autorización de clave de cuenta del servicio Azure Storage.

TokenCredential

TokenCredential es una credencial que se usa para generar un tokenCredentialPolicy. Renueve el token estableciendo un nuevo valor de cadena de token en la propiedad token.

UserDelegationKeyCredential

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. UserDelegationKeyCredential solo se usa para la generación de SAS de delegación de usuarios.

AppendBlob

Clase que representa un AppendBlob.

Blob

Clase que representa un blob.

BlockBlob

Clase que representa un BlockBlob.

Container

Clase que representa un contenedor.

Directory

Clase que representa un directorio.

PageBlob

Clase que representa un PageBlob.

Service

Clase que representa un servicio.

StorageClient
StorageClientContext
AnonymousCredentialPolicy

AnonymousCredentialPolicy se usa con solicitudes HTTP(S) que leen recursos públicos o que se usan con firmas de acceso compartido (SAS).

BrowserPolicy

BrowserPolicy controlará las diferencias entre Node.js y el entorno de ejecución del explorador, entre los que se incluyen:

  1. Los exploradores almacenan en caché las solicitudes GET/HEAD agregando encabezados condicionales como "IF_MODIFIED_SINCE". BrowserPolicy es una directiva que se usa para agregar una consulta de marca de tiempo a la dirección URL de solicitud GET/HEAD, por lo que evita la memoria caché del explorador.

  2. Eliminación del encabezado de cookie para la seguridad

  3. Eliminación del encabezado de longitud de contenido para evitar la advertencia de exploradores

CredentialPolicy

Directiva de credenciales que se usa para firmar solicitudes HTTP(S) antes de enviarlos. Se trata de una clase abstracta.

KeepAlivePolicy

KeepAlivePolicy es una directiva que se usa para controlar la configuración de mantenimiento activo de cada solicitud.

LoggingPolicy

LoggingPolicy es una directiva que se usa para registrar las solicitudes.

RetryPolicy

Directiva de reintento con reintento exponencial y reintento lineal implementado.

SharedKeyCredentialPolicy

SharedKeyCredentialPolicy es una directiva que se usa para firmar la solicitud HTTP con una clave compartida.

TelemetryPolicy

TelemetryPolicy es una directiva que se usa para etiquetar el encabezado user-agent para cada solicitud.

TokenCredentialPolicy

TokenCredentialPolicy es una directiva que se usa para firmar la solicitud HTTP con un token. Por ejemplo, un token de portador de OAuth.

UniqueRequestIDPolicy

UniqueRequestIDPolicy genera un UUID como valor de encabezado x-ms-request-id.

Batch

Batch proporciona una ejecución en paralelo básica con límites de simultaneidad. Detendrá las operaciones izquierdas cuando una de las operaciones ejecutadas produzca un error. Pero Batch no puede cancelar las operaciones en curso, debe cancelarlas por su cuenta.

BufferScheduler

Esta clase acepta un Node.js flujo legible como entrada y mantiene la lectura de datos de la secuencia en la estructura de búfer interna, hasta que alcanza maxBuffers. Cada búfer disponible intentará desencadenar outgoingHandler. La estructura del búfer interno incluye una matriz de búfer entrante y una matriz de búfer de salida. La matriz de búfer entrante incluye los búferes "vacíos" se pueden rellenar con nuevos datos entrantes. La matriz saliente incluye los búferes rellenados que se van a controlar mediante outgoingHandler. Cada tamaño de búfer anterior se define mediante bufferSize de parámetros.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers

SUGERENCIAS PARA MEJORAR EL RENDIMIENTO:

  1. HighWaterMark de flujo de entrada es mejor establecer un mismo valor con el parámetro bufferSize, lo que evitará las operaciones Buffer.concat().
  2. El paralelismo debe establecer un valor menor que maxBuffers, lo que resulta útil para reducir la posibilidad de que un controlador saliente espere los datos del flujo. en esta situación, se bloquean los controladores salientes. La cola saliente no debe estar vacía.
Mutex

Un bloqueo de exclusión mutua asincrónica.

RetriableReadableStream

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Un Node.js ReadableStream reintentará internamente cuando finalice inesperadamente ReadableStream interno.

Interfaces

IAppendBlobAppendBlockFromURLOptions
IAppendBlobAppendBlockOptions
IAppendBlobCreateOptions
BatchSubRequest
BatchSubResponse
ParsedBatchResponse
IBlobAbortCopyFromURLOptions
IBlobAcquireLeaseOptions
IBlobBreakLeaseOptions
IBlobChangeLeaseOptions
IBlobCreateSnapshotOptions
IBlobDeleteOptions
IBlobDownloadOptions
IBlobGetPropertiesOptions
IBlobReleaseLeaseOptions
IBlobRenewLeaseOptions
IBlobSetHTTPHeadersOptions
IBlobSetMetadataOptions
IBlobSetTierOptions
IBlobStartCopyFromURLOptions
IBlobSyncCopyFromURLOptions
IBlockBlobCommitBlockListOptions
IBlockBlobGetBlockListOptions
IBlockBlobStageBlockFromURLOptions
IBlockBlobStageBlockOptions
IBlockBlobUploadOptions
IContainerAcquireLeaseOptions
IContainerBreakLeaseOptions
IContainerChangeLeaseOptions
IContainerCreateOptions
IContainerDeleteMethodOptions
IContainerGetAccessPolicyOptions
IContainerGetPropertiesOptions
IContainerListBlobsSegmentOptions
IContainerReleaseLeaseOptions
IContainerRenewLeaseOptions
IContainerSetAccessPolicyOptions
IContainerSetMetadataOptions
ISignedIdentifier
IAccountSASSignatureValues

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. IAccountSASSignatureValues se usa para generar una firma de acceso compartido (SAS) para una cuenta de Azure Storage. Una vez que todos los valores aquí se establecen correctamente, llame a generateSASQueryParameters() para obtener una representación de la SAS que realmente se puede aplicar a las direcciones URL de blob. Nota: que tanto esta clase como <xref:SASQueryParameters> existen porque la primera es mutable y una representación lógica, mientras que esta última es inmutable y se usa para generar solicitudes REST reales.

IBlobSASSignatureValues

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. IBlobSASSignatureValues se usa para ayudar a generar tokens saS de Blob service para contenedores o blobs.

IIPRange

Intervalo IP permitido para una SAS.

IRange

Intervalo para las operaciones de Blob Service.

IKeepAliveOptions

Interfaz de las opciones KeepAlivePolicy.

IRequestLogOptions

RequestLogOptions configura el comportamiento de la directiva de reintento.

IPageBlobClearPagesOptions
IPageBlobCreateOptions
IPageBlobGetPageRangesDiffOptions
IPageBlobGetPageRangesOptions
IPageBlobResizeOptions
IPageBlobStartCopyIncrementalOptions
IPageBlobUpdateSequenceNumberOptions
IPageBlobUploadPagesFromURLOptions
IPageBlobUploadPagesOptions
IPipelineOptions

Interfaz de opción para el constructor de canalización.

IRetryOptions

Interfaz de opciones de reintento.

IServiceListContainersSegmentOptions
UserDelegationKey

Una clave de delegación de usuarios

INewPipelineOptions

Interfaz de opción para el método Pipeline.newPipeline.

ITelemetryOptions

Interfaz de las opciones telemetryPolicy.

AccessPolicy

Una directiva de acceso

AppendBlobAppendBlockFromUrlHeaders

Define encabezados para la operación AppendBlockFromUrl.

AppendBlobAppendBlockFromUrlOptionalParams

Parámetros opcionales.

AppendBlobAppendBlockHeaders

Define encabezados para la operación AppendBlock.

AppendBlobAppendBlockOptionalParams

Parámetros opcionales.

AppendBlobCreateHeaders

Define encabezados para la operación Create.

AppendBlobCreateOptionalParams

Parámetros opcionales.

AppendPositionAccessConditions

Parámetros adicionales para un conjunto de operaciones, como: AppendBlob_appendBlock, AppendBlob_appendBlockFromUrl.

BlobAbortCopyFromURLHeaders

Define encabezados para la operación AbortCopyFromURL.

BlobAbortCopyFromURLOptionalParams

Parámetros opcionales.

BlobAcquireLeaseHeaders

Define encabezados para la operación AcquireLease.

BlobAcquireLeaseOptionalParams

Parámetros opcionales.

BlobBreakLeaseHeaders

Define encabezados para la operación BreakLease.

BlobBreakLeaseOptionalParams

Parámetros opcionales.

BlobChangeLeaseHeaders

Define encabezados para la operación ChangeLease.

BlobChangeLeaseOptionalParams

Parámetros opcionales.

BlobCopyFromURLHeaders

Define encabezados para la operación CopyFromURL.

BlobCopyFromURLOptionalParams

Parámetros opcionales.

BlobCreateSnapshotHeaders

Define encabezados para la operación CreateSnapshot.

BlobCreateSnapshotOptionalParams

Parámetros opcionales.

BlobDeleteHeaders

Define encabezados para la operación Delete.

BlobDeleteMethodOptionalParams

Parámetros opcionales.

BlobDownloadHeaders

Define encabezados para la operación de descarga.

BlobDownloadOptionalParams

Parámetros opcionales.

BlobFlatListSegment

Interfaz que representa BlobFlatListSegment.

BlobGetAccessControlHeaders

Define encabezados para la operación GetAccessControl.

BlobGetAccessControlOptionalParams

Parámetros opcionales.

BlobGetAccountInfoHeaders

Define encabezados para la operación GetAccountInfo.

BlobGetPropertiesHeaders

Define encabezados para la operación GetProperties.

BlobGetPropertiesOptionalParams

Parámetros opcionales.

BlobHTTPHeaders

Parámetros adicionales para un conjunto de operaciones.

BlobHierarchyListSegment

Interfaz que representa BlobHierarchyListSegment.

BlobItem

Un blob de Azure Storage

BlobMetadata

Interfaz que representa BlobMetadata.

BlobPrefix

Interfaz que representa BlobPrefix.

BlobProperties

Propiedades de un blob

BlobReleaseLeaseHeaders

Define encabezados para la operación ReleaseLease.

BlobReleaseLeaseOptionalParams

Parámetros opcionales.

BlobRenameHeaders

Define encabezados para la operación Cambiar nombre.

BlobRenameOptionalParams

Parámetros opcionales.

BlobRenewLeaseHeaders

Define encabezados para la operación RenewLease.

BlobRenewLeaseOptionalParams

Parámetros opcionales.

BlobSetAccessControlHeaders

Define encabezados para la operación SetAccessControl.

BlobSetAccessControlOptionalParams

Parámetros opcionales.

BlobSetHTTPHeadersHeaders

Define encabezados para la operación SetHTTPHeaders.

BlobSetHTTPHeadersOptionalParams

Parámetros opcionales.

BlobSetMetadataHeaders

Define encabezados para la operación SetMetadata.

BlobSetMetadataOptionalParams

Parámetros opcionales.

BlobSetTierHeaders

Define encabezados para la operación SetTier.

BlobSetTierOptionalParams

Parámetros opcionales.

BlobStartCopyFromURLHeaders

Define encabezados para la operación StartCopyFromURL.

BlobStartCopyFromURLOptionalParams

Parámetros opcionales.

BlobUndeleteHeaders

Define encabezados para la operación Undelete.

BlobUndeleteOptionalParams

Parámetros opcionales.

Block

Representa un único bloque en un blob en bloques. Describe el identificador y el tamaño del bloque.

BlockBlobCommitBlockListHeaders

Define encabezados para la operación CommitBlockList.

BlockBlobCommitBlockListOptionalParams

Parámetros opcionales.

BlockBlobGetBlockListHeaders

Define encabezados para la operación GetBlockList.

BlockBlobGetBlockListOptionalParams

Parámetros opcionales.

BlockBlobStageBlockFromURLHeaders

Define encabezados para la operación StageBlockFromURL.

BlockBlobStageBlockFromURLOptionalParams

Parámetros opcionales.

BlockBlobStageBlockHeaders

Define encabezados para la operación StageBlock.

BlockBlobStageBlockOptionalParams

Parámetros opcionales.

BlockBlobUploadHeaders

Define encabezados para la operación de carga.

BlockBlobUploadOptionalParams

Parámetros opcionales.

BlockList

Interfaz que representa BlockList.

BlockLookupList

Interfaz que representa BlockLookupList.

ClearRange

Interfaz que representa ClearRange.

ContainerAcquireLeaseHeaders

Define encabezados para la operación AcquireLease.

ContainerAcquireLeaseOptionalParams

Parámetros opcionales.

ContainerBreakLeaseHeaders

Define encabezados para la operación BreakLease.

ContainerBreakLeaseOptionalParams

Parámetros opcionales.

ContainerChangeLeaseHeaders

Define encabezados para la operación ChangeLease.

ContainerChangeLeaseOptionalParams

Parámetros opcionales.

ContainerCreateHeaders

Define encabezados para la operación Create.

ContainerCreateOptionalParams

Parámetros opcionales.

ContainerDeleteHeaders

Define encabezados para la operación Delete.

ContainerDeleteMethodOptionalParams

Parámetros opcionales.

ContainerGetAccessPolicyHeaders

Define encabezados para la operación GetAccessPolicy.

ContainerGetAccessPolicyOptionalParams

Parámetros opcionales.

ContainerGetAccountInfoHeaders

Define encabezados para la operación GetAccountInfo.

ContainerGetPropertiesHeaders

Define encabezados para la operación GetProperties.

ContainerGetPropertiesOptionalParams

Parámetros opcionales.

ContainerItem

Un contenedor de Azure Storage

ContainerListBlobFlatSegmentHeaders

Define encabezados para la operación ListBlobFlatSegment.

ContainerListBlobFlatSegmentOptionalParams

Parámetros opcionales.

ContainerListBlobHierarchySegmentHeaders

Define encabezados para la operación ListBlobHierarchySegment.

ContainerListBlobHierarchySegmentOptionalParams

Parámetros opcionales.

ContainerProperties

Propiedades de un contenedor

ContainerReleaseLeaseHeaders

Define encabezados para la operación ReleaseLease.

ContainerReleaseLeaseOptionalParams

Parámetros opcionales.

ContainerRenewLeaseHeaders

Define encabezados para la operación RenewLease.

ContainerRenewLeaseOptionalParams

Parámetros opcionales.

ContainerSetAccessPolicyHeaders

Define encabezados para la operación SetAccessPolicy.

ContainerSetAccessPolicyOptionalParams

Parámetros opcionales.

ContainerSetMetadataHeaders

Define encabezados para la operación SetMetadata.

ContainerSetMetadataOptionalParams

Parámetros opcionales.

CorsRule

CORS es una característica HTTP que permite que una aplicación web que se ejecute en un dominio acceda a los recursos de otro dominio. Los exploradores web implementan una restricción de seguridad conocida como directiva de mismo origen que impide que una página web llame a las API en un dominio diferente; CORS proporciona una manera segura de permitir que un dominio (el dominio de origen) llame a las API de otro dominio.

CpkInfo

Parámetros adicionales para un conjunto de operaciones.

DataLakeStorageError

Interfaz que representa DataLakeStorageError.

DataLakeStorageErrorError

Objeto de respuesta de error del servicio.

DirectoryCreateHeaders

Define encabezados para la operación Create.

DirectoryCreateOptionalParams

Parámetros opcionales.

DirectoryDeleteHeaders

Define encabezados para la operación Delete.

DirectoryDeleteMethodOptionalParams

Parámetros opcionales.

DirectoryGetAccessControlHeaders

Define encabezados para la operación GetAccessControl.

DirectoryGetAccessControlOptionalParams

Parámetros opcionales.

DirectoryHttpHeaders

Parámetros adicionales para un conjunto de operaciones, como: Directory_create, Directory_rename, Blob_rename.

DirectoryRenameHeaders

Define encabezados para la operación Cambiar nombre.

DirectoryRenameOptionalParams

Parámetros opcionales.

DirectorySetAccessControlHeaders

Define encabezados para la operación SetAccessControl.

DirectorySetAccessControlOptionalParams

Parámetros opcionales.

GeoReplication

Geo-Replication información del servicio de almacenamiento secundario

KeyInfo

Información clave

LeaseAccessConditions

Parámetros adicionales para un conjunto de operaciones.

ListBlobsFlatSegmentResponse

Enumeración de blobs

ListBlobsHierarchySegmentResponse

Enumeración de blobs

ListContainersSegmentResponse

Enumeración de contenedores

Logging

Configuración de registro de Azure Analytics.

Metrics

un resumen de las estadísticas de solicitud agrupadas por API en agregados de hora o minuto para blobs

ModifiedAccessConditions

Parámetros adicionales para un conjunto de operaciones.

PageBlobClearPagesHeaders

Define encabezados para la operación ClearPages.

PageBlobClearPagesOptionalParams

Parámetros opcionales.

PageBlobCopyIncrementalHeaders

Define encabezados para la operación CopyIncremental.

PageBlobCopyIncrementalOptionalParams

Parámetros opcionales.

PageBlobCreateHeaders

Define encabezados para la operación Create.

PageBlobCreateOptionalParams

Parámetros opcionales.

PageBlobGetPageRangesDiffHeaders

Define encabezados para la operación GetPageRangesDiff.

PageBlobGetPageRangesDiffOptionalParams

Parámetros opcionales.

PageBlobGetPageRangesHeaders

Define encabezados para la operación GetPageRanges.

PageBlobGetPageRangesOptionalParams

Parámetros opcionales.

PageBlobResizeHeaders

Define encabezados para la operación Resize.

PageBlobResizeOptionalParams

Parámetros opcionales.

PageBlobUpdateSequenceNumberHeaders

Define encabezados para la operación UpdateSequenceNumber.

PageBlobUpdateSequenceNumberOptionalParams

Parámetros opcionales.

PageBlobUploadPagesFromURLHeaders

Define encabezados para la operación UploadPagesFromURL.

PageBlobUploadPagesFromURLOptionalParams

Parámetros opcionales.

PageBlobUploadPagesHeaders

Define encabezados para la operación UploadPages.

PageBlobUploadPagesOptionalParams

Parámetros opcionales.

PageList

la lista de páginas

PageRange

Interfaz que representa PageRange.

RetentionPolicy

la directiva de retención que determina cuánto tiempo deben conservarse los datos asociados.

SequenceNumberAccessConditions

Parámetros adicionales para un conjunto de operaciones, como: PageBlob_uploadPages, PageBlob_clearPages, PageBlob_uploadPagesFromURL.

ServiceGetAccountInfoHeaders

Define encabezados para la operación GetAccountInfo.

ServiceGetPropertiesHeaders

Define encabezados para la operación GetProperties.

ServiceGetPropertiesOptionalParams

Parámetros opcionales.

ServiceGetStatisticsHeaders

Define encabezados para la operación GetStatistics.

ServiceGetStatisticsOptionalParams

Parámetros opcionales.

ServiceGetUserDelegationKeyHeaders

Define encabezados para la operación GetUserDelegationKey.

ServiceGetUserDelegationKeyOptionalParams

Parámetros opcionales.

ServiceListContainersSegmentHeaders

Define encabezados para la operación ListContainersSegment.

ServiceListContainersSegmentOptionalParams

Parámetros opcionales.

ServiceSetPropertiesHeaders

Define encabezados para la operación SetProperties.

ServiceSetPropertiesOptionalParams

Parámetros opcionales.

ServiceSubmitBatchHeaders

Define encabezados para la operación SubmitBatch.

ServiceSubmitBatchOptionalParams

Parámetros opcionales.

SignedIdentifier

identificador firmado

SourceModifiedAccessConditions

Parámetros adicionales para un conjunto de operaciones.

StaticWebsite

Propiedades que permiten que una cuenta hospede un sitio web estático

StorageClientOptions

Interfaz que representa StorageClientOptions.

StorageError

Interfaz que representa StorageError.

StorageServiceProperties

Propiedades del servicio de almacenamiento.

StorageServiceStats

Estadísticas del servicio de almacenamiento.

IDownloadFromBlobOptions

Interfaz de opción para DownloadBlockBlobToBuffer.

IUploadToBlockBlobOptions

Interfaz de opción para uploadFileToBlockBlob y uploadSeekableStreamToBlockBlob.

IUploadStreamToBlockBlobOptions

Interfaz de opción para uploadStreamToBlockBlob.

IAppendBlobAccessConditions
IBlobAccessConditions
IContainerAccessConditions
IMetadata
IPageBlobAccessConditions
IRetriableReadableStreamOptions

Alias de tipos

BlobDownloadResponse

Contiene datos de respuesta para la operación de descarga.

ContainerGetAccessPolicyResponse

Contiene datos de respuesta para la operación getAccessPolicy.

ServiceGetUserDelegationKeyResponse

Contiene datos de respuesta para la operación getUserDelegationKey.

ServiceSubmitBatchResponse

Contiene datos de respuesta para la operación submitBatch.

CredentialPolicyCreator

Función de fábrica que crea una nueva CredentialPolicy que usa nextPolicy proporcionada.

AccessTier

Define los valores de AccessTier. Los valores posibles son: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'

AccountKind

Define los valores de AccountKind. Los valores posibles son: "Storage", "BlobStorage", "StorageV2"

AppendBlobAppendBlockFromUrlResponse

Contiene datos de respuesta para la operación appendBlockFromUrl.

AppendBlobAppendBlockResponse

Contiene datos de respuesta para la operación appendBlock.

AppendBlobCreateResponse

Contiene datos de respuesta para la operación de creación.

ArchiveStatus

Define valores para ArchiveStatus. Entre los valores posibles se incluyen: "rehidratación pendiente a frecuente", "rehidratación pendiente a esporádico".

BlobAbortCopyFromURLResponse

Contiene datos de respuesta para la operación abortCopyFromURL.

BlobAcquireLeaseResponse

Contiene datos de respuesta para la operación acquireLease.

BlobBreakLeaseResponse

Contiene datos de respuesta para la operación breakLease.

BlobChangeLeaseResponse

Contiene datos de respuesta para la operación changeLease.

BlobCopyFromURLResponse

Contiene datos de respuesta para la operación copyFromURL.

BlobCreateSnapshotResponse

Contiene datos de respuesta para la operación createSnapshot.

BlobDeleteResponse

Contiene datos de respuesta para la operación deleteMethod.

BlobGetAccessControlResponse

Contiene datos de respuesta para la operación getAccessControl.

BlobGetAccountInfoResponse

Contiene datos de respuesta para la operación getAccountInfo.

BlobGetPropertiesResponse

Contiene datos de respuesta para la operación getProperties.

BlobReleaseLeaseResponse

Contiene datos de respuesta para la operación releaseLease.

BlobRenameResponse

Contiene datos de respuesta para la operación de cambio de nombre.

BlobRenewLeaseResponse

Contiene datos de respuesta para la operación renewLease.

BlobSetAccessControlResponse

Contiene datos de respuesta para la operación setAccessControl.

BlobSetHTTPHeadersResponse

Contiene datos de respuesta para la operación setHTTPHeaders.

BlobSetMetadataResponse

Contiene datos de respuesta para la operación setMetadata.

BlobSetTierResponse

Contiene datos de respuesta para la operación setTier.

BlobStartCopyFromURLResponse

Contiene datos de respuesta para la operación startCopyFromURL.

BlobType

Define valores para BlobType. Los valores posibles son: 'BlockBlob', 'PageBlob', 'AppendBlob'

BlobUndeleteResponse

Contiene datos de respuesta para la operación de recuperación.

BlockBlobCommitBlockListResponse

Contiene datos de respuesta para la operación commitBlockList.

BlockBlobGetBlockListResponse

Contiene datos de respuesta para la operación getBlockList.

BlockBlobStageBlockFromURLResponse

Contiene datos de respuesta para la operación stageBlockFromURL.

BlockBlobStageBlockResponse

Contiene datos de respuesta para la operación stageBlock.

BlockBlobUploadResponse

Contiene datos de respuesta para la operación de carga.

BlockListType

Define valores para BlockListType. Entre los valores posibles se incluyen: 'committed', 'uncommitted', 'all'

ContainerAcquireLeaseResponse

Contiene datos de respuesta para la operación acquireLease.

ContainerBreakLeaseResponse

Contiene datos de respuesta para la operación breakLease.

ContainerChangeLeaseResponse

Contiene datos de respuesta para la operación changeLease.

ContainerCreateResponse

Contiene datos de respuesta para la operación de creación.

ContainerDeleteResponse

Contiene datos de respuesta para la operación deleteMethod.

ContainerGetAccountInfoResponse

Contiene datos de respuesta para la operación getAccountInfo.

ContainerGetPropertiesResponse

Contiene datos de respuesta para la operación getProperties.

ContainerListBlobFlatSegmentResponse

Contiene datos de respuesta para la operación listBlobFlatSegment.

ContainerListBlobHierarchySegmentResponse

Contiene datos de respuesta para la operación listBlobHierarchySegment.

ContainerReleaseLeaseResponse

Contiene datos de respuesta para la operación releaseLease.

ContainerRenewLeaseResponse

Contiene datos de respuesta para la operación renewLease.

ContainerSetAccessPolicyResponse

Contiene datos de respuesta para la operación setAccessPolicy.

ContainerSetMetadataResponse

Contiene datos de respuesta para la operación setMetadata.

CopyStatusType

Define valores para CopyStatusType. Entre los valores posibles se incluyen: 'pendiente', 'success', 'aborted', 'failed'

DeleteSnapshotsOptionType

Define valores para DeleteSnapshotsOptionType. Entre los valores posibles se incluyen: 'include', 'only'

DirectoryCreateResponse

Contiene datos de respuesta para la operación de creación.

DirectoryDeleteResponse

Contiene datos de respuesta para la operación deleteMethod.

DirectoryGetAccessControlResponse

Contiene datos de respuesta para la operación getAccessControl.

DirectoryRenameResponse

Contiene datos de respuesta para la operación de cambio de nombre.

DirectorySetAccessControlResponse

Contiene datos de respuesta para la operación setAccessControl.

EncryptionAlgorithmType

Define valores para EncryptionAlgorithmType. Entre los valores posibles se incluyen: "AES256"

GeoReplicationStatusType

Define valores para GeoReplicationStatusType. Entre los valores posibles se incluyen: 'live', 'bootstrap', 'unavailable'

LeaseDurationType

Define valores para LeaseDurationType. Entre los valores posibles se incluyen: 'infinite', 'fixed'

LeaseStateType

Define valores para LeaseStateType. Entre los valores posibles se incluyen: 'available', 'leased', 'expired', 'breaking', 'broken'

LeaseStatusType

Define valores para LeaseStatusType. Entre los valores posibles se incluyen: "bloqueado", "desbloqueado".

ListBlobsIncludeItem

Define valores para ListBlobsIncludeItem. Los valores posibles son: 'copy', 'deleted', 'metadata', 'snapshots', 'uncommittedblobs'

ListContainersIncludeType

Define valores para ListContainersIncludeType. Entre los valores posibles se incluyen los siguientes: 'metadata'

PageBlobClearPagesResponse

Contiene datos de respuesta para la operación clearPages.

PageBlobCopyIncrementalResponse

Contiene datos de respuesta para la operación copyIncremental.

PageBlobCreateResponse

Contiene datos de respuesta para la operación de creación.

PageBlobGetPageRangesDiffResponse

Contiene datos de respuesta para la operación getPageRangesDiff.

PageBlobGetPageRangesResponse

Contiene datos de respuesta para la operación getPageRanges.

PageBlobResizeResponse

Contiene datos de respuesta para la operación de cambio de tamaño.

PageBlobUpdateSequenceNumberResponse

Contiene datos de respuesta para la operación updateSequenceNumber.

PageBlobUploadPagesFromURLResponse

Contiene datos de respuesta para la operación uploadPagesFromURL.

PageBlobUploadPagesResponse

Contiene datos de respuesta para la operación uploadPages.

PathRenameMode

Define valores para PathRenameMode. Entre los valores posibles se incluyen: 'legacy', 'posix'

PublicAccessType

Define valores para PublicAccessType. Entre los valores posibles se incluyen: 'container', 'blob'

RehydratePriority

Define valores para RehydratePriority. Entre los valores posibles se incluyen: 'High', 'Standard'

SequenceNumberActionType

Define valores para SequenceNumberActionType. Entre los valores posibles se incluyen: 'max', 'update', 'increment'

ServiceGetAccountInfoResponse

Contiene datos de respuesta para la operación getAccountInfo.

ServiceGetPropertiesResponse

Contiene datos de respuesta para la operación getProperties.

ServiceGetStatisticsResponse

Contiene datos de respuesta para la operación getStatistics.

ServiceListContainersSegmentResponse

Contiene datos de respuesta para la operación listContainersSegment.

ServiceSetPropertiesResponse

Contiene datos de respuesta para la operación setProperties.

SkuName

Define valores para SkuName. Los valores posibles son: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Premium_LRS".

StorageErrorCode

Define los valores de StorageErrorCode. Los valores posibles son: "AccountAlreadyExists", "AccountBeingCreated", "AccountIsDisabled", "AuthenticationFailed", "AuthorizationFailure", 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidQueryParameterValue', 'InvalidQueryParameterValue', 'InvalidResourceName', 'InvalidUri', ' InvalidXmlDocument', 'InvalidXmlNodeValue', 'Md5Mismatch', 'MetadataTooLarge', 'MissingContentLengthHeader', 'MissingRequiredQueryParameter', 'MissingRequiredHeader', 'MissingRequiredXmlNode', 'MultipleConditionHeadersNotSupported', 'OperationTimedOut', 'OutOfRangeInput', 'OutOfRangeQueryParameterValue', 'RequestBodyTooLarge', 'ResourceTypeMismatch', 'RequestUrlFailedToParse', 'ResourceAlreadyExists', 'ResourceNotFound', 'ServerBusy', 'UnsupportedHeader', ' UnsupportedXmlNode', 'UnsupportedQueryParameter', 'UnsupportedHttpVerb', 'AppendPositionConditionNotMet', 'BlobAlreadyExists', 'BlobNotFound', 'BlobOverwritten', 'BlobTierInadequateForContentLength', 'BlockCountExceedsLimit', 'BlockListTooLong', 'CannotChangeToLowerTier', 'CannotVerifyCopySource', 'ContainerAlreadyExists', 'ContainerBeingDeleted', 'ContainerDisabled', 'ContainerNotFound', 'ContentLengthLargerThanLimit', 'CopyAcrossAccountsNotSupported', ' CopyIdMismatch', 'FeatureVersionMismatch', 'IncrementalCopyBlobMismatch', 'IncrementalCopyOfEralierVersionSnapshotNotAllowed', 'IncrementalCopySourceMustBeSnapshot', 'InfiniteLeaseDurationRequired', 'InvalidBlobOrBlock', 'InvalidBlobTier', 'InvalidBlobType', 'InvalidBlockId', 'InvalidBlockList', 'InvalidOperation', 'InvalidPageRange', 'InvalidSourceBlobType', 'InvalidSourceBlobUrl', 'InvalidVersionForPageBlobOperation', 'LeaseAlreadyPresent', 'LeaseAlreadyBroken', 'LeaseAlreadyBroken', 'LeaseIdMismatchWithBlobOperation', 'LeaseIdMismatchWithContainerOperation', 'LeaseIdMismatchWithLeaseOperation', 'LeaseIdMissing', 'LeaseIsBreakingAndCannotBeAcquired', 'LeaseIsBreakingAndCannotBeChanged', 'LeaseIsBrokenAndCannotBeRenewed', 'LeaseNotPresentWithBlobOperation', 'LeaseNotPresentWithContainerOperation', 'LeaseNotPresentWithLeaseOperation', 'MaxBlobSizeConditionNotMet', 'NoPendingCopyOperation', ' OperationNotAllowedOnIncrementalCopyBlob' , 'PendingCopyOperation', 'PreviousSnapshotCannotBeNewer', 'PreviousSnapshotNotFound', 'PreviousSnapshotOperationNotSupported', 'SequenceNumberConditionNotMet', 'SequenceNumberIncrementTooLarge', 'SnapshotCountExceed', 'SnaphotOperationRateExceededed', 'SnapshotsPresent', 'SourceConditionNotMet', 'SystemInUse', 'TargetConditionNotMet', 'UnauthorizedBlobOverwrite', 'BlobBeingRehydrated', 'BlobArchived', 'BlobNotArchived'

SyncCopyStatusType

Define valores para SyncCopyStatusType. Entre los valores posibles se incluyen: "success"

BlobUploadCommonResponse

Escriba uploadFileToBlockBlob, uploadStreamToBlockBlob y uploadBrowserDateToBlockBlob.

Operation

La operación es una función asincrónica que Batch ejecutará y administrará.

OutgoingHandler

OutgoingHandler es una función asincrónica desencadenada por BufferScheduler.

ReadableStreamGetter

Enumeraciones

SASProtocol

Protocolos para SAS generados.

BlockBlobTier
PremiumPageBlobTier
RetryPolicyType

Tipos RetryPolicy.

Funciones

getBodyAsText(Models.ServiceSubmitBatchResponse)
utf8ByteLength(string)
generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Genera un objeto <xref:SASQueryParameters> que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.

generateBlobSASQueryParameters(IBlobSASSignatureValues, SharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Crea una instancia de SASQueryParameters.

Solo acepta la configuración necesaria para crear una SAS. Para la configuración opcional, establezca las propiedades correspondientes directamente, como permisos, startTime e identificador.

ADVERTENCIA: Cuando no se proporciona el identificador, se requieren permisos y expiryTime. Debe asignar valor al identificador o a los permisos expiryTime & manualmente si se inicializa con este constructor.

generateBlobSASQueryParameters(IBlobSASSignatureValues, UserDelegationKey, string)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Crea una instancia de SASQueryParameters. ADVERTENCIA: se omitirá el identificador al generar saS de delegación de usuarios, se requieren permisos y expiryTime.

ipRangeToString(IIPRange)

Generar cadena de formato IPRange. Por ejemplo: "8.8.8.8" o "1.1.1.1-255.255.255.255"

rangeToString(IRange)

Genere una cadena de intervalo. Por ejemplo: "bytes=255-" o "bytes=0-511"

uploadBrowserDataToBlockBlob(Aborter, Blob | ArrayBuffer | ArrayBufferView, BlockBlobURL, IUploadToBlockBlobOptions)

SOLO ESTÁ DISPONIBLE EN EXPLORADORES. Carga un objeto Blob/File/ArrayBuffer/ArrayBufferView del explorador en blob en bloques.

Cuando la longitud del búfer <= 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.

downloadBlobToBuffer(Aborter, Buffer, BlobURL, number, undefined | number, IDownloadFromBlobOptions)

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, pase 0 para que ambos descarguen todo el blob.

uploadFileToBlockBlob(Aborter, string, BlockBlobURL, IUploadToBlockBlobOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga un archivo local en bloques en un blob en bloques.

Cuando el tamaño de archivo <= 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.

uploadStreamToBlockBlob(Aborter, Readable, BlockBlobURL, number, number, IUploadStreamToBlockBlobOptions)

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().
ensureCpkIfSpecified(CpkInfo | undefined, boolean)
toAccessTier(BlockBlobTier | PremiumPageBlobTier | string | undefined)
NewRetryPolicyFactory(IRetryOptions)

Un método de fábrica usado para generar una factoría RetryPolicy.

blobToArrayBuffer(Blob)

Convierta un objeto Browser Blob en ArrayBuffer.

blobToString(Blob)

Convierta un objeto Browser Blob en una cadena.

appendToURLPath(string, string)

Anexe una cadena a la ruta de acceso url. Quitará "/" duplicado delante de la cadena cuando la ruta de acceso url termine con "/".

base64decode(string)

Descodificación de Base64.

base64encode(string)

Codificación base64.

delay(number, AbortSignalLike, Error)

Retraso del intervalo de tiempo especificado.

escapeURLPath(string)

Los caracteres de dirección URL reservada deben tener un escape correcto para los servicios de Storage, como Blob o File.

Codificación de direcciones URL y estrategia de escape para LOS SDK de JSv10

Cuando los clientes pasan una cadena de dirección URL a clases XXXURL constrcutor, es posible que la cadena de dirección URL ya esté codificada o no. Pero antes de enviarlos al servidor de Azure Storage, se debe codificar la dirección URL. Sin embargo, es difícil que un SDK adivina si la cadena de dirección URL se ha codificado o no. Tenemos 2 estrategias potenciales y elegimos la estrategia dos para los constructores XXXURL.

Estrategia Uno: suponga que la cadena de dirección URL del cliente no está codificada y codifica siempre la cadena de dirección URL en el SDK.

Esto es lo que hace el SDK de V2 heredado, sencillo y funciona para la mayoría de los casos.

  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b:", el SDK lo codificará en "http://account.blob.core.windows.net/con/b%3A" y enviar al servidor. Se creará un blob denominado "b:".
  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b%3A", el SDK lo codificará en "http://account.blob.core.windows.net/con/b%253A" y enviar al servidor. Se creará un blob denominado "b%3A".

Pero esta estrategia no permitirá crear un blob con "?" en su nombre. Dado que cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/blob?name", el "?name" se tratará como parámetro de dirección URL en lugar de nombre de blob. Si la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/blob%3Fname", se creará un blob denominado "blob%3Fname". El SDK de V2 no tiene este problema porque no permite que el cliente pase una dirección URL completa, acepta un nombre de blob independiente y codificarURIComponent para él. No podemos aceptar un SDK no puede crear un nombre de blob con "?". Por lo tanto, implementamos la estrategia dos:

Estrategia Dos: EL SDK no supone que la dirección URL se ha codificado o no. Simplemente escapará de los caracteres especiales.

Esto es lo que hace el SDK de Go para blobs V10. Acepta un tipo de dirección URL en Go y llama a la dirección URL. EscapedPath() para escapar de los caracteres especiales sin escape.

  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b:", el SDK escapará ":" como "http://account.blob.core.windows.net/con/b%3A" y enviar al servidor. Se creará un blob denominado "b:".
  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b%3A", no hay caracteres especiales, por lo que enviar "http://account.blob.core.windows.net/con/b%3A" en el servidor. Se creará un blob denominado "b:".
  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b%253A", no hay caracteres especiales, por lo que enviar "http://account.blob.core.windows.net/con/b%253A" en el servidor. Se creará un blob denominado "b%3A".

Esta estrategia nos ofrece flexibilidad para crear con cualquier carácter especial. Pero "%" se tratará como caracteres especiales, si la cadena de dirección URL no está codificada, no debería haber "%" en la cadena de dirección URL; de lo contrario, la dirección URL no es una dirección URL válida. Si el cliente necesita crear un blob con "%" en su nombre de blob, use "%25" insead of "%". Al igual que en el ejemplo anterior. Y las siguientes cadenas de dirección URL no son válidas:

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Otro carácter especial es "?", use "%2F" para representar un nombre de blob con "?" en una cadena de dirección URL.

Estrategia para containerName, blobName u otros parámetros XXXName específicos en métodos como BlobURL.fromContainerURL(containerURL, blobName)

Aplicaremos la estrategia uno y llamaremos a encodeURIComponent para estos parámetros como blobName. Dado que lo que los clientes pasan es un nombre sin formato en lugar de una dirección URL.

generateBlockID(string, number)

Genere una cadena de identificador de bloque base64 bytes de 64 bytes.

getURLParameter(string, string)

Obtenga el parámetro URL por nombre.

getURLPath(string)

Obtiene la ruta de acceso de dirección URL de una cadena de dirección URL.

getURLPathAndQuery(string)

Obtiene la ruta de acceso de la dirección URL y consulta desde una cadena de dirección URL.

getURLQueries(string)

Obtiene pares de valor de clave de consulta url de una cadena de dirección URL.

getURLScheme(string)

Obtiene el esquema de dirección URL de una cadena de dirección URL.

iEqual(string, string)

Si dos cadenas son iguales cuando se comparan sin distinción entre mayúsculas y minúsculas.

padStart(string, number, undefined | string)

String.prototype.padStart()

setURLHost(string, string)

Establezca el host de dirección URL.

setURLParameter(string, string, undefined | string)

Establezca el nombre y el valor del parámetro de dirección URL. Si el nombre existe en los parámetros de dirección URL, el valor anterior se reemplazará por clave de nombre. Si no proporciona valor, se eliminará el parámetro .

truncatedISO8061Date(Date, undefined | false | true)

Redondea una fecha de salida a segundos.

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Lee una secuencia legible en el búfer. Rellene el búfer del desplazamiento al final.

streamToBuffer2(ReadableStream, Buffer, undefined | string)

Lee un flujo legible en el búfer por completo.

Detalles de la función

getBodyAsText(Models.ServiceSubmitBatchResponse)

function getBodyAsText(batchResponse: Models.ServiceSubmitBatchResponse)

Parámetros

batchResponse
Models.ServiceSubmitBatchResponse

Devoluciones

Promise<string>

utf8ByteLength(string)

function utf8ByteLength(str: string)

Parámetros

str

string

Devoluciones

number

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Genera un objeto <xref:SASQueryParameters> que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parámetros

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Devoluciones

generateBlobSASQueryParameters(IBlobSASSignatureValues, SharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Crea una instancia de SASQueryParameters.

Solo acepta la configuración necesaria para crear una SAS. Para la configuración opcional, establezca las propiedades correspondientes directamente, como permisos, startTime e identificador.

ADVERTENCIA: Cuando no se proporciona el identificador, se requieren permisos y expiryTime. Debe asignar valor al identificador o a los permisos expiryTime & manualmente si se inicializa con este constructor.

function generateBlobSASQueryParameters(blobSASSignatureValues: IBlobSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parámetros

blobSASSignatureValues
IBlobSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Devoluciones

generateBlobSASQueryParameters(IBlobSASSignatureValues, UserDelegationKey, string)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Crea una instancia de SASQueryParameters. ADVERTENCIA: se omitirá el identificador al generar saS de delegación de usuarios, se requieren permisos y expiryTime.

function generateBlobSASQueryParameters(blobSASSignatureValues: IBlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

Parámetros

blobSASSignatureValues
IBlobSASSignatureValues
userDelegationKey
UserDelegationKey

Valor devuelto de ServiceURL.getUserDelegationKey()

accountName

string

Devoluciones

ipRangeToString(IIPRange)

Generar cadena de formato IPRange. Por ejemplo: "8.8.8.8" o "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parámetros

ipRange
IIPRange

Devoluciones

string

rangeToString(IRange)

Genere una cadena de intervalo. Por ejemplo: "bytes=255-" o "bytes=0-511"

function rangeToString(iRange: IRange)

Parámetros

iRange
IRange

Devoluciones

string

uploadBrowserDataToBlockBlob(Aborter, Blob | ArrayBuffer | ArrayBufferView, BlockBlobURL, IUploadToBlockBlobOptions)

SOLO ESTÁ DISPONIBLE EN EXPLORADORES. Carga un objeto Blob/File/ArrayBuffer/ArrayBufferView del explorador en blob en bloques.

Cuando la longitud del búfer <= 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 uploadBrowserDataToBlockBlob(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, blockBlobURL: BlockBlobURL, options?: IUploadToBlockBlobOptions)

Parámetros

aborter
Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer o ArrayBufferView

blockBlobURL
BlockBlobURL

Devoluciones

downloadBlobToBuffer(Aborter, Buffer, BlobURL, number, undefined | number, IDownloadFromBlobOptions)

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, pase 0 para que ambos descarguen todo el blob.

function downloadBlobToBuffer(aborter: Aborter, buffer: Buffer, blobURL: BlobURL, offset: number, count?: undefined | number, options?: IDownloadFromBlobOptions)

Parámetros

aborter
Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

buffer

Buffer

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

blobURL
BlobURL

Un objeto BlobURL

offset

number

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

count

undefined | number

Devoluciones

Promise<void>

uploadFileToBlockBlob(Aborter, string, BlockBlobURL, IUploadToBlockBlobOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga un archivo local en bloques en un blob en bloques.

Cuando el tamaño de archivo <= 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 uploadFileToBlockBlob(aborter: Aborter, filePath: string, blockBlobURL: BlockBlobURL, options?: IUploadToBlockBlobOptions)

Parámetros

aborter
Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

filePath

string

Ruta de acceso completa del archivo local

blockBlobURL
BlockBlobURL

BlockBlobURL

Devoluciones

ICommonResponse

uploadStreamToBlockBlob(Aborter, Readable, BlockBlobURL, number, number, IUploadStreamToBlockBlobOptions)

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 uploadStreamToBlockBlob(aborter: Aborter, stream: Readable, blockBlobURL: BlockBlobURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToBlockBlobOptions)

Parámetros

aborter
Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

stream

Readable

Node.js secuencia legible

blockBlobURL
BlockBlobURL

Una instancia de BlockBlobURL

bufferSize

number

Tamaño de cada búfer asignado, también el tamaño del bloque en el blob en bloques cargado

maxBuffers

number

Los búferes máximos se asignarán durante la carga, correlación positiva con la simultaneidad máxima de carga.

Devoluciones

ensureCpkIfSpecified(CpkInfo | undefined, boolean)

function ensureCpkIfSpecified(cpk: CpkInfo | undefined, isHttps: boolean)

Parámetros

cpk

CpkInfo | undefined

isHttps

boolean

toAccessTier(BlockBlobTier | PremiumPageBlobTier | string | undefined)

function toAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string | undefined)

Parámetros

tier

BlockBlobTier | PremiumPageBlobTier | string | undefined

Devoluciones

Models

NewRetryPolicyFactory(IRetryOptions)

Un método de fábrica usado para generar una factoría RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parámetros

retryOptions
IRetryOptions

Devoluciones

RequestPolicyFactory

blobToArrayBuffer(Blob)

Convierta un objeto Browser Blob en ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parámetros

blob

Blob

Devoluciones

Promise<ArrayBuffer>

blobToString(Blob)

Convierta un objeto Browser Blob en una cadena.

function blobToString(blob: Blob)

Parámetros

blob

Blob

Devoluciones

Promise<string>

appendToURLPath(string, string)

Anexe una cadena a la ruta de acceso url. Quitará "/" duplicado delante de la cadena cuando la ruta de acceso url termine con "/".

function appendToURLPath(url: string, name: string)

Parámetros

url

string

Cadena de dirección URL de origen

name

string

Cadena que se va a anexar a la dirección URL

Devoluciones

string

Cadena de dirección URL actualizada

base64decode(string)

Descodificación de Base64.

function base64decode(encodedString: string)

Parámetros

encodedString

string

Devoluciones

string

base64encode(string)

Codificación base64.

function base64encode(content: string)

Parámetros

content

string

Devoluciones

string

delay(number, AbortSignalLike, Error)

Retraso del intervalo de tiempo especificado.

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Parámetros

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Devoluciones

Promise<unknown>

escapeURLPath(string)

Los caracteres de dirección URL reservada deben tener un escape correcto para los servicios de Storage, como Blob o File.

Codificación de direcciones URL y estrategia de escape para LOS SDK de JSv10

Cuando los clientes pasan una cadena de dirección URL a clases XXXURL constrcutor, es posible que la cadena de dirección URL ya esté codificada o no. Pero antes de enviarlos al servidor de Azure Storage, se debe codificar la dirección URL. Sin embargo, es difícil que un SDK adivina si la cadena de dirección URL se ha codificado o no. Tenemos 2 estrategias potenciales y elegimos la estrategia dos para los constructores XXXURL.

Estrategia Uno: suponga que la cadena de dirección URL del cliente no está codificada y codifica siempre la cadena de dirección URL en el SDK.

Esto es lo que hace el SDK de V2 heredado, sencillo y funciona para la mayoría de los casos.

  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b:", el SDK lo codificará en "http://account.blob.core.windows.net/con/b%3A" y enviar al servidor. Se creará un blob denominado "b:".
  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b%3A", el SDK lo codificará en "http://account.blob.core.windows.net/con/b%253A" y enviar al servidor. Se creará un blob denominado "b%3A".

Pero esta estrategia no permitirá crear un blob con "?" en su nombre. Dado que cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/blob?name", el "?name" se tratará como parámetro de dirección URL en lugar de nombre de blob. Si la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/blob%3Fname", se creará un blob denominado "blob%3Fname". El SDK de V2 no tiene este problema porque no permite que el cliente pase una dirección URL completa, acepta un nombre de blob independiente y codificarURIComponent para él. No podemos aceptar un SDK no puede crear un nombre de blob con "?". Por lo tanto, implementamos la estrategia dos:

Estrategia Dos: EL SDK no supone que la dirección URL se ha codificado o no. Simplemente escapará de los caracteres especiales.

Esto es lo que hace el SDK de Go para blobs V10. Acepta un tipo de dirección URL en Go y llama a la dirección URL. EscapedPath() para escapar de los caracteres especiales sin escape.

  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b:", el SDK escapará ":" como "http://account.blob.core.windows.net/con/b%3A" y enviar al servidor. Se creará un blob denominado "b:".
  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b%3A", no hay caracteres especiales, por lo que enviar "http://account.blob.core.windows.net/con/b%3A" en el servidor. Se creará un blob denominado "b:".
  • Cuando la cadena de dirección URL del cliente es "http://account.blob.core.windows.net/con/b%253A", no hay caracteres especiales, por lo que enviar "http://account.blob.core.windows.net/con/b%253A" en el servidor. Se creará un blob denominado "b%3A".

Esta estrategia nos ofrece flexibilidad para crear con cualquier carácter especial. Pero "%" se tratará como caracteres especiales, si la cadena de dirección URL no está codificada, no debería haber "%" en la cadena de dirección URL; de lo contrario, la dirección URL no es una dirección URL válida. Si el cliente necesita crear un blob con "%" en su nombre de blob, use "%25" insead of "%". Al igual que en el ejemplo anterior. Y las siguientes cadenas de dirección URL no son válidas:

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Otro carácter especial es "?", use "%2F" para representar un nombre de blob con "?" en una cadena de dirección URL.

Estrategia para containerName, blobName u otros parámetros XXXName específicos en métodos como BlobURL.fromContainerURL(containerURL, blobName)

Aplicaremos la estrategia uno y llamaremos a encodeURIComponent para estos parámetros como blobName. Dado que lo que los clientes pasan es un nombre sin formato en lugar de una dirección URL.

function escapeURLPath(url: string)

Parámetros

url

string

Devoluciones

string

generateBlockID(string, number)

Genere una cadena de identificador de bloque base64 bytes de 64 bytes.

function generateBlockID(blockIDPrefix: string, blockIndex: number)

Parámetros

blockIDPrefix

string

blockIndex

number

Devoluciones

string

getURLParameter(string, string)

Obtenga el parámetro URL por nombre.

function getURLParameter(url: string, name: string)

Parámetros

url

string

name

string

Devoluciones

string | string[] | undefined

getURLPath(string)

Obtiene la ruta de acceso de dirección URL de una cadena de dirección URL.

function getURLPath(url: string)

Parámetros

url

string

Cadena de dirección URL de origen

Devoluciones

string | undefined

getURLPathAndQuery(string)

Obtiene la ruta de acceso de la dirección URL y consulta desde una cadena de dirección URL.

function getURLPathAndQuery(url: string)

Parámetros

url

string

Cadena de dirección URL de origen

Devoluciones

string | undefined

getURLQueries(string)

Obtiene pares de valor de clave de consulta url de una cadena de dirección URL.

function getURLQueries(url: string)

Parámetros

url

string

Devoluciones

[key: string]: string

getURLScheme(string)

Obtiene el esquema de dirección URL de una cadena de dirección URL.

function getURLScheme(url: string)

Parámetros

url

string

Cadena de dirección URL de origen

Devoluciones

string | undefined

iEqual(string, string)

Si dos cadenas son iguales cuando se comparan sin distinción entre mayúsculas y minúsculas.

function iEqual(str1: string, str2: string)

Parámetros

str1

string

str2

string

Devoluciones

boolean

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Parámetros

currentString

string

targetLength

number

padString

undefined | string

Devoluciones

string

setURLHost(string, string)

Establezca el host de dirección URL.

function setURLHost(url: string, host: string)

Parámetros

url

string

Cadena de dirección URL de origen

host

string

Nueva cadena de host

Devoluciones

string

Cadena de dirección URL actualizada

setURLParameter(string, string, undefined | string)

Establezca el nombre y el valor del parámetro de dirección URL. Si el nombre existe en los parámetros de dirección URL, el valor anterior se reemplazará por clave de nombre. Si no proporciona valor, se eliminará el parámetro .

function setURLParameter(url: string, name: string, value?: undefined | string)

Parámetros

url

string

Cadena de dirección URL de origen

name

string

Nombre del parámetro

value

undefined | string

Devoluciones

string

Cadena de dirección URL actualizada

truncatedISO8061Date(Date, undefined | false | true)

Redondea una fecha de salida a segundos.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Parámetros

date

Date

withMilliseconds

undefined | false | true

Devoluciones

string

Cadena de fecha en formato ISO8061, con o sin componente de 7 milisegundos

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Lee una secuencia legible en el búfer. Rellene el búfer del desplazamiento al final.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Parámetros

stream

ReadableStream

Secuencia legible de Node.js

buffer

Buffer

El búfer que se va a rellenar, la longitud debe >= desplazamiento

offset

number

Desde qué posición del búfer se va a rellenar, inclusive

end

number

A qué posición del búfer se va a rellenar, exclusiva

encoding

undefined | string

Devoluciones

Promise<void>

streamToBuffer2(ReadableStream, Buffer, undefined | string)

Lee un flujo legible en el búfer por completo.

function streamToBuffer2(stream: ReadableStream, buffer: Buffer, encoding?: undefined | string)

Parámetros

stream

ReadableStream

Secuencia legible de Node.js

buffer

Buffer

El búfer que se va a rellenar, la longitud debe >= desplazamiento

encoding

undefined | string

Devoluciones

Promise<number>

con el recuento de bytes leídos.