@azure/storage-file-datalake package

Előkelő társaság

AccountSASPermissions

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Ez egy segédosztály, amely egy AccountSAS által megadott engedélyeket képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy AccountSASSignatureValues objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

AccountSASResourceTypes

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Ez egy segédosztály egy, az AccountSAS által elérhető erőforrásokat képviselő sztring létrehozásához. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó sasok hozzáférést biztosítanak az adott erőforrástípushoz. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy AccountSASSignatureValues objektum erőforrásmezőjeként kell beállítani. Az erőforrás-sztring ezen osztály nélkül is felépíthető, de az erőforrások sorrendje különleges, és ez az osztály garantálja a helyességet.

AccountSASServices

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Ez egy segédosztály, amely egy, az AccountSAS által elérhető szolgáltatásokat képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az engedélyeket használó SAS hozzáférést biztosít az adott szolgáltatáshoz. Miután az összes érték be van állítva, ezt a toString használatával kell szerializálni, és egy AccountSASSignatureValues objektum szolgáltatásmezőjeként kell beállítani. A szolgáltatási sztring ezen osztály nélkül is felépíthető, de a szolgáltatások sorrendje különleges, és ez az osztály garantálja a helyességet.

AnonymousCredential

Az AnonymousCredential egy hitelesítőadatPolicyCreator-tagot biztosít, amellyel AnonymousCredentialPolicy objektumokat hozhat létre. Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.

AnonymousCredentialPolicy

Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.

BaseRequestPolicy

Az az alaposztály, amelyből az összes kérelemszabályzat származik.

Credential

A hitelesítő adatok az Azure Storage HTTP-kérések aláírásának absztrakt osztályai. Ez az osztály egy credentialPolicyCreator gyárat fog üzemeltetni, amely credentialPolicy-t hoz létre.

CredentialPolicy

A HTTP(S) kérések elküldése előtt történő aláírásához használt hitelesítőadat-szabályzat. Ez egy absztrakt osztály.

DataLakeAclChangeFailedError

Egy művelet megszakításakor megjelenő hiba, amely később folytatható.

DataLakeDirectoryClient

A DataLakeDirectoryClient az Azure Storage-címtár URL-címét jelöli.

DataLakeFileClient

A DataLakeFileClient az Azure Storage-fájl URL-címét jelöli.

DataLakeFileSystemClient

A DataLakeFileSystemClient az Azure Storage fájlrendszer url-címét jelöli, amely lehetővé teszi a címtárak és fájlok manipulálását.

DataLakeLeaseClient
DataLakePathClient

A DataLakePathClient az Azure Storage elérési útja (könyvtár vagy fájl) URL-címét jelöli.

DataLakeSASPermissions

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Ez egy segédosztály, amely egy ServiceSAS által megadott engedélyeket képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Ha az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy DataLakeSASSignatureValues objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

DataLakeServiceClient

A DataLakeServiceClient lehetővé teszi az Azure Data Lake-szolgáltatás erőforrásainak és fájlrendszerének manipulálására. A tárfiók biztosítja a Data Lake szolgáltatás legfelső szintű névterét.

DirectorySASPermissions

Ez egy segédosztály, amely egy olyan sztringet hoz létre, amely a ServiceSAS által a címtárnak adott engedélyeket jelöli. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Ha az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy DataLakeSASSignatureValues objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

FileSystemSASPermissions

Ez egy segédosztály, amely egy olyan sztringet hoz létre, amely a ServiceSAS által a tárolónak adott engedélyeket jelöli. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Ha az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy DataLakeSASSignatureValues objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.

Pipeline

HTTP-kérési szabályzatokat tartalmazó folyamatosztály. Létrehozhat egy alapértelmezett folyamatot newPipelinemeghívásával. Vagy létrehozhat egy saját szabályzatokkal rendelkező folyamatot a Pipeline konstruktorával.

A testreszabott folyamat implementálása előtt tekintse meg newPipeline és a megadott szabályzatokat.

SASQueryParameters

Az Azure Storage SAS lekérdezési paramétereit alkotó összetevőket jelöli. Ezt a típust nem közvetlenül a felhasználó készíti el; csak a AccountSASSignatureValues és <xref:BlobSASSignatureValues> típusok generálják. A létrehozás után kódolható egy toString(), és közvetlenül hozzáfűzhető egy URL-címhez (itt azonban körültekintően kell eljárni, ha vannak meglévő lekérdezési paraméterek, amelyek befolyásolhatják a lekérdezési paraméterek hozzáfűzésének megfelelő módját).

MEGJEGYZÉS: Az osztály példányai nem módosíthatók.

StorageBrowserPolicy

A StorageBrowserPolicy kezeli a Node.js és a böngésző futtatókörnyezete közötti különbségeket, beleértve a következőket:

  1. A böngészők a GET/HEAD kéréseket feltételes fejlécek, például a "IF_MODIFIED_SINCE" hozzáadásával gyorsítótárazják. A StorageBrowserPolicy egy szabályzat, amellyel időbélyeg-lekérdezést adhat hozzá a GET/HEAD kérelem URL-címéhez, így elkerülheti a böngésző gyorsítótárát.

  2. Cookie-fejléc eltávolítása a biztonság érdekében

  3. Tartalomhosszúságú fejléc eltávolítása a böngészők figyelmeztetésének elkerülése érdekében

StorageBrowserPolicyFactory

A StorageBrowserPolicyFactory egy olyan gyári osztály, amely segít a StorageBrowserPolicy objektumok létrehozásában.

StorageRetryPolicy

Újrapróbálkozási szabályzat exponenciális újrapróbálkozással és lineáris újrapróbálkozással.

StorageRetryPolicyFactory

A StorageRetryPolicyFactory egy olyan gyári osztály, amely segít StorageRetryPolicy objektumok létrehozásában.

StorageSharedKeyCredential

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

StorageSharedKeyCredential az Azure Storage szolgáltatás fiókkulcs-engedélyezéséhez.

StorageSharedKeyCredentialPolicy

A StorageSharedKeyCredentialPolicy egy olyan szabályzat, amellyel HTTP-kéréseket írhat alá megosztott kulccsal.

Felületek

AccessControlChangeCounters

Az AccessControlChangeCounters olyan műveletek számát tartalmazza, amelyek rekurzív módon módosítják a hozzáférés-vezérlési listákat.

AccessControlChangeError

Olyan bejegyzést jelöl, amely setAccessControlRecursive, updateAccessControlRecursive és removeAccessControlRecursivesorán nem tudta frissíteni a hozzáférés-vezérlési listát.

AccessControlChanges

Az AccessControlChanges a hozzáférés-vezérlési listákat rekurzívan módosító műveletek köteg- és halmozott számát tartalmazza. Emellett olyan elérésiút-bejegyzéseket is elérhetővé tesz, amelyek a műveletek előrehaladása során nem frissültek.

AccessPolicy
AccountSASSignatureValues

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Az AccountSASSignatureValues használatával közös hozzáférésű jogosultságkód (SAS) jön létre egy Azure Storage-fiókhoz. Ha az összes érték helyesen van beállítva, hívja meg generateAccountSASQueryParameters, hogy lekérje az SAS-t, amely ténylegesen alkalmazható a data lake URL-címekre. Vegye figyelembe, hogy ez az osztály és SASQueryParameters létezik, mert az előbbi nem módosítható és logikai ábrázolás, míg az utóbbi nem módosítható, és a tényleges REST-kérések létrehozására szolgál.

Az SAS-ről a https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 további fogalmi információkért lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas a paraméterek leírását, beleértve azokat is, amelyek szükségesek

BlobHierarchyListSegment
BlobItemModel

Azure Storage-blob

BlobPrefix
BlobPropertiesModel

Blob tulajdonságai

CommonGenerateSasUrlOptions

A FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions és FileGenerateSasUrlOptionsáltalános beállításai.

CommonOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

CpkInfo

Paramétercsoport

DataLakeRequestConditions

Paramétercsoport

DataLakeSASSignatureValues

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

A DataLakeSASSignatureValues segítségével blob- és DataLake-szolgáltatás SAS-jogkivonatokat hozhat létre tárolókhoz, blobokhoz, fájlrendszerekhez, könyvtárakhoz és fájlokhoz.

DataLakeServiceProperties

Tárolási szolgáltatás tulajdonságai.

DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

DirectoryCreateIfNotExistsResponse

A createIfNotExists művelet válaszadatait tartalmazza.

DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

A generateSasUrl művelet konfigurálásához szükséges beállítások.

FileAppendOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileCreateIfNotExistsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileCreateIfNotExistsResponse

A createIfNotExists művelet válaszadatait tartalmazza.

FileCreateOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileCreateResponse
FileFlushOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileGenerateSasUrlOptions

A generateSasUrl művelet konfigurálásához szükséges beállítások.

FileParallelUploadOptions

A Data Lake-fájl beállítási felülete – Feltöltési műveletek

See:

FileQueryCsvTextConfiguration

A CSV formátumú fájl lekérdezésének beállításai.

FileQueryError

Fájl lekérdezési hibatípusa.

FileQueryJsonTextConfiguration

A JSON formátumú fájl lekérdezésének beállításai.

FileQueryOptions

Beállítási felület a Data Lake-fájlhoz – lekérdezési műveletek

See:

FileQueryParquetConfiguration

A Parquet formátumú fájl lekérdezésének beállításai.

FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Option interface for Data Lake file – readToBuffer operations

See:

FileSetExpiryHeaders

A Path_setExpiry művelet fejléceit határozza meg.

FileSetExpiryOptions

Az setExpiry művelet beállítási felülete.

FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

A createIfNotExists művelet válaszadatait tartalmazza.

FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

A deleteIfExists művelet válaszadatait tartalmazza.

FileSystemDeleteOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileSystemEncryptionScope

A fájlrendszer titkosítási hatókörének megadására vonatkozó beállítások.

FileSystemExistsOptions

A Data Lake-fájlrendszer beállítási felülete létezik műveletekhez

See:

FileSystemGenerateSasUrlOptions

A generateSasUrl művelet konfigurálásához szükséges beállítások.

FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

A FileSystem_listBlobHierarchySegment művelet fejléceit határozza meg.

FileSystemListPathsHeaders

A FileSystem_listPaths művelet fejléceit határozza meg.

FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

FileSystemUndeletePathOption

Minden távoli művelethez gyakran használt lehetőségek felülete.

HttpHeaders

HTTP-fejléckulcs/érték párok gyűjteménye.

HttpOperationResponse

Http-válasz, amely kompatibilis a core-v1 (core-http).

Lease

Egy adott bérlet részletei.

LeaseAccessConditions

Paramétercsoport

LeaseOperationOptions

Bérletműveleteket konfigurál.

ListBlobsHierarchySegmentResponse

Blobok számbavétele

ListDeletedPathsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

ListDeletedPathsSegmentOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

ListFileSystemsSegmentResponse
ListPathsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

ListPathsSegmentOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

A Path_appendData művelet fejléceit határozza meg.

PathChangeAccessControlRecursiveOptions

Az setAccessControlRecursive, updateAccessControlRecursive és removeAccessControlRecursivebeállításainak típusa.

PathChangeAccessControlRecursiveResponse

Választípus setAccessControlRecursive, updateAccessControlRecursive és removeAccessControlRecursive.

PathCreateHeaders

A Path_create művelet fejléceit határozza meg.

PathCreateHttpHeaders
PathCreateIfNotExistsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathCreateIfNotExistsResponse

A createIfNotExists művelet válaszadatait tartalmazza.

PathCreateOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathDeleteHeaders

A Path_delete művelet fejléceit határozza meg.

PathDeleteIfExistsResponse

A deleteIfExists művelet válaszadatait tartalmazza.

PathDeleteOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathExistsOptions

A Data Lake-címtár/fájl beállítási felülete létezik műveletekhez

See:

PathFlushDataHeaders

A Path_flushData művelet fejléceit határozza meg.

PathGetAccessControlHeaders
PathGetAccessControlOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

A Path_getProperties művelet fejléceit határozza meg.

PathGetPropertiesOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

A Path_setAccessControl művelet fejléceit határozza meg.

PathSetAccessControlOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathSetMetadataHeaders
PathSetMetadataOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathSetPermissionsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

PathUndeleteHeaders

A Path_undelete művelet fejléceit határozza meg.

PathUpdateHeaders

A Path_update művelet fejléceit határozza meg.

PipelineLike

A HTTP-kérési szabályzatokat tartalmazó folyamat osztály felülete. Létrehozhat egy alapértelmezett folyamatot newPipelinemeghívásával. Vagy létrehozhat egy saját szabályzatokkal rendelkező folyamatot a Pipeline konstruktorával.

A testreszabott folyamat implementálása előtt tekintse meg newPipeline és a megadott szabályzatokat.

PipelineOptions

A Folyamatkonstruktor beállítási felülete.

RawAccessPolicy
RemovePathAccessControlItem
RequestPolicy

A core-http kérési szabályzatok kompatibilis felülete

RequestPolicyFactory

A core-http RequestPolicyFactory-jával való kompatibilitási felület

RequestPolicyOptions

A RequestPolicyval való kompatibilitást biztosító felület

RolePermissions
SASQueryParametersOptions

A SASQueryParameters létrehozásának lehetőségei.

SasIPRange

SAS-hez engedélyezett IP-címtartomány.

ServiceClientOptions

A ServiceClientOptions @azure/core-http részhalmaza

ServiceGenerateAccountSasUrlOptions

Az generateAccountSasUrl művelet konfigurálásához szükséges beállítások.

ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

Minden távoli művelethez gyakran használt lehetőségek felülete.

ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Az undeleteFileSystem konfigurálására használt beállítások.

SignedIdentifier
StoragePipelineOptions

Az newPipeline függvény beállítási felülete.

StorageRetryOptions

A Storage Blob újrapróbálkozési beállításainak felülete.

UserDelegationKey

Egy felhasználódelegálási kulcs.

UserDelegationKeyModel

Felhasználódelegálási kulcs

WebResource

A távoli kiszolgálóra irányuló HTTP-kérés leírása.

Típus-aliasok

AccessControlType
CopyStatusType
CredentialPolicyCreator

Egy gyári függvény, amely létrehoz egy új CredentialPolicy-t, amely a megadott nextPolicy-t használja.

DataLakeServiceGetPropertiesResponse

A getProperties művelet válaszadatait tartalmazza.

EncryptionAlgorithmType

A EncryptionAlgorithmType értékeit határozza meg.
<xref:KnownEncryptionAlgorithmType> a EncryptionAlgorithmType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

None
AES256

FileAppendResponse
FileExpiryMode

A PathExpiryOptions értékeit határozza meg.

FileFlushResponse
FileQueryArrowConfiguration

Az Apache Arrow formátumú fájl lekérdezésének lehetőségei. Csak kimenetiTextConfigurationérvényes.

FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

A <xref:DataLakeServiceClient.renameFileSystem> művelet válaszadatait tartalmazza.

FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

A undeleteFileSystem művelet válaszadatait tartalmazza.

FileUploadResponse
HttpRequestBody

A kérelemben támogatott szervek típusai. NodeJS.ReadableStream és () => NodeJS.ReadableStream csak csomópont. A Blob, a ReadableStream<Uint8Array> és a () => ReadableStream<Uint8Array> csak böngésző.

LeaseDurationType
LeaseOperationResponse

A bérletet létrehozó, módosító vagy törölni kívánt műveletek válaszadatait tartalmazza.

Lásd: <xref:BlobLeaseClient>.

LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

A PathGetPropertiesAction értékeit határozza meg.

PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

A PathRenameMode értékeit határozza meg.

PathResourceTypeModel

A PathResourceType értékeit határozza meg.

PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

A listContainersSegment művelet válaszadatait tartalmazza.

ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

A <xref:DataLakeServiceClient.renameFileSystem>konfigurálható beállítások.

Enums

PathGetPropertiesAction

A PathGetPropertiesAction értékeit határozza meg. A lehetséges értékek a következők: "getAccessControl", "getStatus"

PathRenameMode

A PathRenameMode értékeit határozza meg. A lehetséges értékek a következők: "örökölt", "posix"

PathResourceType

A PathResourceType értékeit határozza meg. A lehetséges értékek a következők: "könyvtár", "fájl"

SASProtocol

A létrehozott SAS protokolljai.

StorageDataLakeAudience

Meghatározza a Storage ismert felhőbeli célközönségeit.

StorageRetryPolicyType

RetryPolicy típusok.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters objektumot, amely tartalmazza a tényleges REST-kérés létrehozásához szükséges ÖSSZES SAS-lekérdezési paramétert.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters-példányt.

Csak az SAS létrehozásához szükséges beállításokat fogadja el. Az opcionális beállításokhoz adja meg közvetlenül a megfelelő tulajdonságokat, például az engedélyeket, a startsOnt és az azonosítót.

FIGYELMEZTETÉS: Ha az azonosító nincs megadva, engedélyekre és lejáratokra van szükség. A konstruktor első használatakor manuálisan kell értéket hozzárendelnie az azonosítóhoz vagy a expiresOn & engedélyekhez.

A következő kódrészletek futtatása előtt adja meg a szükséges adatokat.

Example

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

A kódrészlet futtatása előtt adja meg a szükséges adatokat.

Example

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

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters-példányt. FIGYELMEZTETÉS: Az azonosító figyelmen kívül lesz hagyva a felhasználói delegálási SAS létrehozásakor, az engedélyek és a lejárati idő Megadása kötelező.

Example

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

OAuth-célközönség lekérése a datalake szolgáltatáshoz tartozó tárfiókhoz.

isPipelineLike(unknown)

Segéd annak eldöntéséhez, hogy egy adott argumentum megfelel-e a folyamatszerződésnek

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehoz egy új folyamatobjektumot a hitelesítő adatok megadva.

Változók

RestError

A sikertelen folyamatkérések egyéni hibatípusa.

StorageOAuthScopes

Az OAuth hatókör Azure Storage-hez használható.

ToBlobEndpointHostMappings
ToDfsEndpointHostMappings
logger

A @azure/logger csomag konfigurációja.

Funkciók részletei

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters objektumot, amely tartalmazza a tényleges REST-kérés létrehozásához szükséges ÖSSZES SAS-lekérdezési paramétert.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

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

Paraméterek

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Visszatér

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters-példányt.

Csak az SAS létrehozásához szükséges beállításokat fogadja el. Az opcionális beállításokhoz adja meg közvetlenül a megfelelő tulajdonságokat, például az engedélyeket, a startsOnt és az azonosítót.

FIGYELMEZTETÉS: Ha az azonosító nincs megadva, engedélyekre és lejáratokra van szükség. A konstruktor első használatakor manuálisan kell értéket hozzárendelnie az azonosítóhoz vagy a expiresOn & engedélyekhez.

A következő kódrészletek futtatása előtt adja meg a szükséges adatokat.

Example

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

A kódrészlet futtatása előtt adja meg a szükséges adatokat.

Example

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

Paraméterek

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Visszatér

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters-példányt. FIGYELMEZTETÉS: Az azonosító figyelmen kívül lesz hagyva a felhasználói delegálási SAS létrehozásakor, az engedélyek és a lejárati idő Megadása kötelező.

Example

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

Paraméterek

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

accountName

string

Visszatér

getDataLakeServiceAccountAudience(string)

OAuth-célközönség lekérése a datalake szolgáltatáshoz tartozó tárfiókhoz.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Paraméterek

storageAccountName

string

Visszatér

string

isPipelineLike(unknown)

Segéd annak eldöntéséhez, hogy egy adott argumentum megfelel-e a folyamatszerződésnek

function isPipelineLike(pipeline: unknown): pipeline

Paraméterek

pipeline

unknown

Egy olyan argumentum, amely lehet folyamat

Visszatér

pipeline

igaz, ha az argumentum megfelel a folyamatszerződésnek

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehoz egy új folyamatobjektumot a hitelesítő adatok megadva.

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

Paraméterek

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

pipelineOptions
StoragePipelineOptions

Optional. Options.

Visszatér

Egy új folyamatobjektum.

Variable Details

RestError

A sikertelen folyamatkérések egyéni hibatípusa.

RestError: RestErrorConstructor

Típus

StorageOAuthScopes

Az OAuth hatókör Azure Storage-hez használható.

StorageOAuthScopes: string | string[]

Típus

string | string[]

ToBlobEndpointHostMappings

ToBlobEndpointHostMappings: string[][]

Típus

string[][]

ToDfsEndpointHostMappings

ToDfsEndpointHostMappings: string[][]

Típus

string[][]

logger

A @azure/logger csomag konfigurációja.

logger: AzureLogger

Típus