Freigeben über

@azure/storage-file-datalake package

  • Referenz

Klassen

AccountSASPermissions

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse, um eine Zeichenfolge zu erstellen, die die von einem AccountSAS gewährten Berechtigungen darstellt. Das Festlegen eines Werts auf "true" bedeutet, dass jeder SAS, der 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 dies 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 Korrektheit.
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 jeder SAS, der diese Berechtigungen verwendet, Zugriff auf diesen Dienst gewährt. Nachdem alle Werte festgelegt wurden, 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-Mitglied 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) verwenden.
AnonymousCredentialPolicy

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

Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.
Credential

Anmeldeinformationen sind eine abstrakte Klasse für die Signierung von Azure Storage-HTTP-Anforderungen. 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 wird ausgelöst, 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 ihre 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, um eine Zeichenfolge zu erstellen, die die von einem ServiceSAS gewährten Berechtigungen darstellt. Das Festlegen eines Werts auf "true" bedeutet, dass jeder SAS, der 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, um eine Zeichenfolge zu erstellen, die von einem ServiceSAS für ein Verzeichnis gewährte Berechtigungen darstellt. Das Festlegen eines Werts auf "true" bedeutet, dass jeder SAS, der 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, um eine Zeichenfolge zu erstellen, die die berechtigungen darstellt, die von einem ServiceSAS für einen Container gewährt werden. Das Festlegen eines Werts auf "true" bedeutet, dass jeder SAS, der 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.
Pipeline

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

Lesen Sie newPipeline- und bereitgestellten Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.
RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
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 AccountSASSignatureValues-- und <xref:BlobSASSignatureValues> typen generiert. Nachdem sie generiert wurde, kann sie in eine toString() codiert und direkt an eine URL angefügt werden (allerdings sollten Sie hier vorsichtig sein, falls es vorhandene Abfrageparameter gibt, die sich auf die geeigneten Methoden zum Anfügen dieser Abfrageparameter auswirken können).

HINWEIS: Instanzen dieser Klasse sind unveränderlich.
StorageBrowserPolicy

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

  1. Browser speichern GET/HEAD-Anforderungen zwischen, indem Sie bedingte Header wie "IF_MODIFIED_SINCE" hinzufügen. StorageBrowserPolicy ist eine Richtlinie, die verwendet wird, um eine Zeitstempelabfrage zur GET/HEAD-Anforderungs-URL hinzuzufügen, wodurch der Browsercache vermieden wird.

  2. Entfernen des Cookieheaders zur Sicherheit

  3. Entfernen des Headers mit Inhaltslänge, um Browserwarnungen zu vermeiden
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory ist eine Factoryklasse, die das Generieren von StorageBrowserPolicy-Objekten unterstützt.
StorageRetryPolicy

Wiederholungsrichtlinie mit exponentieller Wiederholung und linearer Wiederholung implementiert.
StorageRetryPolicyFactory

StorageRetryPolicyFactory ist eine Factoryklasse, die StorageRetryPolicy--Objekte generiert.
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 einer HTTP-Anforderung mit einem freigegebenen Schlüssel verwendet wird.

Schnittstellen

AccessControlChangeCounters

AccessControlChangeCounters enthält die Anzahl der Vorgänge, die Zugriffssteuerungslisten rekursiv ändern.
AccessControlChangeError

Stellt einen Eintrag dar, der während setAccessControlRecursive, updateAccessControlRecursive und removeAccessControlRecursivedie Zugriffssteuerungsliste nicht aktualisiert werden konnte.
AccessControlChanges

AccessControlChanges enthält Batch- und kumulierte Anzahl von Vorgängen, die Zugriffssteuerungslisten rekursiv ändern. Darüber hinaus werden Pfadeinträge verfügbar gemacht, die nicht aktualisiert werden konnten, während diese Vorgänge ausgeführt werden.
AccessPolicy
AccountSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR.

AccountSASSignatureValues wird verwendet, um eine Freigegebene Zugriffssignatur (SAS) für ein Azure Storage-Konto zu generieren. Nachdem alle hier aufgeführten Werte entsprechend festgelegt wurden, rufen Sie generateAccountSASQueryParameters auf, um eine Darstellung des SAS abzurufen, die tatsächlich auf Data Lake-URLs angewendet werden kann. Hinweis: Sowohl diese Klasse als auch SASQueryParameters vorhanden, da der frühere Wert ä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 Sie unter https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 Unter https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas finden Sie Beschreibungen der Parameter, einschließlich der erforderlichen Parameter.
BlobHierarchyListSegment
BlobItemModel

Ein Azure Storage-Blob
BlobPrefix
BlobPropertiesModel

Eigenschaften eines Blobs
CommonGenerateSasUrlOptions

Allgemeine Optionen der 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

Speicherdiensteigenschaften.
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
DirectoryGenerateSasUrlOptions

Optionen zum Konfigurieren 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
FileFlushOptions

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

Optionen zum Konfigurieren generateSasUrl Vorgangs.
FileParallelUploadOptions

Option interface for Data Lake file - Upload operations

Siehe:
FileQueryCsvTextConfiguration

Optionen zum Abfragen der Datei im CSV-Format.
FileQueryError

Fehlertyp der Dateiabfrage.
FileQueryJsonTextConfiguration

Optionen zum Abfragen der Datei mit JSON-Format.
FileQueryOptions

Option interface for Data Lake file - query operations

Siehe:
FileQueryParquetConfiguration

Optionen zum Abfragen der Datei mit dem Parkettformat.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Option interface for Data Lake file - readToBuffer operations

Siehe:
FileSetExpiryHeaders

Definiert Kopfzeilen für Path_setExpiry Vorgang.
FileSetExpiryOptions

Option interface for the setExpiry operation.
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 in einem Dateisystem.
FileSystemExistsOptions

Option interface for Data Lake file system exists operations

Siehe:
FileSystemGenerateSasUrlOptions

Optionen zum Konfigurieren 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 Kopfzeilen für FileSystem_listBlobHierarchySegment Vorgang.
FileSystemListPathsHeaders

Definiert Kopfzeilen 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.
HttpHeaders

Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
HttpOperationResponse

Http-Antwort, die mit core-v1(core-http) kompatibel ist.
IHttpClient

Eine kompatible Schnittstelle für Kern-HTTP-Anforderungsrichtlinien
Lease

Die Details für eine bestimmte Lease.
LeaseAccessConditions

Parametergruppe
LeaseOperationOptions

Konfiguriert Leasevorgänge.
ListBlobsHierarchySegmentResponse

Eine Aufzählung 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 Kopfzeilen für Path_appendData Vorgang.
PathChangeAccessControlRecursiveOptions

Optionstyp für setAccessControlRecursive, updateAccessControlRecursive und removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Antworttyp für setAccessControlRecursive, updateAccessControlRecursive und removeAccessControlRecursive.
PathCreateHeaders

Definiert Kopfzeilen 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 Kopfzeilen 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

Option interface for Data Lake directory/file exists operations

Siehe:
PathFlushDataHeaders

Definiert Kopfzeilen für Path_flushData Vorgang.
PathGetAccessControlHeaders
PathGetAccessControlOptions

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

Definiert Kopfzeilen 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 Kopfzeilen 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 Kopfzeilen für Path_undelete Vorgang.
PathUpdateHeaders

Definiert Kopfzeilen für Path_update Vorgang.
PipelineLike

Eine Schnittstelle für die Pipeline Klasse, die HTTP-Anforderungsrichtlinien enthält. Sie können eine Standardpipeline erstellen, indem Sie newPipeline-aufrufen. Oder Sie können eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen.

Lesen Sie newPipeline- und bereitgestellten Richtlinien, bevor Sie Ihre angepasste Pipeline implementieren.
PipelineOptions

Option interface for Pipeline constructor.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory

Eine Schnittstelle zur Kompatibilität mit der RequestPolicyFactory von Core-http
RequestPolicyOptions

Eine Schnittstelle zur Kompatibilität mit RequestPolicy
RolePermissions
SASQueryParametersOptions

Optionen zum Erstellen SASQueryParameters.
SasIPRange

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

Eine Teilmenge von @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions

Optionen zum Konfigurieren generateAccountSasUrl Vorgangs.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

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

Optionen zum Konfigurieren undeleteFileSystem-.
SignedIdentifier
StoragePipelineOptions

Optionsschnittstelle für die newPipeline--Funktion.
StorageRetryOptions

Speicher-BLOB-Wiederholungsoptionenschnittstelle.
UserDelegationKey
UserDelegationKeyModel

Ein Benutzerdelegierungsschlüssel
WebResource

Eine Beschreibung einer HTTP-Anforderung, die an einem Remoteserver gesendet werden soll.

Typaliase

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

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

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

Bekannte Werte, die vom Dienst unterstützt werden

Keine
AES256-
FileAppendResponse
FileExpiryMode

Definiert Werte für PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Optionen zum Abfragen der Datei mit dem Apache Arrow-Format. Nur gültig für outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
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.
FileUploadResponse
HttpRequestBody

Typen von Textkörpern, die auf der Anforderung unterstützt werden. NodeJS.ReadableStream und () => NodeJS.ReadableStream ist nur Node. Blob, ReadableStream und () => ReadableStream sind nur Browser.
LeaseDurationType
LeaseOperationResponse

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

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

Definiert Werte für PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definiert Werte für PathRenameMode.
PathResourceTypeModel

Definiert Werte für PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

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

Optionen zum Konfigurieren <xref:DataLakeServiceClient.renameFileSystem>.

Enumerationen

PathGetPropertiesAction

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

Definiert Werte für PathRenameMode. Mögliche Werte sind: 'Legacy', 'posix'
PathResourceType

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

Protokolle für generierte SAS.
StorageDataLakeAudience

Definiert die bekannten Cloudgruppen für den Speicher.
StorageRetryPolicyType

RetryPolicy-Typen.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Generiert ein SASQueryParameters- -Objekt, das alle SAS-Abfrageparameter enthält, die zum Erstellen einer tatsächlichen REST-Anforderung erforderlich sind.

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

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine Instanz von SASQueryParameters.

Akzeptiert nur erforderliche Einstellungen, die zum Erstellen einer SAS erforderlich sind. Für optionale Einstellungen legen Sie die entsprechenden Eigenschaften direkt fest, z. B. Berechtigungen, startsOn und Bezeichner.

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

Füllen Sie die erforderlichen Details aus, 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();

Füllen Sie die erforderlichen Details aus, 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 Instanz von SASQueryParameters. WARNUNG: Der Bezeichner wird ignoriert, wenn SAS der Benutzerdelegierung generiert wird, Berechtigungen und Ablaufen Erforderlich sind.

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)

So rufen Sie die OAuth-Zielgruppe für ein Speicherkonto für den Datalake-Dienst ab.
isPipelineLike(unknown)

Ein Helfer, der entscheidet, ob ein bestimmtes Argument dem Pipelinevertrag entspricht.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

Details zur Funktion

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Generiert ein SASQueryParameters- -Objekt, das alle SAS-Abfrageparameter enthält, die zum Erstellen einer tatsächlichen REST-Anforderung erforderlich sind.

Siehe https://learn.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 Instanz von SASQueryParameters.

Akzeptiert nur erforderliche Einstellungen, die zum Erstellen einer SAS erforderlich sind. Für optionale Einstellungen legen Sie die entsprechenden Eigenschaften direkt fest, z. B. Berechtigungen, startsOn und Bezeichner.

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

Füllen Sie die erforderlichen Details aus, 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();

Füllen Sie die erforderlichen Details aus, 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 Instanz von SASQueryParameters. WARNUNG: Der Bezeichner wird ignoriert, wenn SAS der Benutzerdelegierung generiert wird, Berechtigungen und Ablaufen Erforderlich sind.

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)

So rufen Sie die OAuth-Zielgruppe für ein Speicherkonto für den Datalake-Dienst ab.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName

string

Gibt zurück

string

isPipelineLike(unknown)

Ein Helfer, der entscheidet, ob ein bestimmtes Argument dem Pipelinevertrag entspricht.

function isPipelineLike(pipeline: unknown): pipeline

Parameter

pipeline

unknown

Ein Argument, das eine Pipeline sein kann

Gibt zurück

pipeline

true, wenn das Argument dem Pipeline-Vertrag entspricht

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

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

pipelineOptions
StoragePipelineOptions

Wahlfrei. Optionen.

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.