@azure/storage-file-share 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 el campo de permisos en un objeto accountSASSignatureValues de. 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 accountSASSignatureValues de. 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 el campo de servicios en un objeto accountSASSignatureValues de. 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).
BaseRequestPolicy	Clase base de la que derivan todas las directivas de solicitud.
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.
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 FileSASSignatureValues . 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. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
Pipeline	Una clase pipeline que contiene directivas de solicitud HTTP. Puede crear una canalización predeterminada llamando a newPipeline. O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte 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 lo generan los accountSASSignatureValues y fileSASSignatureValues tipos. Una vez generado, se puede codificar en un toString() 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.
ShareClient	Un shareClient representa una dirección URL al recurso compartido de Azure Storage que le permite manipular sus directorios y archivos.
ShareDirectoryClient	Un shareDirectoryClient representa una dirección URL al directorio de Azure Storage que le permite manipular sus archivos y directorios.
ShareFileClient	Un objeto ShareFileClient representa una dirección URL a un archivo de Azure Storage.
ShareLeaseClient	Un cliente que administra concesiones de un shareFileClient o ShareClient. Consulte https://learn.microsoft.com/rest/api/storageservices/lease-file y Consulte https://learn.microsoft.com/rest/api/storageservices/lease-share
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 FileSASSignatureValues . 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.
ShareServiceClient	ShareServiceClient representa una dirección URL al servicio Azure Storage File que le permite manipular recursos compartidos de archivos.
StorageBrowserPolicy	StorageBrowserPolicy 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". 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. Eliminación del encabezado de cookie para la seguridad 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.
StorageRetryPolicy	Directiva de reintento con reintento exponencial y reintento lineal implementado.
StorageRetryPolicyFactory	StorageRetryPolicyFactory es una clase de fábrica que ayuda a generar objetos 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.
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 generateAccountSASQueryParameters para obtener una representación de la SAS que realmente se puede aplicar a las direcciones URL de archivo. Nota: tanto esta clase como SASQueryParameters existen porque el primero es mutable y una representación lógica, mientras que esta última es inmutable y se usa para generar solicitudes REST reales. Consulte https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obtener más información conceptual sobre SAS Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas para obtener descripciones de los parámetros, incluidos los que son necesarios.
ClearRange
CloseHandlesInfo	Close controla la información del resultado.
CommonGenerateSasUrlOptions	Opciones comunes de shareGenerateSasUrlOptions y FileGenerateSasUrlOptions.
CommonOptions	Interfaz para las opciones comunes a cada operación remota.
CopyFileSmbInfo	Grupo de parámetros
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.
DirectoryCloseHandlesHeaders	Valores de encabezado de respuesta adicionales para la solicitud de identificadores de cierre.
DirectoryCreateHeaders	Define encabezados para Directory_create operación.
DirectoryCreateIfNotExistsResponse	Contiene datos de respuesta para la operación de createIfNotExists(DirectoryCreateOptions).
DirectoryCreateOptions	Opciones para configurar crear operación.
DirectoryDeleteHeaders	Define encabezados para Directory_delete operación.
DirectoryDeleteIfExistsResponse	Contiene datos de respuesta para la operación de deleteIfExists(DirectoryDeleteOptions).
DirectoryDeleteOptions	Opciones para configurar la operación eliminar.
DirectoryExistsOptions	Las opciones para configurar el existen operación.
DirectoryForceCloseHandlesHeaders	Define encabezados para Directory_forceCloseHandles operación.
DirectoryForceCloseHandlesOptions	Opciones para configurar forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Opciones para configurar las operaciones directory - Force Close Handles Segment. Ver: <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	Define encabezados para Directory_getProperties operación.
DirectoryGetPropertiesOptions	Opciones para configurar operación getProperties.
DirectoryItem	Un elemento de directorio enumerado.
DirectoryListFilesAndDirectoriesOptions	Opciones para configurar operación listFilesAndDirectories.
DirectoryListFilesAndDirectoriesSegmentHeaders	Define encabezados para Directory_listFilesAndDirectoriesSegment operación.
DirectoryListHandlesHeaders	Define encabezados para Directory_listHandles operación.
DirectoryListHandlesOptions	Opciones para configurar la operación de listHandles.
DirectoryListHandlesSegmentOptions	Opciones para configurar las operaciones directory- List Handles Segment. Ver: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	Interfaz para las opciones comunes a cada operación remota.
DirectoryRenameHeaders	Define encabezados para Directory_rename operación.
DirectoryRenameOptions	Opciones para configurar la operación cambiar el nombre de.
DirectorySetMetadataHeaders	Define encabezados para Directory_setMetadata operación.
DirectorySetMetadataOptions	Opciones para configurar la operación setMetadata.
DirectorySetPropertiesHeaders	Define encabezados para Directory_setProperties operación.
FileAbortCopyFromURLOptions	Opciones para configurar la operación de abortCopyFromURL.
FileAbortCopyHeaders	Define encabezados para File_abortCopy operación.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Opciones para configurar la operación de clearRange.
FileCloseHandlesHeaders	Valores de encabezado de respuesta adicionales para la solicitud de identificadores de cierre.
FileCreateHardLinkHeaders	Define encabezados para File_createHardLink operación.
FileCreateHardLinkOptions	Opciones para configurar Archivo: crear operaciones de vínculo físico. Ver: createHardLink
FileCreateHeaders	Define encabezados para File_create operación.
FileCreateOptions	Opciones para configurar la operación crear.
FileDeleteHeaders	Define encabezados para File_delete operación.
FileDeleteIfExistsResponse	Contiene datos de respuesta para la operación de deleteIfExists.
FileDeleteOptions	Opciones para configurar la operación eliminar.
FileDownloadHeaders	Define encabezados para File_download operación.
FileDownloadOptionalParams	Parámetros opcionales.
FileDownloadOptions	Opciones para configurar operaciones de archivo: descarga. Ver: descargar downloadToFile
FileDownloadToBufferOptions	Interfaz de opción para la operación de downloadToBuffer.
FileExistsOptions	Las opciones para configurar el existen operación.
FileForceCloseHandlesHeaders	Define encabezados para File_forceCloseHandles operación.
FileForceCloseHandlesOptions	Opciones para configurar las operaciones File - Force Close Handles. Ver: <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	Opciones para configurar operación generateSasUrl.
FileGetPropertiesHeaders	Define encabezados para File_getProperties operación.
FileGetPropertiesOptions	Opciones para configurar operación getProperties.
FileGetRangeListHeaders	Define encabezados para File_getRangeList operación.
FileGetRangeListOptions	Opciones para configurar la operación de getRangeList.
FileHttpHeaders
FileItem	Un elemento de archivo enumerado.
FileListHandlesHeaders	Define encabezados para File_listHandles operación.
FileListHandlesOptions	Interfaz para las opciones comunes a cada operación remota.
FileListHandlesSegmentOptions	Opciones para configurar las operaciones file - List Handles Segment. Ver: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	Interfaz de opción para archivo: operaciones de carga Ver: uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	Propiedades NFS. Tenga en cuenta que estas propiedades solo se aplican a archivos o directorios en cuentas de archivos NFS premium.
FileProperties	Interfaz para las opciones comunes a cada operación remota.
FileProperty	Propiedades de archivo.
FileRenameHeaders	Define encabezados para File_rename operación.
FileRenameOptions	Opciones para configurar la operación cambiar el nombre de.
FileResizeOptions	Opciones para configurar la operación de cambio de tamaño de .
FileSASSignatureValues	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. FileSASSignatureValues se usa para ayudar a generar tokens SAS del servicio de archivos para recursos compartidos o archivos.
FileServiceProperties	Propiedades del servicio de almacenamiento.
FileSetHTTPHeadersHeaders	Define encabezados para File_setHttpHeaders operación.
FileSetHttpHeadersOptions	Opciones para configurar el setHttpHeaders operación.
FileSetMetadataHeaders	Define encabezados para File_setMetadata operación.
FileSetMetadataOptions	Opciones para configurar la operación setMetadata.
FileStartCopyHeaders	Define encabezados para File_startCopy operación.
FileStartCopyOptions	Opciones para configurar la operación de startCopyFromURL.
FileUploadRangeFromURLHeaders	Define encabezados para File_uploadRangeFromURL operación.
FileUploadRangeFromURLOptionalParams	Parámetros opcionales.
FileUploadRangeFromURLOptions	Opciones para configurar la operación uploadRangeFromURL.
FileUploadRangeHeaders	Define encabezados para File_uploadRange operación.
FileUploadRangeOptions	Opciones para configurar la operación de uploadRange.
FileUploadStreamOptions	Interfaz de opción para ShareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Abstract for entries that can be listed from Directory.
HandleItem	Un elemento de identificador de Azure Storage enumerado.
HttpAuthorization	Representa información de autenticación en los valores de encabezado Authorization, ProxyAuthorization, WWW-Authenticate y Proxy-Authenticate.
HttpHeaders	Colección de pares clave-valor de encabezado HTTP.
HttpOperationResponse	Respuesta HTTP compatible con core-v1(core-http).
HttpResponse	Representación de una respuesta HTTP que incluye una referencia a la solicitud que la originó.
IHttpClient	Una interfaz compatible para las directivas de solicitud core-http
LeaseAccessConditions	Grupo de parámetros
LeaseOperationOptions	Opciones de operaciones de concesión.
LeaseOperationResponseHeaders	Detalles de la respuesta de una operación de concesión específica.
ListFilesAndDirectoriesSegmentResponse	Enumeración de directorios y archivos.
ListHandlesResponse	Enumeración de identificadores.
ListSharesResponse	Enumeración de recursos compartidos.
ListSharesResponseModel	Enumeración de recursos compartidos.
Metadata
Metrics	Métricas de Storage Analytics para el servicio de archivos.
NfsFileMode	Permisos de modo del archivo o directorio.
PipelineLike	Interfaz para la clase canalización de que contiene directivas de solicitud HTTP. Puede crear una canalización predeterminada llamando a newPipeline. O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte newPipeline y las directivas proporcionadas antes de implementar la canalización personalizada.
PipelineOptions	Interfaz de opción para el constructor de canalización.
PosixRolePermissions	Representa los permisos de archivo para un rol específico.
Range	Intervalo para operaciones de servicio. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Intervalo de archivos de Azure Storage.
RequestPolicyFactory	Interfaz de compatibilidad con RequestPolicyFactory de core-http
RequestPolicyOptions	Interfaz de compatibilidad con RequestPolicy
ResponseLike	Objeto con una propiedad _response simple.
ResponseWithBody	Objeto con una propiedad _response que tiene el cuerpo y los encabezados ya analizados en tipos conocidos.
ResponseWithHeaders	Objeto con una propiedad _response que tiene encabezados ya analizados en un objeto con tipo.
RestError	Tipo de error personalizado para solicitudes de canalización con error.
RetentionPolicy	Directiva de retención.
SasIPRange	Intervalo IP permitido para una SAS.
ServiceClientOptions	Subconjunto de `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opciones para configurar operación de generateAccountSasUrl.
ServiceGetPropertiesHeaders	Define encabezados para Service_getProperties operación.
ServiceGetPropertiesOptions	Opciones para configurar operación getProperties.
ServiceListSharesOptions	Opciones para configurar la operación listShares.
ServiceListSharesSegmentHeaders	Define encabezados para Service_listSharesSegment operación.
ServiceSetPropertiesHeaders	Define encabezados para Service_setProperties operación.
ServiceSetPropertiesOptions	Opciones para configurar la operación setProperties.
ServiceUndeleteShareOptions	Opciones para configurar la operación de <xref:ShareServiceClient.undelete>.
SetPropertiesResponse	Contiene datos de respuesta para la operación setHttpHeaders.
ShareClientConfig
ShareCreateHeaders	Define encabezados para Share_create operación.
ShareCreateIfNotExistsResponse	Contiene datos de respuesta para la operación de createIfNotExists.
ShareCreateOptions	Opciones para configurar la operación crear.
ShareCreatePermissionHeaders	Define encabezados para Share_createPermission operación.
ShareCreatePermissionOptions	Opciones para configurar la operación createPermission.
ShareCreateSnapshotHeaders	Define encabezados para Share_createSnapshot operación.
ShareCreateSnapshotOptions	Opciones para configurar la operación de createSnapshot.
ShareDeleteHeaders	Define encabezados para Share_delete operación.
ShareDeleteIfExistsResponse	Contiene datos de respuesta para la operación de deleteIfExists.
ShareDeleteMethodOptions	Opciones para configurar la operación eliminar.
ShareExistsOptions	Las opciones para configurar el existen operación.
ShareFileRangeList	Lista de intervalos de archivos
ShareGenerateSasUrlOptions	Opciones para configurar operación generateSasUrl.
ShareGetAccessPolicyHeaders	Define encabezados para Share_getAccessPolicy operación.
ShareGetAccessPolicyOptions	Opciones para configurar la operación getAccessPolicy.
ShareGetPermissionHeaders	Define encabezados para Share_getPermission operación.
ShareGetPermissionOptions	Opciones para configurar la operación de getPermission.
ShareGetPropertiesHeaders	Define encabezados para Share_getProperties operación.
ShareGetPropertiesOptions	Opciones para configurar operación getProperties.
ShareGetStatisticsHeaders	Define encabezados para Share_getStatistics operación.
ShareGetStatisticsOptions	Opciones para configurar la operación de getStatistics.
ShareItem	Un elemento de recurso compartido de Azure Storage enumerado.
ShareItemInternal	Un elemento de recurso compartido de Azure Storage enumerado.
SharePermission	Permiso (un descriptor de seguridad) en el nivel de recurso compartido.
SharePropertiesInternal	Propiedades de un recurso compartido.
ShareProtocolSettings	Configuración del protocolo
ShareProtocols	Protocolos para habilitar en el recurso compartido. Por ahora, solo admite SMB o NFS.
ShareSetAccessPolicyHeaders	Define encabezados para Share_setAccessPolicy operación.
ShareSetAccessPolicyOptions	Opciones para configurar la operación setAccessPolicy setAccessPolicy.
ShareSetMetadataHeaders	Define encabezados para Share_setMetadata operación.
ShareSetMetadataOptions	Opciones para configurar la operación setMetadata.
ShareSetPropertiesHeaders	Define encabezados para Share_setProperties operación.
ShareSetPropertiesOptions	Opciones para configurar la operación setProperties.
ShareSetQuotaOptions	Opciones para configurar la operación setQuota.
ShareSmbSettings	Configuración del protocolo SMB.
ShareStats	Estadísticas del recurso compartido.
SignedIdentifier	Identificador firmado
SignedIdentifierModel	Identificador firmado.
SmbMultichannel	Configuración de SMB multicanal
SourceModifiedAccessConditions	Grupo de parámetros
StoragePipelineOptions	Interfaz de opciones de la función newPipeline.
StorageRetryOptions	Interfaz de opciones de reintento de blobs de storage.
WebResource	Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.

Alias de tipos

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.
DirectoryCreateResponse	Contiene datos de respuesta para la operación de creación.
DirectoryDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
DirectoryForceCloseHandlesResponse	Tipo de respuesta para forceCloseHandle.
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.
DirectoryRenameResponse	Contiene datos de respuesta para la operación de cambio de nombre.
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.
FileAttributesPreserveType	Indica que los atributos de archivo existentes no cambian.
FileCreateHardLinkResponse	Contiene datos de respuesta para la operación de creación de vínculos físicos.
FileCreateResponse	Contiene datos de respuesta para la operación de creación.
FileDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
FileDownloadResponseModel	Contiene datos de respuesta para la operación de descarga.
FileForceCloseHandlesResponse	Tipo de respuesta para forceCloseHandle.
FileGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
FileGetRangeListDiffResponse	Contiene datos de respuesta para la operación getRangeList.
FileGetRangeListResponse	Contiene datos de respuesta para la operación de getRangeList de.
FileLastWrittenMode	Define valores para FileLastWrittenMode.
FileListHandlesResponse	Contiene datos de respuesta para la operación listHandles.
FilePermissionFormat	Define los valores de FilePermissionFormat.
FilePermissionInheritType	Indica que hereda el permiso de archivo del directorio primario.
FilePermissionPreserveType	Indica que el valor del permiso de archivo existente no cambia.
FileRenameResponse	Contiene datos de respuesta para la operación de cambio de nombre.
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.
FileUploadRangeFromURLResponse	Contiene datos de respuesta para la operación uploadRangeFromURL.
FileUploadRangeResponse	Contiene datos de respuesta para la operación uploadRange.
HttpRequestBody	Tipos de cuerpos admitidos en la solicitud. NodeJS.ReadableStream y () => NodeJS.ReadableStream es solo Node. Blob, ReadableStream y () => ReadableStream son solo el explorador.
LeaseDurationType	Define valores para LeaseDurationType.
LeaseOperationResponse	Contiene los datos de respuesta de las operaciones que adquieren, cambian, interrumpen o liberan una concesión. Consulte shareLeaseClient.
LeaseStateType	Define valores para LeaseStateType.
LeaseStatusType	Define valores para LeaseStatusType.
ListSharesIncludeType	Define valores para ListSharesIncludeType.
ModeCopyMode	Define valores para ModeCopyMode.
NfsFileType	Define valores para NfsFileType. <xref:KnownNfsFileType> se puede usar indistintamente con NfsFileType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Regular Directory SymLink
OwnerCopyMode	Define valores para OwnerCopyMode.
PermissionCopyModeType	Define valores para PermissionCopyModeType.
RawFileDownloadResponse	Contiene datos de respuesta para la operación de descarga.
ServiceGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
ServiceListSharesSegmentResponse	Contiene datos de respuesta para la operación de listShares de.
ServiceSetPropertiesResponse	Contiene datos de respuesta para la operación setProperties.
ShareAccessTier	Define valores para ShareAccessTier.
ShareClientOptions
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 de eliminación.
ShareFileHandleAccessRights	Define los valores de AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Contiene datos de respuesta para la operación getPermission.
ShareGetPropertiesResponse	Contiene datos de respuesta para la operación de getProperties.
ShareGetPropertiesResponseModel	Contiene datos de respuesta para la operación getProperties.
ShareGetStatisticsResponse	Datos de respuesta de la operación getStatistics.
ShareGetStatisticsResponseModel	Contiene datos de respuesta para la operación getStatistics.
ShareProperties	Propiedades de un recurso compartido.
ShareRootSquash	Define valores para ShareRootSquash.
ShareSetAccessPolicyResponse	Contiene datos de respuesta para la operación setAccessPolicy.
ShareSetMetadataResponse	Contiene datos de respuesta para la operación setMetadata.
ShareSetPropertiesResponse	Contiene datos de respuesta para la operación setProperties.
ShareSetQuotaHeaders	Define encabezados para la operación setQuota.
ShareSetQuotaResponse	Contiene datos de respuesta para la operación setQuota.
ShareTokenIntent	Define valores para ShareTokenIntent. knownShareTokenIntent se puede usar indistintamente con ShareTokenIntent, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio de copia de seguridad
TimeNowType	Indica la configuración como la hora de la solicitud.
TimePreserveType	Indica que el valor de hora existente no cambia.
WithResponse	Tipo que representa un resultado de operación con una propiedad _response conocida.

Enumeraciones

KnownShareTokenIntent	Valores conocidos de shareTokenIntent que acepta el servicio.
SASProtocol	Protocolos para SAS generados.
StorageFileAudience	Define las audiencias en la nube conocidas para Storage.
StorageRetryPolicyType	Tipos RetryPolicy.

Funciones

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Genera un objeto SASQueryParameters que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real. Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, 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.
getFileServiceAccountAudience(string)	Para obtener la audiencia de OAuth para una cuenta de almacenamiento para el servicio de archivos.
isPipelineLike(unknown)	Asistente para decidir si un argumento determinado satisface el contrato de canalización
newPipeline(Credential_2 \| TokenCredential, StoragePipelineOptions)	Crea un nuevo objeto Pipeline con credential proporcionado.
parseOctalFileMode(string)	Analizar la representación de cadena octal de 4 dígitos de un modo de archivo en una estructura nfsFileMode de.
parseSymbolicFileMode(string)	Analice una representación de cadena simbólica de 9 caracteres de un modo de archivo en una estructura de NfsFileMode.
toOctalFileMode(NfsFileMode)	Convierta estructura NfsFileMode en una represenación de cadena octal de 4 dígitos.
toSymbolicFileMode(NfsFileMode)	Convierte un NfsFileMode en una cadena en notación simbólica.

Detalles de la función

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Genera un objeto SASQueryParameters que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.

Consulte https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parámetros

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Devoluciones

SASQueryParameters

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.

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parámetros

fileSASSignatureValues: FileSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Devoluciones

SASQueryParameters

Para obtener la audiencia de OAuth para una cuenta de almacenamiento para el servicio de archivos.

function getFileServiceAccountAudience(storageAccountName: string): string

Parámetros

storageAccountName: string

Devoluciones

string

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

function isPipelineLike(pipeline: unknown): pipeline

Parámetros

pipeline: unknown

Argumento que puede ser una canalización

Devoluciones

pipeline

true cuando el argumento satisface el contrato de canalización

Crea un nuevo objeto Pipeline con credential proporcionado.

function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parámetros

credential: Credential | 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

Pipeline

Nuevo objeto Pipeline.

Analizar la representación de cadena octal de 4 dígitos de un modo de archivo en una estructura nfsFileMode de.

function parseOctalFileMode(input?: string): NfsFileMode | undefined

Parámetros

input: string

Devoluciones

NfsFileMode | undefined

Analice una representación de cadena simbólica de 9 caracteres de un modo de archivo en una estructura de NfsFileMode.

function parseSymbolicFileMode(input?: string): NfsFileMode | undefined

Parámetros

input: string

Devoluciones

NfsFileMode | undefined

Convierta estructura NfsFileMode en una represenación de cadena octal de 4 dígitos.

function toOctalFileMode(input?: NfsFileMode): string | undefined

Parámetros

input: NfsFileMode

Devoluciones

string | undefined

Convierte un NfsFileMode en una cadena en notación simbólica.

function toSymbolicFileMode(input?: NfsFileMode): string | undefined

Parámetros

input: NfsFileMode

Devoluciones

string | undefined

Compartir a través de

@azure/storage-file-share package

Clases

Interfaces

Alias de tipos

Valores conocidos admitidos por el servicio

Valores conocidos admitidos por el servicio

Enumeraciones

Funciones

Detalles de la función

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parámetros

Devoluciones

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

Parámetros

Devoluciones

getFileServiceAccountAudience(string)

Parámetros

Devoluciones

isPipelineLike(unknown)

Parámetros

Devoluciones

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Parámetros

Devoluciones

parseOctalFileMode(string)

Parámetros

Devoluciones

parseSymbolicFileMode(string)

Parámetros

Devoluciones

toOctalFileMode(NfsFileMode)

Parámetros

Devoluciones

toSymbolicFileMode(NfsFileMode)

Parámetros

Devoluciones