Sdílet prostřednictvím


@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ěl by být serializován s toString a nastaven jako pole oprávnění v AccountSASSignatureValues 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.

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ěl by být serializován s toString a nastaven jako pole zdroje v AccountSASSignatureValues objektu. Ř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 AccountSASSignatureValues objektu. Ř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).

BaseRequestPolicy

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

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ěl by být serializován s toString a nastaven jako pole oprávnění na 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ěl by být serializován s toString a nastaven jako pole oprávnění na 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ěl by být serializován s toString a nastaven jako pole oprávnění na 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 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 přečtěte 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; generuje se pouze typy AccountSASSignatureValues a <xref:BlobSASSignatureValues>. Po vygenerování je možné ho zakódovat do toString() 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ě:

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

  2. Odebrání hlavičky cookie pro zabezpečení

  3. 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.

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 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ě nastaveny, zavolejte generateAccountSASQueryParameters získat reprezentaci SAS, která se může skutečně 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á třída je neměnná a používá se k vygenerování skutečných požadavků REST.

Další koncepční informace o SAS najdete v https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1, kde najdete 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 slouží ke generování tokenů SAS služby Blob a DataLake pro kontejnery, objekty blob, systém souborů, adresáře a soubory.

DataLakeServiceProperties

Vlastnosti služby úložiště.

DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

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

DirectoryCreateIfNotExistsResponse

Obsahuje data odpovědí pro operaci createIfNotExists.

DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Možnosti konfigurace vygenerování operace SasUrl

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ědí 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 vygenerování operace SasUrl

FileParallelUploadOptions

Rozhraní možností pro soubor Data Lake – Operace nahrávání

Vidět:

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 dotazů

Vidět:

FileQueryParquetConfiguration

Možnosti dotazování na soubor ve formátu Parquet

FileReadHeaders
FileReadOptions
FileReadToBufferOptions

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

Vidět:

FileSetExpiryHeaders

Definuje hlavičky pro operaci Path_setExpiry.

FileSetExpiryOptions

Rozhraní možností pro operaci setExpiry.

FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Obsahuje data odpovědí pro operaci createIfNotExists.

FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Obsahuje data odpovědí pro operaci deleteIfExists.

FileSystemDeleteOptions

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

FileSystemEncryptionScope

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

FileSystemExistsOptions

Rozhraní možností pro systém souborů Data Lake existuje operace

Vidět:

FileSystemGenerateSasUrlOptions

Možnosti konfigurace vygenerování operace SasUrl

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 jádrem-v1 (core-http).

IHttpClient

Kompatibilní rozhraní pro zásady požadavků core-http

Lease

Podrobnosti o určitém zapůjčení.

LeaseAccessConditions

Skupina parametrů

LeaseOperationOptions

Konfiguruje 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 operaci Path_create.

PathCreateHttpHeaders
PathCreateIfNotExistsOptions

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

PathCreateIfNotExistsResponse

Obsahuje data odpovědí pro operaci createIfNotExists.

PathCreateOptions

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

PathDeleteHeaders

Definuje hlavičky pro operaci Path_delete.

PathDeleteIfExistsResponse

Obsahuje data odpovědí pro operaci deleteIfExists.

PathDeleteOptions

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

PathExistsOptions

Rozhraní možností pro operace adresáře a souboru Data Lake existuje

Vidět:

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 operaci Path_getProperties.

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 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 konstruktorem kanálu.

Před implementací přizpůsobeného kanálu si přečtěte newPipeline a poskytnuté zásady.

PipelineOptions

Rozhraní option 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 @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Možnosti konfigurace generateAccountSasUrl operace

ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

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

ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Možnosti konfigurace undeleteFileSystem.

SignedIdentifier
StoragePipelineOptions

Rozhraní Options pro funkci newPipeline

StorageRetryOptions

Rozhraní možností opakování objektu blob úložiště

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ědí 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 dotazování souboru ve formátu Apache Arrow Platí pouze pro outputTextConfiguration.

FileReadResponse
FileSetExpiryResponse
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 undeleteFileSystem.

FileUploadResponse
HttpRequestBody

Typy subjektů podporovaných na žádosti. NodeJS.ReadableStream a () => NodeJS.ReadableStream je pouze Uzel. Objekty blob, ReadableStream a () => ReadableStream jsou pouze prohlížečem.

LeaseDurationType
LeaseOperationResponse

Obsahuje data odpovědí pro operace, které vytvářejí, upravují nebo odstraňou zapůjčení.

Viz <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é cílové skupiny cloudu pro službu Storage.

StorageRetryPolicyType

Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vygeneruje SASQueryParameters objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření 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í 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.

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

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á rutina, 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 SASQueryParameters objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření 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

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.

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

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.

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

Návratová hodnota blobServiceClient.getUserDelegationKey()

accountName

string

Návraty

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á rutina, která rozhodne, jestli daný argument splňuje kontrakt kanálu

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline

unknown

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

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

Nový objekt kanálu.