Share via

@azure/storage-file-datalake package

  • Referenz

Klassen

AccountSASPermissions

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die von einem AccountSAS erteilten Berechtigungen darstellt. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Nachdem alle Werte festgelegt wurden, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein AccountSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Berechtigungszeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Berechtigungen ist besonders, und diese Klasse garantiert die Richtigkeit.
AccountSASResourceTypes

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Ressourcen darstellt, auf die ein AccountSAS zugreifen kann. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Zugriff auf diesen Ressourcentyp gewährt. Nachdem alle Werte festgelegt wurden, sollte diese mit toString serialisiert und als Ressourcenfeld für ein AccountSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Ressourcenzeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Ressourcen ist besonders, und diese Klasse garantiert die Richtigkeit.
AccountSASServices

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Dienste darstellt, auf die ein AccountSAS zugreifen kann. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Zugriff auf diesen Dienst gewährt. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Dienstfeld für ein AccountSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Dienstzeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Dienste ist besonders, und diese Klasse garantiert die Richtigkeit.
AnonymousCredential

AnonymousCredential stellt ein credentialPolicyCreator-Element bereit, das zum Erstellen von AnonymousCredentialPolicy-Objekten verwendet wird. AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen, oder für die Verwendung mit Shared Access Signatures (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen, oder für die Verwendung mit Shared Access Signatures (SAS).
BaseRequestPolicy

Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.
Credential

Credential ist eine abstrakte Klasse für die Signierung von HTTP-Anforderungen in Azure Storage. Diese Klasse hostt eine credentialPolicyCreator-Factory, die CredentialPolicy generiert.
CredentialPolicy

Anmeldeinformationsrichtlinie zum Signieren von HTTP(S)-Anforderungen vor dem Senden. Dies ist eine abstrakte Klasse.
DataLakeAclChangeFailedError

Ein Fehler, der ausgelöst wird, wenn ein Vorgang unterbrochen wird und später fortgesetzt werden kann.
DataLakeDirectoryClient

Ein DataLakeDirectoryClient stellt eine URL zum Azure Storage-Verzeichnis dar.
DataLakeFileClient

Ein DataLakeFileClient stellt eine URL zur Azure Storage-Datei dar.
DataLakeFileSystemClient

Ein DataLakeFileSystemClient stellt eine URL zum Azure Storage-Dateisystem dar, mit der Sie seine Verzeichnisse und Dateien bearbeiten können.
DataLakeLeaseClient
DataLakePathClient

Ein DataLakePathClient stellt eine URL zum Azure Storage-Pfad (Verzeichnis oder Datei) dar.
DataLakeSASPermissions

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die von einem ServiceSAS erteilten Berechtigungen darstellt. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Nachdem alle Werte festgelegt wurden, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein DataLakeSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Berechtigungszeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Berechtigungen ist besonders, und diese Klasse garantiert die Richtigkeit.
DataLakeServiceClient

Mit DataLakeServiceClient können Sie Azure Data Lake-Dienstressourcen und -Dateisysteme bearbeiten. Das Speicherkonto stellt den Namespace der obersten Ebene für den Data Lake-Dienst bereit.
DirectorySASPermissions

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die von einem ServiceSAS für ein Verzeichnis erteilt werden. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Nachdem alle Werte festgelegt wurden, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein DataLakeSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Berechtigungszeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Berechtigungen ist besonders, und diese Klasse garantiert die Richtigkeit.
FileSystemSASPermissions

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die einem Container von einem ServiceSAS erteilt werden. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Nachdem alle Werte festgelegt wurden, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein DataLakeSASSignatureValues-Objekt festgelegt werden. Es ist möglich, die Berechtigungszeichenfolge ohne diese Klasse zu erstellen, aber die Reihenfolge der Berechtigungen ist besonders, und diese Klasse garantiert die Richtigkeit.
HttpHeaders

Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.
Pipeline

Eine Pipelineklasse, die HTTP-Anforderungsrichtlinien enthält. Sie können eine Standardpipeline erstellen, indem Sie newPipeline aufrufen. Alternativ können Sie eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen.

Lesen Sie newPipeline und bereitgestellte Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.
RequestPolicyOptions

Optionale Eigenschaften, die beim Erstellen einer RequestPolicy verwendet werden können.
RestError

Ein Fehler, der sich aus einer HTTP-Anforderung an einen Dienstendpunkt ergibt.
SASQueryParameters

Stellt die Komponenten dar, aus denen die Abfrageparameter einer Azure Storage-SAS bestehen. Dieser Typ wird nicht direkt vom Benutzer erstellt. Sie wird nur von den Typen AccountSASSignatureValues und <xref:BlobSASSignatureValues> generiert. Nach der Generierung kann es in eine toString() codiert und direkt an eine URL angefügt werden (wobei hier Vorsicht geboten ist, wenn abfrageparameter vorhanden sind, was sich auf die geeignete Methode zum Anfügen dieser Abfrageparameter auswirken kann).

HINWEIS: Instanzen dieser Klasse sind unveränderlich.
StorageBrowserPolicy

StorageBrowserPolicy behandelt Unterschiede zwischen Node.js und Browserruntime, einschließlich:

  1. Browser speichern GET/HEAD-Anforderungen zwischen, indem sie bedingte Header wie "IF_MODIFIED_SINCE" hinzufügen. StorageBrowserPolicy ist eine Richtlinie, die zum Hinzufügen einer Zeitstempelabfrage zur GET/HEAD-Anforderungs-URL verwendet wird, um den Browsercache zu vermeiden.

  2. Entfernen des Cookie-Headers aus Sicherheitsgründen

  3. Entfernen von Inhaltslängenheader, um Browserwarnungen zu vermeiden
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory ist eine Factoryklasse, die beim Generieren von StorageBrowserPolicy-Objekten hilft.
StorageRetryPolicy

Wiederholungsrichtlinie mit implementierter exponentieller Wiederholung und linearer Wiederholung.
StorageRetryPolicyFactory

StorageRetryPolicyFactory ist eine Factoryklasse, die das Generieren von StorageRetryPolicy-Objekten unterstützt.
StorageSharedKeyCredential

NUR IN NODE.JS RUNTIME VERFÜGBAR.

StorageSharedKeyCredential für die Kontoschlüsselautorisierung des Azure Storage-Diensts.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy ist eine Richtlinie, die zum Signieren von HTTP-Anforderungen mit einem freigegebenen Schlüssel verwendet wird.
WebResource

Erstellt ein neues WebResource-Objekt.

Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsunabhängig ist und die erforderlichen Eigenschaften umschlossen, um eine Anforderung zu initiieren.

Schnittstellen

AccessControlChangeCounters

AccessControlChangeCounters enthält die Anzahl von Vorgängen, die sich Access Control Listen rekursiv ändern.
AccessControlChangeError

Stellt einen Eintrag dar, bei dem Access Control Liste während setAccessControlRecursiveund updateAccessControlRecursiveremoveAccessControlRecursivenicht aktualisiert werden konnte.
AccessControlChanges

AccessControlChanges enthält Batch- und kumulative Anzahl von Vorgängen, die sich Access Control Listen rekursiv ändern. Darüber hinaus werden Pfadeinträge verfügbar gemacht, die während des Fortschritts dieser Vorgänge nicht aktualisiert werden konnten.
AccessPolicy
AccountSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR.

AccountSASSignatureValues wird verwendet, um eine Shared Access Signature (SAS) für ein Azure Storage-Konto zu generieren. Nachdem alle werte hier ordnungsgemäß festgelegt wurden, rufen Sie generateAccountSASQueryParameters auf, um eine Darstellung der SAS zu erhalten, die tatsächlich auf Data Lake-URLs angewendet werden kann. Hinweis: Sowohl diese Klasse als auch SASQueryParameters sind vorhanden, da erstere änderbar und eine logische Darstellung ist, während letztere unveränderlich ist und zum Generieren tatsächlicher REST-Anforderungen verwendet wird.

Weitere konzeptionelle Informationen zu SAS finden https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas Beschreibungen der Parameter, einschließlich der erforderlichen Parameter.
BlobHierarchyListSegment
BlobItemModel

Ein Azure Storage-Blob
BlobPrefix
BlobPropertiesModel

Eigenschaften eines Blobs
CommonGenerateSasUrlOptions

Allgemeine Optionen von FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions und FileGenerateSasUrlOptions.
CommonOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
CpkInfo

Parametergruppe
DataLakeRequestConditions

Parametergruppe
DataLakeSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR.

DataLakeSASSignatureValues wird verwendet, um Blob- und DataLake-Dienst-SAS-Token für Container, Blobs, Dateisystem, Verzeichnisse und Dateien zu generieren.
DataLakeServiceProperties

Eigenschaften des Speicherdiensts.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
DirectoryCreateIfNotExistsResponse

Enthält Antwortdaten für den CreateIfNotExists-Vorgang .
DirectoryCreateOptions
DirectoryCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
DirectoryGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .
FileAppendOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileCreateIfNotExistsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileCreateIfNotExistsResponse

Enthält Antwortdaten für den CreateIfNotExists-Vorgang .
FileCreateOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
FileFlushOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .
FileParallelUploadOptions

Optionsschnittstelle für Data Lake-Datei : Uploadvorgänge

Thema
FileQueryCsvTextConfiguration

Optionen zum Abfragen von Dateien im CSV-Format.
FileQueryError

Fehlertyp der Dateiabfrage.
FileQueryJsonTextConfiguration

Optionen zum Abfragen von Dateien im JSON-Format.
FileQueryOptions

Optionsschnittstelle für Data Lake-Datei : Abfragevorgänge

Thema
FileQueryParquetConfiguration

Optionen zum Abfragen einer Datei im Parquet-Format.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Optionsschnittstelle für Data Lake-Datei : readToBuffer-Vorgänge

Thema
FileSetExpiryHeaders

Definiert Header für Path_setExpiry Vorgang.
FileSetExpiryOptions

Optionsschnittstelle für den setExpiry-Vorgang .
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Enthält Antwortdaten für den CreateIfNotExists-Vorgang .
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Enthält Antwortdaten für den DeleteIfExists-Vorgang .
FileSystemDeleteOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileSystemEncryptionScope

Optionen zum Angeben des Verschlüsselungsbereichs für ein Dateisystem.
FileSystemExistsOptions

Optionsschnittstelle für Vorhandene Vorgänge des Data Lake-Dateisystems

Thema
FileSystemGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Definiert Header für FileSystem_listBlobHierarchySegment Vorgang.
FileSystemListPathsHeaders

Definiert Header für FileSystem_listPaths Vorgang.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileSystemUndeletePathOption

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
HttpOperationResponse

Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der parsedBody -Eigenschaft gespeichert, wenn der Antworttext in JSON oder XML empfangen wird.
IHttpClient

Eine Schnittstelle, die HttpRequests senden und zugesagte HttpResponses empfangen kann.
Lease

Die Details für eine bestimmte Lease.
LeaseAccessConditions

Parametergruppe
LeaseOperationOptions

Konfiguriert Leasevorgänge.
ListBlobsHierarchySegmentResponse

Eine Enumeration von Blobs
ListDeletedPathsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
ListDeletedPathsSegmentOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
ListFileSystemsSegmentResponse
ListPathsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
ListPathsSegmentOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Definiert Header für Path_appendData Vorgang.
PathChangeAccessControlRecursiveOptions

Optionstyp für setAccessControlRecursive, updateAccessControlRecursive und removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Antworttyp für setAccessControlRecursive, updateAccessControlRecursive und removeAccessControlRecursive.
PathCreateHeaders

Definiert Header für Path_create Vorgang.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathCreateIfNotExistsResponse

Enthält Antwortdaten für den CreateIfNotExists-Vorgang .
PathCreateOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathDeleteHeaders

Definiert Header für Path_delete Vorgang.
PathDeleteIfExistsResponse

Enthält Antwortdaten für den DeleteIfExists-Vorgang .
PathDeleteOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathExistsOptions

Optionsschnittstelle für Data Lake-Verzeichnis-/Dateivorgänge vorhanden

Thema
PathFlushDataHeaders

Definiert Header für Path_flushData Vorgang.
PathGetAccessControlHeaders
PathGetAccessControlOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Definiert Header für Path_getProperties Vorgang.
PathGetPropertiesOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Definiert Header für Path_setAccessControl Vorgang.
PathSetAccessControlOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathSetMetadataHeaders
PathSetMetadataOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathSetPermissionsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
PathUndeleteHeaders

Definiert Header für Path_undelete Vorgang.
PathUpdateHeaders

Definiert Header für Path_update Vorgang.
PipelineOptions

Optionsschnittstelle für pipeline-Konstruktor.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicy

Die zugrunde liegende Struktur einer Anforderungsrichtlinie.
RolePermissions
SASQueryParametersOptions

Optionen zum Erstellen von SASQueryParameters.
SasIPRange

Zulässiger IP-Bereich für eine SAS.
ServiceGenerateAccountSasUrlOptions

Optionen zum Konfigurieren des GenerateAccountSasUrl-Vorgangs .
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Optionen zum Konfigurieren von undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions

Optionsschnittstelle für die newPipeline-Funktion .
StorageRetryOptions

Schnittstelle für Speicherblob-Wiederholungsoptionen.
UserDelegationKey
UserDelegationKeyModel

Ein Benutzerdelegierungsschlüssel

Typaliase

AccessControlType
CopyStatusType
CredentialPolicyCreator

Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet.
DataLakeServiceGetPropertiesResponse

Enthält Antwortdaten für den getProperties-Vorgang.
EncryptionAlgorithmType

Definiert Werte für EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> kann austauschbar mit EncryptionAlgorithmType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte

None
AES256
FileAppendResponse

Enthält Antwortdaten für den appendData-Vorgang.
FileExpiryMode

Definiert Werte für PathExpiryOptions.
FileFlushResponse

Enthält Antwortdaten für den FlushData-Vorgang.
FileQueryArrowConfiguration

Optionen zum Abfragen einer Datei im Apache Arrow-Format. Nur gültig für outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse

Enthält Antwortdaten für den setExpiry-Vorgang.
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Enthält Antwortdaten für den <xref:DataLakeServiceClient.renameFileSystem> Vorgang.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Enthält Antwortdaten für den Vorgang "undeleteFileSystem" .
HttpRequestBody

Mögliche HTTP-Anforderungstexttypen
LeaseDurationType
LeaseOperationResponse

Enthält die Antwortdaten für Vorgänge, die eine Lease erstellen, ändern oder löschen.

Siehe <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

Enthält Antwortdaten für den listPaths-Vorgang.
ModifiedAccessConditions
PathCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.
PathDeleteResponse

Enthält Antwortdaten für den Löschvorgang.
PathGetAccessControlResponse
PathGetPropertiesActionModel

Definiert Werte für PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definiert Werte für PathRenameMode.
PathResourceTypeModel

Definiert Werte für PathResourceType.
PathSetAccessControlResponse

Enthält Antwortdaten für den setAccessControl-Vorgang.
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
RequestPolicyFactory

Erstellt eine neue RequestPolicy pro Anforderung, die die bereitgestellte nextPolicy verwendet.
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Enthält Antwortdaten für den ListContainersSegment-Vorgang.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Optionen zum Konfigurieren <xref:DataLakeServiceClient.renameFileSystem>von .

Enumerationen

PathGetPropertiesAction

Definiert Werte für PathGetPropertiesAction. Mögliche Werte: "getAccessControl", "getStatus"
PathRenameMode

Definiert Werte für PathRenameMode. Mögliche Werte: "legacy", "posix"
PathResourceType

Definiert Werte für PathResourceType. Mögliche Werte: "directory", "file"
SASProtocol

Protokolle für generierte SAS.
StorageDataLakeAudience

Definiert die bekannten Cloudgruppen für Storage.
StorageRetryPolicyType

RetryPolicy-Typen.

Functions

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen.
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Generiert ein SASQueryParameters-Objekt , das alle SAS-Abfrageparameter enthält, die für eine tatsächliche REST-Anforderung erforderlich sind.

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

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine instance von SASQueryParameters.

Akzeptiert nur die erforderlichen Einstellungen, die zum Erstellen einer SAS erforderlich sind. Legen Sie für optionale Einstellungen die entsprechenden Eigenschaften wie berechtigungen, startsOn und identifier direkt fest.

WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und Ablauf erforderlich. Sie MÜSSEN dem Bezeichner einen Wert zuweisen oder ablaufenOn & Berechtigungen manuell, wenn Sie mit diesem Konstruktor initialisieren.

Geben Sie die erforderlichen Details ein, bevor Sie die folgenden Codeausschnitte ausführen.

Beispiel

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

Geben Sie die erforderlichen Details ein, bevor Sie den Codeausschnitt ausführen.

Beispiel

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

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine instance von SASQueryParameters. WARNUNG: Der Bezeichner wird beim Generieren der Sas für die Benutzerdelegierung ignoriert, Berechtigungen und Ablauf sind erforderlich.

Beispiel

// 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)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

Details zur Funktion

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parameter

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Gibt zurück

RequestPolicyFactory

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Generiert ein SASQueryParameters-Objekt , das alle SAS-Abfrageparameter enthält, die für eine tatsächliche REST-Anforderung erforderlich sind.

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

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

Parameter

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine instance von SASQueryParameters.

Akzeptiert nur die erforderlichen Einstellungen, die zum Erstellen einer SAS erforderlich sind. Legen Sie für optionale Einstellungen die entsprechenden Eigenschaften wie berechtigungen, startsOn und identifier direkt fest.

WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und Ablauf erforderlich. Sie MÜSSEN dem Bezeichner einen Wert zuweisen oder ablaufenOn & Berechtigungen manuell, wenn Sie mit diesem Konstruktor initialisieren.

Geben Sie die erforderlichen Details ein, bevor Sie die folgenden Codeausschnitte ausführen.

Beispiel

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

Geben Sie die erforderlichen Details ein, bevor Sie den Codeausschnitt ausführen.

Beispiel

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

Parameter

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine instance von SASQueryParameters. WARNUNG: Der Bezeichner wird beim Generieren der Sas für die Benutzerdelegierung ignoriert, Berechtigungen und Ablauf sind erforderlich.

Beispiel

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

Parameter

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Rückgabewert von blobServiceClient.getUserDelegationKey()

accountName

string

Gibt zurück

SASQueryParameters

getDataLakeServiceAccountAudience(string) 

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName

string

Gibt zurück

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

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

Parameter

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

pipelineOptions
StoragePipelineOptions

Optional. Optionen.

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.