@azure/storage-file-datalake package

Referência

Classes

AccountSASPermissions	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.
AccountSASResourceTypes	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.
AccountSASServices	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	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	AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).
BaseRequestPolicy	A classe base a partir da qual todas as políticas de pedido derivam.
Credential	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.
CredentialPolicy	Política de credenciais utilizada para assinar pedidos HTTP(S) antes de enviar. Esta é uma classe abstrata.
DataLakeAclChangeFailedError	Ocorreu um erro quando uma operação é interrompida e pode ser continuada mais tarde.
DataLakeDirectoryClient	Um DataLakeDirectoryClient representa um URL para o diretório do Armazenamento do Azure.
DataLakeFileClient	Um DataLakeFileClient representa um URL para o ficheiro de Armazenamento do Azure.
DataLakeFileSystemClient	Um DataLakeFileSystemClient representa um URL para o sistema de ficheiros do Armazenamento do Azure que lhe permite manipular os respetivos diretórios e ficheiros.
DataLakeLeaseClient
DataLakePathClient	Um DataLakePathClient representa um URL para o caminho do Armazenamento do Azure (diretório ou ficheiro).
DataLakeSASPermissions	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.
DataLakeServiceClient	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.
DirectorySASPermissions	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.
FileSystemSASPermissions	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.
Pipeline	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.
RestError	Um tipo de erro personalizado para pedidos de pipeline falhados.
SASQueryParameters	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	StorageBrowserPolicy processará as diferenças entre Node.js e o runtime do browser, incluindo: 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. Remover cabeçalho de cookie para segurança Remover cabeçalho de comprimento do conteúdo para evitar avisos de browsers
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy.
StorageRetryPolicy	Repita a política com repetição exponencial e repetição linear implementada.
StorageRetryPolicyFactory	StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy .
StorageSharedKeyCredential	APENAS DISPONÍVEL NO NODE.JS RUNTIME. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy é uma política utilizada para assinar o pedido HTTP com uma chave partilhada.

Interfaces

AccessControlChangeCounters	AccessControlChangeCounters contém contagens de operações que alteram as Listas de Controlo de Acesso de forma recursiva.
AccessControlChangeError	Representa uma entrada que não conseguiu atualizar a Lista de Controlo de Acesso durante `setAccessControlRecursive`e `removeAccessControlRecursiveupdateAccessControlRecursive` .
AccessControlChanges	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.
AccessPolicy
AccountSASSignatureValues	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
BlobHierarchyListSegment
BlobItemModel	Um blob do 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 todas as operações remotas.
CpkInfo	Grupo de parâmetros
DataLakeRequestConditions	Grupo de parâmetros
DataLakeSASSignatureValues	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.
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 a operação createIfNotExists .
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions	Opções para configurar a operação generateSasUrl .
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 a 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 a operação generateSasUrl .
FileParallelUploadOptions	Interface de opção para ficheiro do Data Lake – Operações de carregamento Veja: carregar uploadFile uploadStream
FileQueryCsvTextConfiguration	Opções para consultar o ficheiro com o formato CSV.
FileQueryError	Tipo de erro de consulta de ficheiro.
FileQueryJsonTextConfiguration	Opções para consultar o ficheiro com o formato JSON.
FileQueryOptions	Interface de opção para ficheiros do Data Lake – operações de consulta Veja: consulta
FileQueryParquetConfiguration	Opções para consultar o ficheiro com o formato Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions	Interface de opção para ficheiros do Data Lake – operações readToBuffer Veja: 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 todas as operações remotas.
FileSystemEncryptionScope	Opções para especificar o âmbito de encriptação num sistema de ficheiros.
FileSystemExistsOptions	A interface de opção para o sistema de ficheiros do Data Lake existe operações Veja: existe
FileSystemGenerateSasUrlOptions	Opções para configurar a operação generateSasUrl .
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 pedidos 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 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`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 todas as operações remotas.
PathCreateIfNotExistsResponse	Contém dados de resposta para a 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 a operação deleteIfExists .
PathDeleteOptions	Uma interface para opções comuns a todas as operações remotas.
PathExistsOptions	A interface de opção para o diretório/ficheiro do Data Lake existe operações Veja: existe
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 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.
PipelineOptions	Interface de opção do construtor de pipelines.
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 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 Blobs de Armazenamento.
UserDelegationKey
UserDelegationKeyModel	Uma chave de delegação de utilizador
WebResource	Uma descrição de um pedido HTTP a ser feito num 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 utilizado alternadamente com EncryptionAlgorithmType, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Nenhuma AES256
FileAppendResponse
FileExpiryMode	Define valores para PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration	Opções para consultar o ficheiro com o formato De seta do Apache. Apenas válido 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 suportados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é apenas Node. Blob, ReadableStream e () => ReadableStream são apenas browser.
LeaseDurationType
LeaseOperationResponse	Contém os dados de resposta para operações que criam, modificam ou eliminam 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>.

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", "ficheiro"
SASProtocol	Protocolos para SAS gerados.
StorageDataLakeAudience	Define as audiências na cloud conhecidas para o Armazenamento.
StorageRetryPolicyType	Tipos de RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	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
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)	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();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)	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();
getDataLakeServiceAccountAudience(string)	Para obter a audiência do OAuth para uma conta de armazenamento para o serviço datalake.
isPipelineLike(unknown)	Um programa auxiliar para decidir se um determinado argumento satisfaz o contrato do Pipeline
newPipeline(StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Cria um novo objeto pipeline com credenciais fornecidas.

Detalhes de Função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parâmetros

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Devoluções

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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

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

Parâmetros

dataLakeSASSignatureValues: DataLakeSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Devoluções

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

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

Parâmetros

dataLakeSASSignatureValues: DataLakeSASSignatureValues

userDelegationKey: UserDelegationKey

Valor devolvido de blobServiceClient.getUserDelegationKey()

accountName: string

Devoluções

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Para obter a audiência do 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 programa auxiliar para decidir se um determinado argumento satisfaz o contrato do Pipeline

function isPipelineLike(pipeline: unknown): pipeline

Parâmetros

pipeline: unknown

Um argumento que pode ser um Pipeline

Devoluções

pipeline

verdadeiro quando o argumento satisfaz o contrato pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto pipeline com credenciais fornecidas.

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

Parâmetros

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

pipelineOptions: StoragePipelineOptions

Opcional. Opções.

Devoluções

Pipeline

Um novo objeto pipeline.

Partilhar via

@azure/storage-file-datalake package

Classes

Interfaces

Aliases de Tipo

Valores conhecidos suportados pelo serviço

Enumerações

Funções

Detalhes de Função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parâmetros

Devoluções

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

Parâmetros

Devoluções

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

Parâmetros

Devoluções

getDataLakeServiceAccountAudience(string)

Parâmetros

Devoluções

isPipelineLike(unknown)

Parâmetros

Devoluções

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parâmetros

Devoluções

Recursos adicionais