@azure/storage-file 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.
BrowserPolicyFactory	BrowserPolicyFactory es una clase de fábrica que ayuda a generar objetos BrowserPolicy.
DirectoryURL	Un DirectoryURL representa una dirección URL al directorio de Azure Storage que le permite manipular sus archivos y directorios.
FileSASPermissions	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 archivo. 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:IFileSASSignatureValues>. 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.
FileSystemAttributes	Se trata de una clase auxiliar para construir una cadena que representa los atributos NTFS en un archivo o directorio.
FileURL	Un FileURL representa una dirección URL a un archivo de Azure Storage.
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.
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:IFileSASSignatureValues>. 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 File que le permite manipular recursos compartidos de archivos.
ShareSASPermissions	Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un ServiceSAS a un recurso compartido. 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:IFileSASSignatureValues>. 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.
ShareURL	Un shareURL representa una dirección URL al recurso compartido de Azure Storage que le permite manipular sus directorios y archivos.
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.
Directory	Clase que representa un directorio.
File	Clase que representa un archivo.
Service	Clase que representa un servicio.
Share	Clase que representa un recurso compartido.
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: 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. Eliminación del encabezado de cookie para la seguridad 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.
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: HighWaterMark de flujo de entrada es mejor establecer un mismo valor con el parámetro bufferSize, lo que evitará las operaciones Buffer.concat(). 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.
RetriableReadableStream	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Un Node.js ReadableStream reintentará internamente cuando finalice inesperadamente ReadableStream interno.

Interfaces

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions	La opción se define como paridad en la definición de REST. Aunque no está listo para usarse ahora, teniendo en cuenta que Crc64 de contenido de origen no es accesible.
IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
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 archivo. 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.
IFileSASSignatureValues	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. IFileSASSignatureValues se usa para ayudar a generar tokens SAS del servicio de archivos para recursos compartidos o archivos.
IIPRange	Intervalo IP permitido para una SAS.
IRange	Intervalo para operaciones de servicio.
IKeepAliveOptions	Interfaz de las opciones KeepAlivePolicy.
IRequestLogOptions	RequestLogOptions configura el comportamiento de la directiva de reintento.
IPipelineOptions	Interfaz de opción para el constructor de canalización.
IRetryOptions	Interfaz de opciones de reintento.
IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions	Interfaz de opción para el método Pipeline.newPipeline.
ITelemetryOptions	Interfaz de las opciones telemetryPolicy.
AccessPolicy	Una directiva de acceso.
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.
DirectoryCreateHeaders	Define encabezados para la operación Create.
DirectoryCreateOptionalParams	Parámetros opcionales.
DirectoryDeleteHeaders	Define encabezados para la operación Delete.
DirectoryDeleteMethodOptionalParams	Parámetros opcionales.
DirectoryForceCloseHandlesHeaders	Define encabezados para la operación ForceCloseHandles.
DirectoryForceCloseHandlesOptionalParams	Parámetros opcionales.
DirectoryGetPropertiesHeaders	Define encabezados para la operación GetProperties.
DirectoryGetPropertiesOptionalParams	Parámetros opcionales.
DirectoryItem	Un elemento de directorio enumerado.
DirectoryListFilesAndDirectoriesSegmentHeaders	Define encabezados para la operación ListFilesAndDirectoriesSegment.
DirectoryListFilesAndDirectoriesSegmentOptionalParams	Parámetros opcionales.
DirectoryListHandlesHeaders	Define encabezados para la operación ListHandles.
DirectoryListHandlesOptionalParams	Parámetros opcionales.
DirectorySetMetadataHeaders	Define encabezados para la operación SetMetadata.
DirectorySetMetadataOptionalParams	Parámetros opcionales.
DirectorySetPropertiesHeaders	Define encabezados para la operación SetProperties.
DirectorySetPropertiesOptionalParams	Parámetros opcionales.
FileAbortCopyHeaders	Define encabezados para la operación AbortCopy.
FileAbortCopyOptionalParams	Parámetros opcionales.
FileCreateHeaders	Define encabezados para la operación Create.
FileCreateOptionalParams	Parámetros opcionales.
FileDeleteHeaders	Define encabezados para la operación Delete.
FileDeleteMethodOptionalParams	Parámetros opcionales.
FileDownloadHeaders	Define encabezados para la operación de descarga.
FileDownloadOptionalParams	Parámetros opcionales.
FileForceCloseHandlesHeaders	Define encabezados para la operación ForceCloseHandles.
FileForceCloseHandlesOptionalParams	Parámetros opcionales.
FileGetPropertiesHeaders	Define encabezados para la operación GetProperties.
FileGetPropertiesOptionalParams	Parámetros opcionales.
FileGetRangeListHeaders	Define encabezados para la operación GetRangeList.
FileGetRangeListOptionalParams	Parámetros opcionales.
FileHTTPHeaders	Parámetros adicionales para un conjunto de operaciones, como: File_create, File_setHTTPHeaders.
FileItem	Un elemento de archivo enumerado.
FileListHandlesHeaders	Define encabezados para la operación ListHandles.
FileListHandlesOptionalParams	Parámetros opcionales.
FileProperty	Propiedades de archivo.
FileSetHTTPHeadersHeaders	Define encabezados para la operación SetHTTPHeaders.
FileSetHTTPHeadersOptionalParams	Parámetros opcionales.
FileSetMetadataHeaders	Define encabezados para la operación SetMetadata.
FileSetMetadataOptionalParams	Parámetros opcionales.
FileStartCopyHeaders	Define encabezados para la operación StartCopy.
FileStartCopyOptionalParams	Parámetros opcionales.
FileUploadRangeFromURLHeaders	Define encabezados para la operación UploadRangeFromURL.
FileUploadRangeFromURLOptionalParams	Parámetros opcionales.
FileUploadRangeHeaders	Define encabezados para la operación UploadRange.
FileUploadRangeOptionalParams	Parámetros opcionales.
FilesAndDirectoriesListSegment	Resumen de las entradas que se pueden enumerar desde el Directorio.
HandleItem	Un elemento de identificador de Azure Storage enumerado.
ListFilesAndDirectoriesSegmentResponse	Enumeración de directorios y archivos.
ListHandlesResponse	Enumeración de identificadores.
ListSharesResponse	Enumeración de recursos compartidos.
Metrics	Métricas de Storage Analytics para el servicio de archivos.
Permission	Permission(a security descriptor) descrito en Security Descriptor Definition Language(SDDL).
Range	Intervalo de archivos de Azure Storage.
RetentionPolicy	Directiva de retención.
ServiceGetPropertiesHeaders	Define encabezados para la operación GetProperties.
ServiceGetPropertiesOptionalParams	Parámetros opcionales.
ServiceListSharesSegmentHeaders	Define encabezados para la operación ListSharesSegment.
ServiceListSharesSegmentOptionalParams	Parámetros opcionales.
ServiceSetPropertiesHeaders	Define encabezados para la operación SetProperties.
ServiceSetPropertiesOptionalParams	Parámetros opcionales.
ShareCreateHeaders	Define encabezados para la operación Create.
ShareCreateOptionalParams	Parámetros opcionales.
ShareCreatePermissionHeaders	Define encabezados para la operación CreatePermission.
ShareCreatePermissionOptionalParams	Parámetros opcionales.
ShareCreateSnapshotHeaders	Define encabezados para la operación CreateSnapshot.
ShareCreateSnapshotOptionalParams	Parámetros opcionales.
ShareDeleteHeaders	Define encabezados para la operación Delete.
ShareDeleteMethodOptionalParams	Parámetros opcionales.
ShareGetAccessPolicyHeaders	Define encabezados para la operación GetAccessPolicy.
ShareGetAccessPolicyOptionalParams	Parámetros opcionales.
ShareGetPermissionHeaders	Define encabezados para la operación GetPermission.
ShareGetPermissionOptionalParams	Parámetros opcionales.
ShareGetPropertiesHeaders	Define encabezados para la operación GetProperties.
ShareGetPropertiesOptionalParams	Parámetros opcionales.
ShareGetStatisticsHeaders	Define encabezados para la operación GetStatistics.
ShareGetStatisticsOptionalParams	Parámetros opcionales.
ShareItem	Un elemento de recurso compartido de Azure Storage enumerado.
ShareProperties	Propiedades de un recurso compartido.
ShareSetAccessPolicyHeaders	Define encabezados para la operación SetAccessPolicy.
ShareSetAccessPolicyOptionalParams	Parámetros opcionales.
ShareSetMetadataHeaders	Define encabezados para la operación SetMetadata.
ShareSetMetadataOptionalParams	Parámetros opcionales.
ShareSetQuotaHeaders	Define encabezados para la operación SetQuota.
ShareSetQuotaOptionalParams	Parámetros opcionales.
ShareStats	Estadísticas del recurso compartido.
SignedIdentifier	Identificador firmado.
SourceModifiedAccessConditions	Parámetros adicionales para la operación uploadRangeFromURL.
StorageError	Interfaz que representa StorageError.
StorageServiceProperties	Propiedades del servicio de almacenamiento.
IDownloadFromAzureFileOptions	Interfaz de opción para DownloadAzurefileToBuffer.
IUploadToAzureFileOptions	Interfaz de opción para uploadFileToAzureFile y uploadSeekableStreamToAzureFile.
IUploadStreamToAzureFileOptions	Interfaz de opción para uploadStreamToAzureFile.
IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Alias de tipos

FileDownloadResponse	Contiene datos de respuesta para la operación de descarga.
FileGetRangeListResponse	Contiene datos de respuesta para la operación getRangeList.
ShareGetAccessPolicyResponse	Contiene datos de respuesta para la operación getAccessPolicy.
ShareGetStatisticsResponse	Contiene datos de respuesta para la operación getStatistics.
CredentialPolicyCreator	Función de fábrica que crea una nueva CredentialPolicy que usa nextPolicy proporcionada.
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'
DirectoryCreateResponse	Contiene datos de respuesta para la operación de creación.
DirectoryDeleteResponse	Contiene datos de respuesta para la operación deleteMethod.
DirectoryForceCloseHandlesResponse	Contiene datos de respuesta para la operación forceCloseHandles.
DirectoryGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse	Contiene datos de respuesta para la operación listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse	Contiene datos de respuesta para la operación listHandles.
DirectorySetMetadataResponse	Contiene datos de respuesta para la operación setMetadata.
DirectorySetPropertiesResponse	Contiene datos de respuesta para la operación setProperties.
FileAbortCopyResponse	Contiene datos de respuesta para la operación abortCopy.
FileCreateResponse	Contiene datos de respuesta para la operación de creación.
FileDeleteResponse	Contiene datos de respuesta para la operación deleteMethod.
FileForceCloseHandlesResponse	Contiene datos de respuesta para la operación forceCloseHandles.
FileGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
FileListHandlesResponse	Contiene datos de respuesta para la operación listHandles.
FileRangeWriteType	Define valores para FileRangeWriteType. Entre los valores posibles se incluyen: 'update', 'clear'
FileSetHTTPHeadersResponse	Contiene datos de respuesta para la operación setHTTPHeaders.
FileSetMetadataResponse	Contiene datos de respuesta para la operación setMetadata.
FileStartCopyResponse	Contiene datos de respuesta para la operación startCopy.
FileType	Define valores para FileType. Entre los valores posibles se incluyen: 'File'
FileUploadRangeFromURLResponse	Contiene datos de respuesta para la operación uploadRangeFromURL.
FileUploadRangeResponse	Contiene datos de respuesta para la operación uploadRange.
ListSharesIncludeType	Define valores para ListSharesIncludeType. Entre los valores posibles se incluyen: "instantáneas", "metadatos"
ServiceGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
ServiceListSharesSegmentResponse	Contiene datos de respuesta para la operación listSharesSegment.
ServiceSetPropertiesResponse	Contiene datos de respuesta para la operación setProperties.
ShareCreatePermissionResponse	Contiene datos de respuesta para la operación createPermission.
ShareCreateResponse	Contiene datos de respuesta para la operación de creación.
ShareCreateSnapshotResponse	Contiene datos de respuesta para la operación createSnapshot.
ShareDeleteResponse	Contiene datos de respuesta para la operación deleteMethod.
ShareGetPermissionResponse	Contiene datos de respuesta para la operación getPermission.
ShareGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
ShareSetAccessPolicyResponse	Contiene datos de respuesta para la operación setAccessPolicy.
ShareSetMetadataResponse	Contiene datos de respuesta para la operación setMetadata.
ShareSetQuotaResponse	Contiene datos de respuesta para la operación setQuota.
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', 'CannotDeleteFileOrDirectory', 'ClientCacheFlushDelay', 'DeletePending', 'DirectoryNotEmpty', 'FileLockConflict', 'InvalidFileOrDirectoryPathName', 'ParentNotFound', 'ReadOnlyAttribute', 'ShareAlreadyExists', 'ShareBeingDeleted', 'ShareDisabled', 'ShareNotFound', 'SharingViolation', 'ShareSnapshotInProgress', 'ShareSnapshotCountExceeded', 'ShareSnapshotOperationNotSupported', ' ShareHasSnapshots", "ContainerQuotaDowngradeNotAllowed"
FileAttributesPreserveType	Indica que los atributos de archivo existentes no cambian.
FilePermissionInheritType	Indica que hereda el permiso de archivo del directorio primario.
FilePermissionPreserveType	Indica que el valor del permiso de archivo existente no cambia.
TimeNowType	Indica la configuración como la hora de la solicitud.
TimePreserveType	Indica que el valor de hora existente no cambia.
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.
RetryPolicyType	Tipos RetryPolicy.

Funciones

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.
generateFileSASQueryParameters(IFileSASSignatureValues, 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.
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"
uploadBrowserDataToAzureFile(Aborter, Blob \| ArrayBuffer \| ArrayBufferView, FileURL, IUploadToAzureFileOptions)	SOLO ESTÁ DISPONIBLE EN EXPLORADORES. Carga un objeto Blob/File/ArrayBuffer/ArrayBufferView del explorador en un archivo de Azure.
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined \| number, IDownloadFromAzureFileOptions)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Descarga un archivo de Azure en paralelo a un búfer. Desplazamiento y recuento son opcionales, pase 0 para que ambos descarguen todo el archivo.
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga un archivo local en un archivo de Azure.
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga una secuencia legible Node.js en un archivo de Azure. Este método intentará crear una instancia de Azure y, a continuación, empezará a cargar el fragmento por fragmento. El tamaño del fragmento se define mediante `bufferSize` parámetro. Asegúrese de que el tamaño potencial de la secuencia no supere el tamaño del archivo. 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().
fileAttributesToString(FileSystemAttributes \| FileAttributesPreserveType)
fileCreationTimeToString(Date \| TimeNowType \| TimePreserveType)
fileLastWriteTimeToString(Date \| TimeNowType \| TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined \| string, undefined \| string)
NewRetryPolicyFactory(IRetryOptions)	Un método de fábrica usado para generar una factoría RetryPolicy.
blobToArrayBuffer(Blob)	Convierta un objeto Browser Blob en ArrayBuffer.
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 al constructor de clases XXXURL, 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.
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.
getURLQueries(string)	Obtiene pares de valor de clave de consulta url de una cadena de dirección URL.
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.

Detalles de la función

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

SASQueryParameters

generateFileSASQueryParameters(IFileSASSignatureValues, 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 generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parámetros

fileSASSignatureValues: IFileSASSignatureValues

sharedKeyCredential: SharedKeyCredential

Devoluciones

SASQueryParameters

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

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

SOLO ESTÁ DISPONIBLE EN EXPLORADORES. Carga un objeto Blob/File/ArrayBuffer/ArrayBufferView del explorador en un archivo de Azure.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)

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

fileURL: FileURL

options: IUploadToAzureFileOptions

Devoluciones

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Descarga un archivo de Azure en paralelo a un búfer. Desplazamiento y recuento son opcionales, pase 0 para que ambos descarguen todo el archivo.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

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.

fileURL: FileURL

Un objeto FileURL

offset: number

Desde qué posición del archivo de Azure se va a descargar

count: undefined | number

options: IDownloadFromAzureFileOptions

Devoluciones

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga un archivo local en un archivo de Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

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

fileURL: FileURL

FileURL

options: IUploadToAzureFileOptions

Devoluciones

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Carga una secuencia legible Node.js en un archivo de Azure. Este método intentará crear una instancia de Azure y, a continuación, empezará a cargar el fragmento por fragmento. El tamaño del fragmento se define mediante bufferSize parámetro. Asegúrese de que el tamaño potencial de la secuencia no supere el tamaño del archivo.

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 uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

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. Debe ser menor o igual que el tamaño de archivo.

size: number

Tamaño del archivo que se va a crear. El tamaño máximo permitido es de 1 TB. Si este valor es mayor que el tamaño de la secuencia, habrá bytes vacíos en la cola del archivo.

fileURL: FileURL

Una instancia de FileURL

bufferSize: number

Tamaño de cada búfer asignado en bytes, también el tamaño del fragmento o intervalo durante el archivo cargado. El tamaño debe ser > 0 y <= 4 * 1024 * 1024 (4 MB)

maxBuffers: number

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

options: IUploadStreamToAzureFileOptions

Devoluciones

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parámetros

fileAttributes: FileSystemAttributes | FileAttributesPreserveType

Devoluciones

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parámetros

time: Date | TimeNowType | TimePreserveType

Devoluciones

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parámetros

time: Date | TimeNowType | TimePreserveType

Devoluciones

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parámetros

options: IFileAndDirectoryCreateCommonOptions

Devoluciones

IFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parámetros

options: IFileAndDirectorySetPropertiesCommonOptions

Devoluciones

IFileAndDirectorySetPropertiesCommonOptions

validateFilePermissionOptions(undefined | string, undefined | string)

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Parámetros

filePermission: undefined | string

filePermissionKey: undefined | string

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>

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 al constructor de clases XXXURL, 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

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

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

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>

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

@azure/storage-file package

Clases

Interfaces

Alias de tipos

Enumeraciones

Funciones

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

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.

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

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

Detalles de la función

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

Parámetros

Devoluciones

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

Parámetros

Devoluciones

ipRangeToString(IIPRange)

Parámetros

Devoluciones

rangeToString(IRange)

Parámetros

Devoluciones

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

Parámetros

Devoluciones

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

Parámetros

Devoluciones

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

Parámetros

Devoluciones

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

Parámetros

Devoluciones

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

Parámetros

Devoluciones

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

Parámetros

Devoluciones

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

Parámetros

Devoluciones

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

Parámetros

Devoluciones

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

Parámetros

Devoluciones

validateFilePermissionOptions(undefined | string, undefined | string)

Parámetros

NewRetryPolicyFactory(IRetryOptions)

Parámetros

Devoluciones

blobToArrayBuffer(Blob)

Parámetros

Devoluciones

appendToURLPath(string, string)

Parámetros

Devoluciones

base64decode(string)

Parámetros

Devoluciones

base64encode(string)

Parámetros

Devoluciones

delay(number, AbortSignalLike, Error)

Parámetros

Devoluciones

escapeURLPath(string)

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

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.

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

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

Parámetros

Devoluciones

getURLParameter(string, string)

Parámetros

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

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