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 k vytvoření řetězce představujícího oprávnění udělená AccountSAS. Nastavení hodnoty na true znamená, že každý SAS, který používá tato oprávnění, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole oprávnění v AccountSASSignatureValues objektu. 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é pomocí AccountSAS. Nastavení hodnoty na true znamená, že každý sas, který používá tato oprávnění, 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 AccountSASSignatureValues objektu. 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é pomocí AccountSAS. Nastavení hodnoty na true znamená, že každý SAS, který tato oprávnění používá, udělí přístup k dané službě. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole služeb v AccountSASSignatureValues objektu. 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 credentialPolicyCreator člen slouží k vytvoření AnonymousCredentialPolicy objekty. AnonymousCredentialPolicy se používá s požadavky 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á s požadavky HTTP(S), které čtou veřejné prostředky, nebo pro použití se sdílenými přístupovými podpisy (SAS).
BaseRequestPolicy

Základní třída, ze které se odvozují všechny zásady požadavků.
Credential

Credential je abstraktní třída pro podepisování požadavků HTTP služby Azure Storage. Tato třída bude hostitelem credentialPolicyCreator factory, 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ě, která může později pokračovat.
DataLakeDirectoryClient

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

DataLakeFileClient představuje adresu URL souboru služby 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ý SAS, který používá tato oprávnění, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole oprávnění dataLakeSASSignatureValues objektu. 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ý SAS, který používá tato oprávnění, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole oprávnění dataLakeSASSignatureValues objektu. 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 s toString a nastavit jako pole oprávnění DataLakeSASSignatureValues objektu. 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 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 téma newPipeline a poskytnuté zásady.
RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.
SASQueryParameters

Představuje komponenty, které tvoří parametry dotazu SAS služby Azure Storage. Tento typ není vytvořen přímo uživatelem; je generován pouze AccountSASSignatureValues a <xref:BlobSASSignatureValues> typy. Po vygenerování může být kód zakódován do toString() 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.
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 objekty StorageRetryPolicy .
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é rekurzivně mění seznamy řízení přístupu.
AccessControlChangeError

Představuje položku, u které se nepodařilo aktualizovat seznam řízení přístupu během setAccessControlRecursivea removeAccessControlRecursiveupdateAccessControlRecursive .
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 nepodařilo aktualizovat, zatímco tyto operace probíhají.
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 generateAccountSASQueryParameters , abyste získali reprezentaci SAS, která se ve skutečnosti dá použít na adresy URL data lake. Poznámka: Tato třída i 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.

Viz https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 další koncepční informace o SAS Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas popisy parametrů, včetně požadovaných parametrů.
BlobHierarchyListSegment
BlobItemModel

Objekt blob služby Azure Storage
BlobPrefix
BlobPropertiesModel

Vlastnosti objektu blob
CommonGenerateSasUrlOptions

Běžné možnosti FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions a FileGenerateSasUrlOptions.
CommonOptions

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

Skupina parametrů
DataLakeRequestConditions

Skupina parametrů
DataLakeSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME.

DataLakeSASSignatureValues pomáhá generovat tokeny SAS služby Blob a DataLake pro kontejnery, objekty blob, systém souborů, adresáře a soubory.
DataLakeServiceProperties

Vlastnosti služby Storage.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

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

Obsahuje data odpovědi pro operaci createIfNotExists .
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Možnosti konfigurace operace generateSasUrl
FileAppendOptions

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

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

Obsahuje data odpovědi pro operaci createIfNotExists .
FileCreateOptions

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

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

Možnosti konfigurace operace generateSasUrl
FileParallelUploadOptions

Rozhraní možností pro data lake file – operace nahrávání

Přečtěte si:
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í option pro soubor Data Lake – operace dotazů

Přečtěte si:
FileQueryParquetConfiguration

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

Rozhraní option pro soubor Data Lake – operace readToBuffer

Přečtěte si:
FileSetExpiryHeaders

Definuje hlavičky pro Path_setExpiry operaci.
FileSetExpiryOptions

Option rozhraní pro operaci setExpiry .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Obsahuje data odpovědi pro operaci createIfNotExists .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Obsahuje data odpovědi pro operaci deleteIfExists .
FileSystemDeleteOptions

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

Možnosti pro určení oboru šifrování v systému souborů
FileSystemExistsOptions

Existuje rozhraní option pro systém souborů Data Lake.

Přečtěte si:
FileSystemGenerateSasUrlOptions

Možnosti konfigurace operace generateSasUrl
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

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

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

Definuje hlavičky pro operaci FileSystem_listBlobHierarchySegment.
FileSystemListPathsHeaders

Definuje hlavičky pro operaci FileSystem_listPaths.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

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

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

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

Kolekce párů klíč/hodnota hlavičky HTTP.
HttpOperationResponse

Odpověď HTTP, která je kompatibilní s core-v1 (core-http).
IHttpClient

Kompatibilní rozhraní pro zásady požadavků HTTP jádra
Lease

Podrobnosti o konkrétním zapůjčení
LeaseAccessConditions

Skupina parametrů
LeaseOperationOptions

Nakonfiguruje operace zapůjčení.
ListBlobsHierarchySegmentResponse

Výčet objektů blob
ListDeletedPathsOptions

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

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

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

Rozhraní pro možnosti společné pro každou vzdálenou operaci.
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 Path_create operaci.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions

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

Obsahuje data odpovědi pro operaci createIfNotExists .
PathCreateOptions

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

Definuje hlavičky pro Path_delete operaci.
PathDeleteIfExistsResponse

Obsahuje data odpovědi pro operaci deleteIfExists .
PathDeleteOptions

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

Existuje rozhraní option pro operace s adresářem nebo souborem Data Lake

Přečtěte si:
PathFlushDataHeaders

Definuje hlavičky pro operaci Path_flushData.
PathGetAccessControlHeaders
PathGetAccessControlOptions

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

Definuje hlavičky pro Path_getProperties operaci.
PathGetPropertiesOptions

Rozhraní pro možnosti společné pro každou vzdálenou operaci.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Rozhraní pro možnosti společné pro každou vzdálenou operaci.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Definuje hlavičky pro operaci Path_setAccessControl.
PathSetAccessControlOptions

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

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

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

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

Definuje hlavičky pro operaci Path_undelete.
PathUpdateHeaders

Definuje hlavičky pro operaci Path_update.
PipelineLike

Rozhraní pro třídu pipeline obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním 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 téma newPipeline a poskytnuté zásady.
PipelineOptions

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

Rozhraní pro kompatibilitu s RequestPolicyFactory core-http
RequestPolicyOptions

Rozhraní pro kompatibilitu s RequestPolicy
RolePermissions
SASQueryParametersOptions

Možnosti pro vytvoření SASQueryParameters
SasIPRange

Povolený rozsah IP adres pro SAS
ServiceClientOptions

Podmnožina ServiceClientOptions @azure/core-http
ServiceGenerateAccountSasUrlOptions

Možnosti konfigurace operace generateAccountSasUrl
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

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

Možnosti konfigurace undeleteFileSystem
SignedIdentifier
StoragePipelineOptions

Rozhraní možnosti pro funkci newPipeline .
StorageRetryOptions

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

Klíč delegování uživatele
WebResource

Popis požadavku HTTP, který se má provést na vzdálený server.

Aliasy typu

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

Obsahuje data odpovědi pro operaci getProperties.
EncryptionAlgorithmType

Definuje hodnoty pro EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> Lze použít zaměnitelně s EncryptionAlgorithmType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Žádný
AES256
FileAppendResponse
FileExpiryMode

Definuje hodnoty pro PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Možnosti pro dotazování souboru ve formátu Apache Arrow Platí pouze pro outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

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

Obsahuje data odpovědi na operaci undeleteFileSystem .
FileUploadResponse
HttpRequestBody

Typy subjektů podporovaných v požadavku NodeJS.ReadableStream a () => NodeJS.ReadableStream je Pouze uzel. Objekty blob, ReadableStream a () => ReadableStream jsou jenom v prohlížeči.
LeaseDurationType
LeaseOperationResponse

Obsahuje data odpovědí pro operace, které vytvoří, upraví nebo odstraní zapůjčení.

Viz třída <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

Definuje hodnoty pro PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definuje hodnoty pro PathRenameMode.
PathResourceTypeModel

Definuje hodnoty pro PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Obsahuje data odpovědi pro operaci listContainersSegment.
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.
StorageDataLakeAudience

Definuje známé cloudové cílové skupiny pro službu Storage.
StorageRetryPolicyType

Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vygeneruje objekt SASQueryParameters , který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas.
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.

Příklad

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

Před spuštěním fragmentu kódu vyplňte požadované podrobnosti.

Příklad

// 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)

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.

Příklad

// 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)

Získání cílové skupiny OAuth pro účet úložiště pro službu Datalake
isPipelineLike(unknown)

Pomocník, který rozhodne, jestli daný argument splňuje kontrakt kanálu.
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 SASQueryParameters , který obsahuje všechny parametry dotazu SAS potřebné k provedení skutečného požadavku REST.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas.

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

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.

Příklad

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

Před spuštěním fragmentu kódu vyplňte požadované podrobnosti.

Příklad

// 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

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.

Příklad

// 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

Parametry

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Vrácená hodnota blobServiceClient.getUserDelegationKey()

accountName

string

Návraty

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Získání cílové skupiny OAuth pro účet úložiště pro službu Datalake

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName

string

Návraty

string

isPipelineLike(unknown)

Pomocník, který rozhodne, jestli daný argument splňuje kontrakt kanálu.

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline

unknown

Argument, kterým může být kanál

Návraty

pipeline

true, pokud argument splňuje kontrakt kanálu

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): Pipeline

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.