Läs på engelska

Dela via

@azure/storage-file-datalake package

  • Referens

Klasser

AccountSASPermissions

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett AccountSASSignatureValues-objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
AccountSASResourceTypes

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

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

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Det här är en hjälpklass för att konstruera en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfält på ett AccountSASSignatureValues-objekt. Det går att konstruera tjänstesträngen utan den här klassen, men ordningen på tjänsterna är speciell och den här klassen garanterar korrekthet.
AnonymousCredential

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

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

Basklassen som alla begärandeprinciper härleds från.
Credential

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

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

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

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

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

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

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

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

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

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

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

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

En Pipeline-klass som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa newPipeline. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline.

Läs nyaPipeline- och tillhandahållna principer innan du implementerar din anpassade pipeline.
RestError

En anpassad feltyp för misslyckade pipelinebegäranden.
SASQueryParameters

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

Obs! Instanser av den här klassen är oföränderliga.
StorageBrowserPolicy

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

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

  2. Ta bort cookierubrik för säkerhet

  3. Ta bort innehållslängdsrubrik för att undvika webbläsarvarningar
StorageBrowserPolicyFactory

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

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

StorageRetryPolicyFactory är en fabriksklass som hjälper till att generera StorageRetryPolicy objekt.
StorageSharedKeyCredential

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

StorageSharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten.
StorageSharedKeyCredentialPolicy

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

Gränssnitt

AccessControlChangeCounters

AccessControlChangeCounters innehåller antalet åtgärder som ändrar åtkomstkontrollistorna rekursivt.
AccessControlChangeError

Representerar en post som inte kunde uppdatera åtkomstkontrollistan under setAccessControlRecursive, updateAccessControlRecursive och removeAccessControlRecursive.
AccessControlChanges

AccessControlChanges innehåller batch- och kumulativa antal åtgärder som ändrar åtkomstkontrollistorna rekursivt. Dessutom exponeras sökvägsposter som inte kunde uppdateras medan åtgärderna förlopp.
AccessPolicy
AccountSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

AccountSASSignatureValues används för att generera en signatur för delad åtkomst (SAS) för ett Azure Storage-konto. När alla värden här har angetts korrekt anropar du genereraAccountSASQueryParameters för att få en representation av SAS som faktiskt kan tillämpas på datasjö-URL:er. Obs! Att både den här klassen och SASQueryParameters finns eftersom den förra är föränderlig och en logisk representation medan den senare är oföränderlig och används för att generera faktiska REST-begäranden.

Se https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 för mer konceptuell information om SAS Se https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas för beskrivningar av parametrarna, inklusive vilka som krävs
BlobHierarchyListSegment
BlobItemModel

En Azure Storage-blob
BlobPrefix
BlobPropertiesModel

Egenskaper för en blob
CommonGenerateSasUrlOptions

Vanliga alternativ för FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions och FileGenerateSasUrlOptions.
CommonOptions

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

Parametergrupp
DataLakeRequestConditions

Parametergrupp
DataLakeSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

DataLakeSASSignatureValues används för att generera SAS-token för Blob- och DataLake-tjänsten för containrar, blobar, filsystem, kataloger och filer.
DataLakeServiceProperties

Egenskaper för lagringstjänsten.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

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

Innehåller svarsdata för åtgärden createIfNotExists.
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Alternativ för att konfigurera genereraSasUrl- åtgärd.
FileAppendOptions

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

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

Innehåller svarsdata för åtgärden createIfNotExists.
FileCreateOptions

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

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

Alternativ för att konfigurera genereraSasUrl- åtgärd.
FileParallelUploadOptions

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

Se:
FileQueryCsvTextConfiguration

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

Feltyp för filfråga.
FileQueryJsonTextConfiguration

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

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

Se:
FileQueryParquetConfiguration

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

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

Se:
FileSetExpiryHeaders

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

Alternativgränssnitt för åtgärden setExpiry.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Innehåller svarsdata för åtgärden createIfNotExists.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Innehåller svarsdata för åtgärden deleteIfExists.
FileSystemDeleteOptions

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

Alternativ för att ange krypteringsomfång för ett filsystem.
FileSystemExistsOptions

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

Se:
FileSystemGenerateSasUrlOptions

Alternativ för att konfigurera genereraSasUrl- åtgärd.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

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

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

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

Definierar rubriker för FileSystem_listPaths åtgärd.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

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

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

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

En samling HTTP-huvudnyckel/värdepar.
HttpOperationResponse

Http-svar som är kompatibelt med core-v1(core-http).
IHttpClient

Ett kompatibelt gränssnitt för core-http-begärandeprinciper
Lease

Information om ett specifikt lån.
LeaseAccessConditions

Parametergrupp
LeaseOperationOptions

Konfigurerar låneåtgärder.
ListBlobsHierarchySegmentResponse

En uppräkning av blobar
ListDeletedPathsOptions

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

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

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

Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

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

Alternativtyp för setAccessControlRecursive, updateAccessControlRecursive och removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Svarstyp för setAccessControlRecursive, updateAccessControlRecursive och removeAccessControlRecursive.
PathCreateHeaders

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

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

Innehåller svarsdata för åtgärden createIfNotExists.
PathCreateOptions

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

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

Innehåller svarsdata för åtgärden deleteIfExists.
PathDeleteOptions

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

Alternativgränssnittet för Data Lake-katalog/fil finns åtgärder

Se:
PathFlushDataHeaders

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

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

Definierar rubriker för Path_getProperties åtgärd.
PathGetPropertiesOptions

Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Definierar rubriker för Path_setAccessControl åtgärd.
PathSetAccessControlOptions

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

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

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

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

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

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

Ett gränssnitt för klassen Pipeline som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa newPipeline. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline.

Läs nyaPipeline- och tillhandahållna principer innan du implementerar din anpassade pipeline.
PipelineOptions

Alternativgränssnitt för pipelinekonstruktor.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory

Ett gränssnitt för kompatibilitet med Core-HTTP:s RequestPolicyFactory
RequestPolicyOptions

Ett gränssnitt för kompatibilitet med RequestPolicy
RolePermissions
SASQueryParametersOptions

Alternativ för att konstruera SASQueryParameters.
SasIPRange

Tillåtna IP-intervall för en SAS.
ServiceClientOptions

En delmängd av @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions

Alternativ för att konfigurera genereraAccountSasUrl åtgärd.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

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

Alternativ för att konfigurera ta bortFileSystem.
SignedIdentifier
StoragePipelineOptions

Alternativgränssnittet för funktionen newPipeline.
StorageRetryOptions

Alternativ för återförsök av lagringsblob.
UserDelegationKey
UserDelegationKeyModel

En nyckel för användardelegering
WebResource

En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Typalias

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

Innehåller svarsdata för åtgärden getProperties.
EncryptionAlgorithmType

Definierar värden för EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> kan användas utbytbart med EncryptionAlgorithmType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Ingen
AES256
FileAppendResponse
FileExpiryMode

Definierar värden för PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Alternativ för att fråga fil med Apache Arrow-format. Gäller endast för outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

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

Innehåller svarsdata för åtgärden undeleteFileSystem.
FileUploadResponse
HttpRequestBody

Typer av organ som stöds i begäran. NodeJS.ReadableStream och () => NodeJS.ReadableStream är endast Node. Blob, ReadableStream och () => ReadableStream är endast webbläsare.
LeaseDurationType
LeaseOperationResponse

Innehåller svarsdata för åtgärder som skapar, ändrar eller tar bort ett lån.

Se <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

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

Definierar värden för PathRenameMode.
PathResourceTypeModel

Definierar värden för PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Innehåller svarsdata för åtgärden listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

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

Uppräkningar

PathGetPropertiesAction

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

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

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

Protokoll för genererad SAS.
StorageDataLakeAudience

Definierar kända molnmålgrupper för Lagring.
StorageRetryPolicyType

RetryPolicy-typer.

Funktioner

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Genererar en SASQueryParameters objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters.

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

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

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

Exempel

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

Fyll i nödvändig information innan du kör kodfragmentet.

Exempel

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

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters. VARNING! Identifieraren ignoreras när sas för användardelegering genereras, behörigheter och upphör att gällaPå krävs.

Exempel

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

Så här hämtar du OAuth-målgrupp för ett lagringskonto för datalake-tjänsten.
isPipelineLike(unknown)

En hjälp för att avgöra om ett visst argument uppfyller pipelinekontraktet
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter.

Funktionsinformation

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Genererar en SASQueryParameters objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.

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

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

Parametrar

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returer

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters.

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

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

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

Exempel

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

Fyll i nödvändig information innan du kör kodfragmentet.

Exempel

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

Parametrar

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returer

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters. VARNING! Identifieraren ignoreras när sas för användardelegering genereras, behörigheter och upphör att gällaPå krävs.

Exempel

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

Parametrar

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Returvärde för blobServiceClient.getUserDelegationKey()

accountName

string

Returer

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Så här hämtar du OAuth-målgrupp för ett lagringskonto för datalake-tjänsten.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parametrar

storageAccountName

string

Returer

string

isPipelineLike(unknown)

En hjälp för att avgöra om ett visst argument uppfyller pipelinekontraktet

function isPipelineLike(pipeline: unknown): pipeline

Parametrar

pipeline

unknown

Ett argument som kan vara en pipeline

Returer

pipeline

sant när argumentet uppfyller pipelinekontraktet

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter.

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

Parametrar

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Valfri. Alternativ.

Returer

Pipeline

Ett nytt pipelineobjekt.