@azure/storage-file-share package

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.
FileSASPermissions	NUR IN NODE.JS RUNTIME VERFÜGBAR. Dies ist eine Hilfsklasse, um eine Zeichenfolge zu erstellen, die von einem ServiceSAS für eine Datei 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 FileSASSignatureValues-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.
FileSystemAttributes	Dies ist eine Hilfsklasse, um eine Zeichenfolge zu erstellen, die die NTFS-Attribute für eine Datei oder ein Verzeichnis darstellt. Siehe https://learn.microsoft.com/rest/api/storageservices/create-file#file-system-attributes
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.
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 FileSASSignatureValues 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.
ShareClient	Ein ShareClient stellt eine URL zur Azure Storage-Freigabe dar, mit der Sie ihre Verzeichnisse und Dateien bearbeiten können.
ShareDirectoryClient	Ein ShareDirectoryClient stellt eine URL zum Azure Storage-Verzeichnis dar, mit der Sie seine Dateien und Verzeichnisse bearbeiten können.
ShareFileClient	Ein ShareFileClient stellt eine URL zu einer Azure Storage-Datei dar.
ShareLeaseClient	Ein Client, der Leases für einen ShareFileClient- oder ShareClient-verwaltet. Siehe https://learn.microsoft.com/rest/api/storageservices/lease-file und https://learn.microsoft.com/rest/api/storageservices/lease-share
ShareSASPermissions	Dies ist eine Hilfsklasse, um eine Zeichenfolge zu erstellen, die von einem ServiceSAS für eine Freigabe 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 FileSASSignatureValues-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.
ShareServiceClient	Ein ShareServiceClient stellt eine URL zum Azure Storage File-Dienst dar, mit der Sie Dateifreigaben bearbeiten können.
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

AccessPolicy	Eine Access-Richtlinie.
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 der SAS abzurufen, die tatsächlich auf Datei-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/azure/storage/common/storage-dotnet-shared-access-signature-part-1 Unter https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas finden Sie Beschreibungen der Parameter, einschließlich der erforderlichen Parameter.
ClearRange
CloseHandlesInfo	Schließen Sie Die Ergebnisinformationen.
CommonGenerateSasUrlOptions	Allgemeine Optionen der ShareGenerateSasUrlOptions und FileGenerateSasUrlOptions.
CommonOptions	Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
CopyFileSmbInfo	Gruppe "Parameter"
CorsRule	CORS ist ein HTTP-Feature, mit dem eine Webanwendung, die unter einer Domäne ausgeführt wird, auf Ressourcen in einer anderen Domäne zugreifen kann. Webbrowser implementieren eine Sicherheitseinschränkung, die als Richtlinie für denselben Ursprung bezeichnet wird, die verhindert, dass eine Webseite APIs in einer anderen Domäne aufruft; CORS bietet eine sichere Möglichkeit, eine Domäne (die Ursprungsdomäne) zum Aufrufen von APIs in einer anderen Domäne zuzulassen.
DirectoryCloseHandlesHeaders	Zusätzliche Antwortheaderwerte für close handles request.
DirectoryCreateHeaders	Definiert Kopfzeilen für Directory_create Vorgang.
DirectoryCreateIfNotExistsResponse	Enthält Antwortdaten für den createIfNotExists(DirectoryCreateOptions) Vorgang.
DirectoryCreateOptions	Optionen zur Konfiguration der ShareDirectoryClient.create-Operation .
DirectoryDeleteHeaders	Definiert Kopfzeilen für Directory_delete Vorgang.
DirectoryDeleteIfExistsResponse	Enthält Antwortdaten für den deleteIfExists(DirectoryDeleteOptions) Vorgang.
DirectoryDeleteOptions	Optionen zur Konfiguration der Operationen ShareDirectoryClient.delete .
DirectoryExistsOptions	Optionen zur Konfiguration der Operationen ShareDirectoryClient.exists .
DirectoryForceCloseHandlesHeaders	Definiert Kopfzeilen für Directory_forceCloseHandles Vorgang.
DirectoryForceCloseHandlesOptions	Optionen zur Konfiguration von ShareDirectoryClient.forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Optionen zum Konfigurieren des Verzeichnisses – Erzwingen von Schließvorgängen für Segmentvorgänge. See: <xref:ShareDirectoryClient.forceCloseHandlesSegment> ShareDirectoryClient.forceCloseAllHandles
DirectoryGetPropertiesHeaders	Definiert Kopfzeilen für Directory_getProperties Vorgang.
DirectoryGetPropertiesOptions	Optionen zur Konfiguration der Operationen ShareDirectoryClient.getProperties .
DirectoryItem	Ein aufgelistetes Verzeichniselement.
DirectoryListFilesAndDirectoriesOptions	Optionen zur Konfiguration der Operationen ShareDirectoryClient.listFilesAndDirectories .
DirectoryListFilesAndDirectoriesSegmentHeaders	Definiert Kopfzeilen für Directory_listFilesAndDirectoriesSegment Vorgang.
DirectoryListHandlesHeaders	Definiert Kopfzeilen für Directory_listHandles Vorgang.
DirectoryListHandlesOptions	Optionen zur Konfiguration der Operationen ShareDirectoryClient.listHandles .
DirectoryListHandlesSegmentOptions	Optionen zum Konfigurieren des Verzeichnisses – Liste behandelt Segmentvorgänge. See: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
DirectoryRenameHeaders	Definiert Kopfzeilen für Directory_rename Vorgang.
DirectoryRenameOptions	Optionen zur Konfiguration der Operation ShareDirectoryClient.rename .
DirectorySetMetadataHeaders	Definiert Kopfzeilen für Directory_setMetadata Vorgang.
DirectorySetMetadataOptions	Optionen zur Konfiguration der Operationen ShareDirectoryClient.setMetadata .
DirectorySetPropertiesHeaders	Definiert Kopfzeilen für Directory_setProperties Vorgang.
FileAbortCopyFromURLOptions	Optionen zur Konfiguration der Operation ShareFileClient.abortCopyFromURL .
FileAbortCopyHeaders	Definiert Kopfzeilen für File_abortCopy Vorgang.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Optionen zur Konfiguration der Operationen ShareFileClient.clearRange .
FileCloseHandlesHeaders	Zusätzliche Antwortheaderwerte für close handles request.
FileCreateHardLinkHeaders	Definiert Kopfzeilen für File_createHardLink Vorgang.
FileCreateHardLinkOptions	Optionen zum Konfigurieren der Datei – Erstellen von HardLink-Vorgängen. See: ShareFileClient.createHardLink
FileCreateHeaders	Definiert Kopfzeilen für File_create Vorgang.
FileCreateOptions	Optionen zur Konfiguration der ShareFileClient.create-Operation .
FileCreateSymbolicLinkHeaders	Definiert Header für File_createSymbolicLink Vorgang.
FileCreateSymbolicLinkOptions	Optionen zum Konfigurieren der Vorgänge Datei - Symbolische Verknüpfung erstellen. See: ShareFileClient.createSymbolicLink
FileDeleteHeaders	Definiert Kopfzeilen für File_delete Vorgang.
FileDeleteIfExistsResponse	Enthält Antwortdaten für die Operation ShareFileClient.deleteIfExists .
FileDeleteOptions	Optionen zur Konfiguration der ShareFileClient.delete-Operation .
FileDownloadHeaders	Definiert Kopfzeilen für File_download Vorgang.
FileDownloadOptions	Optionen zum Konfigurieren von Datei - Downloadvorgängen. See: ShareFileClient.download ShareFileClient.downloadToFile
FileDownloadToBufferOptions	Optionsoberfläche für die Operation ShareFileClient.downloadToBuffer .
FileExistsOptions	Optionen zur Konfiguration der Operationen ShareFileClient.exists .
FileForceCloseHandlesHeaders	Definiert Kopfzeilen für File_forceCloseHandles Vorgang.
FileForceCloseHandlesOptions	Optionen zum Konfigurieren von Datei – Erzwingen von Schließhandles-Vorgängen. See: <xref:ShareFileClient.forceCloseHandlesSegment> ShareFileClient.forceCloseAllHandles ShareFileClient.forceCloseHandle
FileGenerateSasUrlOptions	Optionen zur Konfiguration der ShareFileClient.generateSasUrl-Operation .
FileGetPropertiesHeaders	Definiert Kopfzeilen für File_getProperties Vorgang.
FileGetPropertiesOptions	Optionen zur Konfiguration der Operationen ShareFileClient.getProperties .
FileGetRangeListHeaders	Definiert Kopfzeilen für File_getRangeList Vorgang.
FileGetRangeListOptions	Optionen zur Konfiguration der Operationen ShareFileClient.getRangeList .
FileGetSymbolicLinkHeaders	Definiert Header für File_getSymbolicLink Vorgang.
FileGetSymbolicLinkOptions	Optionen zum Konfigurieren von Dateien - Symbolischen Verknüpfungsvorgängen abrufen. See: ShareFileClient.getSymbolicLink
FileHttpHeaders
FileItem	Ein aufgelistetes Dateielement.
FileListHandlesHeaders	Definiert Kopfzeilen für File_listHandles Vorgang.
FileListHandlesOptions	Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileListHandlesSegmentOptions	Optionen zum Konfigurieren von Datei – Liste behandelt Segmentvorgänge. See: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileListRangesDiffOptions	Optionen zur Konfiguration der Operationen ShareFileClient.listRangesDiff .
FileListRangesOptions	Optionen zur Konfiguration der Operation ShareFileClient.listRanges .
FileListRangesSegment	Der Hauptteil einer einzigen Seite mit Ergebnissen für die Operationen ShareFileClient.listRanges und ShareFileClient.listRangesDiff .
FileParallelUploadOptions	Optionsschnittstelle für Datei – Uploadvorgänge See: ShareFileClient.uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	NFS-Eigenschaften. Beachten Sie, dass diese Eigenschaften nur für Dateien oder Verzeichnisse in Premium NFS-Dateikonten gelten.
FileProperties	Eine Schnittstelle für Optionen, die für jeden Remotevorgang gemeinsam sind.
FileProperty	Dateieigenschaften.
FileRenameHeaders	Definiert Kopfzeilen für File_rename Vorgang.
FileRenameOptions	Optionen zur Konfiguration der Operationen ShareFileClient.rename .
FileResizeOptions	Optionen zur Konfiguration der ShareFileClient.resize-Operation .
FileSASSignatureValues	NUR IN NODE.JS RUNTIME VERFÜGBAR. FileSASSignatureValues wird verwendet, um das Generieren von Dateidienst-SAS-Token für Freigaben oder Dateien zu unterstützen.
FileServiceProperties	Speicherdiensteigenschaften.
FileSetHTTPHeadersHeaders	Definiert Kopfzeilen für File_setHttpHeaders Vorgang.
FileSetHttpHeadersOptions	Optionen zur Konfiguration der ShareFileClient.setHttpHeaders-Operation .
FileSetMetadataHeaders	Definiert Kopfzeilen für File_setMetadata Vorgang.
FileSetMetadataOptions	Optionen zur Konfiguration der Operationen ShareFileClient.setMetadata .
FileStartCopyHeaders	Definiert Kopfzeilen für File_startCopy Vorgang.
FileStartCopyOptions	Optionen zur Konfiguration der Operation ShareFileClient.startCopyFromURL .
FileUploadRangeFromURLHeaders	Definiert Kopfzeilen für File_uploadRangeFromURL Vorgang.
FileUploadRangeFromURLOptions	Optionen zur Konfiguration der Operation ShareFileClient.uploadRangeFromURL .
FileUploadRangeHeaders	Definiert Kopfzeilen für File_uploadRange Vorgang.
FileUploadRangeOptions	Optionen zur Konfiguration der Operation ShareFileClient.uploadRange .
FileUploadStreamOptions	Optionsschnittstelle für ShareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Zusammenfassung für Einträge, die aus dem Verzeichnis aufgelistet werden können.
HandleItem	Ein aufgelistetes Azure Storage-Handle-Element.
HttpAuthorization	Stellt Authentifizierungsinformationen in Autorisierungs-, Proxyauthentifizierungs-, WWW-Authenticate- und Proxy-Authenticate Headerwerten dar.
HttpHeaders	Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
HttpOperationResponse	Http-Antwort, die mit core-v1(core-http) kompatibel ist.
HttpResponse	Eine Darstellung einer HTTP-Antwort, die einen Verweis auf die Anforderung enthält, die sie stammt.
LeaseAccessConditions	Gruppe "Parameter"
LeaseOperationOptions	Optionen für Leasevorgänge.
LeaseOperationResponseHeaders	Die Details der Antwort für einen bestimmten Leasingvorgang.
ListFilesAndDirectoriesSegmentResponse	Eine Aufzählung von Verzeichnissen und Dateien.
ListHandlesResponse	Eine Aufzählung von Handles.
ListSharesResponse	Eine Aufzählung von Freigaben.
ListSharesResponseModel	Eine Aufzählung von Freigaben.
Metadata
Metrics	Speicheranalysemetriken für den Dateidienst.
NfsFileMode	Die Modusberechtigungen der Datei oder des Verzeichnisses.
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	Optionsschnittstelle für den Pipeline-Konstruktor.
PosixRolePermissions	Stellt Dateiberechtigungen für eine bestimmte Rolle dar.
Range	Bereich für Dienstvorgänge. Siehe https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Ein Azure Storage-Dateibereich.
RequestPolicy	Eine kompatible Schnittstelle für Kern-HTTP-Anforderungsrichtlinien
RequestPolicyFactory	Eine Schnittstelle zur Kompatibilität mit der RequestPolicyFactory von Core-http
RequestPolicyOptions	Eine Schnittstelle zur Kompatibilität mit RequestPolicy
ResponseLike	Ein Objekt mit einer einfachen _response-Eigenschaft.
ResponseWithBody	Ein Objekt mit einer _response Eigenschaft mit Textkörper und Kopfzeilen, die bereits in bekannte Typen analysiert wurden.
ResponseWithHeaders	Ein Objekt mit einer _response-Eigenschaft, die bereits in ein typiertes Objekt analysiert wurde.
RetentionPolicy	Die Aufbewahrungsrichtlinie.
SasIPRange	Zulässiger IP-Bereich für eine SAS.
ServiceClientOptions	Eine Teilmenge von `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Optionen zur Konfiguration der ShareServiceClient.generateAccountSasUrl-Operation .
ServiceGetPropertiesHeaders	Definiert Kopfzeilen für Service_getProperties Vorgang.
ServiceGetPropertiesOptions	Optionen zur Konfiguration der Operationen ShareServiceClient.getProperties .
ServiceGetUserDelegationKeyHeaders	Definiert Header für Service_getUserDelegationKey Operation.
ServiceGetUserDelegationKeyOptions	Optionen zur Konfiguration des Dienstes – Erhalten Sie den Benutzerdelegierungsschlüssel.
ServiceListSharesOptions	Optionen zur Konfiguration der Operation ShareServiceClient.listShares .
ServiceListSharesSegmentHeaders	Definiert Kopfzeilen für Service_listSharesSegment Vorgang.
ServiceSetPropertiesHeaders	Definiert Kopfzeilen für Service_setProperties Vorgang.
ServiceSetPropertiesOptions	Optionen zur Konfiguration der Operation ShareServiceClient.setProperties .
ServiceUndeleteShareOptions	Optionen zum Konfigurieren des <xref:ShareServiceClient.undelete> Vorgangs.
SetPropertiesResponse	Enthält Antwortdaten für den setHttpHeaders-Vorgang.
ShareClientConfig
ShareCreateHeaders	Definiert Kopfzeilen für Share_create Vorgang.
ShareCreateIfNotExistsResponse	Enthält Antwortdaten für die Operationen ShareClient.createIfNotExists .
ShareCreateOptions	Optionen zur Konfiguration der ShareClient.create-Operation .
ShareCreatePermissionHeaders	Definiert Kopfzeilen für Share_createPermission Vorgang.
ShareCreatePermissionOptions	Optionen zur Konfiguration der Operationen ShareClient.createPermission .
ShareCreateSnapshotHeaders	Definiert Kopfzeilen für Share_createSnapshot Vorgang.
ShareCreateSnapshotOptions	Optionen zur Konfiguration der Operationen ShareClient.createSnapshot .
ShareDeleteHeaders	Definiert Kopfzeilen für Share_delete Vorgang.
ShareDeleteIfExistsResponse	Enthält Antwortdaten für die Operationen ShareClient.deleteIfExists .
ShareDeleteMethodOptions	Optionen zur Konfiguration der ShareClient.delete-Operation .
ShareExistsOptions	Optionen zur Konfiguration der ShareClient.exist-Operation .
ShareFileRange	Ein Bereich von Bytes innerhalb einer Azure-Datei, wie sie von ShareFileClient.listRanges und ShareFileClient.listRangesDiff zurückgegeben werden.
ShareFileRangeList	Die Liste der Dateibereiche
ShareGenerateSasUrlOptions	Optionen zur Konfiguration der ShareClient.generateSasUrl-Operation .
ShareGetAccessPolicyHeaders	Definiert Kopfzeilen für Share_getAccessPolicy Vorgang.
ShareGetAccessPolicyOptions	Optionen zur Konfiguration der Operationen ShareClient.getAccessPolicy .
ShareGetPermissionHeaders	Definiert Kopfzeilen für Share_getPermission Vorgang.
ShareGetPermissionOptions	Optionen zur Konfiguration der Operationen ShareClient.getPermission .
ShareGetPropertiesHeaders	Definiert Kopfzeilen für Share_getProperties Vorgang.
ShareGetPropertiesOptions	Optionen zur Konfiguration der Operationen ShareClient.getProperties .
ShareGetStatisticsHeaders	Definiert Kopfzeilen für Share_getStatistics Vorgang.
ShareGetStatisticsOptions	Optionen zur Konfiguration der Operationen ShareClient.getStatistics .
ShareGetUserDelegationKeyParameters	Parameter zum Erhalten des Benutzer-Delegationsschlüssels.
ShareItem	Ein aufgelistetes Azure Storage-Freigabeelement.
ShareItemInternal	Ein aufgelistetes Azure Storage-Freigabeelement.
ShareNfsSettings	Einstellungen für das SMB-Protokoll.
ShareNfsSettingsEncryptionInTransit	Verschlüsselung während des Transits aktivieren oder deaktivieren.
SharePermission	Eine Berechtigung (ein Sicherheitsdeskriptor) auf Freigabeebene.
SharePropertiesInternal	Eigenschaften einer Freigabe.
ShareProtocolSettings	Protokoll-Einstellungen
ShareProtocols	Protokolle, die für die Freigabe aktiviert werden sollen. Unterstützen Sie vorerst nur SMB oder NFS.
ShareSetAccessPolicyHeaders	Definiert Kopfzeilen für Share_setAccessPolicy Vorgang.
ShareSetAccessPolicyOptions	Optionen zur Konfiguration der Operationen ShareClient.setAccessPolicy .
ShareSetMetadataHeaders	Definiert Kopfzeilen für Share_setMetadata Vorgang.
ShareSetMetadataOptions	Optionen zur Konfiguration der ShareClient.setMetadata-Operation .
ShareSetPropertiesHeaders	Definiert Kopfzeilen für Share_setProperties Vorgang.
ShareSetPropertiesOptions	Optionen zur Konfiguration der Operation ShareClient.setProperties .
ShareSetQuotaOptions	Optionen zur Konfiguration der Operationen ShareClient.setQuota .
ShareSmbSettings	Einstellungen für das SMB-Protokoll.
ShareSmbSettingsEncryptionInTransit	Verschlüsselung während des Transits aktivieren oder deaktivieren.
ShareStats	Statistiken für die Freigabe.
SignedIdentifier	Signierter Bezeichner
SignedIdentifierModel	Signierter Bezeichner.
SmbMultichannel	Einstellungen für SMB Multichannel
SourceModifiedAccessConditions	Gruppe "Parameter"
StoragePipelineOptions	Optionsschnittstelle für die newPipeline--Funktion.
StorageRetryOptions	Speicher-BLOB-Wiederholungsoptionenschnittstelle.
UserDelegationKey	Ein Benutzerdelegierungsschlüssel.
UserDelegationKeyModel	Ein Benutzerdelegationsschlüssel
WebResource	Eine Beschreibung einer HTTP-Anforderung, die an einem Remoteserver gesendet werden soll.

Typaliase

CopyStatusType	Definiert Werte für CopyStatusType.
CredentialPolicyCreator	Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet.
DeleteSnapshotsOptionType	Definiert Werte für DeleteSnapshotsOptionType.
DirectoryCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
DirectoryDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
DirectoryForceCloseHandlesResponse	Antworttyp für ShareDirectoryClient.forceCloseHandle.
DirectoryGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
DirectoryListFilesAndDirectoriesSegmentResponse	Enthält Antwortdaten für den ListFilesAndDirectoriesSegment-Vorgang.
DirectoryListHandlesResponse	Enthält Antwortdaten für den listHandles-Vorgang.
DirectoryRenameResponse	Enthält Antwortdaten für den Umbenennungsvorgang.
DirectorySetMetadataResponse	Enthält Antwortdaten für den setMetadata-Vorgang.
DirectorySetPropertiesResponse	Enthält Antwortdaten für den setProperties-Vorgang.
FileAbortCopyResponse	Enthält Antwortdaten für den Vorgang "abortCopy".
FileAttributesPreserveType	Gibt an, dass vorhandene Dateiattribute unverändert bleiben.
FileCreateHardLinkResponse	Enthält Antwortdaten für den Vorgang zum Erstellen einer endgültigen Verknüpfung.
FileCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
FileCreateSymbolicLinkResponse	Enthält Antwortdaten für den Vorgang zum Erstellen einer endgültigen Verknüpfung.
FileDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
FileDownloadResponseModel	Enthält Antwortdaten für den Downloadvorgang.
FileForceCloseHandlesResponse	Antworttyp für ShareFileClient.forceCloseHandle.
FileGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
FileGetRangeListDiffResponse	Enthält Antwortdaten für den getRangeList-Vorgang.
FileGetRangeListResponse	Enthält Antwortdaten für die Operation ShareFileClient.getRangeList .
FileGetSymbolicLinkResponse	Enthält Antwortdaten für den Vorgang zum Erstellen einer endgültigen Verknüpfung.
FileLastWrittenMode	Definiert Werte für FileLastWrittenMode.
FileListHandlesResponse	Enthält Antwortdaten für den listHandles-Vorgang.
FileListRangesSegmentResponse	Enthält eine einzelne Seite mit Ergebnissen für die Operationen ShareFileClient.listRanges und ShareFileClient.listRangesDiff .
FilePermissionFormat	Definiert Werte für FilePermissionFormat.
FilePermissionInheritType	Gibt an, dass die Dateiberechtigung vom übergeordneten Verzeichnis geerbt wird.
FilePermissionPreserveType	Gibt an, dass der vorhandene Dateiberechtigungswert unverändert bleibt.
FileRenameResponse	Enthält Antwortdaten für den Umbenennungsvorgang.
FileSetHTTPHeadersResponse	Enthält Antwortdaten für den setHttpHeaders-Vorgang.
FileSetMetadataResponse	Enthält Antwortdaten für den setMetadata-Vorgang.
FileStartCopyResponse	Enthält Antwortdaten für den StartCopy-Vorgang.
FileUploadRangeFromURLResponse	Enthält Antwortdaten für den UploadRangeFromURL-Vorgang.
FileUploadRangeResponse	Enthält Antwortdaten für den UploadRange-Vorgang.
HttpRequestBody	Typen von Textkörpern, die auf der Anforderung unterstützt werden. NodeReadableStream und () => NodeReadableStream ist nur Knoten. Blob, WebReadableStream<Uint8Array> und () => WebReadableStream<Uint8Array> sind nur im Browser verfügbar.
LeaseDurationType	Definiert Werte für LeaseDurationType.
LeaseOperationResponse	Enthält die Antwortdaten für Vorgänge, die eine Lease abrufen, ändern, unterbrechen oder freigeben. Siehe ShareLeaseClient.
LeaseStateType	Definiert Werte für LeaseStateType.
LeaseStatusType	Definiert Werte für LeaseStatusType.
ListSharesIncludeType	Definiert Werte für ListSharesIncludeType.
ModeCopyMode	Definiert Werte für ModeCopyMode.
NfsFileType	Definiert Werte für NfsFileType. <xref:KnownNfsFileType> austauschbar mit NfsFileType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Regular Directory SymLink
OwnerCopyMode	Definiert Werte für OwnerCopyMode.
PermissionCopyModeType	Definiert Werte für PermissionCopyModeType.
RawFileDownloadResponse	Enthält Antwortdaten für den Downloadvorgang.
ServiceGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
ServiceGetUserDelegationKeyResponse	Enthält Antwortdaten für den getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) Vorgang.
ServiceListSharesSegmentResponse	Enthält Antwortdaten für die ShareServiceClient.listShares-Operation .
ServiceSetPropertiesResponse	Enthält Antwortdaten für den setProperties-Vorgang.
ShareAccessTier	Definiert Werte für ShareAccessTier.
ShareClientOptions
ShareCreatePermissionResponse	Enthält Antwortdaten für den createPermission-Vorgang.
ShareCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
ShareCreateSnapshotResponse	Enthält Antwortdaten für den createSnapshot-Vorgang.
ShareDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
ShareFileHandleAccessRights	Definiert Werte für AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Enthält Antwortdaten für den getPermission-Vorgang.
ShareGetPropertiesResponse	Enthält Antwortdaten für die ShareClient.getProperties-Operation .
ShareGetPropertiesResponseModel	Enthält Antwortdaten für den getProperties-Vorgang.
ShareGetStatisticsResponse	Antwortdaten für die ShareClient.getStatistics-Operation .
ShareGetStatisticsResponseModel	Enthält Antwortdaten für den getStatistics-Vorgang.
ShareProperties	Eigenschaften einer Freigabe.
ShareRootSquash	Definiert Werte für ShareRootSquash.
ShareSetAccessPolicyResponse	Enthält Antwortdaten für den setAccessPolicy-Vorgang.
ShareSetMetadataResponse	Enthält Antwortdaten für den setMetadata-Vorgang.
ShareSetPropertiesResponse	Enthält Antwortdaten für den setProperties-Vorgang.
ShareSetQuotaHeaders	Definiert Kopfzeilen für den SetQuota-Vorgang.
ShareSetQuotaResponse	Enthält Antwortdaten für den setQuota-Vorgang.
ShareTokenIntent	Definiert Werte für ShareTokenIntent. KnownShareTokenIntent- austauschbar mit ShareTokenIntent verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden backup
StorageChecksumAlgorithm	Zur Anzeige des Prüfsummen-Algorithmus, der bei der Inhaltsvalidierung verwendet wird.
TimeNowType	Gibt die Einstellung als Uhrzeit der Anforderung an.
TimePreserveType	Gibt an, dass der vorhandene Zeitwert unverändert bleibt.
WithResponse	Ein Typ, der ein Vorgangsergebnis mit einer bekannten _response-Eigenschaft darstellt.

Enumerationen

KnownShareTokenIntent	Bekannte Werte von ShareTokenIntent, die der Dienst akzeptiert.
SASProtocol	Protokolle für generierte SAS.
StorageFileAudience	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/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, UserDelegationKey, string)
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)
getFileServiceAccountAudience(string)	So rufen Sie die OAuth-Zielgruppe für ein Speicherkonto für den Dateidienst ab.
isPipelineLike(unknown)	Ein Helfer, der entscheidet, ob ein bestimmtes Argument dem Pipelinevertrag entspricht.
isRestError(unknown)	Typeguard für RestError
newPipeline(Credential \| TokenCredential, StoragePipelineOptions)	Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.
parseOctalFileMode(string)	Analysieren Sie eine 4-stellige oktale Zeichenfolgendarstellung eines Dateimodus in eine NfsFileMode- Struktur.
parseSymbolicFileMode(string)	Analysieren Sie eine 9-stellige symbolische Zeichenfolgendarstellung eines Dateimodus in eine NfsFileMode- Struktur.
toOctalFileMode(NfsFileMode)	Konvertieren Sie NfsFileMode- Struktur in eine 4-stellige Oktale Zeichenfolgenumsetzung.
toSymbolicFileMode(NfsFileMode)	Konvertieren Sie eine NfsFileMode- in eine Zeichenfolge in symbolische Schreibweise.

Variablen

RestError	Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
StorageOAuthScopes	Der OAuth-Scope zur Verwendung mit Azure Storage.
logger	Die Konfiguration `@azure/logger` dieses Pakets.

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/rest/api/storageservices/constructing-an-account-sas

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

Parameter

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Parameter

fileSASSignatureValues: FileSASSignatureValues

userDelegationKey: UserDelegationKey

accountName: string

Gibt zurück

SASQueryParameters

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

fileSASSignatureValues: FileSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Gibt zurück

SASQueryParameters

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

function getFileServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName: string

Gibt zurück

string

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

function isPipelineLike(pipeline: unknown): pipeline is PipelineLike

Parameter

pipeline: unknown

Ein Argument, das eine Pipeline sein kann

Gibt zurück

pipeline is PipelineLike

true, wenn das Argument dem Pipeline-Vertrag entspricht

Typeguard für RestError

function isRestError(e: unknown): e is RestError

Parameter

e: unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e is RestError

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen.

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

Parameter

credential: Credential | 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

Optional. Options.

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.

Analysieren Sie eine 4-stellige oktale Zeichenfolgendarstellung eines Dateimodus in eine NfsFileMode- Struktur.

function parseOctalFileMode(input?: string): NfsFileMode | undefined

Parameter

input: string

Gibt zurück

NfsFileMode | undefined

Analysieren Sie eine 9-stellige symbolische Zeichenfolgendarstellung eines Dateimodus in eine NfsFileMode- Struktur.

function parseSymbolicFileMode(input?: string): NfsFileMode | undefined

Parameter

input: string

Gibt zurück

NfsFileMode | undefined

Konvertieren Sie NfsFileMode- Struktur in eine 4-stellige Oktale Zeichenfolgenumsetzung.

function toOctalFileMode(input?: NfsFileMode): string | undefined

Parameter

input: NfsFileMode

Gibt zurück

string | undefined

Konvertieren Sie eine NfsFileMode- in eine Zeichenfolge in symbolische Schreibweise.

function toSymbolicFileMode(input?: NfsFileMode): string | undefined

Parameter

input: NfsFileMode

Gibt zurück

string | undefined

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ

RestErrorConstructor

Der OAuth-Scope zur Verwendung mit Azure Storage.

StorageOAuthScopes: string | string[]

Typ

string | string[]

Die Konfiguration @azure/logger dieses Pakets.

logger: AzureLogger

Typ

AzureLogger

@azure/storage-file-share package

Klassen

Schnittstellen

Typaliase

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Enumerationen

Functions

Variablen

Details zur Funktion

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parameter

Gibt zurück

generateFileSASQueryParameters(FileSASSignatureValues, UserDelegationKey, string)

Parameter

Gibt zurück

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

Parameter

Gibt zurück

getFileServiceAccountAudience(string)

Parameter

Gibt zurück

isPipelineLike(unknown)

Parameter

Gibt zurück

isRestError(unknown)

Parameter

Gibt zurück

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

Parameter

Gibt zurück

parseOctalFileMode(string)

Parameter

Gibt zurück

parseSymbolicFileMode(string)

Parameter

Gibt zurück

toOctalFileMode(NfsFileMode)

Parameter

Gibt zurück

toSymbolicFileMode(NfsFileMode)

Parameter

Gibt zurück

Details zu Variablen

RestError

Typ

StorageOAuthScopes

Typ

logger

Typ