@azure/storage-file package

Klassen

Aborter	Ein Aborter instance die AbortSignal-Schnittstelle implementiert, kann HTTP-Anforderungen abbrechen. Rufen Sie Aborter.none auf, um eine neue aborter-instance ohne Timeout zu erstellen. Rufen Sie Aborter.timeout() auf, um eine neue Aborter-instance mit Timeout zu erstellen. Für einen vorhandenen instance Aborter: Rufen Sie aborter.withTimeout() auf, um eine untergeordnete Aborter-instance mit Timeout zu erstellen und zurückzugeben. Rufen Sie aborter.withValue(key, value) auf, um ein untergeordnetes Aborter-instance mit Schlüssel-Wert-Paar zu erstellen und zurückzugeben. Rufen Sie aborter.aborter() auf, um aktuelle instance und alle untergeordneten Instanzen abzubrechen. Rufen Sie aborter.getValue(key) auf, um den Wert mit dem entsprechenden Schlüssel aus dem aktuellen Aborter für alle eltern abzurufen. Beispiel // Abort without timeout await fileURL.uploadRange(Aborter.none, buf, 0, buf.length); Beispiel // Abort container create in 1000ms await fileURL.uploadRange(Aborter.timeout(1000), buf, 0, buf.length); Beispiel // Share aborter cross multiple operations in 30s // Upload the same data to 2 different data centers at the same time, abort another when any of them is finished const aborter = Aborter.timeout(30 * 1000); fileURL1.uploadRange(aborter, buf, 0, buf.length).then(aborter.abort); fileURL2.uploadRange(aborter, buf, 0, buf.length).then(aborter.abort); Beispiel // Cascaded aborting // All operations can't take more than 30 seconds const aborter = Aborter.timeout(30 * 1000); // Following 2 operations can't take more than 25 seconds await fileURL.uploadRange(aborter.withTimeout(25 * 1000), buf, 0, buf.length); await fileURL.uploadRange(aborter.withTimeout(25 * 1000), buf, 0, buf.length);
AccountSASPermissions	NUR IN NODE.JS RUNTIME VERFÜGBAR. Dies ist eine Hilfsklasse zum Erstellen einer Zeichenfolge, die die von einem AccountSAS gewährten Berechtigungen darstellt. 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 IAccountSASSignatureValues-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. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Ressourcenfeld für ein IAccountSASSignatureValues-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 IAccountSASSignatureValues-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-Member 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
BrowserPolicyFactory	BrowserPolicyFactory ist eine Factoryklasse, die beim Generieren von BrowserPolicy-Objekten hilft.
Credential	Anmeldeinformationen sind eine abstrakte Klasse für die Signatur von HTTP-Anforderungen in Azure Storage. Diese Klasse hostt eine credentialPolicyCreator-Factory, die CredentialPolicy generiert.
CredentialPolicy	Anmeldeinformationsrichtlinie, die zum Signieren von HTTP(S)-Anforderungen vor dem Senden verwendet wird. Dies ist eine abstrakte Klasse.
DirectoryURL	Eine DirectoryURL stellt eine URL zum Azure Storage-Verzeichnis dar, mit der Sie seine Dateien und Verzeichnisse bearbeiten können.
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. Nachdem alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein IFileSASSignatureValues-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.
FileURL	Eine FileURL stellt eine URL zu einer Azure Storage-Datei dar.
HttpHeaders	Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.
LoggingPolicyFactory	LoggingPolicyFactory ist eine Factoryklasse, die beim Generieren von LoggingPolicy-Objekten hilft.
Pipeline	Eine Pipelineklasse, die HTTP-Anforderungsrichtlinien enthält. Sie können eine Standardpipeline erstellen, indem Sie StorageURL.newPipeline() aufrufen. Alternativ können Sie eine Pipeline mit Ihren eigenen Richtlinien durch den Konstruktor von Pipeline erstellen. Lesen Sie StorageURL.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
RetryPolicyFactory	RetryPolicyFactory ist eine Factoryklasse, die beim Generieren von RetryPolicy-Objekten hilft.
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 IAccountSASSignatureValues und IFileSASSignatureValues generiert. Nach der Generierung kann sie in eine {@code Zeichenfolge} codiert und direkt an eine URL angefügt werden (wobei hier Vorsicht geboten ist, falls bereits Abfrageparameter vorhanden sind, was sich auf die geeignete Methode zum Anfügen dieser Abfrageparameter auswirken kann). HINWEIS: Instanzen dieser Klasse sind unveränderlich.
ServiceURL	Eine ServiceURL stellt eine URL zum Azure Storage-Dateidienst dar, mit der Sie Dateifreigaben bearbeiten können.
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 dies mit toString serialisiert und als Berechtigungsfeld für ein IFileSASSignatureValues-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.
ShareURL	Eine ShareURL stellt eine URL zur Azure Storage-Freigabe dar, mit der Sie ihre Verzeichnisse und Dateien bearbeiten können.
SharedKeyCredential	NUR IN NODE.JS RUNTIME VERFÜGBAR. SharedKeyCredential für die Kontoschlüsselautorisierung des Azure Storage-Diensts.
SharedKeyCredentialPolicy	SharedKeyCredentialPolicy ist eine Richtlinie, die zum Signieren von HTTP-Anforderungen mit einem freigegebenen Schlüssel verwendet wird.
StorageURL	Ein ServiceURL stellt eine basierende URL-Klasse für ServiceURL, ContainerURL usw. dar.
TelemetryPolicyFactory	TelemetryPolicyFactory ist eine Factoryklasse, die das Generieren von TelemetryPolicy-Objekten unterstützt.
UniqueRequestIDPolicyFactory	UniqueRequestIDPolicyFactory ist eine Factoryklasse, die das Generieren von UniqueRequestIDPolicy-Objekten unterstützt.
WebResource	Erstellt ein neues WebResource-Objekt. Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsunabhängig ist und die erforderlichen Eigenschaften umschlossen, um eine Anforderung zu initiieren.

Schnittstellen

AccessPolicy	Eine Zugriffsrichtlinie.
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.
DirectoryCreateHeaders	Definiert Header für den Create-Vorgang.
DirectoryCreateOptionalParams	Optionale Parameter.
DirectoryDeleteHeaders	Definiert Header für den Löschvorgang.
DirectoryDeleteMethodOptionalParams	Optionale Parameter.
DirectoryForceCloseHandlesHeaders	Definiert Header für den ForceCloseHandles-Vorgang.
DirectoryForceCloseHandlesOptionalParams	Optionale Parameter.
DirectoryGetPropertiesHeaders	Definiert Header für den GetProperties-Vorgang.
DirectoryGetPropertiesOptionalParams	Optionale Parameter.
DirectoryItem	Ein aufgelistetes Verzeichniselement.
DirectoryListFilesAndDirectoriesSegmentHeaders	Definiert Header für den ListFilesAndDirectoriesSegment-Vorgang.
DirectoryListFilesAndDirectoriesSegmentOptionalParams	Optionale Parameter.
DirectoryListHandlesHeaders	Definiert Header für den ListHandles-Vorgang.
DirectoryListHandlesOptionalParams	Optionale Parameter.
DirectorySetMetadataHeaders	Definiert Header für den SetMetadata-Vorgang.
DirectorySetMetadataOptionalParams	Optionale Parameter.
DirectorySetPropertiesHeaders	Definiert Header für den SetProperties-Vorgang.
DirectorySetPropertiesOptionalParams	Optionale Parameter.
FileAbortCopyHeaders	Definiert Header für den AbortCopy-Vorgang.
FileAbortCopyOptionalParams	Optionale Parameter.
FileCreateHeaders	Definiert Header für den Create-Vorgang.
FileCreateOptionalParams	Optionale Parameter.
FileDeleteHeaders	Definiert Header für den Löschvorgang.
FileDeleteMethodOptionalParams	Optionale Parameter.
FileDownloadHeaders	Definiert Header für den Downloadvorgang.
FileDownloadOptionalParams	Optionale Parameter.
FileForceCloseHandlesHeaders	Definiert Header für den ForceCloseHandles-Vorgang.
FileForceCloseHandlesOptionalParams	Optionale Parameter.
FileGetPropertiesHeaders	Definiert Header für den GetProperties-Vorgang.
FileGetPropertiesOptionalParams	Optionale Parameter.
FileGetRangeListHeaders	Definiert Header für den GetRangeList-Vorgang.
FileGetRangeListOptionalParams	Optionale Parameter.
FileHTTPHeaders	Zusätzliche Parameter für eine Reihe von Vorgängen, z. B.: File_create, File_setHTTPHeaders.
FileItem	Ein aufgelistetes Dateielement.
FileListHandlesHeaders	Definiert Header für den ListHandles-Vorgang.
FileListHandlesOptionalParams	Optionale Parameter.
FileProperty	Dateieigenschaften.
FilesAndDirectoriesListSegment	Abstract für Einträge, die aus Verzeichnis aufgelistet werden können.
FileSetHTTPHeadersHeaders	Definiert Header für den SetHTTPHeaders-Vorgang.
FileSetHTTPHeadersOptionalParams	Optionale Parameter.
FileSetMetadataHeaders	Definiert Header für den SetMetadata-Vorgang.
FileSetMetadataOptionalParams	Optionale Parameter.
FileStartCopyHeaders	Definiert Header für den StartCopy-Vorgang.
FileStartCopyOptionalParams	Optionale Parameter.
FileUploadRangeFromURLHeaders	Definiert Header für den UploadRangeFromURL-Vorgang.
FileUploadRangeFromURLOptionalParams	Optionale Parameter.
FileUploadRangeHeaders	Definiert Header für den UploadRange-Vorgang.
FileUploadRangeOptionalParams	Optionale Parameter.
HandleItem	Ein aufgeführtes Azure Storage-Handle-Element.
ListFilesAndDirectoriesSegmentResponse	Eine Enumeration von Verzeichnissen und Dateien.
ListHandlesResponse	Eine Enumeration von Handles.
ListSharesResponse	Eine Enumeration von Freigaben.
Metrics	Storage Analytics Metriken für den Dateidienst.
Permission	Berechtigung (ein Sicherheitsdeskriptor), der in der Security Descriptor Definition Language (SDDL) beschrieben wird.
Range	Ein Azure Storage-Dateibereich.
RetentionPolicy	Die Aufbewahrungsrichtlinie.
ServiceGetPropertiesHeaders	Definiert Header für den GetProperties-Vorgang.
ServiceGetPropertiesOptionalParams	Optionale Parameter.
ServiceListSharesSegmentHeaders	Definiert Header für den ListSharesSegment-Vorgang.
ServiceListSharesSegmentOptionalParams	Optionale Parameter.
ServiceSetPropertiesHeaders	Definiert Header für den SetProperties-Vorgang.
ServiceSetPropertiesOptionalParams	Optionale Parameter.
ShareCreateHeaders	Definiert Header für den Erstellungsvorgang.
ShareCreateOptionalParams	Optionale Parameter.
ShareCreatePermissionHeaders	Definiert Header für den CreatePermission-Vorgang.
ShareCreatePermissionOptionalParams	Optionale Parameter.
ShareCreateSnapshotHeaders	Definiert Header für den CreateSnapshot-Vorgang.
ShareCreateSnapshotOptionalParams	Optionale Parameter.
ShareDeleteHeaders	Definiert Header für den Löschvorgang.
ShareDeleteMethodOptionalParams	Optionale Parameter.
ShareGetAccessPolicyHeaders	Definiert Header für den GetAccessPolicy-Vorgang.
ShareGetAccessPolicyOptionalParams	Optionale Parameter.
ShareGetPermissionHeaders	Definiert Header für den GetPermission-Vorgang.
ShareGetPermissionOptionalParams	Optionale Parameter.
ShareGetPropertiesHeaders	Definiert Header für den GetProperties-Vorgang.
ShareGetPropertiesOptionalParams	Optionale Parameter.
ShareGetStatisticsHeaders	Definiert Header für getStatistics-Vorgänge.
ShareGetStatisticsOptionalParams	Optionale Parameter.
ShareItem	Ein aufgelistetes Azure Storage-Freigabeelement.
ShareProperties	Eigenschaften einer Freigabe.
ShareSetAccessPolicyHeaders	Definiert Header für den SetAccessPolicy-Vorgang.
ShareSetAccessPolicyOptionalParams	Optionale Parameter.
ShareSetMetadataHeaders	Definiert Header für den SetMetadata-Vorgang.
ShareSetMetadataOptionalParams	Optionale Parameter.
ShareSetQuotaHeaders	Definiert Header für den SetQuota-Vorgang.
ShareSetQuotaOptionalParams	Optionale Parameter.
ShareStats	Statistiken für die Freigabe.
SignedIdentifier	Signierter Bezeichner.
SourceModifiedAccessConditions	Zusätzliche Parameter für uploadRangeFromURL-Vorgang.
StorageError	Eine Schnittstelle, die StorageError darstellt.
StorageServiceProperties	Eigenschaften des Speicherdiensts.
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.
IAccountSASSignatureValues	NUR IN NODE.JS RUNTIME VERFÜGBAR. IAccountSASSignatureValues wird verwendet, um eine SAS (Shared Access Signature) für ein Azure Storage-Konto zu generieren. Nachdem alle hier angegebenen Werte entsprechend festgelegt wurden, rufen Sie generateSASQueryParameters() 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 veränderlich 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 Beschreibungen https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas der Parameter, einschließlich der erforderlichen Parameter.
IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IDownloadFromAzureFileOptions	Optionsschnittstelle für DownloadAzurefileToBuffer.
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions	Die Option ist als Parität zur REST-Definition definiert. Obwohl es nicht bereit ist, jetzt verwendet zu werden, da Crc64 von Quellinhalten nicht zugänglich ist.
IFileListHandlesSegmentOptions
IFileProperties
IFileSASSignatureValues	NUR IN NODE.JS RUNTIME VERFÜGBAR. IFileSASSignatureValues wird verwendet, um dateidienst-SAS-Token für Freigaben oder Dateien zu generieren.
IFileStartCopyOptions
IFileUploadRangeOptions
IHttpClient	Eine Schnittstelle, die HttpRequests senden und zugesagte HttpResponses empfangen kann.
IHttpPipelineLogger	Eine Protokollierung, die einer HttpPipeline hinzugefügt werden kann. Dadurch kann jede RequestPolicy Nachrichten protokollieren, die für Debuggingzwecke verwendet werden können.
IIPRange	Zulässiger IP-Bereich für eine SAS.
INewPipelineOptions	Optionsschnittstelle für die Pipeline.newPipeline-Methode.
IPipelineOptions	Optionsschnittstelle für pipeline-Konstruktor.
IRange	Bereich für Dienstvorgänge. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations.
IRequestLogOptions	RequestLogOptions konfiguriert das Verhalten der Wiederholungsrichtlinie.
IRetryOptions	Schnittstelle für Wiederholungsoptionen.
IServiceListSharesSegmentOptions
ISetPropertiesResponse	Enthält Antwortdaten für den SetHTTPHeaders-Vorgang.
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
ITelemetryOptions	Schnittstelle von TelemetryPolicy-Optionen.
IUploadStreamToAzureFileOptions	Optionsschnittstelle für uploadStreamToAzureFile.
IUploadToAzureFileOptions	Optionsschnittstelle für uploadFileToAzureFile und uploadSeekableStreamToAzureFile.
RequestPolicy

Typaliase

CopyStatusType	Definiert Werte für CopyStatusType. Mögliche Werte: "ausstehend", "erfolg", "abgebrochen", "failed"
DeleteSnapshotsOptionType	Definiert Werte für DeleteSnapshotsOptionType. Mögliche Werte: 'include'
DirectoryCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
DirectoryDeleteResponse	Enthält Antwortdaten für den deleteMethod-Vorgang.
DirectoryForceCloseHandlesResponse	Enthält Antwortdaten für den forceCloseHandles-Vorgang.
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.
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 AbbruchKopievorgang.
FileCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
FileDeleteResponse	Enthält Antwortdaten für den deleteMethod-Vorgang.
FileDownloadResponse	Enthält Antwortdaten für den Downloadvorgang.
FileForceCloseHandlesResponse	Enthält Antwortdaten für den forceCloseHandles-Vorgang.
FileGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
FileGetRangeListResponse	Enthält Antwortdaten für den getRangeList-Vorgang.
FileListHandlesResponse	Enthält Antwortdaten für den listHandles-Vorgang.
FileRangeWriteType	Definiert Werte für FileRangeWriteType. Mögliche Werte: "update", "clear"
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.
FileType	Definiert Werte für FileType. Mögliche Werte sind: "File"
FileUploadRangeFromURLResponse	Enthält Antwortdaten für den UploadRangeFromURL-Vorgang.
FileUploadRangeResponse	Enthält Antwortdaten für den UploadRange-Vorgang.
ListSharesIncludeType	Definiert Werte für ListSharesIncludeType. Mögliche Werte: "Momentaufnahmen", "Metadaten"
ServiceGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
ServiceListSharesSegmentResponse	Enthält Antwortdaten für den ListSharesSegment-Vorgang.
ServiceSetPropertiesResponse	Enthält Antwortdaten für den SetProperties-Vorgang.
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 DeleteMethod-Vorgang.
ShareGetAccessPolicyResponse	Enthält Antwortdaten für den getAccessPolicy-Vorgang.
ShareGetPermissionResponse	Enthält Antwortdaten für den getPermission-Vorgang.
ShareGetPropertiesResponse	Enthält Antwortdaten für den getProperties-Vorgang.
ShareGetStatisticsResponse	Enthält Antwortdaten für den getStatistics-Vorgang.
ShareSetAccessPolicyResponse	Enthält Antwortdaten für den setAccessPolicy-Vorgang.
ShareSetMetadataResponse	Enthält Antwortdaten für den setMetadata-Vorgang.
ShareSetQuotaResponse	Enthält Antwortdaten für den setQuota-Vorgang.
StorageErrorCode	Definiert Werte für StorageErrorCode. Mögliche Werte: "AccountAlreadyExists", "AccountBeingCreated", "AccountIsDisabled", "AuthenticationFailed", "AuthorizationFailure", 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidMetadata', 'InvalidQueryParameterValue', 'InvalidRange', 'InvalidResourceName', 'InvalidUri', ' ' InvalidXmlDocument", "InvalidXmlNodeValue", "Md5Mismatch", "MetadataTooLarge", "MissingContentLengthHeader", "MissingRequiredQueryParameter", "MissingRequiredHeader", "MissingRequiredXmlNode", "MultipleConditionHeadersNotSupported", "OperationTimedOut", "OutOfRangeInput", "OutOfRangeQueryParameterValue", "RequestBodyTooLarge", "ResourceTypeMismatch", "RequestUrlFailedToParse", "ResourceAlreadyExists", "ResourceNotFound", "ServerBusy", "UnsupportedHeader", ' UnsupportedXmlNode", "UnsupportedQueryParameter", "UnsupportedHttpVerb", "CannotDeleteFileOrDirectory", "ClientCacheFlushDelay", "DeletePending", "DirectoryNotEmpty", 'FileLockConflict', 'InvalidFileOrDirectoryPathName', 'ParentNotFound', 'ReadOnlyAttribute', 'ShareAlreadyExists', 'ShareBeingDeleted', 'ShareDisabled', 'ShareNotFound', 'SharingViolation', 'ShareSnapshotInProgress', 'ShareSnapshotCountExceeded', 'ShareSnapshotOperationNotSupported', ' ShareHasSnapshots", "ContainerQuotaDowngradeNotAllowed"
CredentialPolicyCreator	Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet.
FileAttributesPreserveType	Gibt an, dass vorhandene Dateiattribute unverändert bleiben.
FileGetRangeListResponse	Enthält Antwortdaten für den getRangeList-Vorgang.
FilePermissionInheritType	Gibt die Berechtigung zum Erben einer Datei aus dem übergeordneten Verzeichnis an.
FilePermissionPreserveType	Gibt an, dass der vorhandene Dateiberechtigungswert unverändert bleibt.
HttpRequestBody
RequestPolicyFactory	Erstellt eine neue RequestPolicy pro Anforderung, die die bereitgestellte nextPolicy verwendet.
ShareGetAccessPolicyResponse
ShareGetStatisticsResponse
TimeNowType	Gibt die Einstellung als Zeitpunkt der Anforderung an.
TimePreserveType	Gibt an, dass der vorhandene Zeitwert unverändert bleibt.

Enumerationen

HttpPipelineLogLevel	Die verschiedenen Protokollebenen, die mit dem HttpPipelineLogger verwendet werden können.
RetryPolicyType	RetryPolicy-Typen.
SASProtocol	Protokolle für generierte SAS.

Functions

deserializationPolicy(DeserializationContentTypes)	Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die HTTP-Anforderungstexte serialisiert, während sie die HTTP-Pipeline durchlaufen.
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, number, IDownloadFromAzureFileOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt eine Azure-Datei parallel in einen Puffer herunter. Offset und Count sind optional. Übergeben Sie 0 für beide, um die gesamte Datei herunterzuladen.
generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)	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(IFileSASSignatureValues, SharedKeyCredential)	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, startTime und Bezeichner. WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und expiryTime erforderlich. Wenn Sie mit diesem Konstruktor initialisieren, MÜSSEN Sie identifier oder expiryTime & Berechtigungen manuell zuweisen.
uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)	NUR IN BROWSERN VERFÜGBAR. Lädt ein Blob/File/ArrayBuffer/ArrayBufferView-Objekt des Browsers in eine Azure-Datei hoch.
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt eine lokale Datei in eine Azure-Datei hoch.
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt einen Node.js lesbaren Stream in eine Azure-Datei hoch. Diese Methode versucht, eine Azure-Instanz zu erstellen, und beginnt dann mit dem Hochladen von Blöcken für Blöcke. Die Größe des Blöckes wird durch bufferSize den Parameter definiert. Stellen Sie sicher, dass die potenzielle Größe des Streams die Dateigröße nicht überschreitet. TIPPS ZUR LEISTUNGSVERBESSERUNG: Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem parameter bufferSize festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.

Details zur Funktion

deserializationPolicy(DeserializationContentTypes)

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

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parameter

deserializationContentTypes

DeserializationContentTypes

Gibt zurück

RequestPolicyFactory

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, number, IDownloadFromAzureFileOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt eine Azure-Datei parallel in einen Puffer herunter. Offset und Count sind optional. Übergeben Sie 0 für beide, um die gesamte Datei herunterzuladen.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: number, options?: IDownloadFromAzureFileOptions): Promise<void>

Parameter

aborter

Aborter

Erstellen eines neuen Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

buffer

Buffer

Puffer, der gefüllt werden soll, muss eine Länge haben, die größer als die Anzahl ist

fileURL

FileURL

Ein FileURL-Objekt

offset

number

Von welcher Position der Azure-Datei heruntergeladen werden soll

count

number

Wie viele Daten heruntergeladen werden sollen. Wird beim Übergeben von undefined an das Ende heruntergeladen.

options

IDownloadFromAzureFileOptions

Gibt zurück

Promise<void>

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

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: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential): SASQueryParameters

Parameter

accountSASSignatureValues

IAccountSASSignatureValues

sharedKeyCredential

SharedKeyCredential

Gibt zurück

SASQueryParameters

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

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, startTime und Bezeichner.

WARNUNG: Wenn der Bezeichner nicht angegeben wird, sind Berechtigungen und expiryTime erforderlich. Wenn Sie mit diesem Konstruktor initialisieren, MÜSSEN Sie identifier oder expiryTime & Berechtigungen manuell zuweisen.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential): SASQueryParameters

Parameter

fileSASSignatureValues

IFileSASSignatureValues

sharedKeyCredential

SharedKeyCredential

Gibt zurück

SASQueryParameters

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

NUR IN BROWSERN VERFÜGBAR.

Lädt ein Blob/File/ArrayBuffer/ArrayBufferView-Objekt des Browsers in eine Azure-Datei hoch.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions): Promise<void>

Parameter

aborter

Aborter

Erstellen Eines neuen aborter-instance mit Aborter.none oder Aborter.timeout(), navigieren Sie zu Dokumenten von Aborter, um weitere Beispiele für die Anforderungsabbruch zu erhalten.

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer oder ArrayBufferView

fileURL

FileURL

options

IUploadToAzureFileOptions

Gibt zurück

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt eine lokale Datei in eine Azure-Datei hoch.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions): Promise<void>

Parameter

aborter

Aborter

Erstellen Eines neuen aborter-instance mit Aborter.none oder Aborter.timeout(), navigieren Sie zu Dokumenten von Aborter, um weitere Beispiele für die Anforderungsabbruch zu erhalten.

filePath

string

Vollständiger Pfad der lokalen Datei

fileURL

FileURL

Fileurl

options

IUploadToAzureFileOptions

Gibt zurück

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt einen Node.js lesbaren Stream in eine Azure-Datei hoch. Diese Methode versucht, eine Azure-Instanz zu erstellen, und beginnt dann mit dem Hochladen von Blöcken für Blöcke. Die Größe des Blöckes wird durch bufferSize den Parameter definiert. Stellen Sie sicher, dass die potenzielle Größe des Streams die Dateigröße nicht überschreitet.

TIPPS ZUR LEISTUNGSVERBESSERUNG:

• Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem parameter bufferSize festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.

function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions): Promise<void>

Parameter

aborter

Aborter

Erstellen Eines neuen aborter-instance mit Aborter.none oder Aborter.timeout(), navigieren Sie zu Dokumenten von Aborter, um weitere Beispiele für die Anforderungsabbruch zu erhalten.

stream

Readable

Node.js lesbarer Stream. Muss kleiner oder gleich der Dateigröße sein.

size

number

Größe der zu erstellenden Datei. Die zulässige Maximale Größe beträgt 1 TB. Wenn dieser Wert größer als die Streamgröße ist, befinden sich leere Bytes im Dateischwanz.

fileURL

FileURL

Ein FileURL-instance

bufferSize

number

Größe jedes Puffers, der in Bytes zugeordnet ist, auch die Größe von Block/Bereich während der hochgeladenen Datei. Die Größe muss 0 und <= 4 * 1024 * 1024 (4 MB) sein>.

maxBuffers

number

Maximale Pufferzuweisung während des Uploads, positive Korrelation mit maximaler Upload-Parallelität

options

IUploadStreamToAzureFileOptions

Gibt zurück

Promise<void>