@azure/storage-file-datalake package

Referência

Classes

AccountSASPermissions	DISPONÍVEL APENAS NO RUNTIME NODE.JS. 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 usa 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 objeto AccountSASSignatureValues . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
AccountSASResourceTypes	DISPONÍVEL APENAS NO RUNTIME NODE.JS. 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 usa 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 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 NO RUNTIME NODE.JS. 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 usa 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 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 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).
BaseRequestPolicy	A classe base da qual todas as políticas de solicitação derivam.
Credential	A credencial é 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 APENAS NO RUNTIME NODE.JS. 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 usa 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 objeto DataLakeSASSignatureValues . É possível construir a cadeia de caracteres 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 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 usa 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 objeto DataLakeSASSignatureValues . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correçã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 usa 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 objeto DataLakeSASSignatureValues . É possível construir a cadeia de caracteres 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 do 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 uma SAS do Armazenamento do Azure. Esse tipo não é construído diretamente pelo usuário; ele só é gerado pelos tipos e <xref:BlobSASSignatureValues>AccountSASSignatureValues. Uma vez gerado, ele pode ser codificado em um toString() e acrescentado a uma URL diretamente (embora seja necessário ter cuidado 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: 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, evitando assim o cache do navegador. Remover cabeçalho de cookie para segurança Remover o cabeçalho de comprimento do conteúdo para evitar o aviso 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 implementadas.
StorageRetryPolicyFactory	StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy .
StorageSharedKeyCredential	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy é uma política usada para assinar uma solicitação HTTP com uma chave compartilhada.

Interfaces

AccessControlChangeCounters	AccessControlChangeCounters contém contagens de operações que alteram listas de controle de acesso recursivamente.
AccessControlChangeError	Representa uma entrada que falhou ao atualizar a Lista de Controle de Acesso durante `setAccessControlRecursive`e `removeAccessControlRecursiveupdateAccessControlRecursive` .
AccessControlChanges	AccessControlChanges contém contagens cumulativas e em lotes de operações que alteram listas de controle de acesso 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 APENAS NO RUNTIME NODE.JS. 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 generateAccountSASQueryParameters para obter uma representação da SAS que pode realmente ser aplicada às URLs do data lake. Observação: essa classe e 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. 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 de FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions e FileGenerateSasUrlOptions.
CommonOptions	Uma interface para opções comuns a cada operação remota.
CpkInfo	Grupo de parâmetros
DataLakeRequestConditions	Grupo de parâmetros
DataLakeSASSignatureValues	DISPONÍVEL APENAS NO RUNTIME 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 cada operação remota.
DirectoryCreateIfNotExistsResponse	Contém dados de resposta para a operação createIfNotExists .
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions	Opções para configurar a operação generateSasUrl .
FileAppendOptions	Uma interface para opções comuns a cada operação remota.
FileCreateIfNotExistsOptions	Uma interface para opções comuns a cada operação remota.
FileCreateIfNotExistsResponse	Contém dados de resposta para a operação createIfNotExists .
FileCreateOptions	Uma interface para opções comuns a cada operação remota.
FileCreateResponse
FileFlushOptions	Uma interface para opções comuns a cada operação remota.
FileGenerateSasUrlOptions	Opções para configurar a operação generateSasUrl .
FileParallelUploadOptions	Interface de opção para o arquivo Data Lake – Operações de upload Consulte: upload Uploadfile uploadStream
FileQueryCsvTextConfiguration	Opções para consultar o arquivo com 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: consulta
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: readToBuffer
FileSetExpiryHeaders	Define cabeçalhos para Path_setExpiry operação.
FileSetExpiryOptions	Interface de opção para a operação setExpiry .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse	Contém dados de resposta para a operação createIfNotExists .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse	Contém dados de resposta para a operação deleteIfExists .
FileSystemDeleteOptions	Uma interface para opções comuns a cada operação remota.
FileSystemEncryptionScope	Opções para especificar o escopo de criptografia em um sistema de arquivos.
FileSystemExistsOptions	A interface de opção para o sistema de arquivos data lake existe operações Consulte: exists
FileSystemGenerateSasUrlOptions	Opções para configurar a operação generateSasUrl .
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions	Uma interface para opções comuns a cada operação remota.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions	Uma interface para opções comuns a cada operação remota.
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 cada operação remota.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions	Uma interface para opções comuns a cada operação remota.
FileSystemUndeletePathOption	Uma interface para opções comuns a cada operação remota.
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 concessão específica.
LeaseAccessConditions	Grupo de parâmetros
LeaseOperationOptions	Configura operações de concessão.
ListBlobsHierarchySegmentResponse	Uma enumeração de blobs
ListDeletedPathsOptions	Uma interface para opções comuns a cada operação remota.
ListDeletedPathsSegmentOptions	Uma interface para opções comuns a cada operação remota.
ListFileSystemsSegmentResponse
ListPathsOptions	Uma interface para opções comuns a cada operação remota.
ListPathsSegmentOptions	Uma interface para opções comuns a cada operação remota.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders	Define cabeçalhos para Path_appendData operação.
PathChangeAccessControlRecursiveOptions	Tipo de opções para `setAccessControlRecursive`e `updateAccessControlRecursiveremoveAccessControlRecursive`.
PathChangeAccessControlRecursiveResponse	Tipo de resposta para `setAccessControlRecursive`e `removeAccessControlRecursiveupdateAccessControlRecursive` .
PathCreateHeaders	Define cabeçalhos para Path_create operação.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions	Uma interface para opções comuns a cada operação remota.
PathCreateIfNotExistsResponse	Contém dados de resposta para a operação createIfNotExists .
PathCreateOptions	Uma interface para opções comuns a cada operação remota.
PathDeleteHeaders	Define cabeçalhos para Path_delete operação.
PathDeleteIfExistsResponse	Contém dados de resposta para a operação deleteIfExists .
PathDeleteOptions	Uma interface para opções comuns a cada operação remota.
PathExistsOptions	Interface de opção para operações de diretório/arquivo do Data Lake Consulte: exists
PathFlushDataHeaders	Define cabeçalhos para Path_flushData operação.
PathGetAccessControlHeaders
PathGetAccessControlOptions	Uma interface para opções comuns a cada operação remota.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel	Define cabeçalhos para Path_getProperties operação.
PathGetPropertiesOptions	Uma interface para opções comuns a cada operação remota.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions	Uma interface para opções comuns a cada operação remota.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders	Define cabeçalhos para Path_setAccessControl operação.
PathSetAccessControlOptions	Uma interface para opções comuns a cada operação remota.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions	Uma interface para opções comuns a cada operação remota.
PathSetMetadataHeaders
PathSetMetadataOptions	Uma interface para opções comuns a cada operação remota.
PathSetPermissionsOptions	Uma interface para opções comuns a cada operação remota.
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 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 do 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 a operação generateAccountSasUrl .
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions	Uma interface para opções comuns a cada operação remota.
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 do 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhuma AES256
FileAppendResponse
FileExpiryMode	Define valores para PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration	Opções para consultar o arquivo com o formato de Seta do Apache. Válido apenas para outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
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 operação undeleteFileSystem .
FileUploadResponse
HttpRequestBody	Tipos de corpos com suporte na solicitação. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream e () => ReadableStream são somente navegador.
LeaseDurationType
LeaseOperationResponse	Contém os dados de resposta para operações que criam, modificam ou excluem uma concessão. Consulte <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>o .

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.
StorageDataLakeAudience	Define as audiências de nuvem conhecidas para Armazenamento.
StorageRetryPolicyType	Tipos retryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. 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 identificador. AVISO: quando o identificador não é fornecido, permissões e expiraOn são necessárias. Você DEVE atribuir o valor ao identificador ou expirarEm permissões de & manualmente se você iniciar com esse construtor. Preencha os detalhes necessários antes de executar os snippets a seguir. 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 snippet. 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 SOMENTE EM NODE.JS RUNTIME. 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. 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-alvo do 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 a Credencial fornecida.

Detalhes da função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

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

Veja 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

Retornos

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

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

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

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

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

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

Retornos

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

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.

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 retornado de blobServiceClient.getUserDelegationKey()

accountName: string

Retornos

SASQueryParameters

getDataLakeServiceAccountAudience(string)

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

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parâmetros

storageAccountName: string

Retornos

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

Retornos

pipeline

true quando o argumento satisfaz o contrato de pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com a Credencial fornecida.

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

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.

Compartilhar via

@azure/storage-file-datalake package

Classes

Interfaces

Aliases de tipo

Valores conhecidos compatíveis com o serviço

Enumerações

Funções

Detalhes da função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parâmetros

Retornos

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

Parâmetros

Retornos

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

Parâmetros

Retornos

getDataLakeServiceAccountAudience(string)

Parâmetros

Retornos

isPipelineLike(unknown)

Parâmetros

Retornos

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parâmetros

Retornos

Recursos adicionais