Compartir a través de

@azure/storage-file-datalake package

  • Referencia

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 <xref:AccountSASSignatureValues> objeto. 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 accesibles por 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 campo de recursos en un <xref:AccountSASSignatureValues> objeto . Es posible construir la cadena de recursos sin esta clase, pero el orden de los recursos es particular 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 representa los servicios accesibles por un 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, se debe serializar con toString y establecerse como el campo de servicios en un <xref:AccountSASSignatureValues> objeto . 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 para su uso con firmas de acceso compartido (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy se usa con solicitudes HTTP(S) que leen recursos públicos o para su uso 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.
CredentialPolicy

Directiva de credenciales usada para firmar solicitudes HTTP(S) antes de enviarlas. Esta es una clase abstracta.
DataLakeAclChangeFailedError

Se produce un error cuando se interrumpe una operación y se puede continuar más adelante.
DataLakeDirectoryClient

DataLakeDirectoryClient representa una dirección URL al directorio de Azure Storage.
DataLakeFileClient

DataLakeFileClient representa una dirección URL al archivo de Azure Storage.
DataLakeFileSystemClient

DataLakeFileSystemClient representa una dirección URL al sistema de archivos de Azure Storage que le permite manipular sus directorios y archivos.
DataLakeLeaseClient
DataLakePathClient

DataLakePathClient representa una dirección URL a la ruta de acceso de Azure Storage (directorio o archivo).
DataLakeSASPermissions

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. 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 <xref:DataLakeSASSignatureValues> objeto. 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.
DataLakeServiceClient

DataLakeServiceClient permite manipular los recursos y sistemas de archivos del servicio Azure Data Lake. La cuenta de almacenamiento proporciona el espacio de nombres de nivel superior para el servicio de Data Lake.
DirectorySASPermissions

Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un ServiceSAS a un directorio. 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 <xref:DataLakeSASSignatureValues> objeto. 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.
FileSystemSASPermissions

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 campo de permisos en un <xref:DataLakeSASSignatureValues> objeto. 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.
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 y proporcione directivas <xref:newPipeline> antes de implementar la canalización personalizada.
SASQueryParameters

Representa los componentes que componen los parámetros de consulta de una SAS de Azure Storage. El usuario no construye directamente este tipo; solo lo generan los <xref:AccountSASSignatureValues> tipos y <xref:BlobSASSignatureValues> . Una vez generado, se puede codificar en y <xref:String> 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 para 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 en <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 <xref:StorageRetryPolicy> objetos.
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

AccessControlChangeCounters

AccessControlChangeCounters contiene recuentos de operaciones que cambian Access Control listas de forma recursiva.
AccessControlChangeError

Representa una entrada que no pudo actualizar Access Control Lista durante setAccessControlRecursiveupdateAccessControlRecursive y removeAccessControlRecursive.
AccessControlChanges

AccessControlChanges contiene recuentos por lotes y acumulativos de operaciones que cambian Access Control Listas de forma recursiva. Además, expone entradas de ruta de acceso que no se pudieron actualizar mientras estas operaciones progresan.
AccessPolicy
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 <xref:generateAccountSASQueryParameters> a para obtener una representación de la SAS que realmente se puede aplicar a las direcciones URL del lago de datos. Nota: tanto esta clase <xref:SASQueryParameters> como existen porque la anterior es mutable y una representación lógica, mientras que esta última es inmutable y se usa para generar solicitudes REST reales.
BlobHierarchyListSegment
BlobItemModel

Un blob de Azure Storage
BlobPrefix
BlobPropertiesModel

Propiedades de un blob
CommonGenerateSasUrlOptions

Opciones comunes de <xref:FileSystemGenerateSasUrlOptions>, <xref:DirectoryGenerateSasUrlOptions> y <xref:FileGenerateSasUrlOptions>.
CommonOptions

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

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. DataLakeSASSignatureValues se usa para ayudar a generar tokens SAS del servicio Blob y DataLake para contenedores, blobs, sistema de archivos, directorios y archivos.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Opciones para configurar <xref:DataLakeDirectoryClient.generateSasUrl> la operación.
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

Opciones para configurar <xref:DataLakeFileClient.generateSasUrl> la operación.
FileParallelUploadOptions

Interfaz de opción para el archivo de Data Lake: operaciones de carga Consulte:

  • <xref:DataLakeFileClient.upload>
  • <xref:DataLakeFileClient.uploadFile>
  • <xref:DataLakeFileClient.uploadStream>
FileQueryCsvTextConfiguration

Opciones para consultar el archivo con formato CSV.
FileQueryError

Tipo de error de consulta de archivo.
FileQueryJsonTextConfiguration

Opciones para consultar el archivo con formato JSON.
FileQueryOptions

Interfaz de opción para el archivo de Data Lake: operaciones de consulta Consulte:

  • <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration

Opciones para consultar el archivo con formato Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Interfaz de opción para el archivo de Data Lake: operaciones readToBuffer Consulte:

  • <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders

Define encabezados para Path_setExpiry operación.
FileSetExpiryOptions

Interfaz de opción para la <xref:DataLakeFileClient.setExpiry> operación.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Contiene datos de respuesta para la <xref:DataLakeFileSystemClient.createIfNotExists> operación.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Contiene datos de respuesta para la <xref:DataLakeFileSystemClient.deleteIfExists> operación.
FileSystemDeleteOptions
FileSystemExistsOptions

La interfaz de opción para el sistema de archivos de Data Lake existe operaciones. Consulte:

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

Opciones para configurar <xref:DataLakeFileSystemClient.generateSasUrl> la operación.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Define encabezados para FileSystem_listBlobHierarchySegment operación.
FileSystemListPathsHeaders

Define encabezados para FileSystem_listPaths operación.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse

Enumeración de blobs
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Define encabezados para Path_appendData operación.
PathChangeAccessControlRecursiveOptions

Opciones de tipo para setAccessControlRecursivey removeAccessControlRecursiveupdateAccessControlRecursive .
PathChangeAccessControlRecursiveResponse

Tipo de respuesta para setAccessControlRecursivey removeAccessControlRecursiveupdateAccessControlRecursive .
PathCreateHeaders

Define encabezados para Path_create operación.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions
PathCreateIfNotExistsResponse

Contiene datos de respuesta para la <xref:DataLakePathClient.createIfNotExists> operación.
PathCreateOptions
PathDeleteHeaders

Define encabezados para Path_delete operación.
PathDeleteIfExistsResponse

Contiene datos de respuesta para la <xref:DataLakePathClient.deleteIfExists> operación.
PathDeleteOptions
PathExistsOptions

La interfaz de opción para las operaciones de directorio o archivo de Data Lake existe. Consulte:

  • <xref:DataLakePathClient.exists>
PathFlushDataHeaders

Define encabezados para Path_flushData operación.
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Define encabezados para Path_getProperties operación.
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Define encabezados para Path_setAccessControl operación.
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders

Define encabezados para Path_undelete operación.
PathUpdateHeaders

Define encabezados para Path_update operación.
PipelineOptions

Interfaz de opción para el constructor pipeline.
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions

Opciones para construir <xref:SASQueryParameters>.
SasIPRange

Intervalo IP permitido para una SAS.
ServiceGenerateAccountSasUrlOptions

Opciones para configurar <xref:DataLakeServiceClient.generateAccountSasUrl> la operación.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Opciones para configurar <xref:DataLakeServiceClient.undeleteFileSystem>.
SignedIdentifier
StorageClientOptionalParams

Parámetros opcionales.
StoragePipelineOptions

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

Interfaz de opciones de reintento de blobs de almacenamiento.
UserDelegationKey

Alias de tipos

AccessControlType
CopyStatusType
CredentialPolicyCreator

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

Contiene datos de respuesta para la operación appendData.
FileExpiryMode

Define los valores de PathExpiryOptions.
FileQueryArrowConfiguration

Opciones para consultar el archivo con formato de flecha de Apache. Solo es válido para <xref:FileQueryOptions.outputTextConfiguration>.
FileReadResponse
FileSetExpiryResponse

Contiene datos de respuesta para la operación setExpiry.
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Contiene datos de respuesta para la <xref:DataLakeServiceClient.renameFileSystem> operación.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Contiene datos de respuesta para la <xref:DataLakeServiceClient.undeleteFileSystem> operación.
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

Contiene datos de respuesta para la operación listPaths.
ModifiedAccessConditions
PathCreateResponse

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

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

Contiene datos de respuesta para la operación flushData.
PathGetAccessControlResponse
PathGetPropertiesActionModel

Define los valores de PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Define los valores de PathRenameMode.
PathResourceTypeModel

Define los valores de PathResourceType.
PathSetAccessControlResponse

Contiene datos de respuesta para la operación setAccessControl.
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Opciones para configurar <xref:DataLakeServiceClient.renameFileSystem>.

Enumeraciones

PathGetPropertiesAction

Define los valores de PathGetPropertiesAction. Entre los valores posibles se incluyen: "getAccessControl", "getStatus"
PathRenameMode

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

Define los valores de PathResourceType. Entre los valores posibles se incluyen: 'directory', 'file'
SASProtocol

Protocolos para SAS generados.
StorageRetryPolicyType

Tipos RetryPolicy.

Funciones

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Genera un <xref:SASQueryParameters> objeto que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, 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 expirar Los permisos de & manualmente si se inicializa con este constructor.

Rellene los detalles necesarios antes de ejecutar los fragmentos de código siguientes.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Crea una instancia de SASQueryParameters. ADVERTENCIA: se omitirá el identificador al generar la SAS de delegación de usuarios, los permisos y expiresOn.
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 <xref:SASQueryParameters> objeto 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

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, 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 expirar Los permisos de & manualmente si se inicializa con este constructor.

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

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parámetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluciones

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

Parámetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Valor devuelto de blobServiceClient.getUserDelegationKey()

accountName

string

Devoluciones

SASQueryParameters

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 @azure/identity paquete para autenticar las solicitudes en el servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

pipelineOptions
StoragePipelineOptions

Opcional. Opciones.

Devoluciones

Pipeline

Nuevo objeto Pipeline.