@azure/storage-file-datalake package

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die zijn verleend door een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een AccountSASSignatureValues object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de resources vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot dat resourcetype. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het resourceveld op een AccountSASSignatureValues object. Het is mogelijk om de tekenreeks voor resources zonder deze klasse samen te stellen, maar de volgorde van de resources is bijzonder en deze klasse garandeert juistheid.

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de services vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot die service. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het servicesveld op een AccountSASSignatureValues object. Het is mogelijk om de servicesreeks zonder deze klasse samen te stellen, maar de volgorde van de services is bijzonder en deze klasse garandeert juistheid.

AnonymousCredential biedt een credentialPolicyCreator-lid dat wordt gebruikt om AnonymousCredentialPolicy-objecten te maken. AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS).

AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS).

De basisklasse waaruit alle aanvraagbeleidsregels zijn afgeleid.

Referentie is een abstracte klasse voor ondertekening van HTTP-aanvragen voor Azure Storage. Deze klasse host een credentialPolicyCreator-factory die CredentialPolicy genereert.

Referentiebeleid dat wordt gebruikt om HTTP(S)-aanvragen te ondertekenen voordat deze worden verzonden. Dit is een abstracte klasse.

Er is een fout opgetreden wanneer een bewerking wordt onderbroken en later kan worden voortgezet.

Een DataLakeDirectoryClient vertegenwoordigt een URL naar de Azure Storage-map.

Een DataLakeFileClient vertegenwoordigt een URL naar het Azure Storage-bestand.

Een DataLakeFileSystemClient vertegenwoordigt een URL naar het Azure Storage-bestandssysteem, zodat u de mappen en bestanden kunt bewerken.

Een DataLakePathClient vertegenwoordigt een URL naar het Azure Storage-pad (map of bestand).

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die zijn verleend door een ServiceSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een DataLakeSASSignatureValues-object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

Met DataLakeServiceClient kunt u azure Data Lake-servicebronnen en bestandssystemen bewerken. Het opslagaccount biedt de naamruimte op het hoogste niveau voor de Data Lake-service.

Dit is een helperklasse voor het maken van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een directory worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een DataLakeSASSignatureValues-object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een container worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een DataLakeSASSignatureValues-object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

Een pijplijnklasse met HTTP-aanvraagbeleid. U kunt een standaardpijplijn maken door newPipeline-aan te roepen. U kunt ook een pijplijn maken met uw eigen beleid door de constructor van Pipeline.

Raadpleeg newPipeline- en opgegeven beleidsregels voordat u uw aangepaste pijplijn implementeert.

Vertegenwoordigt de onderdelen waaruit de queryparameters van Azure Storage SAS bestaan. Dit type wordt niet rechtstreeks samengesteld door de gebruiker; het wordt alleen gegenereerd door de AccountSASSignatureValues en <xref:BlobSASSignatureValues> typen. Zodra deze is gegenereerd, kan deze worden gecodeerd in een toString() en rechtstreeks aan een URL worden toegevoegd (hoewel hier voorzichtigheid moet worden genomen als er bestaande queryparameters zijn, wat van invloed kan zijn op de juiste manier om deze queryparameters toe te voegen).

OPMERKING: Exemplaren van deze klasse zijn onveranderbaar.

StorageBrowserPolicy verwerkt verschillen tussen Node.js en browserruntime, waaronder:

1. Browsers slaan GET/HEAD-aanvragen in de cache op door voorwaardelijke headers toe te voegen, zoals 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is een beleid dat wordt gebruikt om een tijdstempelquery toe te voegen aan de GET/HEAD-aanvraag-URL, waardoor de browsercache wordt vermeden.

2. Cookieheader verwijderen voor beveiliging

3. Inhoudslengtekop verwijderen om waarschuwing van browsers te voorkomen

StorageBrowserPolicyFactory is een factoryklasse die helpt bij het genereren van StorageBrowserPolicy-objecten.

Beleid voor opnieuw proberen met exponentieel opnieuw proberen en lineaire nieuwe poging geïmplementeerd.

StorageRetryPolicyFactory is een fabrieksklasse die helpt bij het genereren van StorageRetryPolicy--objecten.

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

StorageSharedKeyCredential voor accountsleutelautorisatie van de Azure Storage-service.

StorageSharedKeyCredentialPolicy is een beleid dat wordt gebruikt om een HTTP-aanvraag te ondertekenen met een gedeelde sleutel.

AccessControlChangeCounters bevat aantallen bewerkingen die recursief toegangsbeheerlijsten wijzigen.

Vertegenwoordigt een vermelding die de toegangsbeheerlijst niet kan bijwerken tijdens setAccessControlRecursive, updateAccessControlRecursive en removeAccessControlRecursive.

AccessControlChanges bevat batch- en cumulatieve tellingen van bewerkingen die recursief toegangsbeheerlijsten wijzigen. Daarnaast worden padvermeldingen weergegeven die niet kunnen worden bijgewerkt terwijl deze bewerkingen worden uitgevoerd.

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

AccountSASSignatureValues wordt gebruikt om een Shared Access Signature (SAS) te genereren voor een Azure Storage-account. Zodra alle waarden hier correct zijn ingesteld, roept u generateAccountSASQueryParameters aan om een weergave van de SAS te verkrijgen die daadwerkelijk kan worden toegepast op data lake-URL's. Opmerking: zowel deze klasse als SASQueryParameters bestaan omdat het voormalige veranderlijk is en een logische weergave terwijl de laatste onveranderbaar is en wordt gebruikt om werkelijke REST-aanvragen te genereren.

Zie https://free.blessedness.top/azure/storage/common/storage-dotnet-shared-access-signature-part-1 voor meer conceptuele informatie over SAS Zie https://free.blessedness.top/rest/api/storageservices/constructing-an-account-sas voor beschrijvingen van de parameters, waaronder welke vereist zijn

Een Azure Storage-blob

Eigenschappen van een blob

Algemene opties van de FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions en FileGenerateSasUrlOptions.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Parametergroep

Parametergroep

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

DataLakeSASSignatureValues wordt gebruikt om SAS-tokens voor blob- en DataLake-services te genereren voor containers, blobs, bestandssysteem, mappen en bestanden.

Eigenschappen van opslagservice.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Bevat antwoordgegevens voor de createIfNotExists bewerking.

Opties voor het configureren van generateSasUrl--bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Bevat antwoordgegevens voor de createIfNotExists bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Opties voor het configureren van generateSasUrl--bewerking.

Optie-interface voor Data Lake-bestand - Uploadbewerkingen

See:

• upload
• uploadFile
• uploadStream

Opties om een query uit te voeren op een bestand met CSV-indeling.

Fouttype bestandsquery.

Opties voor het opvragen van een bestand met JSON-indeling.

Optie-interface voor Data Lake-bestand - querybewerkingen

See:

• query

Opties voor het uitvoeren van query's op bestanden met Parquet-indeling.

Optie-interface voor Data Lake-bestand - readToBuffer-bewerkingen

See:

• readToBuffer

Definieert headers voor Path_setExpiry bewerking.

Optieinterface voor de bewerking setExpiry.

Bevat antwoordgegevens voor de createIfNotExists bewerking.

Bevat antwoordgegevens voor de deleteIfExists bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Opties voor het opgeven van een versleutelingsbereik op een bestandssysteem.

Optie-interface voor het Data Lake-bestandssysteem bestaat bewerkingen

See:

• exists

Opties voor het configureren van generateSasUrl--bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Definieert headers voor FileSystem_listBlobHierarchySegment bewerking.

Definieert headers voor FileSystem_listPaths bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een verzameling HTTP-headersleutel-waardeparen.

Http-antwoord dat compatibel is met core-v1 (core-http).

De details voor een specifieke lease.

Parametergroep

Hiermee configureert u leasebewerkingen.

Een opsomming van blobs

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Definieert headers voor Path_appendData bewerking.

Optiestype voor setAccessControlRecursive, updateAccessControlRecursive en removeAccessControlRecursive.

Antwoordtype voor setAccessControlRecursive, updateAccessControlRecursive en removeAccessControlRecursive.

Definieert headers voor Path_create bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Bevat antwoordgegevens voor de createIfNotExists bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Definieert headers voor Path_delete bewerking.

Bevat antwoordgegevens voor de deleteIfExists bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Optie-interface voor Data Lake-map/-bestand bestaat bewerkingen

See:

• exists

Definieert headers voor Path_flushData bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Definieert headers voor Path_getProperties bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Definieert headers voor Path_setAccessControl bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Definieert headers voor Path_undelete bewerking.

Definieert headers voor Path_update bewerking.

Een interface voor de Pipeline-klasse met HTTP-aanvraagbeleid. U kunt een standaardpijplijn maken door newPipeline-aan te roepen. U kunt ook een pijplijn maken met uw eigen beleid door de constructor van Pipeline.

Raadpleeg newPipeline- en opgegeven beleidsregels voordat u uw aangepaste pijplijn implementeert.

Optie-interface voor pijplijnconstructor.

Een compatibele interface voor beleid voor core-http-aanvragen

Een interface voor compatibiliteit met requestPolicyFactory van core-http

Een interface voor compatibiliteit met RequestPolicy

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Opties voor het maken van SASQueryParameters.

Toegestaan IP-bereik voor een SAS.

Een subset van @azure/core-http ServiceClientOptions

Opties voor het configureren van generateAccountSasUrl bewerking.

Een interface voor opties die gebruikelijk zijn voor elke externe bewerking.

Opties voor het configureren van ongedaan maken vanbestandssysteem.

Optiesinterface voor de functie newPipeline.

Interface voor opties voor opnieuw proberen van Opslagblob.

Een gebruikersdelegeringssleutel

Een beschrijving van een HTTP-aanvraag die moet worden gedaan op een externe server.

Bevat antwoordgegevens voor de getProperties-bewerking.

Definieert waarden voor EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> kan door elkaar worden gebruikt met EncryptionAlgorithmType, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

None
AES256

Definieert waarden voor PathExpiryOptions.

Opties om een query uit te voeren op een bestand met Apache Arrow-indeling. Alleen geldig voor outputTextConfiguration-.

Bevat antwoordgegevens voor de <xref:DataLakeServiceClient.renameFileSystem>-bewerking.

Bevat antwoordgegevens voor de bewerking undeleteFileSystem.

Typen lichamen die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen knooppunt. Blob, ReadableStream<Uint8Array> en () => ReadableStream<Uint8Array> zijn alleen voor de browser.

Bevat de antwoordgegevens voor bewerkingen die een lease maken, wijzigen of verwijderen.

Zie <xref:BlobLeaseClient>.

Definieert waarden voor PathGetPropertiesAction.

Definieert waarden voor PathRenameMode.

Definieert waarden voor PathResourceType.

Bevat antwoordgegevens voor de bewerking listContainersSegment.

Opties voor het configureren van <xref:DataLakeServiceClient.renameFileSystem>.

Definieert waarden voor PathGetPropertiesAction. Mogelijke waarden zijn: 'getAccessControl', 'getStatus'

Definieert waarden voor PathRenameMode. Mogelijke waarden zijn: 'legacy', 'posix'

Definieert waarden voor PathResourceType. Mogelijke waarden zijn: 'map', 'bestand'

Protocollen voor gegenereerde SAS.

Definieert de bekende clouddoelgroepen voor Opslag.

Typen RetryPolicy.

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een SASQueryParameters object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.

Zie https://free.blessedness.top/rest/api/storageservices/constructing-an-account-sas

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee maakt u een exemplaar van SASQueryParameters.

Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen stelt u de bijbehorende eigenschappen rechtstreeks in, zoals machtigingen, startsOn en id.

WAARSCHUWING: Wanneer de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET waarde toewijzen aan id of expiresOn & machtigingen handmatig als u in eerste instantie met deze constructor begint.

Vul de vereiste gegevens in voordat u de volgende codefragmenten uitvoert.

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

Vul de vereiste gegevens in voordat u het fragment uitvoert.

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

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee maakt u een exemplaar van SASQueryParameters. WAARSCHUWING: de id wordt genegeerd bij het genereren van SAS voor gebruikersdelegatie, machtigingen en expiresOn zijn vereist.

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

OAuth-doelgroep ophalen voor een opslagaccount voor datalake-service.

Een helper om te bepalen of een bepaald argument voldoet aan het pijplijncontract

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.