@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 objeto AccountSASSignatureValues . Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la corrección.
AccountSASResourceTypes	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los recursos 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 el campo resources en un objeto AccountSASSignatureValues . 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, debe serializarse con toString y establecerse como el campo de servicios en un objeto AccountSASSignatureValues . Es posible construir la cadena de servicios sin esta clase, pero el orden de los servicios es particular y esta clase garantiza la corrección.
AnonymousCredential	AnonymousCredential proporciona un miembro credentialPolicyCreator que se usa para crear objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy se usa con solicitudes HTTP(S) que leen recursos públicos o 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).
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 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 objeto DataLakeSASSignatureValues . 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 objeto DataLakeSASSignatureValues . 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 el campo de permisos en un objeto DataLakeSASSignatureValues . Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la exactitud.
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.
RestError	Tipo de error personalizado para solicitudes de canalización con errores.
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 tipos AccountSASSignatureValues y <xref:BlobSASSignatureValues> . Una vez generado, se puede codificar en y toString() 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: 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

AccessControlChangeCounters	AccessControlChangeCounters contiene recuentos de operaciones que cambian las listas de control de acceso de forma recursiva.
AccessControlChangeError	Representa una entrada que no pudo actualizar la lista de control de acceso durante `setAccessControlRecursive`y `updateAccessControlRecursiveremoveAccessControlRecursive`.
AccessControlChanges	AccessControlChanges contiene recuentos por lotes y acumulativos de operaciones que cambian las listas de control de acceso 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 establecidos correctamente todos los valores aquí, llame a generateAccountSASQueryParameters para obtener una representación de la SAS que se puede aplicar realmente a las direcciones URL del lago de datos. Nota: esta clase y SASQueryParameters existen porque el anterior es mutable y una representación lógica, mientras que este último es inmutable y se usa para generar solicitudes REST reales. Consulte https://docs.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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas para obtener descripciones de los parámetros, incluidos los que son necesarios.
BlobHierarchyListSegment
BlobItemModel	Un blob de Azure Storage
BlobPrefix
BlobPropertiesModel	Propiedades de un blob
CommonGenerateSasUrlOptions	Opciones comunes de FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions y FileGenerateSasUrlOptions.
CommonOptions	Interfaz para las opciones comunes a cada operación remota.
CpkInfo	Grupo de parámetros
DataLakeRequestConditions	Grupo de parámetros
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.
DataLakeServiceProperties	Propiedades del servicio de almacenamiento.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions	Interfaz para las opciones comunes a cada operación remota.
DirectoryCreateIfNotExistsResponse	Contiene datos de respuesta para la operación createIfNotExists .
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions	Opciones para configurar la operación generateSasUrl .
FileAppendOptions	Interfaz para las opciones comunes a cada operación remota.
FileCreateIfNotExistsOptions	Interfaz para las opciones comunes a cada operación remota.
FileCreateIfNotExistsResponse	Contiene datos de respuesta para la operación createIfNotExists .
FileCreateOptions	Interfaz para las opciones comunes a cada operación remota.
FileCreateResponse
FileFlushOptions	Interfaz para las opciones comunes a cada operación remota.
FileGenerateSasUrlOptions	Opciones para configurar la operación generateSasUrl .
FileParallelUploadOptions	Interfaz de opción para el archivo de Data Lake: operaciones de carga Vea: upload uploadFile 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 Vea: consulta
FileQueryParquetConfiguration	Opciones para consultar el archivo con formato Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions	Interfaz de opción para el archivo de Data Lake: operaciones readToBuffer Vea: readToBuffer
FileSetExpiryHeaders	Define encabezados para Path_setExpiry operación.
FileSetExpiryOptions	Interfaz de opción para la operación setExpiry .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse	Contiene datos de respuesta para la operación createIfNotExists .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse	Contiene datos de respuesta para la operación deleteIfExists .
FileSystemDeleteOptions	Interfaz para las opciones comunes a cada operación remota.
FileSystemEncryptionScope	Opciones para especificar el ámbito de cifrado en un sistema de archivos.
FileSystemExistsOptions	La interfaz de opción para el sistema de archivos de Data Lake existe operaciones Vea: exists
FileSystemGenerateSasUrlOptions	Opciones para configurar la operación generateSasUrl .
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions	Interfaz para las opciones comunes a cada operación remota.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions	Interfaz para las opciones comunes a cada operación remota.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders	Define encabezados para FileSystem_listBlobHierarchySegment operación.
FileSystemListPathsHeaders	Define encabezados para FileSystem_listPaths operación.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions	Interfaz para las opciones comunes a cada operación remota.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions	Interfaz para las opciones comunes a cada operación remota.
FileSystemUndeletePathOption	Interfaz para las opciones comunes a cada operación remota.
HttpHeaders	Colección de pares clave-valor de encabezado HTTP.
HttpOperationResponse	Respuesta HTTP compatible con core-v1(core-http).
IHttpClient	Una interfaz compatible para las directivas de solicitud core-http
Lease	Detalles de una concesión específica.
LeaseAccessConditions	Grupo de parámetros
LeaseOperationOptions	Configura las operaciones de concesión.
ListBlobsHierarchySegmentResponse	Enumeración de blobs
ListDeletedPathsOptions	Interfaz para las opciones comunes a cada operación remota.
ListDeletedPathsSegmentOptions	Interfaz para las opciones comunes a cada operación remota.
ListFileSystemsSegmentResponse
ListPathsOptions	Interfaz para las opciones comunes a cada operación remota.
ListPathsSegmentOptions	Interfaz para las opciones comunes a cada operación remota.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders	Define encabezados para Path_appendData operación.
PathChangeAccessControlRecursiveOptions	Tipo de opciones para `setAccessControlRecursive`y `removeAccessControlRecursiveupdateAccessControlRecursive` .
PathChangeAccessControlRecursiveResponse	Tipo de respuesta para `setAccessControlRecursive`y `removeAccessControlRecursiveupdateAccessControlRecursive` .
PathCreateHeaders	Define encabezados para Path_create operación.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions	Interfaz para las opciones comunes a cada operación remota.
PathCreateIfNotExistsResponse	Contiene datos de respuesta para la operación createIfNotExists .
PathCreateOptions	Interfaz para las opciones comunes a cada operación remota.
PathDeleteHeaders	Define encabezados para Path_delete operación.
PathDeleteIfExistsResponse	Contiene datos de respuesta para la operación deleteIfExists .
PathDeleteOptions	Interfaz para las opciones comunes a cada operación remota.
PathExistsOptions	Interfaz de opción para las operaciones de directorio o archivo de Data Lake Vea: exists
PathFlushDataHeaders	Define encabezados para Path_flushData operación.
PathGetAccessControlHeaders
PathGetAccessControlOptions	Interfaz para las opciones comunes a cada operación remota.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel	Define encabezados para Path_getProperties operación.
PathGetPropertiesOptions	Interfaz para las opciones comunes a cada operación remota.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions	Interfaz para las opciones comunes a cada operación remota.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders	Define encabezados para Path_setAccessControl operación.
PathSetAccessControlOptions	Interfaz para las opciones comunes a cada operación remota.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions	Interfaz para las opciones comunes a cada operación remota.
PathSetMetadataHeaders
PathSetMetadataOptions	Interfaz para las opciones comunes a cada operación remota.
PathSetPermissionsOptions	Interfaz para las opciones comunes a cada operación remota.
PathUndeleteHeaders	Define encabezados para Path_undelete operación.
PathUpdateHeaders	Define encabezados para Path_update operación.
PipelineLike	Interfaz de la 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.
PipelineOptions	Interfaz de opción para el constructor pipeline.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory	Interfaz de compatibilidad con RequestPolicyFactory de core-http
RequestPolicyOptions	Interfaz de compatibilidad con RequestPolicy
RolePermissions
SASQueryParametersOptions	Opciones para construir SASQueryParameters.
SasIPRange	Intervalo IP permitido para una SAS.
ServiceClientOptions	Un subconjunto de `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opciones para configurar la operación generateAccountSasUrl .
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions	Interfaz para las opciones comunes a cada operación remota.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions	Opciones para configurar undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions	Interfaz de opciones para la función newPipeline .
StorageRetryOptions	Interfaz de opciones de reintento de blobs de almacenamiento.
UserDelegationKey
UserDelegationKeyModel	Una clave de delegación de usuarios
WebResource	Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.

Alias de tipos

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
EncryptionAlgorithmType	Define los valores de EncryptionAlgorithmType. <xref:KnownEncryptionAlgorithmType> se puede usar indistintamente con EncryptionAlgorithmType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio None AES256
FileAppendResponse
FileExpiryMode	Define los valores de PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration	Opciones para consultar el archivo con formato de flecha de Apache. Solo es válido para outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
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 operación undeleteFileSystem .
FileUploadResponse
HttpRequestBody	Tipos de cuerpos admitidos en la solicitud. NodeJS.ReadableStream y () => NodeJS.ReadableStream es solo Node. Blob, ReadableStream y () => ReadableStream son solo explorador.
LeaseDurationType
LeaseOperationResponse	Contiene los datos de respuesta de las operaciones que crean, modifican o eliminan una concesión. Vea <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel	Define valores para PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel	Define valores para PathRenameMode.
PathResourceTypeModel	Define valores para PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse	Contiene datos de respuesta para la operación listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions	Opciones para configurar <xref:DataLakeServiceClient.renameFileSystem>.

Enumeraciones

PathGetPropertiesAction	Define valores para PathGetPropertiesAction. Entre los valores posibles se incluyen: 'getAccessControl', 'getStatus'
PathRenameMode	Define valores para PathRenameMode. Entre los valores posibles se incluyen: 'legacy', 'posix'
PathResourceType	Define valores para PathResourceType. Entre los valores posibles se incluyen: "directory", "file"
SASProtocol	Protocolos para SAS generados.
StorageDataLakeAudience	Define las audiencias de 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. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas.
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. Ejemplo // Generate service level SAS for a file system const containerSAS = generateDataLakeSASQueryParameters({ fileSystemName, // Required permissions: ContainerSASPermissions.parse("racwdl"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString(); Rellene los detalles necesarios antes de ejecutar el fragmento de código. Ejemplo // Generate service level SAS for a file const fileSAS = generateDataLakeSASQueryParameters({ fileSystemName, // Required fileName, // Required permissions: DataLakeSASPermissions.parse("racwd"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type cacheControl: "cache-control-override", // Optional contentDisposition: "content-disposition-override", // Optional contentEncoding: "content-encoding-override", // Optional contentLanguage: "content-language-override", // Optional contentType: "content-type-override", // Optional ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString();
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. Ejemplo // Generate user delegation SAS for a file system const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn); const fileSystemSAS = generateDataLakeSASQueryParameters({ fileSystemName, // Required permissions: FileSystemSASPermissions.parse("racwdl"), // Required startsOn, // Optional. Date type expiresOn, // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS }, userDelegationKey, // UserDelegationKey accountName ).toString();
getDataLakeServiceAccountAudience(string)	Para obtener audiencia de OAuth para una cuenta de almacenamiento para el servicio datalake.
isPipelineLike(unknown)	Asistente para decidir si un argumento determinado satisface el contrato de canalización.
newPipeline(StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Crea un nuevo objeto Pipeline con credential proporcionado.

Detalles de la función

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

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

Consulta https://docs.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

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.

Ejemplo

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

Rellene los detalles necesarios antes de ejecutar el fragmento de código.

Ejemplo

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

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

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.

Ejemplo

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

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

Parámetros

dataLakeSASSignatureValues: DataLakeSASSignatureValues

userDelegationKey: UserDelegationKey

Valor devuelto de blobServiceClient.getUserDelegationKey()

accountName: string

Devoluciones

SASQueryParameters

getDataLakeServiceAccountAudience(string)

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

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parámetros

storageAccountName: string

Devoluciones

string

isPipelineLike(unknown)

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuevo objeto Pipeline con credential proporcionado.

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

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.

Compartir a través de

@azure/storage-file-datalake package

Clases

Interfaces

Alias de tipos

Valores conocidos admitidos por el servicio

Enumeraciones

Funciones

Detalles de la función

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parámetros

Devoluciones

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

Parámetros

Devoluciones

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

Parámetros

Devoluciones

getDataLakeServiceAccountAudience(string)

Parámetros

Devoluciones

isPipelineLike(unknown)

Parámetros

Devoluciones

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parámetros

Devoluciones

Recursos adicionales