Compartilhar via

@azure/storage-file-datalake package

  • Referência

Classes

AccountSASPermissions

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um <xref:AccountSASSignatureValues> objeto . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidão.
AccountSASResourceTypes

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa os recursos acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse tipo de recurso. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de recursos em um <xref:AccountSASSignatureValues> objeto . É possível construir a cadeia de caracteres de recursos sem essa classe, mas a ordem dos recursos é específica e essa classe garante a exatidão.
AccountSASServices

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa os serviços acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse serviço. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de serviços em um <xref:AccountSASSignatureValues> objeto . É possível construir a cadeia de caracteres de serviços sem essa classe, mas a ordem dos serviços é específica e essa classe garante a exatidão.
AnonymousCredential

AnonymousCredential fornece um membro credentialPolicyCreator usado para criar objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com SAS (Assinaturas de Acesso Compartilhado).
AnonymousCredentialPolicy

AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com SAS (Assinaturas de Acesso Compartilhado).
Credential

Credential é uma classe abstrata para assinatura de solicitações HTTP do Armazenamento do Azure. Essa classe hospedará uma fábrica credentialPolicyCreator que gera CredentialPolicy.
CredentialPolicy

Política de credencial usada para assinar solicitações HTTP(S) antes de enviar. Esta é uma classe abstrata.
DataLakeAclChangeFailedError

Um erro gerado quando uma operação é interrompida e pode ser continuada posteriormente.
DataLakeDirectoryClient

Um DataLakeDirectoryClient representa uma URL para o diretório do Armazenamento do Azure.
DataLakeFileClient

Um DataLakeFileClient representa uma URL para o arquivo de Armazenamento do Azure.
DataLakeFileSystemClient

Um DataLakeFileSystemClient representa uma URL para o sistema de arquivos do Armazenamento do Azure, permitindo que você manipule seus diretórios e arquivos.
DataLakeLeaseClient
DataLakePathClient

Um DataLakePathClient representa uma URL para o caminho do Armazenamento do Azure (diretório ou arquivo).
DataLakeSASPermissions

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um <xref:DataLakeSASSignatureValues> objeto . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidão.
DataLakeServiceClient

O DataLakeServiceClient permite manipular recursos de serviço e sistemas de arquivos do Azure Data Lake. A conta de armazenamento fornece o namespace de nível superior para o serviço Data Lake.
DirectorySASPermissions

Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a um diretório. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um <xref:DataLakeSASSignatureValues> objeto . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidão.
FileSystemSASPermissions

Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a um contêiner. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um <xref:DataLakeSASSignatureValues> objeto . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidão.
Pipeline

Uma classe Pipeline que contém políticas de solicitação HTTP. Você pode criar um Pipeline padrão chamando <xref:newPipeline>. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor do Pipeline. <xref:newPipeline> Consulte as políticas fornecidas e antes de implementar o Pipeline personalizado.
SASQueryParameters

Representa os componentes que compõem os parâmetros de consulta de uma SAS de Armazenamento do Azure. Esse tipo não é construído diretamente pelo usuário; ele só é gerado pelos <xref:AccountSASSignatureValues> tipos e <xref:BlobSASSignatureValues> . Depois de gerado, ele pode ser codificado em um <xref:String> e acrescentado a uma URL diretamente (embora tenha cuidado para ser tomado aqui caso haja parâmetros de consulta existentes, o que pode afetar os meios apropriados de acrescentar esses parâmetros de consulta). OBSERVAÇÃO: as instâncias dessa classe são imutáveis.
StorageBrowserPolicy

StorageBrowserPolicy lidará com diferenças entre Node.js e o runtime do navegador, incluindo:

  1. Os navegadores armazenam em cache solicitações GET/HEAD adicionando cabeçalhos condicionais, como 'IF_MODIFIED_SINCE'. StorageBrowserPolicy é uma política usada para adicionar uma consulta de carimbo de data/hora à URL de solicitação GET/HEAD, portanto, evite o cache do navegador.

  2. Remover cabeçalho de cookie para segurança

  3. Remover cabeçalho de comprimento de conteúdo para evitar o aviso de navegadores
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy.
StorageClient

Um StorageClient representa uma classe de URL baseada para <xref:BlobServiceClient>e <xref:ContainerClient> etc.
StorageClientContext
StorageRetryPolicy

Política de repetição com repetição exponencial e repetição linear implementada.
StorageRetryPolicyFactory

StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar <xref:StorageRetryPolicy> objetos.
StorageSharedKeyCredential

DISPONÍVEL APENAS NO RUNTIME NODE.JS. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy é uma política usada para assinar a solicitação HTTP com uma chave compartilhada.

Interfaces

AccessControlChangeCounters

AccessControlChangeCounters contém contagens de operações que mudam Controle de Acesso Listas recursivamente.
AccessControlChangeError

Representa uma entrada que falhou ao atualizar Controle de Acesso List durante setAccessControlRecursivee updateAccessControlRecursiveremoveAccessControlRecursive.
AccessControlChanges

AccessControlChanges contém contagens cumulativas e em lote de operações que mudam Controle de Acesso Listas recursivamente. Além disso, ele expõe entradas de caminho que não foram atualizadas enquanto essas operações avançam.
AccessPolicy
AccountSASSignatureValues

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. AccountSASSignatureValues é usado para gerar uma SAS (Assinatura de Acesso Compartilhado) para uma conta de Armazenamento do Azure. Depois que todos os valores aqui forem definidos adequadamente, chame <xref:generateAccountSASQueryParameters> para obter uma representação da SAS que pode realmente ser aplicada às URLs do data lake. Observação: essa classe e <xref:SASQueryParameters> existem porque a primeira é mutável e uma representação lógica enquanto a última é imutável e usada para gerar solicitações REST reais.
BlobHierarchyListSegment
BlobItemModel

Um blob de Armazenamento do Azure
BlobPrefix
BlobPropertiesModel

Propriedades de um blob
CommonGenerateSasUrlOptions

Opções comuns de <xref:FileSystemGenerateSasUrlOptions>, <xref:DirectoryGenerateSasUrlOptions> e <xref:FileGenerateSasUrlOptions>.
CommonOptions

Uma interface para opções comuns a cada operação remota.
DataLakeRequestConditions
DataLakeSASSignatureValues

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. DataLakeSASSignatureValues é usado para ajudar a gerar tokens SAS de serviço Blob e DataLake para contêineres, blobs, sistema de arquivos, diretórios e arquivos.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Opções para configurar <xref:DataLakeDirectoryClient.generateSasUrl> a operação.
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

Opções para configurar <xref:DataLakeFileClient.generateSasUrl> a operação.
FileParallelUploadOptions

Interface de opção para o arquivo Data Lake – Operações de upload Consulte:

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

Opções para consultar o arquivo com o formato CSV.
FileQueryError

Tipo de erro de consulta de arquivo.
FileQueryJsonTextConfiguration

Opções para consultar o arquivo com formato JSON.
FileQueryOptions

Interface de opção para o arquivo data lake – operações de consulta Consulte:

  • <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration

Opções para consultar o arquivo com o formato Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Interface de opção para o arquivo data lake – operações readToBuffer Consulte:

  • <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders

Define cabeçalhos para Path_setExpiry operação.
FileSetExpiryOptions

Interface de opção para a <xref:DataLakeFileClient.setExpiry> operação.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Contém dados de resposta para a <xref:DataLakeFileSystemClient.createIfNotExists> operação.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Contém dados de resposta para a <xref:DataLakeFileSystemClient.deleteIfExists> operação.
FileSystemDeleteOptions
FileSystemExistsOptions

Interface de opção para operações de sistema de arquivos do Data Lake Consulte:

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

Opções para configurar <xref:DataLakeFileSystemClient.generateSasUrl> a operação.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Define cabeçalhos para FileSystem_listBlobHierarchySegment operação.
FileSystemListPathsHeaders

Define cabeçalhos para FileSystem_listPaths operação.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse

Uma enumeração de blobs
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Define cabeçalhos para Path_appendData operação.
PathChangeAccessControlRecursiveOptions

Tipo de opções para setAccessControlRecursivee updateAccessControlRecursiveremoveAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Tipo de resposta para setAccessControlRecursivee removeAccessControlRecursiveupdateAccessControlRecursive .
PathCreateHeaders

Define cabeçalhos para Path_create operação.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions
PathCreateIfNotExistsResponse

Contém dados de resposta para a <xref:DataLakePathClient.createIfNotExists> operação.
PathCreateOptions
PathDeleteHeaders

Define cabeçalhos para Path_delete operação.
PathDeleteIfExistsResponse

Contém dados de resposta para a <xref:DataLakePathClient.deleteIfExists> operação.
PathDeleteOptions
PathExistsOptions

Interface de opção para operações de diretório/arquivo do Data Lake Consulte:

  • <xref:DataLakePathClient.exists>
PathFlushDataHeaders

Define cabeçalhos para Path_flushData operação.
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Define cabeçalhos para Path_getProperties operação.
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Define cabeçalhos para Path_setAccessControl operação.
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders

Define cabeçalhos para Path_undelete operação.
PathUpdateHeaders

Define cabeçalhos para Path_update operação.
PipelineOptions

Interface de opção para o construtor pipeline.
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions

Opções para construir <xref:SASQueryParameters>.
SasIPRange

Intervalo de IP permitido para uma SAS.
ServiceGenerateAccountSasUrlOptions

Opções para configurar <xref:DataLakeServiceClient.generateAccountSasUrl> a operação.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Opções para configurar <xref:DataLakeServiceClient.undeleteFileSystem>.
SignedIdentifier
StorageClientOptionalParams

Parâmetros opcionais.
StoragePipelineOptions

Interface de opções para a <xref:newPipeline> função.
StorageRetryOptions

Interface de opções de repetição do Blob de Armazenamento.
UserDelegationKey

Aliases de tipo

AccessControlType
CopyStatusType
CredentialPolicyCreator

Uma função de fábrica que cria uma nova CredentialPolicy que usa a nextPolicy fornecida.
FileAppendResponse

Contém dados de resposta para a operação appendData.
FileExpiryMode

Define valores para PathExpiryOptions.
FileQueryArrowConfiguration

Opções para consultar o arquivo com o formato do Apache Arrow. Válido somente para <xref:FileQueryOptions.outputTextConfiguration>.
FileReadResponse
FileSetExpiryResponse

Contém dados de resposta para a operação setExpiry.
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Contém dados de resposta para a <xref:DataLakeServiceClient.renameFileSystem> operação.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Contém dados de resposta para a <xref:DataLakeServiceClient.undeleteFileSystem> operação.
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

Contém dados de resposta para a operação listPaths.
ModifiedAccessConditions
PathCreateResponse

Contém dados de resposta para a operação de criação.
PathDeleteResponse

Contém dados de resposta para a operação de exclusão.
PathFlushDataResponse

Contém dados de resposta para a operação flushData.
PathGetAccessControlResponse
PathGetPropertiesActionModel

Define valores para PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Define valores para PathRenameMode.
PathResourceTypeModel

Define valores para PathResourceType.
PathSetAccessControlResponse

Contém dados de resposta para a operação setAccessControl.
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Opções para configurar <xref:DataLakeServiceClient.renameFileSystem>.

Enumerações

PathGetPropertiesAction

Define valores para PathGetPropertiesAction. Os valores possíveis incluem: 'getAccessControl', 'getStatus'
PathRenameMode

Define valores para PathRenameMode. Os valores possíveis incluem: 'legacy', 'posix'
PathResourceType

Define valores para PathResourceType. Os valores possíveis incluem: 'directory', 'file'
SASProtocol

Protocolos para SAS gerada.
StorageRetryPolicyType

Tipos retryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. Gera um <xref:SASQueryParameters> objeto que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. Cria uma instância de SASQueryParameters.

Aceita apenas as configurações necessárias necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identifier.

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraOn. Você DEVE atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar com esse construtor.

Preencha os detalhes necessários antes de executar os snippets a seguir.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de usuário, são necessárias permissões e expiraçõesOn.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com a Credencial fornecida.

Detalhes da função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. Gera um <xref:SASQueryParameters> objeto que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parâmetros

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retornos

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. Cria uma instância de SASQueryParameters.

Aceita apenas as configurações necessárias necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identifier.

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraOn. Você DEVE atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar com esse construtor.

Preencha os detalhes necessários antes de executar os snippets a seguir.

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parâmetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retornos

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de usuário, são necessárias permissões e expiraçõesOn.

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

Parâmetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Valor retornado de blobServiceClient.getUserDelegationKey()

accountName

string

Retornos

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com a Credencial fornecida.

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

Parâmetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

pipelineOptions
StoragePipelineOptions

Opcional. Opções.

Retornos

Pipeline

Um novo objeto Pipeline.