@azure/storage-file-share package

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.

FileSASPermissions

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die von einem ServiceSAS für eine Datei gewährt werden. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Sobald alle Werte festgelegt sind, 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 zum Erstellen einer Zeichenfolge, die die NTFS-Attribute für eine Datei oder ein Verzeichnis darstellt.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes.

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 als Referenz, 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 FileSASSignatureValues 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.

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.

Anzeigen https://docs.microsoft.com/rest/api/storageservices/lease-file und Anzeigen https://docs.microsoft.com/rest/api/storageservices/lease-share

ShareSASPermissions

Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die Berechtigungen darstellt, die von einem ServiceSAS für eine Freigabe erteilt werden. Das Festlegen eines Werts auf true bedeutet, dass jede SAS, die diese Berechtigungen verwendet, Berechtigungen für diesen Vorgang erteilt. Sobald alle Werte festgelegt sind, sollte diese 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-Dateidienst dar, mit der Sie Dateifreigaben bearbeiten können.

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 zum Hinzufügen einer Zeitstempelabfrage zur GET/HEAD-Anforderungs-URL verwendet wird, um den Browsercache zu vermeiden.

  2. Entfernen des Cookieheaders aus Sicherheitsgründen

  3. Entfernen des Inhaltslängenheaders, um Browserwarnungen zu vermeiden

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory ist eine Factory-Klasse, die beim Generieren von BrowserPolicy-Objekten hilft.

StorageRetryPolicy

Wiederholungsrichtlinie mit implementiertem exponentiellen Wiederholungs- und linearen Wiederholungsversuch.

StorageRetryPolicyFactory

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

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.

WebResource

Erstellt ein neues WebResource-Objekt.

Diese Klasse bietet eine Abstraktion für einen REST-Aufruf, indem sie bibliotheksunabhängig ist und die erforderlichen Eigenschaften umgibt, um eine Anforderung zu initiieren.

Schnittstellen

AccessPolicy

Eine Zugriffsrichtlinie.

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 entsprechend festgelegt wurden, rufen Sie generateAccountSASQueryParameters auf, um eine Darstellung der SAS zu erhalten, die tatsächlich auf Datei-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.

ClearRange
CloseHandlesInfo

Schließen behandelt Ergebnisinformationen.

CommonGenerateSasUrlOptions

Allgemeine Optionen der ShareGenerateSasUrlOptions und FileGenerateSasUrlOptions.

CommonOptions

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

CopyFileSmbInfo

Parametergruppe

CorsRule

CORS ist eine HTTP-Funktion, die einer Webanwendung in einer Domäne den Zugriff auf Ressourcen in einer anderen Domäne ermöglicht. Webbrowser implementieren eine als same-origin-Richtlinie bekannte Sicherheitseinschränkung, die verhindert, dass eine Website APIs in einer anderen Domäne aufruft. CORS ist eine sichere Methode, um einer Domäne (der Ursprungsdomäne) den Aufruf von APIs in einer anderen Domäne zu ermöglichen.

DirectoryCloseHandlesHeaders

Zusätzliche Antwortheaderwerte für Close Handles-Anforderungen.

DirectoryCreateHeaders

Definiert Header für Directory_create Vorgang.

DirectoryCreateIfNotExistsResponse

Enthält Antwortdaten für den createIfNotExists(DirectoryCreateOptions) Vorgang.

DirectoryCreateOptions

Optionen zum Konfigurieren des Erstellungsvorgangs .

DirectoryDeleteHeaders

Definiert Header für Directory_delete Vorgang.

DirectoryDeleteIfExistsResponse

Enthält Antwortdaten für den deleteIfExists(DirectoryDeleteOptions) Vorgang.

DirectoryDeleteOptions

Optionen zum Konfigurieren des Löschvorgangs .

DirectoryExistsOptions

Optionen zum Konfigurieren des Exists-Vorgangs .

DirectoryForceCloseHandlesHeaders

Definiert Header für Directory_forceCloseHandles Vorgang.

DirectoryForceCloseHandlesOptions

Optionen zum Konfigurieren von forceCloseHandle.

DirectoryForceCloseHandlesSegmentOptions

Optionen zum Konfigurieren des Verzeichnisses: Erzwingen von Segmentvorgängen zum Schließen von Handles.

Thema

DirectoryGetPropertiesHeaders

Definiert Header für Directory_getProperties Vorgang.

DirectoryGetPropertiesOptions

Optionen zum Konfigurieren des getProperties-Vorgangs .

DirectoryItem

Ein aufgelistetes Verzeichniselement.

DirectoryListFilesAndDirectoriesOptions

Optionen zum Konfigurieren des ListFilesAndDirectories-Vorgangs .

DirectoryListFilesAndDirectoriesSegmentHeaders

Definiert Header für Directory_listFilesAndDirectoriesSegment Vorgang.

DirectoryListHandlesHeaders

Definiert Header für Directory_listHandles Vorgang.

DirectoryListHandlesOptions

Optionen zum Konfigurieren des listHandles-Vorgangs .

DirectoryListHandlesSegmentOptions

Optionen zum Konfigurieren des Verzeichnisses: Liste behandelt Segmentvorgänge.

Thema

  • <xref:ShareDirectoryClient.listHandlesSegment>
  • <xref:ShareDirectoryClient.iterateHandleSegments>
  • <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties

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

DirectoryRenameHeaders

Definiert Header für Directory_rename Vorgang.

DirectoryRenameOptions

Optionen zum Konfigurieren des Umbenennungsvorgangs .

DirectorySetMetadataHeaders

Definiert Header für Directory_setMetadata Vorgang.

DirectorySetMetadataOptions

Optionen zum Konfigurieren des vorgangs setMetadata .

DirectorySetPropertiesHeaders

Definiert Header für Directory_setProperties Vorgang.

FileAbortCopyFromURLOptions

Optionen zum Konfigurieren des abortCopyFromURL-Vorgangs .

FileAbortCopyHeaders

Definiert Header für File_abortCopy Vorgang.

FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions

Optionen zum Konfigurieren des clearRange-Vorgangs .

FileCloseHandlesHeaders

Zusätzliche Antwortheaderwerte für Close Handles-Anforderungen.

FileCreateHeaders

Definiert Header für File_create Vorgang.

FileCreateOptions

Optionen zum Konfigurieren des Erstellungsvorgangs .

FileDeleteHeaders

Definiert Header für File_delete Vorgang.

FileDeleteIfExistsResponse

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

FileDeleteOptions

Optionen zum Konfigurieren des Löschvorgangs .

FileDownloadHeaders

Definiert Header für File_download Vorgang.

FileDownloadOptionalParams

Optionale Parameter.

FileDownloadOptions

Optionen zum Konfigurieren von Datei - Downloadvorgängen.

Thema

FileDownloadToBufferOptions

Optionsschnittstelle für den DownloadToBuffer-Vorgang .

FileExistsOptions

Optionen zum Konfigurieren des vorgangs exists .

FileForceCloseHandlesHeaders

Definiert Header für File_forceCloseHandles Vorgang.

FileForceCloseHandlesOptions

Optionen zum Konfigurieren der Datei: Erzwingen von Vorgängen zum Schließen von Handles.

Thema

FileGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .

FileGetPropertiesHeaders

Definiert Header für File_getProperties Vorgang.

FileGetPropertiesOptions

Optionen zum Konfigurieren des getProperties-Vorgangs .

FileGetRangeListHeaders

Definiert Header für File_getRangeList Vorgang.

FileGetRangeListOptions

Optionen zum Konfigurieren des getRangeList-Vorgangs .

FileHttpHeaders
FileItem

Ein aufgelistetes Dateielement.

FileListHandlesHeaders

Definiert Header für File_listHandles Vorgang.

FileListHandlesOptions

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

FileListHandlesSegmentOptions

Optionen zum Konfigurieren der Datei: Liste behandelt Segmentvorgänge.

Thema

  • <xref:ShareFileClient.listHandlesSegment>
  • <xref:ShareFileClient.iterateHandleSegments>
  • <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions

Optionsschnittstelle für Datei – Uploadvorgänge

Thema

  • Uploadfile
  • <xref:ShareFileClient.uploadSeekableStream>
FileProperties

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

FileProperty

Dateieigenschaften.

FileRenameHeaders

Definiert Header für File_rename Vorgang.

FileRenameOptions

Optionen zum Konfigurieren des Umbenennungsvorgangs .

FileResizeOptions

Optionen zum Konfigurieren des Größenänderungsvorgangs .

FileSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR.

FileSASSignatureValues wird verwendet, um dateidienst-SAS-Token für Freigaben oder Dateien zu generieren.

FileServiceProperties

Speicherdiensteigenschaften.

FileSetHTTPHeadersHeaders

Definiert Header für File_setHttpHeaders Vorgang.

FileSetHttpHeadersOptions

Optionen zum Konfigurieren des Vorgangs setHttpHeaders .

FileSetMetadataHeaders

Definiert Header für File_setMetadata Vorgang.

FileSetMetadataOptions

Optionen zum Konfigurieren des vorgangs setMetadata .

FileStartCopyHeaders

Definiert Header für File_startCopy Vorgang.

FileStartCopyOptions

Optionen zum Konfigurieren des startCopyFromURL-Vorgangs .

FileUploadRangeFromURLHeaders

Definiert Header für File_uploadRangeFromURL Vorgang.

FileUploadRangeFromURLOptionalParams

Optionale Parameter.

FileUploadRangeFromURLOptions

Optionen zum Konfigurieren des UploadRangeFromURL-Vorgangs .

FileUploadRangeHeaders

Definiert Header für File_uploadRange Vorgang.

FileUploadRangeOptions

Optionen zum Konfigurieren des uploadRange-Vorgangs .

FileUploadStreamOptions

Optionsschnittstelle für ShareFileClient.uploadStream().

FilesAndDirectoriesListSegment

Abstract für Einträge, die aus Verzeichnis aufgelistet werden können.

HandleItem

Ein aufgeführtes Azure Storage-Handle-Element.

HttpAuthorization

Stellt Authentifizierungsinformationen in Authorization-, ProxyAuthorization-, WWW-Authenticate- und Proxy-Authenticate-Headerwerten dar.

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.

LeaseAccessConditions

Parametergruppe

LeaseOperationOptions

Optionen für Leasevorgänge.

LeaseOperationResponseHeaders

Die Details der Antwort für einen bestimmten Leasevorgang.

ListFilesAndDirectoriesSegmentResponse

Eine Enumeration von Verzeichnissen und Dateien.

ListHandlesResponse

Eine Enumeration von Handles.

ListSharesResponse

Eine Enumeration von Freigaben.

ListSharesResponseModel

Eine Enumeration von Freigaben.

Metadata
Metrics

Storage Analytics Metriken für den Dateidienst.

PipelineOptions

Optionsschnittstelle für pipeline-Konstruktor.

Range

Bereich für Dienstvorgänge.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations.

RangeModel

Ein Azure Storage-Dateibereich.

RequestPolicy

Die zugrunde liegende Struktur einer Anforderungsrichtlinie.

RetentionPolicy

Die Aufbewahrungsrichtlinie.

SasIPRange

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

ServiceGenerateAccountSasUrlOptions

Optionen zum Konfigurieren des GenerateAccountSasUrl-Vorgangs .

ServiceGetPropertiesHeaders

Definiert Header für Service_getProperties Vorgang.

ServiceGetPropertiesOptions

Optionen zum Konfigurieren des getProperties-Vorgangs .

ServiceListSharesOptions

Optionen zum Konfigurieren des listShares-Vorgangs .

ServiceListSharesSegmentHeaders

Definiert Header für Service_listSharesSegment Vorgang.

ServiceSetPropertiesHeaders

Definiert Header für Service_setProperties Vorgang.

ServiceSetPropertiesOptions

Optionen zum Konfigurieren des Vorgangs setProperties .

ServiceUndeleteShareOptions

Optionen zum Konfigurieren des Vorgangs <xref:ShareServiceClient.undelete> .

SetPropertiesResponse

Enthält Antwortdaten für den SetHttpHeaders-Vorgang.

ShareClientConfig
ShareCreateHeaders

Definiert Header für Share_create Vorgang.

ShareCreateIfNotExistsResponse

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

ShareCreateOptions

Optionen zum Konfigurieren des Erstellungsvorgangs .

ShareCreatePermissionHeaders

Definiert Header für Share_createPermission Vorgang.

ShareCreatePermissionOptions

Optionen zum Konfigurieren des CreatePermission-Vorgangs .

ShareCreateSnapshotHeaders

Definiert Header für Share_createSnapshot Vorgang.

ShareCreateSnapshotOptions

Optionen zum Konfigurieren des createSnapshot-Vorgangs .

ShareDeleteHeaders

Definiert Header für Share_delete Vorgang.

ShareDeleteIfExistsResponse

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

ShareDeleteMethodOptions

Optionen zum Konfigurieren des Löschvorgangs .

ShareExistsOptions

Optionen zum Konfigurieren des Exists-Vorgangs .

ShareFileRangeList

Die Liste der Dateibereiche

ShareGenerateSasUrlOptions

Optionen zum Konfigurieren des GenerateSasUrl-Vorgangs .

ShareGetAccessPolicyHeaders

Definiert Header für Share_getAccessPolicy Vorgang.

ShareGetAccessPolicyOptions

Optionen zum Konfigurieren des getAccessPolicy-Vorgangs .

ShareGetPermissionHeaders

Definiert Header für Share_getPermission Vorgang.

ShareGetPermissionOptions

Optionen zum Konfigurieren des getPermission-Vorgangs .

ShareGetPropertiesHeaders

Definiert Header für Share_getProperties Vorgang.

ShareGetPropertiesOptions

Optionen zum Konfigurieren des getProperties-Vorgangs .

ShareGetStatisticsHeaders

Definiert Header für Share_getStatistics Vorgang.

ShareGetStatisticsOptions

Optionen zum Konfigurieren des getStatistics-Vorgangs .

ShareItem

Ein aufgelistetes Azure Storage-Freigabeelement.

ShareItemInternal

Ein aufgelistetes Azure Storage-Freigabeelement.

SharePermission

Eine Berechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene.

SharePropertiesInternal

Eigenschaften einer Freigabe.

ShareProtocolSettings

Protokolleinstellungen

ShareProtocols

Protokolle, die für die Freigabe aktiviert werden sollen. Derzeit wird nur SMB oder NFS unterstützt.

ShareSetAccessPolicyHeaders

Definiert Header für Share_setAccessPolicy Vorgang.

ShareSetAccessPolicyOptions

Optionen zum Konfigurieren des vorgangs setAccessPolicy .

ShareSetMetadataHeaders

Definiert Header für Share_setMetadata Vorgang.

ShareSetMetadataOptions

Optionen zum Konfigurieren des vorgangs setMetadata .

ShareSetPropertiesHeaders

Definiert Header für Share_setProperties Vorgang.

ShareSetPropertiesOptions

Optionen zum Konfigurieren des Vorgangs setProperties .

ShareSetQuotaOptions

Optionen zum Konfigurieren des vorgangs setQuota .

ShareSmbSettings

Einstellungen für das SMB-Protokoll.

ShareStats

Statistiken für die Freigabe.

SignedIdentifier

Signierter Bezeichner

SignedIdentifierModel

Signierter Bezeichner.

SmbMultichannel

Einstellungen für SMB Multichannel

SourceModifiedAccessConditions

Parametergruppe

StoragePipelineOptions

Optionsschnittstelle für die newPipeline-Funktion .

StorageRetryOptions

Schnittstelle für Wiederholungsoptionen.

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 forceCloseHandle.

DirectoryGetPropertiesResponse

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

DirectoryListFilesAndDirectoriesSegmentResponse

Enthält Antwortdaten für den Vorgang listFilesAndDirectoriesSegment.

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 abortCopy-Vorgang.

FileAttributesPreserveType

Gibt an, dass vorhandene Dateiattribute unverändert bleiben.

FileCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.

FileDeleteResponse

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

FileDownloadResponseModel

Enthält Antwortdaten für den Downloadvorgang.

FileForceCloseHandlesResponse

Antworttyp für 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 den getRangeList-Vorgang .

FileLastWrittenMode

Definiert Werte für FileLastWrittenMode.

FileListHandlesResponse

Enthält Antwortdaten für den listHandles-Vorgang.

FilePermissionInheritType

Gibt die Berechtigung zum Erben einer Datei aus dem übergeordneten Verzeichnis an.

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

Mögliche HTTP-Anforderungstexttypen

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.

PermissionCopyModeType

Definiert Werte für PermissionCopyModeType.

RequestPolicyFactory

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

ServiceGetPropertiesResponse

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

ServiceListSharesSegmentResponse

Enthält Antwortdaten für den ListShares-Vorgang .

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 den getProperties-Vorgang .

ShareGetPropertiesResponseModel

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

ShareGetStatisticsResponse

Antwortdaten für den getStatistics-Vorgang .

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 Header für den setQuota-Vorgang.

ShareSetQuotaResponse

Enthält Antwortdaten für den setQuota-Vorgang.

ShareTokenIntent

Definiert Werte für ShareTokenIntent.
KnownShareTokenIntent kann austauschbar mit ShareTokenIntent verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

backup

TimeNowType

Gibt die Einstellung als Uhrzeit der Anforderung an.

TimePreserveType

Gibt an, dass der vorhandene Zeitwert unverändert bleibt.

Enumerationen

KnownShareTokenIntent

Bekannte Werte von ShareTokenIntent , die der Dienst akzeptiert.

SASProtocol

Protokolle für generierte SAS.

StorageFileAudience

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.

generateFileSASQueryParameters(FileSASSignatureValues, 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. 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 ablaufendesOn erforderlich. Sie MÜSSEN dem Bezeichner Wert zuweisen oder ablaufenOn & Berechtigungen manuell, wenn Sie mit diesem Konstruktor initialisieren.

getFileServiceAccountAudience(string)
newPipeline(Credential_2 | 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

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

generateFileSASQueryParameters(FileSASSignatureValues, 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. 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 ablaufendesOn erforderlich. Sie MÜSSEN dem Bezeichner Wert zuweisen oder ablaufenOn & Berechtigungen manuell, wenn Sie mit diesem Konstruktor initialisieren.

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

Parameter

fileSASSignatureValues
FileSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Gibt zurück

getFileServiceAccountAudience(string)

function getFileServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName

string

Gibt zurück

string

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Erstellt ein neues Pipelineobjekt mit bereitgestellten Anmeldeinformationen .

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

Parameter

credential

Credential | TokenCredential

z. B. AnonymousCredential, StorageSharedKeyCredential.

pipelineOptions
StoragePipelineOptions

Optional. Optionen.

Gibt zurück

Ein neues Pipelineobjekt.