Partilhar via

@azure/storage-file-datalake package

  • Referência

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 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 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 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).
BaseRequestPolicy

A classe base da qual derivam todas as políticas de solicitação.
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 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 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 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 newPipeline. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline.

Consulte newPipeline e as políticas fornecidas antes de implementar seu Pipeline personalizado.
RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.
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; ele é gerado apenas pelos AccountSASSignatureValues e <xref:BlobSASSignatureValues> tipos. Uma vez gerado, ele pode ser codificado em um toString() 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.
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 StorageRetryPolicy objetos.
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 generateAccountSASQueryParameters para obter uma representação do SAS que pode realmente ser aplicado a urls de data lake. Nota: que tanto esta classe como SASQueryParameters existir porque a primeira é mutável e uma representação lógica, enquanto a segunda é imutável e usada para gerar solicitações REST reais.

Consulte https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceituais sobre SAS Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas para obter descrições dos parâmetros, incluindo quais são necessários
BlobHierarchyListSegment
BlobItemModel

Um blob de armazenamento do Azure
BlobPrefix
BlobPropertiesModel

Propriedades de um blob
CommonGenerateSasUrlOptions

Opções comuns do FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions e FileGenerateSasUrlOptions.
CommonOptions

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

Grupo de parâmetros
DataLakeRequestConditions

Grupo de parâmetros
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.
DataLakeServiceProperties

Propriedades do serviço de armazenamento.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

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

Contém dados de resposta para o operação createIfNotExists.
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

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

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

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

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

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

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

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

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

Veja:
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

Veja:
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

Veja:
FileSetExpiryHeaders

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

Interface de opção para o setExpiry operação.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Contém dados de resposta para o operação createIfNotExists.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

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

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

Opções para especificar o escopo de criptografia em um sistema de arquivos.
FileSystemExistsOptions

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

Veja:
FileSystemGenerateSasUrlOptions

Opções para configurar generateSasUrl operação.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

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

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

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

Define cabeçalhos para FileSystem_listPaths operação.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

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

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

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

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

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

Uma interface compatível para políticas de solicitação core-http
Lease

Os detalhes de uma locação específica.
LeaseAccessConditions

Grupo de parâmetros
LeaseOperationOptions

Configura operações de locação.
ListBlobsHierarchySegmentResponse

Uma enumeração de blobs
ListDeletedPathsOptions

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

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

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

Uma interface para opções comuns a todas as operações remotas.
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

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

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

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

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

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

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

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

Veja:
PathFlushDataHeaders

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

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

Define cabeçalhos para Path_getProperties operação.
PathGetPropertiesOptions

Uma interface para opções comuns a todas as operações remotas.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

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

Define cabeçalhos para Path_setAccessControl operação.
PathSetAccessControlOptions

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

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

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

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

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

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

Uma interface para a classe Pipeline que contém diretivas de solicitação HTTP. Você pode criar um Pipeline padrão chamando newPipeline. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline.

Consulte newPipeline e as políticas fornecidas antes de implementar seu Pipeline personalizado.
PipelineOptions

Interface de opção para o construtor Pipeline.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory

Uma interface para compatibilidade com RequestPolicyFactory do core-http
RequestPolicyOptions

Uma interface para compatibilidade com RequestPolicy
RolePermissions
SASQueryParametersOptions

Opções para construir SASQueryParameters.
SasIPRange

Intervalo de IP permitido para uma SAS.
ServiceClientOptions

Um subconjunto de @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions

Opções para configurar generateAccountSasUrl operação.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

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

Opções para configurar undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions

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

Interface de opções de repetição de Blob de armazenamento.
UserDelegationKey
UserDelegationKeyModel

Uma chave de delegação de usuário
WebResource

Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

Aliases de Tipo

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

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

Define valores para EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> pode ser usado de forma intercambiável com EncryptionAlgorithmType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Nenhum
AES256
FileAppendResponse
FileExpiryMode

Define valores para PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Opções para consultar o arquivo com o formato de seta Apache. Válido apenas para outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
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 o operação undeleteFileSystem.
FileUploadResponse
HttpRequestBody

Tipos de organismos apoiados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream e () => ReadableStream são apenas navegadores.
LeaseDurationType
LeaseOperationResponse

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

Ver <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

Contém dados de resposta para a operação listContainersSegment.
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.
StorageDataLakeAudience

Define os públicos de nuvem conhecidos para armazenamento.
StorageRetryPolicyType

Tipos RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

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

Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
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.

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 trecho.

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

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();
getDataLakeServiceAccountAudience(string)

Para obter o público OAuth para uma conta de armazenamento para o serviço datalake.
isPipelineLike(unknown)

Um auxiliar para decidir se um determinado argumento satisfaz o contrato de Pipeline
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 SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

Visualizar 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

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.

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 trecho.

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

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

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.

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

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

Parâmetros

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Valor de retorno de blobServiceClient.getUserDelegationKey()

accountName

string

Devoluções

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Para obter o público OAuth para uma conta de armazenamento para o serviço datalake.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parâmetros

storageAccountName

string

Devoluções

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

Parâmetros

pipeline

unknown

Um argumento que pode ser um Pipeline

Devoluções

pipeline

true quando o argumento satisfaz o contrato de pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com Credential fornecido.

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

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.