Compartir a través de


@azure/storage-blob package

Clases

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:AccountSASSignatureValues>. 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:AccountSASSignatureValues>. 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:AccountSASSignatureValues>. 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.

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

AnonymousCredentialPolicy

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

AppendBlobClient

AppendBlobClient define un conjunto de operaciones aplicables a los blobs en anexos.

BlobBatch

Un BlobBatch representa un conjunto agregado de operaciones en blobs. Actualmente, solo se admiten delete y setAccessTier.

BlobBatchClient

BlobBatchClient permite realizar solicitudes por lotes al servicio Blob de Azure Storage.

BlobClient

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

BlobLeaseClient

Un cliente que administra concesiones para una <xref:ContainerClient> o un <xref:BlobClient>.

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:BlobSASSignatureValues>. 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.

BlobServiceClient

Un BlobServiceClient representa un cliente para el servicio Blob de Azure Storage, lo que le permite manipular contenedores de blobs.

BlockBlobClient

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

ContainerClient

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

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:BlobSASSignatureValues>. 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.

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.

CredentialPolicy

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

PageBlobClient

PageBlobClient 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 <xref:newPipeline>. O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte <xref:newPipeline> y las directivas proporcionadas antes de implementar la canalización personalizada.

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:AccountSASSignatureValues> y <xref:BlobSASSignatureValues>. Una vez generado, se puede codificar en un <xref: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.

StorageBrowserPolicy

StorageBrowserPolicy 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". StorageBrowserPolicy 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

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory es una clase de fábrica que ayuda a generar objetos StorageBrowserPolicy.

StorageClient

StorageClient representa una clase de dirección URL basada para <xref:BlobServiceClient>, <xref:ContainerClient> y etc.

StorageClientContext
StorageRetryPolicy

Directiva de reintento con reintento exponencial y reintento lineal implementado.

StorageRetryPolicyFactory

StorageRetryPolicyFactory es una clase de fábrica que ayuda a generar objetos <xref:StorageRetryPolicy>.

StorageSharedKeyCredential

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

StorageSharedKeyCredentialPolicy

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

Interfaces

AccessPolicy

Una directiva de acceso

AccountSASPermissionsLike

Tipo que tiene un aspecto similar a un permiso SAS de cuenta. Se usa en <xref:AccountSASPermissions> para analizar los permisos de SAS de objetos sin procesar.

AccountSASSignatureValues

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. AccountSASSignatureValues 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 <xref:generateAccountSASQueryParameters> para obtener una representación de la SAS que realmente se puede aplicar a 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.

AppendBlobAppendBlockFromURLOptions

Opciones para configurar la operación de <xref:AppendBlobClient.appendBlockFromURL>.

AppendBlobAppendBlockFromUrlHeaders

Define encabezados para AppendBlob_appendBlockFromUrl operación.

AppendBlobAppendBlockHeaders

Define encabezados para AppendBlob_appendBlock operación.

AppendBlobAppendBlockOptions

Opciones para configurar la operación de <xref:AppendBlobClient.appendBlock>.

AppendBlobCreateHeaders

Define encabezados para AppendBlob_create operación.

AppendBlobCreateIfNotExistsOptions

Opciones para configurar <xref:AppendBlobClient.createIfNotExists> operación.

AppendBlobCreateIfNotExistsResponse

Contiene datos de respuesta para la operación de <xref:appendBlobClient.createIfNotExists>.

AppendBlobCreateOptions

Opciones para configurar <xref:AppendBlobClient.create> operación.

AppendBlobRequestConditions

Condiciones para agregar a la creación de este blob en anexos.

AppendBlobSealOptions

Opciones para configurar <xref:AppendBlobClient.seal> operación.

AppendPositionAccessConditions

Grupo de parámetros

BatchSubRequest

Solicitud asociada a una operación por lotes.

BatchSubResponse

Datos de respuesta asociados a una única solicitud dentro de una operación por lotes.

BlobAbortCopyFromURLHeaders

Define encabezados para Blob_abortCopyFromURL operación.

BlobAbortCopyFromURLOptions

Opciones para configurar la operación de <xref:BlobClient.abortCopyFromURL>.

BlobAcquireLeaseOptions

Opciones para configurar Blob: Adquisición de la operación de concesión.

BlobBatchSubmitBatchOptionalParams

Opciones para configurar el servicio: enviar parámetros opcionales de Batch.

BlobBeginCopyFromURLOptions

Opciones para configurar la operación de <xref:BlobClient.beginCopyFromURL>.

BlobBeginCopyFromURLResponse

Contiene datos de respuesta para la operación de <xref:BlobClient.beginCopyFromURL>.

BlobBeginCopyFromUrlPollState

El estado usado por el sondeo devuelto por <xref:BlobClient.beginCopyFromURL>. Este estado se pasa a la devolución de llamada especificada por el usuario onProgress cada vez que se detecta el progreso de la copia.

BlobBreakLeaseOptions

Opciones para configurar la operación de concesión de blobs: interrupción.

BlobChangeLeaseOptions

Opciones para configurar Blob: cambiar la operación de concesión.

BlobCopyFromURLHeaders

Define encabezados para Blob_copyFromURL operación.

BlobCreateSnapshotHeaders

Define encabezados para Blob_createSnapshot operación.

BlobCreateSnapshotOptions

Opciones para configurar la operación de <xref:BlobClient.createSnapshot>.

BlobDeleteHeaders

Define encabezados para Blob_delete operación.

BlobDeleteIfExistsResponse

Contiene datos de respuesta para la operación de <xref:BlobClient.deleteIfExists>.

BlobDeleteImmutabilityPolicyHeaders

Define encabezados para Blob_deleteImmutabilityPolicy operación.

BlobDeleteImmutabilityPolicyOptions

Opciones para eliminar la directiva de inmutabilidad <xref:BlobClient.deleteImmutabilityPolicy> operación.

BlobDeleteOptions

Opciones para configurar la operación de <xref:BlobClient.delete>.

BlobDownloadHeaders

Define encabezados para Blob_download operación.

BlobDownloadOptionalParams

Parámetros opcionales.

BlobDownloadOptions

Opciones para configurar la operación de <xref:BlobClient.download>.

BlobDownloadResponseParsed

Contiene datos de respuesta para la operación de <xref:BlobClient.download>.

BlobDownloadToBufferOptions

Interfaz de opción para la operación de <xref:BlobClient.downloadToBuffer>.

BlobExistsOptions

Opciones para configurar la operación de <xref:BlobClient.exists>.

BlobFlatListSegment

Interfaz que representa BlobFlatListSegment.

BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

Opciones para configurar <xref:BlobClient.generateSasUrl> operación.

BlobGetPropertiesHeaders

Define encabezados para Blob_getProperties operación.

BlobGetPropertiesOptions

Opciones para configurar la operación de <xref:BlobClient.getProperties>.

BlobGetPropertiesResponse

Contiene datos de respuesta para la operación de <xref:BlobClient.getProperties>.

BlobGetTagsHeaders

Define encabezados para Blob_getTags operación.

BlobGetTagsOptions

Opciones para configurar la operación de <xref:BlobClient.getTags>.

BlobHTTPHeaders

Grupo de parámetros

BlobHierarchyListSegment

Interfaz que representa BlobHierarchyListSegment.

BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

Describir la directiva inmutable para blob.

BlobItem

Un blob de Azure Storage

BlobItemInternal

Un blob de Azure Storage

BlobPrefix
BlobProperties

Propiedades de un blob

BlobQueryArrowConfiguration

Opciones para consultar blob con formato de flecha de Apache. Solo es válido para <xref:BlockBlobQueryOptions.outputTextConfiguration>.

BlobQueryArrowField

Describir un campo en <xref:BlobQueryArrowConfiguration>.

BlobQueryCsvTextConfiguration

Opciones para consultar blob con formato CSV.

BlobQueryError

Tipo de error de consulta de blobs.

BlobQueryHeaders

Define encabezados para Blob_query operación.

BlobQueryJsonTextConfiguration

Opciones para consultar blob con formato JSON.

BlobQueryParquetConfiguration

Opciones para consultar blob con formato Parquet. Solo es válido para <xref:BlockBlobQueryOptions.inputTextConfiguration>.

BlobReleaseLeaseOptions

Opciones para configurar la operación de concesión de versión de Blob.

BlobRenewLeaseOptions

Opciones para configurar Blob: renovación de la operación de concesión.

BlobRequestConditions

encabezados condicionales HTTP estándar, condición de etiquetas y condición de concesión

BlobSASPermissionsLike

Tipo que tiene un aspecto similar a un permiso SAS de blobs. Se usa en <xref:BlobSASPermissions> para analizar los permisos de SAS de objetos sin procesar.

BlobSASSignatureValues

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

BlobServiceProperties

Propiedades del servicio de almacenamiento.

BlobServiceStatistics

Estadísticas del servicio de almacenamiento.

BlobSetHTTPHeadersHeaders

Define encabezados para Blob_setHttpHeaders operación.

BlobSetHTTPHeadersOptions

Opciones para configurar la operación de <xref:BlobClient.setHTTPHeaders>.

BlobSetImmutabilityPolicyHeaders

Define encabezados para Blob_setImmutabilityPolicy operación.

BlobSetImmutabilityPolicyOptions

Opciones para establecer la directiva de inmutabilidad <xref:BlobClient.setImmutabilityPolicy> operación.

BlobSetLegalHoldHeaders

Define encabezados para Blob_setLegalHold operación.

BlobSetLegalHoldOptions

Opciones para establecer la suspensión legal <xref:BlobClient.setLegalHold> operación.

BlobSetMetadataHeaders

Define encabezados para Blob_setMetadata operación.

BlobSetMetadataOptions

Opciones para configurar la operación de <xref:BlobClient.setMetadata>.

BlobSetTagsHeaders

Define encabezados para Blob_setTags operación.

BlobSetTagsOptions

Opciones para configurar la operación de <xref:BlobClient.setTags>.

BlobSetTierHeaders

Define encabezados para Blob_setTier operación.

BlobSetTierOptions

Opciones para configurar la operación de <xref:BlobClient.setAccessTier>.

BlobStartCopyFromURLHeaders

Define encabezados para Blob_startCopyFromURL operación.

BlobStartCopyFromURLOptions

Opciones para configurar la operación de <xref:BlobClient.beginCopyFromURL>.

BlobSyncCopyFromURLOptions

Opciones para configurar la operación de <xref:BlobClient.syncCopyFromURL>.

BlobTag
BlobTags

Etiquetas de blobs

BlobUndeleteHeaders

Define encabezados para Blob_undelete operación.

BlobUndeleteOptions

Opciones para configurar la operación de <xref:BlobClient.undelete>.

Block

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

BlockBlobCommitBlockListHeaders

Define encabezados para BlockBlob_commitBlockList operación.

BlockBlobCommitBlockListOptions

Opciones para configurar <xref:BlockBlobClient.commitBlockList> operación.

BlockBlobGetBlockListHeaders

Define encabezados para BlockBlob_getBlockList operación.

BlockBlobGetBlockListOptions

Opciones para configurar <xref:BlockBlobClient.getBlockList> operación.

BlockBlobParallelUploadOptions

Interfaz de opción para <xref:BlockBlobClient.uploadFile> y <xref:BlockBlobClient.uploadSeekableStream>.

BlockBlobPutBlobFromUrlHeaders

Define encabezados para BlockBlob_putBlobFromUrl operación.

BlockBlobQueryOptions

Opciones para configurar <xref:BlockBlobClient.query> operación.

BlockBlobStageBlockFromURLHeaders

Define encabezados para BlockBlob_stageBlockFromURL operación.

BlockBlobStageBlockFromURLOptions

Opciones para configurar <xref:BlockBlobClient.stageBlockFromURL> operación.

BlockBlobStageBlockHeaders

Define encabezados para BlockBlob_stageBlock operación.

BlockBlobStageBlockOptions

Opciones para configurar <xref:BlockBlobClient.stageBlock> operación.

BlockBlobSyncUploadFromURLOptions

Opciones para configurar <xref:BlockBlobClient.syncUploadFromURL> operación.

BlockBlobUploadHeaders

Define encabezados para BlockBlob_upload operación.

BlockBlobUploadOptions

Opciones para configurar <xref:BlockBlobClient.upload> operación.

BlockBlobUploadStreamOptions

Interfaz de opción para la operación de <xref:BlockBlobClient.uploadStream>.

BlockList
CommonGenerateSasUrlOptions

Opciones comunes de <xref:BlobGenerateSasUrlOptions> y <xref:ContainerGenerateSasUrlOptions>.

CommonOptions

Interfaz para las opciones comunes a cada operación remota.

ContainerAcquireLeaseOptions

Opciones para configurar contenedor: Adquisición de la operación de concesión.

ContainerBreakLeaseOptionalParams

Parámetros opcionales.

ContainerBreakLeaseOptions

Opciones para configurar la operación Container - Break Lease.

ContainerChangeLeaseOptions

Opciones para configurar container - Change Lease operation.

ContainerCreateHeaders

Define encabezados para Container_create operación.

ContainerCreateIfNotExistsResponse

Contiene datos de respuesta para la operación de <xref:ContainerClient.createIfNotExists>.

ContainerCreateOptions

Opciones para configurar <xref:ContainerClient.create> operación.

ContainerDeleteBlobOptions

Opciones para configurar la operación de <xref:ContainerClient.deleteBlob>.

ContainerDeleteHeaders

Define encabezados para Container_delete operación.

ContainerDeleteIfExistsResponse

Contiene datos de respuesta para la operación de <xref:ContainerClient.deleteIfExists>.

ContainerDeleteMethodOptions

Opciones para configurar <xref:ContainerClient.delete> operación.

ContainerEncryptionScope

Grupo de parámetros

ContainerExistsOptions

Opciones para configurar <xref:ContainerClient.exists> operación.

ContainerGenerateSasUrlOptions

Opciones para configurar <xref:ContainerClient.generateSasUrl> operación.

ContainerGetAccessPolicyHeaders

Define encabezados para Container_getAccessPolicy operación.

ContainerGetAccessPolicyOptions

Opciones para configurar <xref:ContainerClient.getAccessPolicy> operación.

ContainerGetPropertiesHeaders

Define encabezados para Container_getProperties operación.

ContainerGetPropertiesOptions

Opciones para configurar <xref:ContainerClient.getProperties> operación.

ContainerItem

Un contenedor de Azure Storage

ContainerListBlobFlatSegmentHeaders

Define encabezados para Container_listBlobFlatSegment operación.

ContainerListBlobHierarchySegmentHeaders

Define encabezados para Container_listBlobHierarchySegment operación.

ContainerListBlobsOptions

Opciones para configurar las operaciones Contenedor: enumerar blobs. Ver:

  • <xref:ContainerClient.listBlobsFlat>
  • <xref:ContainerClient.listBlobsByHierarchy>
ContainerProperties

Propiedades de un contenedor

ContainerReleaseLeaseOptions

Opciones para configurar la operación de concesión de versión de contenedor.

ContainerRenameHeaders

Define encabezados para Container_rename operación.

ContainerRenewLeaseOptions

Opciones para configurar la operación contenedor- Renovar concesión.

ContainerRequestConditions

Condiciones que se deben cumplir para el contenedor.

ContainerSASPermissionsLike

Tipo que tiene un aspecto similar a un permiso SAS de contenedor. Se usa en <xref:ContainerSASPermissions> para analizar los permisos de SAS de objetos sin procesar.

ContainerSetAccessPolicyHeaders

Define encabezados para Container_setAccessPolicy operación.

ContainerSetAccessPolicyOptions

Opciones para configurar <xref:ContainerClient.setAccessPolicy> operación.

ContainerSetMetadataHeaders

Define encabezados para Container_setMetadata operación.

ContainerSetMetadataOptions

Opciones para configurar <xref:ContainerClient.setMetadata> operación.

ContainerUndeleteHeaders

Define encabezados para Container_restore operación.

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

Grupo de parámetros

FilterBlobItem

Información del blob de un <xref:BlobServiceClient.findBlobsByTags>

FilterBlobItemModel

Información de blobs desde una llamada api de blobs de filtro

FilterBlobSegment

Respuesta de segmento de <xref:BlobServiceClient.findBlobsByTags> operación.

FilterBlobSegmentModel

Resultado de una llamada API de blobs de filtro

GeoReplication

Geo-Replication información del servicio de almacenamiento secundario

HttpAuthorization

Representa información de autenticación en los valores de encabezado Authorization, ProxyAuthorization, WWW-Authenticate y Proxy-Authenticate.

Lease

Detalles de una concesión específica.

LeaseAccessConditions

Grupo de parámetros

LeaseOperationOptions

Configura las operaciones de concesión.

ListBlobsFlatSegmentResponse

Enumeración de blobs

ListBlobsFlatSegmentResponseModel

Enumeración de blobs

ListBlobsHierarchySegmentResponse

Enumeración de blobs

ListBlobsHierarchySegmentResponseModel

Enumeración de blobs

ListContainersSegmentResponse

Enumeración de contenedores

Logging

Configuración de registro de Azure Analytics.

MatchConditions

Especifica las opciones HTTP para las solicitudes condicionales basadas en la coincidencia de ETag.

Metadata

Mapa de pares nombre-valor que se van a asociar al recurso.

Metrics

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

ModificationConditions

Especifica las opciones HTTP para las solicitudes condicionales en función del tiempo de modificación.

ModifiedAccessConditions

Encabezados condicionales y condiciones de etiquetas HTTP estándar.

ModifiedAccessConditionsModel

Grupo de parámetros

ObjectReplicationPolicy

Contiene el identificador de directiva de replicación de objetos y la lista correspondiente de <xref:ObjectReplicationRule>. Esto se usa al recuperar las propiedades de replicación de objetos en el blob de origen. El identificador de directiva del blob de destino se establece en ObjectReplicationDestinationPolicyId de las respuestas del método correspondientes (por ejemplo, <xref:BlobProperties.ObjectReplicationDestinationPolicyId>.

ObjectReplicationRule

Contiene el identificador de regla de replicación de objetos y <xref:ObjectReplicationStatus> de un blob. Puede haber más de un <xref:ObjectReplicationRule> en un <xref:ObjectReplicationPolicy>.

PageBlobClearPagesHeaders

Define encabezados para PageBlob_clearPages operación.

PageBlobClearPagesOptions

Opciones para configurar la operación de <xref:PageBlobClient.clearPages>.

PageBlobCopyIncrementalHeaders

Define encabezados para PageBlob_copyIncremental operación.

PageBlobCreateHeaders

Define encabezados para PageBlob_create operación.

PageBlobCreateIfNotExistsOptions

Opciones para configurar la operación de <xref:PageBlobClient.createIfNotExists>.

PageBlobCreateIfNotExistsResponse

Contiene datos de respuesta para la operación de <xref:PageBlobClient.createIfNotExists>.

PageBlobCreateOptions

Opciones para configurar la operación de <xref:PageBlobClient.create>.

PageBlobGetPageRangesDiffHeaders

Define encabezados para PageBlob_getPageRangesDiff operación.

PageBlobGetPageRangesDiffOptions

Opciones para configurar la operación de <xref:PageBlobClient.getRangesDiff>.

PageBlobGetPageRangesDiffResponse

Contiene datos de respuesta para la operación de <xref:BlobClient.getPageRangesDiff>.

PageBlobGetPageRangesHeaders

Define encabezados para PageBlob_getPageRanges operación.

PageBlobGetPageRangesOptions

Opciones para configurar la operación de <xref:PageBlobClient.getPageRanges>.

PageBlobGetPageRangesResponse

Contiene datos de respuesta para la operación de <xref:BlobClient.getPageRanges>.

PageBlobRequestConditions

Condiciones para agregar a la creación de este blob en páginas.

PageBlobResizeHeaders

Define encabezados para PageBlob_resize operación.

PageBlobResizeOptions

Opciones para configurar <xref:PageBlobClient.resize> operación.

PageBlobStartCopyIncrementalOptions

Opciones para configurar <xref:PageBlobClient.startCopyIncremental> operación.

PageBlobUpdateSequenceNumberHeaders

Define encabezados para PageBlob_updateSequenceNumber operación.

PageBlobUpdateSequenceNumberOptions

Opciones para configurar <xref:PageBlobClient.updateSequenceNumber> operación.

PageBlobUploadPagesFromURLHeaders

Define encabezados para PageBlob_uploadPagesFromURL operación.

PageBlobUploadPagesFromURLOptions

Opciones para configurar <xref:PageBlobClient.uploadPagesFromURL> operación.

PageBlobUploadPagesHeaders

Define encabezados para PageBlob_uploadPages operación.

PageBlobUploadPagesOptions

Opciones para configurar la operación de <xref:PageBlobClient.uploadPages>.

PageList

Lista de intervalos de páginas de un blob.

ParsedBatchResponse

Respuesta multipart/mixta que contiene la respuesta de cada subbrequest.

PipelineLike

Interfaz para la clase <xref:Pipeline> que contiene directivas de solicitud HTTP. Puede crear una canalización predeterminada llamando a <xref:newPipeline>. O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte <xref:newPipeline> y las directivas proporcionadas antes de implementar la canalización personalizada.

PipelineOptions

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

Range

Intervalo para las operaciones de Blob Service.

RetentionPolicy

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

SASQueryParametersOptions

Opciones para construir <xref:SASQueryParameters>.

SasIPRange

Intervalo IP permitido para una SAS.

SequenceNumberAccessConditions

Grupo de parámetros

ServiceFilterBlobsHeaders

Define encabezados para Service_filterBlobs operación.

ServiceFindBlobByTagsOptions

Opciones para configurar la operación de <xref:BlobServiceClient.findBlobsByTags>.

ServiceGenerateAccountSasUrlOptions

Opciones para configurar <xref:BlobServiceClient.generateAccountSasUrl> operación.

ServiceGetAccountInfoHeaders

Define encabezados para Service_getAccountInfo operación.

ServiceGetAccountInfoOptions

Opciones para configurar la operación de <xref:BlobServiceClient.getAccountInfo>.

ServiceGetPropertiesHeaders

Define encabezados para Service_getProperties operación.

ServiceGetPropertiesOptions

Opciones para configurar la operación de <xref:BlobServiceClient.getProperties>.

ServiceGetStatisticsHeaders

Define encabezados para Service_getStatistics operación.

ServiceGetStatisticsOptions

Opciones para configurar la operación de <xref:BlobServiceClient.getStatistics>.

ServiceGetUserDelegationKeyHeaders

Define encabezados para Service_getUserDelegationKey operación.

ServiceGetUserDelegationKeyOptions

Opciones para configurar el servicio: obtener la clave de delegación de usuarios.

ServiceListContainersOptions

Opciones para configurar la operación de <xref:BlobServiceClient.listContainers>.

ServiceListContainersSegmentHeaders

Define encabezados para Service_listContainersSegment operación.

ServiceRenameContainerOptions

Opciones para configurar <xref:BlobServiceClient.renameContainer> operación.

ServiceSetPropertiesHeaders

Define encabezados para Service_setProperties operación.

ServiceSetPropertiesOptions

Opciones para configurar la operación de <xref:BlobServiceClient.setProperties>.

ServiceSubmitBatchHeaders

Define encabezados para Service_submitBatch operación.

ServiceSubmitBatchOptionalParamsModel

Parámetros opcionales.

ServiceUndeleteContainerOptions

Opciones para configurar <xref:BlobServiceClient.undeleteContainer> operación.

SignedIdentifier

Identificador firmado.

SignedIdentifierModel

identificador firmado

StaticWebsite

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

StorageClientOptionalParams

Parámetros opcionales.

StoragePipelineOptions

Interfaz de opciones para la función <xref:newPipeline>.

StorageRetryOptions

Interfaz de opciones de reintento de blobs de storage.

TagConditions

Especifica las opciones HTTP para las solicitudes condicionales basadas en etiquetas de blob.

UserDelegationKey

Una clave de delegación de usuarios.

UserDelegationKeyModel

Una clave de delegación de usuarios

Alias de tipos

AccessTier

Define los valores de AccessTier.

AccountKind

Define los valores de AccountKind.

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.

BlobAbortCopyFromURLResponse

Contiene datos de respuesta para la operación abortCopyFromURL.

BlobBatchDeleteBlobsResponse

Contiene datos de respuesta para la operación de <xref:deleteBlobs>.

BlobBatchSetBlobsAccessTierResponse

Contiene datos de respuesta para la operación de <xref:setBlobsAccessTier>.

BlobBatchSubmitBatchResponse

Contiene datos de respuesta para las operaciones por lotes de blobs.

BlobCopyFromURLResponse

Contiene datos de respuesta para la operación copyFromURL.

BlobCreateSnapshotResponse

Contiene datos de respuesta para la operación createSnapshot.

BlobDeleteImmutabilityPolicyResponse

Contiene datos de respuesta para la operación deleteImmutabilityPolicy.

BlobDeleteResponse

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

BlobDownloadResponseModel

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

BlobGetPropertiesResponseModel

Contiene datos de respuesta para la operación getProperties.

BlobGetTagsResponse

Contiene datos de respuesta para la operación de <xref:BlobClient.getTags>.

BlobImmutabilityPolicyMode

Define valores para BlobImmutabilityPolicyMode.

BlobQueryArrowFieldType

Tipo de un <xref:BlobQueryArrowField>.

BlobQueryResponseModel

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

BlobSetHTTPHeadersResponse

Contiene datos de respuesta para la operación setHttpHeaders.

BlobSetImmutabilityPolicyResponse

Contiene datos de respuesta para la operación setImmutabilityPolicy.

BlobSetLegalHoldResponse

Contiene datos de respuesta para la operación setLegalHold.

BlobSetMetadataResponse

Contiene datos de respuesta para la operación setMetadata.

BlobSetTagsResponse

Contiene datos de respuesta para la operación setTags.

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.

BlobUndeleteResponse

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

BlobUploadCommonResponse

Tipo de respuesta para <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream>y <xref:BlockBlobClient.uploadBrowserDate>.

BlockBlobCommitBlockListResponse

Contiene datos de respuesta para la operación commitBlockList.

BlockBlobGetBlockListResponse

Contiene datos de respuesta para la operación getBlockList.

BlockBlobPutBlobFromUrlResponse

Contiene datos de respuesta para la operación putBlobFromUrl.

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.

ContainerCreateResponse

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

ContainerDeleteResponse

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

ContainerGetAccessPolicyResponse

Contiene datos de respuesta para la operación de <xref:ContainerClient.getAccessPolicy>.

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.

ContainerRenameResponse

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

ContainerSetAccessPolicyResponse

Contiene datos de respuesta para la operación setAccessPolicy.

ContainerSetMetadataResponse

Contiene datos de respuesta para la operación setMetadata.

ContainerUndeleteResponse

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

CopyPollerBlobClient

Define las operaciones de un <xref:BlobClient> que son necesarios para que el sondeo devuelto por <xref:BlobClient.beginCopyFromURL> funcione.

CopyStatusType

Define valores para CopyStatusType.

CredentialPolicyCreator

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

DeleteSnapshotsOptionType

Define valores para DeleteSnapshotsOptionType.

EncryptionAlgorithmType

Define valores para EncryptionAlgorithmType.

GeoReplicationStatusType

Define valores para GeoReplicationStatusType.

LeaseDurationType

Define valores para LeaseDurationType.

LeaseOperationResponse

Contiene los datos de respuesta de las operaciones que crean, modifican o eliminan una concesión. Consulte <xref:BlobLeaseClient>.

LeaseStateType

Define valores para LeaseStateType.

LeaseStatusType

Define valores para LeaseStatusType.

ListBlobsIncludeItem

Define valores para ListBlobsIncludeItem.

ListContainersIncludeType

Define valores para ListContainersIncludeType.

ObjectReplicationStatus

Especifica el estado de replicación de un blob. Esto se usa cuando se aplica una cuenta de almacenamiento con directivas de replicación de objetos. Consulte <xref:ObjectReplicationPolicy> y <xref:ObjectReplicationRule>.

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.

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.

PublicAccessType

Define valores para PublicAccessType.

RehydratePriority

Define valores para RehydratePriority.

SequenceNumberActionType

Define valores para SequenceNumberActionType.

ServiceFindBlobsByTagsSegmentResponse

Respuesta de <xref:BlobServiceClient.findBlobsByTags> operación.

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.

ServiceGetUserDelegationKeyResponse

Contiene datos de respuesta para la operación de <xref:getUserDelegationKey>.

ServiceListContainersSegmentResponse

Contiene datos de respuesta para la operación listContainersSegment.

ServiceSetPropertiesResponse

Contiene datos de respuesta para la operación setProperties.

ServiceSubmitBatchResponseModel

Contiene datos de respuesta para la operación submitBatch.

SkuName

Define valores para SkuName.

SyncCopyStatusType

Define valores para SyncCopyStatusType.

Tags

Etiquetas de blob.

Enumeraciones

BlockBlobTier

Representa el nivel de acceso en un blob. Para obtener información detallada sobre los niveles de blobs en bloques, consulte niveles de almacenamiento frecuente, esporádico y de archivo.

PremiumPageBlobTier

Especifica el nivel de blob en páginas en el que se va a establecer el blob. Esto solo es aplicable a blobs en páginas en cuentas de premium Storage. Consulte aquí para obtener información detallada sobre las IOPS y el rendimiento correspondientes por PageBlobTier.

SASProtocol

Protocolos para SAS generados.

StorageRetryPolicyType

Tipos RetryPolicy.

Funciones

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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(BlobSASSignatureValues, StorageSharedKeyCredential)

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, startsOn e identificador.

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

Rellene los detalles necesarios antes de ejecutar los siguientes fragmentos de código.

Uso de ejemplo:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Ejemplo de uso de un identificador:

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Ejemplo con un nombre de blob:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateBlobSASQueryParameters(BlobSASSignatureValues, 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 expiresOn.

Uso de ejemplo:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
isPipelineLike(unknown)

Asistente para decidir si un argumento determinado satisface el contrato de canalización

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuevo objeto Pipeline con credential proporcionado.

Detalles de la función

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parámetros

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluciones

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

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, startsOn e identificador.

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

Rellene los detalles necesarios antes de ejecutar los siguientes fragmentos de código.

Uso de ejemplo:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Ejemplo de uso de un identificador:

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Ejemplo con un nombre de blob:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parámetros

blobSASSignatureValues
BlobSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluciones

generateBlobSASQueryParameters(BlobSASSignatureValues, 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 expiresOn.

Uso de ejemplo:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

Parámetros

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

Valor devuelto de blobServiceClient.getUserDelegationKey()

accountName

string

Devoluciones

isPipelineLike(unknown)

Asistente para decidir si un argumento determinado satisface el contrato de canalización

function isPipelineLike(pipeline: unknown)

Parámetros

pipeline

unknown

Argumento que puede ser una canalización

Devoluciones

boolean

true cuando el argumento satisface el contrato de canalización

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuevo objeto Pipeline con credential proporcionado.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)

Parámetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Opcional. Opciones.

Devoluciones

Nuevo objeto Pipeline.