@azure/storage-file-datalake package

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á účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u objektu <xref:AccountSASSignatureValues>. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.
AccountSASResourceTypes	K DISPOZICI POUZE V NODE.JS RUNTIME. Jedná se o pomocnou třídu pro vytvoření řetězce představujícího prostředky přístupné účtem AccountSAS. Nastavení hodnoty na hodnotu true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k danému typu prostředku. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole prostředků v objektu <xref:AccountSASSignatureValues>. Řetězec prostředků je možné sestavit bez této třídy, ale pořadí prostředků je specifické 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í služby přístupné účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k této službě. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole služeb v objektu <xref:AccountSASSignatureValues>. Řetězec služeb je možné sestavit bez této třídy, ale pořadí služeb je specifické a tato třída zaručuje správnost.
AnonymousCredential	AnonymousCredential poskytuje člen credentialPolicyCreator sloužící k vytvoření AnonymousCredentialPolicy objekty. AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).
Credential	Přihlašovací údaje jsou abstraktní třídou 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 podepsání požadavků HTTP(S) před odesláním Toto je abstraktní třída.
DataLakeAclChangeFailedError	Při přerušení operace došlo k chybě a může 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á službou ServiceSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u <xref:DataLakeSASSignatureValues> objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické 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 true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u <xref:DataLakeSASSignatureValues> objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické 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 true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění u <xref:DataLakeSASSignatureValues> objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.
Pipeline	Třída kanálu 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 konstruktorem kanálu. Před implementací přizpůsobeného kanálu si projděte <xref:newPipeline> 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 typy <xref:AccountSASSignatureValues> a <xref:BlobSASSignatureValues>. Po vygenerování je možné ho zakódovat do <xref:String> a připojit se přímo k adrese URL (v případě, že existují existující parametry dotazu, které by mohly ovlivnit vhodné prostředky 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ě: Prohlížeče ukládají požadavky GET/HEAD do mezipaměti přidáním podmíněných hlaviček, jako je například IF_MODIFIED_SINCE. StorageBrowserPolicy je zásada použitá k přidání dotazu časového razítka na adresu URL požadavku GET/HEAD, čímž se vyhnete mezipaměti prohlížeče. Odebrání hlavičky cookie pro zabezpečení Odebrání záhlaví 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 adresu URL třídy pro <xref:BlobServiceClient>, <xref:ContainerClient> atd.
StorageClientContext
StorageRetryPolicy	Zásady opakování s exponenciálními opakováními a implementovanými lineárními opakováními
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 použitá k podepsání požadavku HTTP pomocí sdíleného klíče.

Rozhraní

AccessControlChangeCounters	AccessControlChangeCounters obsahuje počty operací, které mění seznamy řízení přístupu rekurzivně.
AccessControlChangeError	Představuje položku, která se nepodařilo aktualizovat seznam řízení přístupu během setAccessControlRecursive, updateAccessControlRecursive a removeAccessControlRecursive.
AccessControlChanges	AccessControlChanges obsahuje dávkové a kumulativní počty operací, které rekurzivně mění seznamy řízení přístupu. Kromě toho zveřejňuje položky cesty, které se během těchto operací nepodařilo aktualizovat.
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 zde uvedené hodnoty správně nastavené, zavolejte <xref:generateAccountSASQueryParameters> získat reprezentaci SAS, která se dá skutečně 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á třída je neměnná a používá se k vygenerová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ží ke generová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 operace <xref:DataLakeDirectoryClient.generateSasUrl>
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions	Možnosti konfigurace operace <xref:DataLakeFileClient.generateSasUrl>
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 dotazování souboru ve formátu CSV
FileQueryError	Typ chyby dotazu na soubor.
FileQueryJsonTextConfiguration	Možnosti dotazování na soubor ve formátu JSON
FileQueryOptions	Rozhraní možností pro soubor Data Lake – operace dotazu Viz: <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration	Možnosti dotazování na soubor 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 operaci Path_setExpiry.
FileSetExpiryOptions	Rozhraní možností pro operaci <xref:DataLakeFileClient.setExpiry>.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse	Obsahuje data odpovědí pro operaci <xref:DataLakeFileSystemClient.createIfNotExists>.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse	Obsahuje data odpovědí pro operaci <xref:DataLakeFileSystemClient.deleteIfExists>.
FileSystemDeleteOptions
FileSystemExistsOptions	Rozhraní možností pro systém souborů Data Lake existuje operace Viz: <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions	Možnosti konfigurace operace <xref:DataLakeFileSystemClient.generateSasUrl>
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ědí pro operaci <xref:DataLakePathClient.createIfNotExists>.
PathCreateOptions
PathDeleteHeaders	Definuje hlavičky pro operaci Path_delete.
PathDeleteIfExistsResponse	Obsahuje data odpovědí pro operaci <xref:DataLakePathClient.deleteIfExists>.
PathDeleteOptions
PathExistsOptions	Rozhraní možností pro operace adresáře a souboru Data Lake existuje: <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í option 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 operace <xref:DataLakeServiceClient.generateAccountSasUrl>
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions	Možnosti konfigurace <xref:DataLakeServiceClient.undeleteFileSystem>.
SignedIdentifier
StorageClientOptionalParams	Volitelné parametry.
StoragePipelineOptions	Rozhraní Options pro funkci <xref:newPipeline>
StorageRetryOptions	Rozhraní možností opakování objektu blob úložiště
UserDelegationKey

Aliasy typu

AccessControlType
CopyStatusType
CredentialPolicyCreator	Funkce továrny, která vytvoří novou credentialPolicy, která používá zadanou zásadu nextPolicy.
FileAppendResponse	Obsahuje data odpovědi pro operaci appendData.
FileExpiryMode	Definuje hodnoty pro PathExpiryOptions.
FileQueryArrowConfiguration	Možnosti 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ědí pro operaci <xref:DataLakeServiceClient.renameFileSystem>.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse	Obsahuje data odpovědí pro operaci <xref:DataLakeServiceClient.undeleteFileSystem>.
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse	Obsahuje data odpovědi pro operaci listPaths.
ModifiedAccessConditions
PathCreateResponse	Obsahuje data odpovědí pro operaci vytvoření.
PathDeleteResponse	Obsahuje data odpovědí pro operaci odstranění.
PathFlushDataResponse	Obsahuje data odpovědí 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 objekt <xref:SASQueryParameters>, který obsahuje všechny parametry dotazu SAS potřebné k provedení 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í sdíleného přístupového podpisu. Pro volitelná 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. Pokud tento konstruktor inicializace inicializace pomocí tohoto konstruktoru inicialy, musíte k identifikátoru přiřadit hodnotu nebo platnost vyprší & oprávnění ručně. 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, oprávnění a vypršení platnostiOn jsou vyžadovány.
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 objekt <xref:SASQueryParameters>, který obsahuje všechny parametry dotazu SAS potřebné k provedení 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í sdíleného přístupového podpisu. Pro volitelná 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. Pokud tento konstruktor inicializace inicializace pomocí tohoto konstruktoru inicialy, musíte k identifikátoru přiřadit hodnotu nebo platnost vyprší & oprávnění ručně.

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, oprávnění a vypršení platnostiOn jsou vyžadovány.

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

Parametry

dataLakeSASSignatureValues

DataLakeSASSignatureValues

userDelegationKey

UserDelegationKey

Návratová 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 balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

pipelineOptions

StoragePipelineOptions

Volitelný. Volby.

Návraty

Pipeline

Nový objekt kanálu.