Sdílet prostřednictvím

@azure/storage-file-datalake package

  • Reference

Třídy

AccountSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená AccountSAS. Nastavení hodnoty na true znamená, že každý SDÍLENÝ přístupový podpis, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován pomocí toString a nastaven jako pole oprávnění u objektu <xref:AccountSASSignatureValues> . Je možné vytvořit řetězec oprávnění bez této třídy, ale pořadí oprávnění je zvláštní a tato třída zaručuje správnost.
AccountSASResourceTypes

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představujícího prostředky přístupné přes AccountSAS. Nastavení hodnoty na true znamená, že každý sdílený přístupový podpis, který tato oprávnění používá, udělí přístup k danému typu prostředku. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole prostředků v objektu <xref:AccountSASSignatureValues> . Je možné vytvořit řetězec prostředků bez této třídy, ale pořadí prostředků je zvláštní a tato třída zaručuje správnost.
AccountSASServices

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představujícího služby přístupné z AccountSAS. Nastavení hodnoty na true znamená, že každý sdílený přístupový podpis, který tato oprávnění používá, udělí přístup k této službě. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován pomocí toString a nastaven jako services pole objektu <xref:AccountSASSignatureValues> . Je možné vytvořit řetězec služeb bez této třídy, ale pořadí služeb je zvláštní a tato třída zaručuje správnost.
AnonymousCredential

AnonymousCredential poskytuje člen credentialPolicyCreator sloužící k vytvoření objektů AnonymousCredentialPolicy. AnonymousCredentialPolicy se používá u požadavků HTTP(S), které čtou veřejné prostředky, nebo pro použití se sdílenými přístupovými podpisy (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy se používá u požadavků HTTP(S), které čtou veřejné prostředky, nebo pro použití se sdílenými přístupovými podpisy (SAS).
Credential

Credential je abstraktní třída pro podepisování požadavků HTTP služby Azure Storage. Tato třída bude hostitelem objektu pro vytváření přihlašovacích údajůPolicyCreator, který generuje CredentialPolicy.
CredentialPolicy

Zásady přihlašovacích údajů používané k podepisování požadavků HTTP(S) před odesláním. Toto je abstraktní třída.
DataLakeAclChangeFailedError

Při přerušení operace dojde k chybě, ve které můžete pokračovat později.
DataLakeDirectoryClient

DataLakeDirectoryClient představuje adresu URL adresáře služby Azure Storage.
DataLakeFileClient

DataLakeFileClient představuje adresu URL souboru Azure Storage.
DataLakeFileSystemClient

DataLakeFileSystemClient představuje adresu URL systému souborů Azure Storage, která umožňuje manipulovat s jeho adresáři a soubory.
DataLakeLeaseClient
DataLakePathClient

DataLakePathClient představuje adresu URL cesty ke službě Azure Storage (adresář nebo soubor).
DataLakeSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME. Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená ServiceSAS. Nastavení hodnoty na true znamená, že každý SDÍLENÝ přístupový podpis, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován pomocí toString a nastaven jako pole oprávnění u objektu <xref:DataLakeSASSignatureValues> . Je možné vytvořit řetězec oprávnění bez této třídy, ale pořadí oprávnění je zvláštní a tato třída zaručuje správnost.
DataLakeServiceClient

DataLakeServiceClient umožňuje manipulovat s prostředky a systémy souborů služby Azure Data Lake. Účet úložiště poskytuje obor názvů nejvyšší úrovně pro službu Data Lake.
DirectorySASPermissions

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS k adresáři. Nastavení hodnoty na true znamená, že každý SDÍLENÝ přístupový podpis, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován pomocí toString a nastaven jako pole oprávnění u objektu <xref:DataLakeSASSignatureValues> . Je možné vytvořit řetězec oprávnění bez této třídy, ale pořadí oprávnění je zvláštní a tato třída zaručuje správnost.
FileSystemSASPermissions

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS kontejneru. Nastavení hodnoty na true znamená, že každý SDÍLENÝ přístupový podpis, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován pomocí toString a nastaven jako pole oprávnění u objektu <xref:DataLakeSASSignatureValues> . Je možné vytvořit řetězec oprávnění bez této třídy, ale pořadí oprávnění je zvláštní a tato třída zaručuje správnost.
Pipeline

Třída pipeline obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním <xref:newPipeline>. Nebo můžete vytvořit kanál s vlastními zásadami pomocí konstruktoru kanálu. Před implementací přizpůsobeného kanálu si projděte <xref:newPipeline> zásady a poskytnuté zásady.
SASQueryParameters

Představuje komponenty, které tvoří parametry dotazu SAS služby Azure Storage. Tento typ není vytvořen přímo uživatelem; generuje se pouze pomocí <xref:AccountSASSignatureValues> typů a <xref:BlobSASSignatureValues> . Po vygenerování může být kód zakódován do <xref:String> a připojen přímo k adrese URL (i když byste měli být opatrní, pokud existují parametry dotazu, které by mohly ovlivnit vhodné způsoby připojení těchto parametrů dotazu). POZNÁMKA: Instance této třídy jsou neměnné.
StorageBrowserPolicy

StorageBrowserPolicy bude zpracovávat rozdíly mezi Node.js a modulem runtime prohlížeče, včetně následujících:

  1. Prohlížeče ukládají požadavky GET/HEAD do mezipaměti přidáním podmíněných hlaviček, jako je "IF_MODIFIED_SINCE". StorageBrowserPolicy je zásada, která slouží k přidání dotazu časového razítka do adresy URL požadavku GET/HEAD, čímž se vyhnete mezipaměti prohlížeče.

  2. Odebrání hlavičky souboru cookie z důvodu zabezpečení

  3. Odebrání hlavičky délky obsahu, aby se zabránilo upozornění prohlížečů
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory je třída továrny, která pomáhá generovat objekty StorageBrowserPolicy.
StorageClient

StorageClient představuje založenou třídu url pro <xref:BlobServiceClient>, <xref:ContainerClient> a atd.
StorageClientContext
StorageRetryPolicy

Zásady opakování s implementovaným exponenciálním opakováním a lineárním opakováním.
StorageRetryPolicyFactory

StorageRetryPolicyFactory je třída továrny, která pomáhá generovat <xref:StorageRetryPolicy> objekty.
StorageSharedKeyCredential

K DISPOZICI POUZE V NODE.JS RUNTIME. StorageSharedKeyCredential pro autorizaci klíče účtu služby Azure Storage.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy je zásada, která se používá k podepsání požadavku HTTP pomocí sdíleného klíče.

Rozhraní

AccessControlChangeCounters

AccessControlChangeCounters obsahuje počty operací, které se rekurzivně mění Access Control Seznamy.
AccessControlChangeError

Představuje položku, u které se nepodařilo aktualizovat seznam Access Control během setAccessControlRecursivea updateAccessControlRecursiveremoveAccessControlRecursive.
AccessControlChanges

AccessControlChanges obsahuje dávkové a kumulativní počty operací, které se rekurzivně mění Access Control Seznamy. Kromě toho zveřejňuje položky cesty, které se nepodařilo aktualizovat v průběhu těchto operací.
AccessPolicy
AccountSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME. AccountSASSignatureValues slouží k vygenerování sdíleného přístupového podpisu (SAS) pro účet služby Azure Storage. Jakmile jsou všechny hodnoty správně nastavené, zavolejte <xref:generateAccountSASQueryParameters> metodu a získejte reprezentaci SAS, která se dá ve skutečnosti použít na adresy URL data lake. Poznámka: Tato třída i <xref:SASQueryParameters> existují, protože první třída je proměnlivá a logická reprezentace, zatímco druhá je neměnná a používá se ke generování skutečných požadavků REST.
BlobHierarchyListSegment
BlobItemModel

Objekt blob služby Azure Storage
BlobPrefix
BlobPropertiesModel

Vlastnosti objektu blob
CommonGenerateSasUrlOptions

Běžné možnosti , <xref:FileSystemGenerateSasUrlOptions><xref:DirectoryGenerateSasUrlOptions> a <xref:FileGenerateSasUrlOptions>.
CommonOptions

Rozhraní pro možnosti společné pro každou vzdálenou operaci.
DataLakeRequestConditions
DataLakeSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME. DataLakeSASSignatureValues slouží k vygenerování tokenů SAS služby Blob a DataLake pro kontejnery, objekty blob, systém souborů, adresáře a soubory.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Možnosti konfigurace <xref:DataLakeDirectoryClient.generateSasUrl> operace
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

Možnosti konfigurace <xref:DataLakeFileClient.generateSasUrl> operace
FileParallelUploadOptions

Rozhraní možností pro soubor Data Lake – operace nahrávání Viz:

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

Možnosti pro dotazování na soubor ve formátu CSV
FileQueryError

Typ chyby dotazu na soubor
FileQueryJsonTextConfiguration

Možnosti pro dotazování souboru ve formátu JSON
FileQueryOptions

Rozhraní možností pro soubor Data Lake – operace dotazů Viz:

  • <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration

Možnosti pro dotazování souboru ve formátu Parquet
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Rozhraní možností pro soubor Data Lake – operace readToBuffer Viz:

  • <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders

Definuje hlavičky pro Path_setExpiry operaci.
FileSetExpiryOptions

Option interface pro <xref:DataLakeFileClient.setExpiry> operaci.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Obsahuje data odpovědi pro <xref:DataLakeFileSystemClient.createIfNotExists> operaci.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Obsahuje data odpovědi pro <xref:DataLakeFileSystemClient.deleteIfExists> operaci.
FileSystemDeleteOptions
FileSystemExistsOptions

Existuje rozhraní možností pro operace systému souborů Data Lake. Viz:

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

Možnosti konfigurace <xref:DataLakeFileSystemClient.generateSasUrl> operace
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Definuje hlavičky pro operaci FileSystem_listBlobHierarchySegment.
FileSystemListPathsHeaders

Definuje hlavičky pro operaci FileSystem_listPaths.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse

Výčet objektů blob
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Definuje hlavičky pro operaci Path_appendData.
PathChangeAccessControlRecursiveOptions

Typ možností pro setAccessControlRecursive, updateAccessControlRecursive a removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Typ odpovědi pro setAccessControlRecursive, updateAccessControlRecursive a removeAccessControlRecursive.
PathCreateHeaders

Definuje hlavičky pro operaci Path_create.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions
PathCreateIfNotExistsResponse

Obsahuje data odpovědi pro <xref:DataLakePathClient.createIfNotExists> operaci.
PathCreateOptions
PathDeleteHeaders

Definuje hlavičky pro operaci Path_delete.
PathDeleteIfExistsResponse

Obsahuje data odpovědi pro <xref:DataLakePathClient.deleteIfExists> operaci.
PathDeleteOptions
PathExistsOptions

Rozhraní možností pro operace s adresářem nebo souborem Data Lake viz:

  • <xref:DataLakePathClient.exists>
PathFlushDataHeaders

Definuje hlavičky pro operaci Path_flushData.
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Definuje hlavičky pro operaci Path_getProperties.
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Definuje hlavičky pro operaci Path_setAccessControl.
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders

Definuje hlavičky pro operaci Path_undelete.
PathUpdateHeaders

Definuje hlavičky pro operaci Path_update.
PipelineOptions

Rozhraní možností pro konstruktor kanálu.
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions

Možnosti pro vytvoření <xref:SASQueryParameters>.
SasIPRange

Povolený rozsah IP adres pro SAS
ServiceGenerateAccountSasUrlOptions

Možnosti konfigurace <xref:DataLakeServiceClient.generateAccountSasUrl> operace
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Možnosti konfigurace <xref:DataLakeServiceClient.undeleteFileSystem>.
SignedIdentifier
StorageClientOptionalParams

Volitelné parametry.
StoragePipelineOptions

Možnosti rozhraní pro <xref:newPipeline> funkci.
StorageRetryOptions

Rozhraní možností opakování objektů blob služby Storage
UserDelegationKey

Aliasy typu

AccessControlType
CopyStatusType
CredentialPolicyCreator

Funkce továrny, která vytvoří novou zásadu CredentialPolicy, která používá zadanou zásadu nextPolicy.
FileAppendResponse

Obsahuje data odpovědi pro operaci appendData.
FileExpiryMode

Definuje hodnoty pro PathExpiryOptions.
FileQueryArrowConfiguration

Možnosti pro dotazování souboru ve formátu Apache Arrow Platí pouze pro <xref:FileQueryOptions.outputTextConfiguration>.
FileReadResponse
FileSetExpiryResponse

Obsahuje data odpovědi pro operaci setExpiry.
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Obsahuje data odpovědi pro <xref:DataLakeServiceClient.renameFileSystem> operaci.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Obsahuje data odpovědi pro <xref:DataLakeServiceClient.undeleteFileSystem> operaci.
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

Obsahuje data odpovědi pro operaci listPaths.
ModifiedAccessConditions
PathCreateResponse

Obsahuje data odpovědi pro operaci vytvoření.
PathDeleteResponse

Obsahuje data odpovědi pro operaci odstranění.
PathFlushDataResponse

Obsahuje data odpovědi pro operaci flushData.
PathGetAccessControlResponse
PathGetPropertiesActionModel

Definuje hodnoty pro PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definuje hodnoty pro PathRenameMode.
PathResourceTypeModel

Definuje hodnoty pro PathResourceType.
PathSetAccessControlResponse

Obsahuje data odpovědi pro operaci setAccessControl.
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Možnosti konfigurace <xref:DataLakeServiceClient.renameFileSystem>.

Výčty

PathGetPropertiesAction

Definuje hodnoty pro PathGetPropertiesAction. Mezi možné hodnoty patří: getAccessControl, getStatus.
PathRenameMode

Definuje hodnoty pro PathRenameMode. Mezi možné hodnoty patří: 'legacy', 'posix'
PathResourceType

Definuje hodnoty pro PathResourceType. Mezi možné hodnoty patří: 'directory', 'file'
SASProtocol

Protokoly pro vygenerované SAS.
StorageRetryPolicyType

Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje <xref:SASQueryParameters> objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření skutečného požadavku REST.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření SAS. V případě volitelných nastavení nastavte odpovídající vlastnosti přímo, například oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, jsou vyžadována oprávnění a vypršení platnosti. Musíte přiřadit hodnotu identifikátoru nebo vypršíNa & oprávnění ručně, pokud jste inicialy pomocí tohoto konstruktoru.

Před spuštěním následujících fragmentů kódu vyplňte požadované podrobnosti.
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters. UPOZORNĚNÍ: Identifikátor bude ignorován při generování SAS delegování uživatele, jsou vyžadována oprávnění a vypršení platnosti.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří nový objekt kanálu se zadanými přihlašovacími údaji.

Podrobnosti funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vygeneruje <xref:SASQueryParameters> objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření skutečného požadavku REST.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametry

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Návraty

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření SAS. V případě volitelných nastavení nastavte odpovídající vlastnosti přímo, například oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, jsou vyžadována oprávnění a vypršení platnosti. Musíte přiřadit hodnotu identifikátoru nebo vypršíNa & oprávnění ručně, pokud jste inicialy pomocí tohoto konstruktoru.

Před spuštěním následujících fragmentů kódu vyplňte požadované podrobnosti.

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametry

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Návraty

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří instanci SASQueryParameters. UPOZORNĚNÍ: Identifikátor bude ignorován při generování SAS delegování uživatele, jsou vyžadována oprávnění a vypršení platnosti.

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

Parametry

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Vrácená hodnota blobServiceClient.getUserDelegationKey()

accountName

string

Návraty

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří nový objekt kanálu se zadanými přihlašovacími údaji.

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

Parametry

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

pipelineOptions
StoragePipelineOptions

Nepovinný parametr. Možnosti.

Návraty

Pipeline

Nový objekt kanálu.