Dela via

@azure/storage-file-datalake package

  • Referens

Klasser

AccountSASPermissions

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält för ett <xref:AccountSASSignatureValues> objekt. Det går att skapa behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
AccountSASResourceTypes

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de resurser som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den resurstypen. När alla värden har angetts ska detta serialiseras med toString och anges som resursfält för ett <xref:AccountSASSignatureValues> objekt. Det går att skapa resurssträngen utan den här klassen, men resursordningen är speciell och den här klassen garanterar korrekthet.
AccountSASServices

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfältet på ett <xref:AccountSASSignatureValues> objekt. Det går att konstruera tjänststrängen utan den här klassen, men ordningen på tjänsterna är speciell och den här klassen garanterar korrekthet.
AnonymousCredential

AnonymousCredential tillhandahåller en credentialPolicyCreator-medlem som används för att skapa AnonymousCredentialPolicy-objekt. AnonymousCredentialPolicy används med HTTP(S)-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy används med HTTP(S)-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
Credential

Autentiseringsuppgifter är en abstrakt klass för signering av HTTP-begäranden i Azure Storage. Den här klassen är värd för en credentialPolicyCreator-fabrik som genererar CredentialPolicy.
CredentialPolicy

Princip för autentiseringsuppgifter som används för att signera HTTP(S)-begäranden innan de skickas. Det här är en abstrakt klass.
DataLakeAclChangeFailedError

Ett fel uppstod när en åtgärd avbröts och kan fortsätta senare.
DataLakeDirectoryClient

En DataLakeDirectoryClient representerar en URL till Azure Storage-katalogen.
DataLakeFileClient

En DataLakeFileClient representerar en URL till Azure Storage-filen.
DataLakeFileSystemClient

En DataLakeFileSystemClient representerar en URL till Azure Storage-filsystemet så att du kan ändra dess kataloger och filer.
DataLakeLeaseClient
DataLakePathClient

En DataLakePathClient representerar en URL till Azure Storage-sökvägen (katalog eller fil).
DataLakeSASPermissions

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en ServiceSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält för ett <xref:DataLakeSASSignatureValues> objekt. Det går att skapa behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
DataLakeServiceClient

Med DataLakeServiceClient kan du manipulera Azure Data Lake-tjänstresurser och filsystem. Lagringskontot tillhandahåller namnområdet på den översta nivån för Data Lake-tjänsten.
DirectorySASPermissions

Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en katalog. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält för ett <xref:DataLakeSASSignatureValues> objekt. Det går att skapa behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
FileSystemSASPermissions

Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en container. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält för ett <xref:DataLakeSASSignatureValues> objekt. Det går att skapa behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
Pipeline

En Pipeline-klass som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa <xref:newPipeline>. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. <xref:newPipeline> Se och tillhandahållna principer innan du implementerar din anpassade pipeline.
SASQueryParameters

Representerar de komponenter som utgör en Azure Storage SAS-frågeparametrar. Den här typen skapas inte direkt av användaren. den genereras bara av typerna <xref:AccountSASSignatureValues> och <xref:BlobSASSignatureValues> . När den har genererats kan den kodas till en <xref:String> och läggas till i en URL direkt (även om försiktighet bör iakttas här om det finns befintliga frågeparametrar, vilket kan påverka lämpliga sätt att lägga till dessa frågeparametrar). Obs! Instanser av den här klassen är oföränderliga.
StorageBrowserPolicy

StorageBrowserPolicy hanterar skillnader mellan Node.js och webbläsarkörning, inklusive:

  1. Webbläsare cachelagrar GET/HEAD-begäranden genom att lägga till villkorsstyrda rubriker som "IF_MODIFIED_SINCE". StorageBrowserPolicy är en princip som används för att lägga till en tidsstämpelfråga i URL:en för GET/HEAD-begäran och därmed undvika webbläsarens cacheminne.

  2. Ta bort cookierubrik för säkerhet

  3. Ta bort innehållslängdsrubriken för att undvika varningar från webbläsare
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory är en fabriksklass som hjälper till att generera StorageBrowserPolicy-objekt.
StorageClient

En StorageClient representerar en baserad URL-klass för <xref:BlobServiceClient>osv <xref:ContainerClient> .
StorageClientContext
StorageRetryPolicy

Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.
StorageRetryPolicyFactory

StorageRetryPolicyFactory är en fabriksklass som hjälper till att generera <xref:StorageRetryPolicy> objekt.
StorageSharedKeyCredential

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. StorageSharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy är en princip som används för att signera HTTP-begäran med en delad nyckel.

Gränssnitt

AccessControlChangeCounters

AccessControlChangeCounters innehåller antalet åtgärder som ändrar Access Control listor rekursivt.
AccessControlChangeError

Representerar en post som inte kunde uppdatera Access Control-listan under setAccessControlRecursive, updateAccessControlRecursive och removeAccessControlRecursive.
AccessControlChanges

AccessControlChanges innehåller batch- och kumulativa antal åtgärder som ändrar Access Control listor rekursivt. Dessutom exponeras sökvägsposter som inte kunde uppdateras medan dessa åtgärder fortskrider.
AccessPolicy
AccountSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. AccountSASSignatureValues används för att generera en signatur för delad åtkomst (SAS) för ett Azure Storage-konto. När alla värden här har angetts på rätt sätt anropar du <xref:generateAccountSASQueryParameters> för att hämta en representation av SAS som faktiskt kan tillämpas på url:er för datasjöar. Obs! Att både den här klassen och <xref:SASQueryParameters> finns eftersom den förra är föränderlig och en logisk representation medan den senare är oföränderlig och används för att generera faktiska REST-begäranden.
BlobHierarchyListSegment
BlobItemModel

En Azure Storage-blob
BlobPrefix
BlobPropertiesModel

Egenskaper för en blob
CommonGenerateSasUrlOptions

Vanliga alternativ för <xref:FileSystemGenerateSasUrlOptions>, <xref:DirectoryGenerateSasUrlOptions> och <xref:FileGenerateSasUrlOptions>.
CommonOptions

Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
DataLakeRequestConditions
DataLakeSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. DataLakeSASSignatureValues används för att generera SAS-token för Blob- och DataLake-tjänsten för containrar, blobar, filsystem, kataloger och filer.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Alternativ för att konfigurera <xref:DataLakeDirectoryClient.generateSasUrl> åtgärden.
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

Alternativ för att konfigurera <xref:DataLakeFileClient.generateSasUrl> åtgärden.
FileParallelUploadOptions

Alternativgränssnitt för Data Lake-fil – Uppladdningsåtgärder Se:

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

Alternativ för att fråga fil med CSV-format.
FileQueryError

Filfrågefeltyp.
FileQueryJsonTextConfiguration

Alternativ för att fråga fil med JSON-format.
FileQueryOptions

Alternativgränssnitt för Data Lake-fil – frågeåtgärder Se:

  • <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration

Alternativ för att fråga fil med Parquet-format.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Alternativgränssnitt för Data Lake-fil – readToBuffer-åtgärder Se:

  • <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders

Definierar rubriker för Path_setExpiry åtgärd.
FileSetExpiryOptions

Alternativgränssnitt för åtgärden <xref:DataLakeFileClient.setExpiry> .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Innehåller svarsdata för åtgärden <xref:DataLakeFileSystemClient.createIfNotExists> .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Innehåller svarsdata för åtgärden <xref:DataLakeFileSystemClient.deleteIfExists> .
FileSystemDeleteOptions
FileSystemExistsOptions

Alternativgränssnittet för Data Lake-filsystemet finns åtgärder Se:

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

Alternativ för att konfigurera <xref:DataLakeFileSystemClient.generateSasUrl> åtgärden.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Definierar rubriker för FileSystem_listBlobHierarchySegment åtgärd.
FileSystemListPathsHeaders

Definierar rubriker för FileSystem_listPaths åtgärd.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse

En uppräkning av blobar
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Definierar rubriker för Path_appendData åtgärd.
PathChangeAccessControlRecursiveOptions

Alternativtyp för setAccessControlRecursive, updateAccessControlRecursive och removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Svarstyp för setAccessControlRecursive, updateAccessControlRecursive och removeAccessControlRecursive.
PathCreateHeaders

Definierar rubriker för Path_create åtgärd.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions
PathCreateIfNotExistsResponse

Innehåller svarsdata för åtgärden <xref:DataLakePathClient.createIfNotExists> .
PathCreateOptions
PathDeleteHeaders

Definierar rubriker för Path_delete åtgärd.
PathDeleteIfExistsResponse

Innehåller svarsdata för åtgärden <xref:DataLakePathClient.deleteIfExists> .
PathDeleteOptions
PathExistsOptions

Alternativgränssnittet för data lake-katalog-/fil finns-åtgärder Se:

  • <xref:DataLakePathClient.exists>
PathFlushDataHeaders

Definierar rubriker för Path_flushData åtgärd.
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Definierar rubriker för Path_getProperties åtgärd.
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Definierar rubriker för Path_setAccessControl åtgärd.
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders

Definierar rubriker för Path_undelete åtgärd.
PathUpdateHeaders

Definierar rubriker för Path_update åtgärd.
PipelineOptions

Alternativgränssnitt för pipelinekonstruktor.
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions

Alternativ för att konstruera <xref:SASQueryParameters>.
SasIPRange

Tillåtet IP-intervall för en SAS.
ServiceGenerateAccountSasUrlOptions

Alternativ för att konfigurera <xref:DataLakeServiceClient.generateAccountSasUrl> åtgärden.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Alternativ för att konfigurera <xref:DataLakeServiceClient.undeleteFileSystem>.
SignedIdentifier
StorageClientOptionalParams

Valfria parametrar.
StoragePipelineOptions

Alternativgränssnitt för <xref:newPipeline> funktionen.
StorageRetryOptions

Gränssnitt för alternativ för återförsök i Storage Blob.
UserDelegationKey

Typalias

AccessControlType
CopyStatusType
CredentialPolicyCreator

En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy.
FileAppendResponse

Innehåller svarsdata för åtgärden appendData.
FileExpiryMode

Definierar värden för PathExpiryOptions.
FileQueryArrowConfiguration

Alternativ för att fråga fil med Apache Arrow-format. Endast giltigt för <xref:FileQueryOptions.outputTextConfiguration>.
FileReadResponse
FileSetExpiryResponse

Innehåller svarsdata för setExpiry-åtgärden.
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Innehåller svarsdata för åtgärden <xref:DataLakeServiceClient.renameFileSystem> .
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Innehåller svarsdata för åtgärden <xref:DataLakeServiceClient.undeleteFileSystem> .
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

Innehåller svarsdata för åtgärden listPaths.
ModifiedAccessConditions
PathCreateResponse

Innehåller svarsdata för skapandeåtgärden.
PathDeleteResponse

Innehåller svarsdata för borttagningsåtgärden.
PathFlushDataResponse

Innehåller svarsdata för åtgärden flushData.
PathGetAccessControlResponse
PathGetPropertiesActionModel

Definierar värden för PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definierar värden för PathRenameMode.
PathResourceTypeModel

Definierar värden för PathResourceType.
PathSetAccessControlResponse

Innehåller svarsdata för setAccessControl-åtgärden.
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Alternativ för att konfigurera <xref:DataLakeServiceClient.renameFileSystem>.

Uppräkningar

PathGetPropertiesAction

Definierar värden för PathGetPropertiesAction. Möjliga värden är: "getAccessControl", "getStatus"
PathRenameMode

Definierar värden för PathRenameMode. Möjliga värden är: "legacy", "posix"
PathResourceType

Definierar värden för PathResourceType. Möjliga värden är: "directory", "file"
SASProtocol

Protokoll för genererad SAS.
StorageRetryPolicyType

RetryPolicy-typer.

Funktioner

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters.

Accepterar endast de inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare.

VARNING! När identifieraren inte anges krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.

Fyll i nödvändig information innan du kör följande kodfragment.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. VARNING! Identifieraren ignoreras när sas för användardelegering genereras, behörigheter och expiresOn krävs.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

Funktionsinformation

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametrar

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returer

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters.

Accepterar endast de inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare.

VARNING! När identifieraren inte anges krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.

Fyll i nödvändig information innan du kör följande kodfragment.

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametrar

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returer

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. VARNING! Identifieraren ignoreras när sas för användardelegering genereras, behörigheter och expiresOn krävs.

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

Parametrar

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Returvärde för blobServiceClient.getUserDelegationKey()

accountName

string

Returer

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

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

Parametrar

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett -objekt som implementerar TokenCredential-gränssnittet. Om inget anges används AnonymousCredential.

pipelineOptions
StoragePipelineOptions

Valfritt. Alternativ.

Returer

Pipeline

Ett nytt Pipeline-objekt.