Partilhar via

@azure/storage-file-datalake package

Classes

AccountSASPermissions

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é 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 estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:AccountSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
AccountSASResourceTypes

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é 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 estiverem definidos, isso deve ser serializado com toString e definido como o campo de recursos em um objeto <xref:AccountSASSignatureValues>. É possível construir a cadeia de caracteres de recursos sem essa classe, mas a ordem dos recursos é particular e essa classe garante a correção.
AccountSASServices

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é 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 estiverem definidos, isso deve ser serializado com toString e definido como o campo de serviços em um objeto <xref:AccountSASSignatureValues>. É possível construir a cadeia de caracteres de serviços sem essa classe, mas a ordem dos serviços é particular e essa classe garante a correçã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 Assinaturas de Acesso Compartilhado (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).
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 credenciais usada para assinar solicitações HTTP(S) antes do envio. Esta é uma classe abstrata.
DataLakeAclChangeFailedError

Um erro lançado quando uma operação é interrompida e pode ser continuado mais tarde.
DataLakeDirectoryClient

Um DataLakeDirectoryClient representa uma URL para o diretório de 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 de Armazenamento do Azure (diretório ou arquivo).
DataLakeSASPermissions

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é 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 estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:DataLakeSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
DataLakeServiceClient

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

Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS para 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 estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:DataLakeSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
FileSystemSASPermissions

Esta é 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 estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:DataLakeSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correçã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 de Pipeline. Consulte <xref:newPipeline> e políticas fornecidas antes de implementar seu pipeline personalizado.
SASQueryParameters

Representa os componentes que compõem os parâmetros de consulta de um SAS de Armazenamento do Azure. Este tipo não é construído diretamente pelo usuário; é gerado apenas pelos tipos <xref:AccountSASSignatureValues> e <xref:BlobSASSignatureValues>. Uma vez gerado, ele pode ser codificado em um <xref:String> e anexado a uma URL diretamente (embora seja necessário ter cuidado aqui caso existam parâmetros de consulta existentes, o que pode afetar os meios apropriados de anexar esses parâmetros de consulta). Observação : instâncias dessa classe são imutáveis.
StorageBrowserPolicy

StorageBrowserPolicy lidará com as diferenças entre Node.js e o tempo de execução 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 ao URL de solicitação GET/HEAD, evitando assim o cache do navegador.

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

  3. Remova o cabeçalho de comprimento de conteúdo para evitar avisos 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>, <xref:ContainerClient> e 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 objetos <xref:StorageRetryPolicy>.
StorageSharedKeyCredential

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO 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 solicitações HTTP com uma chave compartilhada.

Interfaces

AccessControlChangeCounters

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

Representa uma entrada que não conseguiu atualizar a Lista de Controle de Acesso durante setAccessControlRecursive, updateAccessControlRecursive e removeAccessControlRecursive.
AccessControlChanges

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

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. AccountSASSignatureValues é usado para gerar uma Assinatura de Acesso Compartilhado (SAS) para uma conta de Armazenamento do Azure. Uma vez que todos os valores aqui são definidos adequadamente, chame <xref:generateAccountSASQueryParameters> para obter uma representação do SAS que pode realmente ser aplicado às urls do data lake. Nota: que tanto essa classe quanto <xref:SASQueryParameters> existem porque a primeira é mutável e uma representação lógica, enquanto a segunda é 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 do <xref:FileSystemGenerateSasUrlOptions>, <xref:DirectoryGenerateSasUrlOptions> e <xref:FileGenerateSasUrlOptions>.
CommonOptions

Uma interface para opções comuns a todas as operações remotas.
DataLakeRequestConditions
DataLakeSASSignatureValues

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. 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> operação.
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

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

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

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

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

Tipo de erro de consulta de arquivo.
FileQueryJsonTextConfiguration

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

Interface de opção para 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 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 operação <xref:DataLakeFileClient.setExpiry>.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

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

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

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

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

Opções para configurar <xref:DataLakeFileSystemClient.generateSasUrl> 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 setAccessControlRecursive, updateAccessControlRecursive e removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Tipo de resposta para setAccessControlRecursive, updateAccessControlRecursive e removeAccessControlRecursive.
PathCreateHeaders

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

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

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

Contém dados de resposta para a operação <xref:DataLakePathClient.deleteIfExists>.
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> 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 função <xref:newPipeline>.
StorageRetryOptions

Interface de opções de repetição de 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 de seta Apache. Válido apenas 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 operação <xref:DataLakeServiceClient.renameFileSystem>.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Contém dados de resposta para a operação <xref:DataLakeServiceClient.undeleteFileSystem>.
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 create.
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: 'legado', 'posix'
PathResourceType

Define valores para PathResourceType. Os valores possíveis incluem: 'diretório', 'arquivo'
SASProtocol

Protocolos para SAS gerado.
StorageRetryPolicyType

Tipos RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> 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 EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters.

Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

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

Preencha os detalhes necessários antes de executar os seguintes trechos.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

Cria um novo objeto Pipeline com Credential fornecido.

Detalhes de Função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> 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

Devoluções

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters.

Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

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

Preencha os detalhes necessários antes de executar os seguintes trechos.

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parâmetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluções

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters. AVISO: identificador será ignorado ao gerar delegação de usuário SAS, permissões e expirações são necessárias.

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

Parâmetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Valor de retorno de blobServiceClient.getUserDelegationKey()

accountName

string

Devoluções

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com Credential fornecido.

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

Parâmetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity 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.

Devoluções

Pipeline

Um novo objeto Pipeline.