Delen via

@azure/storage-file-datalake package

  • Referentie

Klassen

AccountSASPermissions

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

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

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het maken 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 worden ingesteld als het veld resources in een AccountSASSignatureValues-object . Het is mogelijk om de tekenreeks voor resources te maken zonder deze klasse, maar de volgorde van de resources is bijzonder en deze klasse garandeert juistheid.
AccountSASServices

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het maken 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 worden ingesteld als het veld services in een AccountSASSignatureValues-object . Het is mogelijk om de servicetekenreeks te maken zonder deze klasse, maar de volgorde van de services is bijzonder en deze klasse garandeert juistheid.
AnonymousCredential

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

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

De basisklasse waaruit alle aanvraagbeleidsregels zijn afgeleid.
Credential

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

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

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

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

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

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

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

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

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

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

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

Dit is een helperklasse voor het maken 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 gebruikmaakt van deze machtigingen machtigingen machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingsveld voor een DataLakeSASSignatureValues-object . Het is mogelijk om de machtigingsreeks te maken zonder deze klasse, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.
Pipeline

Een pijplijnklasse met BELEID voor HTTP-aanvragen. U kunt een standaardpijplijn maken door newPipeline aan te roepen. U kunt ook een pijplijn met uw eigen beleid maken door de constructor pijplijn.

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

Een aangepast fouttype voor mislukte pijplijnaanvragen.
SASQueryParameters

Vertegenwoordigt de onderdelen waaruit de queryparameters van een Azure Storage SAS zijn opgebouwd. Dit type wordt niet rechtstreeks door de gebruiker samengesteld; deze 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 u hier voorzichtig moet zijn 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

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

  1. Browsers plaatsen GET/HEAD-aanvragen in de cache 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. Koptekst met lengte van inhoud verwijderen om waarschuwingen van browsers te voorkomen
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory is een factory-klasse die helpt bij het genereren van StorageBrowserPolicy-objecten.
StorageRetryPolicy

Beleid voor opnieuw proberen met exponentiële nieuwe pogingen en lineaire nieuwe pogingen geïmplementeerd.
StorageRetryPolicyFactory

StorageRetryPolicyFactory is een factory-klasse die helpt bij het genereren van StorageRetryPolicy-objecten .
StorageSharedKeyCredential

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

StorageSharedKeyCredential voor accountsleutelautorisatie van de Azure Storage-service.
StorageSharedKeyCredentialPolicy

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

Interfaces

AccessControlChangeCounters

AccessControlChangeCounters bevat aantallen bewerkingen die toegangsbeheerlijsten recursief wijzigen.
AccessControlChangeError

Vertegenwoordigt een vermelding die de toegangsbeheerlijst niet kon bijwerken tijdens setAccessControlRecursiveen updateAccessControlRecursiveremoveAccessControlRecursive.
AccessControlChanges

AccessControlChanges bevat batchgewijs en cumulatief aantal bewerkingen waarmee toegangsbeheerlijsten recursief worden gewijzigd. Daarnaast worden padvermeldingen weergegeven die niet zijn bijgewerkt terwijl deze bewerkingen worden uitgevoerd.
AccessPolicy
AccountSASSignatureValues

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

AccountSASSignatureValues wordt gebruikt voor het genereren van een Shared Access Signature (SAS) 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 de eerste veranderlijk en een logische weergave is, terwijl de laatste onveranderbaar is en wordt gebruikt om werkelijke REST-aanvragen te genereren.

Zie https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 voor meer conceptuele informatie over SAS Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas voor beschrijvingen van de parameters, waaronder welke vereist zijn
BlobHierarchyListSegment
BlobItemModel

Een Azure Storage-blob
BlobPrefix
BlobPropertiesModel

Eigenschappen van een blob
CommonGenerateSasUrlOptions

Algemene opties van bestandssysteemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions en FileGenerateSasUrlOptions.
CommonOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
CpkInfo

Parametergroep
DataLakeRequestConditions

Parametergroep
DataLakeSASSignatureValues

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

DataLakeSASSignatureValues wordt gebruikt voor het genereren van SAS-tokens voor blob en DataLake-services voor containers, blobs, bestandssysteem, mappen en bestanden.
DataLakeServiceProperties

Eigenschappen van opslagservice.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
DirectoryCreateIfNotExistsResponse

Bevat antwoordgegevens voor de bewerking createIfNotExists .
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Opties voor het configureren van de bewerking generateSasUrl .
FileAppendOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileCreateIfNotExistsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileCreateIfNotExistsResponse

Bevat antwoordgegevens voor de bewerking createIfNotExists .
FileCreateOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileCreateResponse
FileFlushOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileGenerateSasUrlOptions

Opties voor het configureren van de bewerking generateSasUrl .
FileParallelUploadOptions

Optie-interface voor Data Lake-bestand - Uploadbewerkingen

Zie:
FileQueryCsvTextConfiguration

Opties voor het opvragen van een bestand met CSV-indeling.
FileQueryError

Fouttype bestandsquery.
FileQueryJsonTextConfiguration

Opties voor het uitvoeren van query's op een bestand met JSON-indeling.
FileQueryOptions

Optie-interface voor Data Lake-bestand - querybewerkingen

Zie:
FileQueryParquetConfiguration

Opties voor het uitvoeren van query's op het bestand met de Parquet-indeling.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

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

Zie:
FileSetExpiryHeaders

Hiermee definieert u headers voor Path_setExpiry bewerking.
FileSetExpiryOptions

Optie-interface voor de bewerking setExpiry .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Bevat antwoordgegevens voor de bewerking createIfNotExists .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Bevat antwoordgegevens voor de bewerking deleteIfExists .
FileSystemDeleteOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileSystemEncryptionScope

Opties voor het opgeven van het versleutelingsbereik in een bestandssysteem.
FileSystemExistsOptions

Optie-interface voor Data Lake-bestandssysteem bestaat bewerkingen

Zie:
FileSystemGenerateSasUrlOptions

Opties voor het configureren van de bewerking generateSasUrl .
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Hiermee definieert u headers voor FileSystem_listBlobHierarchySegment bewerking.
FileSystemListPathsHeaders

Hiermee definieert u headers voor FileSystem_listPaths bewerking.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
FileSystemUndeletePathOption

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
HttpHeaders

Een verzameling http-headersleutel-waardeparen.
HttpOperationResponse

HTTP-antwoord dat compatibel is met de core-v1(core-http).
IHttpClient

Een compatibele interface voor core-http-aanvraagbeleid
Lease

De details voor een specifieke lease.
LeaseAccessConditions

Parametergroep
LeaseOperationOptions

Hiermee configureert u leasebewerkingen.
ListBlobsHierarchySegmentResponse

Een opsomming van blobs
ListDeletedPathsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
ListDeletedPathsSegmentOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
ListFileSystemsSegmentResponse
ListPathsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
ListPathsSegmentOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Hiermee definieert u headers voor Path_appendData bewerking.
PathChangeAccessControlRecursiveOptions

Optiestype voor setAccessControlRecursive, updateAccessControlRecursive en removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Antwoordtype voor setAccessControlRecursive, updateAccessControlRecursive en removeAccessControlRecursive.
PathCreateHeaders

Hiermee definieert u headers voor Path_create bewerking.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathCreateIfNotExistsResponse

Bevat antwoordgegevens voor de bewerking createIfNotExists .
PathCreateOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathDeleteHeaders

Hiermee definieert u headers voor Path_delete bewerking.
PathDeleteIfExistsResponse

Bevat antwoordgegevens voor de bewerking deleteIfExists .
PathDeleteOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathExistsOptions

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

Zie:
PathFlushDataHeaders

Hiermee definieert u headers voor Path_flushData bewerking.
PathGetAccessControlHeaders
PathGetAccessControlOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Hiermee definieert u headers voor Path_getProperties bewerking.
PathGetPropertiesOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Hiermee definieert u headers voor Path_setAccessControl bewerking.
PathSetAccessControlOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathSetMetadataHeaders
PathSetMetadataOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathSetPermissionsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
PathUndeleteHeaders

Hiermee definieert u headers voor Path_undelete bewerking.
PathUpdateHeaders

Hiermee definieert u headers voor Path_update bewerking.
PipelineLike

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

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

Optie-interface voor pijplijnconstructor.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory

Een interface voor compatibiliteit met RequestPolicyFactory van core-http
RequestPolicyOptions

Een interface voor compatibiliteit met RequestPolicy
RolePermissions
SASQueryParametersOptions

Opties voor het maken van SASQueryParameters.
SasIPRange

Toegestaan IP-bereik voor een SAS.
ServiceClientOptions

Een subset van @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions

Opties voor het configureren van de bewerking generateAccountSasUrl .
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

Een interface voor opties die bij elke bewerking op afstand worden gebruikt.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Opties voor het configureren van undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions

Interface opties voor de functie newPipeline .
StorageRetryOptions

Interface voor opties voor opnieuw proberen van Opslagblob.
UserDelegationKey
UserDelegationKeyModel

Een sleutel voor gebruikersdelegatie
WebResource

Een beschrijving van een HTTP-aanvraag die moet worden ingediend bij een externe server.

Type-aliassen

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

Bevat antwoordgegevens voor de getProperties-bewerking.
EncryptionAlgorithmType

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

Bekende waarden die door de service worden ondersteund

Geen
AES256
FileAppendResponse
FileExpiryMode

Definieert waarden voor PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Opties voor het uitvoeren van query's op een bestand met de Apache Arrow-indeling. Alleen geldig voor outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Bevat antwoordgegevens voor de <xref:DataLakeServiceClient.renameFileSystem> bewerking.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Bevat antwoordgegevens voor de bewerking undeleteFileSystem .
FileUploadResponse
HttpRequestBody

Typen instanties die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen node. Blob, ReadableStream en () => ReadableStream zijn alleen browsers.
LeaseDurationType
LeaseOperationResponse

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

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

Definieert waarden voor PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definieert waarden voor PathRenameMode.
PathResourceTypeModel

Definieert waarden voor PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Bevat antwoordgegevens voor de bewerking listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

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

Enums

PathGetPropertiesAction

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

Definieert waarden voor PathRenameMode. Mogelijke waarden zijn: 'verouderd', 'posix'
PathResourceType

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

Protocollen voor gegenereerde SAS.
StorageDataLakeAudience

Definieert de bekende clouddoelgroepen voor Opslag.
StorageRetryPolicyType

RetryPolicy-typen.

Functies

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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 moet u de bijbehorende eigenschappen rechtstreeks instellen, zoals machtigingen, startsOn en id.

WAARSCHUWING: als de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET een waarde toewijzen aan id of verloopt bij & machtigingen handmatig als u deze constructor initieert.

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

Voorbeeld

// 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 codefragment uitvoert.

Voorbeeld

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

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.

Voorbeeld

// 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-doelgroep ophalen voor een opslagaccount voor datalake-service.
isPipelineLike(unknown)

Een helper om te bepalen of een bepaald argument voldoet aan het pijplijncontract
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.

Functiedetails

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

Parameters

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retouren

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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 moet u de bijbehorende eigenschappen rechtstreeks instellen, zoals machtigingen, startsOn en id.

WAARSCHUWING: als de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET een waarde toewijzen aan id of verloopt bij & machtigingen handmatig als u deze constructor initieert.

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

Voorbeeld

// 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 codefragment uitvoert.

Voorbeeld

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

Parameters

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retouren

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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.

Voorbeeld

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

Parameters

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

accountName

string

Retouren

SASQueryParameters

getDataLakeServiceAccountAudience(string)

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

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parameters

storageAccountName

string

Retouren

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

Parameters

pipeline

unknown

Een argument dat een pijplijn kan zijn

Retouren

pipeline

waar wanneer het argument voldoet aan het pijplijncontract

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.

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

Parameters

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

pipelineOptions
StoragePipelineOptions

Optioneel. Opties.

Retouren

Pipeline

Een nieuw pijplijnobject.