@azure/storage-file-datalake package

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de permissões num objeto AccountSASSignatureValues . É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Esta é uma classe auxiliar para construir uma cadeia que representa os recursos acessíveis por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá acesso a esse tipo de recurso. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de recursos num objeto AccountSASSignatureValues . É possível construir a cadeia de recursos sem esta classe, mas a ordem dos recursos é particular e esta classe garante a correção.

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Esta é uma classe auxiliar para construir uma cadeia que representa os serviços acessíveis por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá acesso a esse serviço. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de serviços num objeto AccountSASSignatureValues . É possível construir a cadeia de serviços sem esta classe, mas a ordem dos serviços é particular e esta classe garante a correção.

AnonymousCredential fornece um membro credentialPolicyCreator utilizado para criar objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).

AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).

A classe base a partir da qual todas as políticas de pedido derivam.

A credencial é uma classe abstrata para a assinatura de pedidos HTTP do Armazenamento do Microsoft Azure. Esta classe irá alojar uma fábrica credentialPolicyCreator que gera CredentialPolicy.

Política de credenciais utilizada para assinar pedidos HTTP(S) antes de enviar. Esta é uma classe abstrata.

Ocorreu um erro quando uma operação é interrompida e pode ser continuada mais tarde.

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

Um DataLakeFileClient representa um URL para o ficheiro de Armazenamento do Azure.

Um DataLakeFileSystemClient representa um URL para o sistema de ficheiros do Armazenamento do Azure que lhe permite manipular os respetivos diretórios e ficheiros.

Um DataLakePathClient representa um URL para o caminho do Armazenamento do Azure (diretório ou ficheiro).

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por um ServiceSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de permissões num objeto DataLakeSASSignatureValues . É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

O DataLakeServiceClient permite-lhe manipular recursos de serviço e sistemas de ficheiros do Azure Data Lake. A conta de armazenamento fornece o espaço de nomes de nível superior para o serviço Data Lake.

Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por um ServiceSAS a um diretório. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de permissões num objeto DataLakeSASSignatureValues . É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por um ServiceSAS a um contentor. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este deve ser serializado com toString e definido como o campo de permissões num objeto DataLakeSASSignatureValues . É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.

Uma classe pipeline que contém políticas de pedido HTTP. Pode criar um Pipeline predefinido ao chamar newPipeline. Em alternativa, pode criar um Pipeline com as suas próprias políticas pelo construtor do Pipeline.

Veja newPipeline e as políticas fornecidas antes de implementar o Pipeline personalizado.

Um tipo de erro personalizado para pedidos de pipeline falhados.

Representa os componentes que constituem os parâmetros de consulta da SAS do Armazenamento do Azure. Este tipo não é construído diretamente pelo utilizador; só é gerado pelos tipos e <xref:BlobSASSignatureValues>accountSASSignatureValues. Uma vez gerado, pode ser codificado num toString() URL e anexado diretamente a um URL (embora deva ter cuidado aqui no caso de existirem parâmetros de consulta, o que pode afetar os meios adequados de anexar estes parâmetros de consulta).

NOTA: as instâncias desta classe são imutáveis.

StorageBrowserPolicy processará as diferenças entre Node.js e o runtime do browser, incluindo:

1. Os browsers colocam em cache pedidos GET/HEAD ao adicionar cabeçalhos condicionais, como "IF_MODIFIED_SINCE". StorageBrowserPolicy é uma política utilizada para adicionar uma consulta de carimbo de data/hora ao URL do pedido GET/HEAD, evitando assim a cache do browser.

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

3. Remover cabeçalho de comprimento do conteúdo para evitar avisos de browsers

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

Repita a política com repetição exponencial e repetição linear implementada.

StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy .

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.

StorageSharedKeyCredentialPolicy é uma política utilizada para assinar o pedido HTTP com uma chave partilhada.

AccessControlChangeCounters contém contagens de operações que alteram as Listas de Controlo de Acesso de forma recursiva.

Representa uma entrada que não conseguiu atualizar a Lista de Controlo de Acesso durante setAccessControlRecursivee removeAccessControlRecursiveupdateAccessControlRecursive .

AccessControlChanges contém lotes e contagens cumulativas de operações que alteram as Listas de Controlo de Acesso de forma recursiva. Além disso, expõe entradas de caminho que não foram atualizadas enquanto estas operações progridem.

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

AccountSASSignatureValues é utilizado para gerar uma Assinatura de Acesso Partilhado (SAS) para uma conta de Armazenamento do Azure. Assim que todos os valores aqui estiverem definidos adequadamente, chame generateAccountSASQueryParameters para obter uma representação da SAS que pode ser aplicada aos URLs do data lake. Nota: esta classe e SASQueryParameters existem porque a primeira é mutável e uma representação lógica enquanto esta é imutável e utilizada para gerar pedidos REST reais.

Veja https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceptuais sobre SAS Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas as descrições dos parâmetros, incluindo os necessários

Um blob do Armazenamento do Azure

Propriedades de um blob

Opções comuns de FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions e FileGenerateSasUrlOptions.

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

Grupo de parâmetros

Grupo de parâmetros

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

DataLakeSASSignatureValues é utilizado para ajudar a gerar tokens SAS do serviço Blob e DataLake para contentores, blobs, sistema de ficheiros, diretórios e ficheiros.

Propriedades do Serviço de Armazenamento.

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

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

Opções para configurar a operação generateSasUrl .

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

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

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

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

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

Opções para configurar a operação generateSasUrl .

Interface de opção para ficheiro do Data Lake – Operações de carregamento

Veja:

• carregar
• uploadFile
• uploadStream

Opções para consultar o ficheiro com o formato CSV.

Tipo de erro de consulta de ficheiro.

Opções para consultar o ficheiro com o formato JSON.

Interface de opção para ficheiros do Data Lake – operações de consulta

Veja:

• consulta

Opções para consultar o ficheiro com o formato Parquet.

Interface de opção para ficheiros do Data Lake – operações readToBuffer

Veja:

• readToBuffer

Define cabeçalhos para Path_setExpiry operação.

Interface de opção para a operação setExpiry .

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

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

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

Opções para especificar o âmbito de encriptação num sistema de ficheiros.

A interface de opção para o sistema de ficheiros do Data Lake existe operações

Veja:

• existe

Opções para configurar a operação generateSasUrl .

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

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

Define cabeçalhos para FileSystem_listBlobHierarchySegment operação.

Define cabeçalhos para FileSystem_listPaths operação.

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

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

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

Uma coleção de pares chave/valor de cabeçalho HTTP.

Resposta Http compatível com o core-v1(core-http).

Uma interface compatível para políticas de pedidos core-http

Os detalhes de uma concessão específica.

Grupo de parâmetros

Configura operações de concessão.

Uma enumeração de blobs

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

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

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

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

Define cabeçalhos para Path_appendData operação.

Tipo de opções para setAccessControlRecursivee updateAccessControlRecursiveremoveAccessControlRecursive.

Tipo de resposta para setAccessControlRecursivee removeAccessControlRecursiveupdateAccessControlRecursive .

Define cabeçalhos para Path_create operação.

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

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

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

Define cabeçalhos para Path_delete operação.

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

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

A interface de opção para o diretório/ficheiro do Data Lake existe operações

Veja:

• existe

Define cabeçalhos para Path_flushData operação.

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

Define cabeçalhos para Path_getProperties operação.

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

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

Define cabeçalhos para Path_setAccessControl operação.

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

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

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

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

Define cabeçalhos para Path_undelete operação.

Define cabeçalhos para Path_update operação.

Uma interface para a classe Pipeline que contém políticas de pedido HTTP. Pode criar um Pipeline predefinido ao chamar newPipeline. Em alternativa, pode criar um Pipeline com as suas próprias políticas pelo construtor do Pipeline.

Veja newPipeline e as políticas fornecidas antes de implementar o Pipeline personalizado.

Interface de opção do construtor de pipelines.

Uma interface para compatibilidade com RequestPolicyFactory do core-http

Uma interface para compatibilidade com RequestPolicy

Opções para construir SASQueryParameters.

Intervalo de IP permitido para uma SAS.

Um subconjunto de @azure/core-http ServiceClientOptions

Opções para configurar a operação generateAccountSasUrl .

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

Opções para configurar undeleteFileSystem.

Interface de opções para a função newPipeline .

Interface de opções de repetição de Blobs de Armazenamento.

Uma chave de delegação de utilizador

Uma descrição de um pedido HTTP a ser feito num servidor remoto.

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

Define valores para EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> pode ser utilizado alternadamente com EncryptionAlgorithmType, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Nenhuma
AES256

Define valores para PathExpiryOptions.

Opções para consultar o ficheiro com o formato De seta do Apache. Apenas válido para outputTextConfiguration.

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

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

Tipos de corpos suportados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é apenas Node. Blob, ReadableStream e () => ReadableStream são apenas browser.

Contém os dados de resposta para operações que criam, modificam ou eliminam uma concessão.

Consulte <xref:BlobLeaseClient>.

Define valores para PathGetPropertiesAction.

Define valores para PathRenameMode.

Define valores para PathResourceType.

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

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

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

Define valores para PathRenameMode. Os valores possíveis incluem: "legado", "posix"

Define valores para PathResourceType. Os valores possíveis incluem: "diretório", "ficheiro"

Protocolos para SAS gerados.

Define as audiências na cloud conhecidas para o Armazenamento.

Tipos de RetryPolicy.

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer um pedido REST real.

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

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Cria uma instância de SASQueryParameters.

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

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraÇões. Tem de atribuir valor ao identificador ou expirarOn & permissões manualmente se inicialmente com este construtor.

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

Exemplo

// 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();

Preencha os detalhes necessários antes de executar o fragmento.

Exemplo

// 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();

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Cria uma instância de SASQueryParameters. AVISO: o identificador será ignorado ao gerar SAS de delegação de utilizador, são necessárias permissões e expiraçõesOn.

Exemplo

// 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();

Para obter a audiência do OAuth para uma conta de armazenamento para o serviço datalake.

Um programa auxiliar para decidir se um determinado argumento satisfaz o contrato do Pipeline

Cria um novo objeto pipeline com credenciais fornecidas.