Freigeben über


@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 Abbruch:

  • 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 eine untergeordnete Aborter-instance mit Schlüssel-Wert-Paar zu erstellen und zurückzugeben.
  • Rufen Sie aborter.abort() auf, um den aktuellen instance und alle untergeordneten Instanzen abzubrechen.
  • Rufen Sie aborter.getValue(key) auf, um den Wert mit dem entsprechenden Schlüssel aus dem aktuellen Aborter an alle übergeordneten Elemente zu suchen und abzurufen.
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 <xref: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 <xref: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 <xref: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.

BrowserPolicyFactory

BrowserPolicyFactory ist eine Factoryklasse, die beim Generieren von BrowserPolicy-Objekten hilft.

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. Sobald alle Werte festgelegt sind, sollte dies mit toString serialisiert und als Berechtigungsfeld für ein <xref: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.

FileURL

Eine FileURL stellt eine URL zu einer Azure Storage-Datei dar.

KeepAlivePolicyFactory

KeepAlivePolicyFactory ist eine Factoryklasse, die beim Generieren von KeepAlivePolicy-Objekten hilft.

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.

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 <xref:IAccountSASSignatureValues> Typen und <xref: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 <xref: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.

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.

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

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.

SharedKeyCredential

NUR IN NODE.JS RUNTIME VERFÜGBAR. SharedKeyCredential für die Kontoschlüsselautorisierung des Azure Storage-Diensts.

Directory

Klasse, die ein Verzeichnis darstellt.

File

Klasse, die eine Datei darstellt.

Service

Klasse, die einen Dienst darstellt.

Share

Klasse, die eine Freigabe darstellt.

StorageClient
StorageClientContext
AnonymousCredentialPolicy

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

BrowserPolicy

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

  2. Entfernen des Cookie-Headers aus Sicherheitsgründen

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

CredentialPolicy

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

KeepAlivePolicy

KeepAlivePolicy ist eine Richtlinie, die zum Steuern der Keep Alive-Einstellungen für jede Anforderung verwendet wird.

LoggingPolicy

LoggingPolicy ist eine Richtlinie, die zum Protokollieren von Anforderungen verwendet wird.

RetryPolicy

Wiederholungsrichtlinie mit implementierter exponentieller Wiederholung und linearer Wiederholung.

SharedKeyCredentialPolicy

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

TelemetryPolicy

TelemetryPolicy ist eine Richtlinie, die zum Markieren des Benutzer-Agent-Headers für alle Anforderungen verwendet wird.

UniqueRequestIDPolicy

UniqueRequestIDPolicy generiert eine UUID als x-ms-request-id-Headerwert.

Batch

Batch bietet eine einfache parallele Ausführung mit Parallelitätsgrenzwerten. Beendet die Ausführung von linken Vorgängen, wenn einer der ausgeführten Vorgänge einen Fehler auslöst. Aber Batch kann laufende Vorgänge nicht abbrechen, Sie müssen sie selbst abbrechen.

BufferScheduler

Diese Klasse akzeptiert einen Node.js lesbaren Datenstrom als Eingabe und liest Daten aus dem Datenstrom in die interne Pufferstruktur, bis maxBuffers erreicht wird. Jeder verfügbare Puffer versucht, outgoingHandler auszulösen. Die interne Pufferstruktur umfasst ein eingehendes Pufferarray und ein ausgehendes Pufferarray. Das eingehende Pufferarray enthält die "leeren" Puffer, die mit neuen eingehenden Daten gefüllt werden können. Das ausgehende Array enthält die gefüllten Puffer, die von outgoingHandler behandelt werden sollen. Jede oben genannte Puffergröße wird durch den Parameter bufferSize definiert.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers

TIPPS ZUR LEISTUNGSVERBESSERUNG:

  1. Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem bufferSize-Parameter festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.
  2. Parallelität sollte einen kleineren Wert als maxBuffers festlegen, was hilfreich ist, um die Wahrscheinlichkeit zu verringern, wenn ein ausgehender Handler auf die Datenstromdaten wartet. in diesem Fall werden ausgehende Handler blockiert. Die ausgehende Warteschlange sollte nicht leer sein.
RetriableReadableStream

NUR IN NODE.JS RUNTIME VERFÜGBAR. Ein Node.js ReadableStream wird intern wiederholt, wenn der interne ReadableStream unerwartet endet.

Schnittstellen

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
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
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
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 <xref:SASQueryParameters> als auch 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.

IFileSASSignatureValues

NUR IN NODE.JS RUNTIME VERFÜGBAR. IFileSASSignatureValues wird verwendet, um dateidienst-SAS-Token für Freigaben oder Dateien zu generieren.

IIPRange

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

IRange

Bereich für Dienstvorgänge.

IKeepAliveOptions

Schnittstelle von KeepAlivePolicy-Optionen.

IRequestLogOptions

RequestLogOptions konfiguriert das Verhalten der Wiederholungsrichtlinie.

IPipelineOptions

Optionsschnittstelle für pipeline-Konstruktor.

IRetryOptions

Benutzeroberfläche für Wiederholungsoptionen.

IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Optionsschnittstelle für die Pipeline.newPipeline-Methode.

ITelemetryOptions

Schnittstelle der TelemetryPolicy-Optionen.

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

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

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.

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.

FilesAndDirectoriesListSegment

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

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.

IDownloadFromAzureFileOptions

Optionsschnittstelle für DownloadAzurefileToBuffer.

IUploadToAzureFileOptions

Optionsschnittstelle für uploadFileToAzureFile und uploadSeekableStreamToAzureFile.

IUploadStreamToAzureFileOptions

Optionsschnittstelle für uploadStreamToAzureFile.

IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Typaliase

FileDownloadResponse

Enthält Antwortdaten für den Downloadvorgang.

FileGetRangeListResponse

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

ShareGetAccessPolicyResponse

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

ShareGetStatisticsResponse

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

CredentialPolicyCreator

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

CopyStatusType

Definiert Werte für CopyStatusType. Mögliche Werte: "pending", "success", "aborted", "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 Vorgang listFilesAndDirectoriesSegment.

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.

FileForceCloseHandlesResponse

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

FileGetPropertiesResponse

Enthält Antwortdaten für den getProperties-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.

ShareGetPermissionResponse

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

ShareGetPropertiesResponse

Enthält Antwortdaten für den getProperties-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"

FileAttributesPreserveType

Gibt an, dass vorhandene Dateiattribute unverändert bleiben.

FilePermissionInheritType

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

FilePermissionPreserveType

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

TimeNowType

Gibt die Einstellung als Zeitpunkt der Anforderung an.

TimePreserveType

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

Operation

Operation ist eine asynchrone Funktion, die von Batch ausgeführt und verwaltet werden soll.

OutgoingHandler

OutgoingHandler ist eine asynchrone Funktion, die von BufferScheduler ausgelöst wird.

ReadableStreamGetter

Enumerationen

SASProtocol

Protokolle für generierte SAS.

RetryPolicyType

RetryPolicy-Typen.

Functions

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Generiert ein <xref:SASQueryParameters> -Objekt, das alle SAS-Abfrageparameter enthält, die zum Ausführen einer tatsächlichen REST-Anforderung erforderlich sind.

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 wie berechtigungen, startTime und bezeichner direkt fest.

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

ipRangeToString(IIPRange)

Generieren sie eine IPRange-Formatzeichenfolge. Beispiel: "8.8.8.8" oder "1.1.1.1-255.255.255.255"

rangeToString(IRange)

Generieren Sie eine Bereichszeichenfolge. Beispiel: "bytes=255-" oder "bytes=0-511"

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

NUR IN BROWSERN VERFÜGBAR. Lädt ein Blob/File/ArrayBuffer/ArrayBufferView-Objekt im Browser in eine Azure-Datei hoch.

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | 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.

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, ein Azure-Objekt zu erstellen, und beginnt dann mit dem Hochladen von Segmenten. Die Größe des Blocks wird durch den bufferSize 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 bufferSize-Parameter festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

Eine Factorymethode, die verwendet wird, um eine RetryPolicy-Factory zu generieren.

blobToArrayBuffer(Blob)

Konvertieren eines Browserblobobjekts in ArrayBuffer.

appendToURLPath(string, string)

Fügen Sie eine Zeichenfolge an den URL-Pfad an. Entfernt doppeltes "/" vor der Zeichenfolge, wenn der URL-Pfad mit einem "/" endet.

base64decode(string)

Base64-Decodierung.

base64encode(string)

Base64-Codierung.

delay(number, AbortSignalLike, Error)

Verzögert das angegebene Zeitintervall.

escapeURLPath(string)

Reservierte URL-Zeichen müssen für Speicherdienste wie Blob oder Datei ordnungsgemäß mit Escapezeichen versehen werden.

URL-Codierungs- und Escapestrategie für JSv10 SDKs

Wenn Kunden eine URL-Zeichenfolge an den XXXURL-Klassenkonstruktor übergeben, ist die URL-Zeichenfolge möglicherweise bereits URL-codiert oder nicht. Vor dem Senden an den Azure Storage-Server muss die URL jedoch codiert werden. Es ist jedoch schwierig für ein SDK zu erraten, ob die URL-Zeichenfolge codiert wurde oder nicht. Wir haben zwei potenzielle Strategien und haben strategie zwei für die XXXURL-Konstruktoren ausgewählt.

Strategie 1: Angenommen, die Kunden-URL-Zeichenfolge ist nicht codiert, und die URL-Zeichenfolge wird immer im SDK codiert.

Dies ist das Legacy-V2-SDK, einfach und funktioniert in den meisten Fällen.

  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b:"" lautet, codiert das SDK sie in "http://account.blob.core.windows.net/con/b%3A" und senden sie an den Server. Ein Blob mit dem Namen "b:" wird erstellt.
  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b%3A"" lautet, codiert das SDK sie in "http://account.blob.core.windows.net/con/b%253A" und senden sie an den Server. Ein Blob mit dem Namen "b%3A" wird erstellt.

Diese Strategie ermöglicht es jedoch nicht, ein Blob mit dem Namen "?" zu erstellen. Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/blob?name"" lautet, wird "?name" als URL-Paramter anstelle des Blobnamens behandelt. Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/blob%3Fname"" lautet, wird ein Blob mit dem Namen "blob%3Fname" erstellt. V2 SDK hat dieses Problem nicht, da es dem Kunden nicht erlaubt, eine vollständige URL zu übergeben, es akzeptiert einen separaten Blobnamen und encodeURIComponent dafür. Wir können nicht akzeptieren, dass ein SDK keinen Blobnamen mit "?" erstellen kann. Daher setzen wir Strategie zwei um:

Strategie 2: Das SDK geht nicht davon aus, dass die URL codiert wurde oder nicht. Es werden nur die Sonderzeichen mit Escapezeichen versehen.

Dies ist das V10 Blob Go SDK. Sie akzeptiert einen URL-Typ in Go und ruft url auf. EscapedPath(), um die sonderbaren Zeichen ohne Scaped zu escapen.

  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b:"" lautet, wird im SDK ":" wie "http://account.blob.core.windows.net/con/b%3A" und senden Sie an den Server. Es wird ein Blob mit dem Namen "b:" erstellt.
  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b%3A"" ist, gibt es keine Sonderzeichen, also senden Sie "http://account.blob.core.windows.net/con/b%3A" zum Server. Es wird ein Blob mit dem Namen "b:" erstellt.
  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b%253A"" ist, gibt es keine Sonderzeichen, also senden Sie "http://account.blob.core.windows.net/con/b%253A" zum Server. Es wird ein Blob mit dem Namen "b%3A" erstellt.

Diese Strategie gibt uns Flexibilität, mit beliebigen Sonderzeichen zu erstellen. "%" wird jedoch als Sonderzeichen behandelt. Wenn die URL-Zeichenfolge nicht codiert ist, sollte in der URL-Zeichenfolge kein "%" vorhanden sein, andernfalls ist die URL keine gültige URL. Wenn der Kunde ein Blob mit "%" im Blobnamen erstellen muss, verwenden Sie "%25" insead von "%". Genau wie oben 3. Beispiel. Die folgenden URL-Zeichenfolgen sind ungültig:

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Ein weiteres Sonderzeichen ist "?". Verwenden Sie "%2F", um einen Blobnamen mit "?" in einer URL-Zeichenfolge darzustellen.

Strategie für containerName, blobName oder andere spezifische XXXName-Parameter in Methoden wie BlobURL.fromContainerURL(containerURL, blobName)

Wir wenden Strategie 1 an und rufen encodeURIComponent für diese Parameter wie blobName auf. Denn was Kunden übergeben, ist ein einfacher Name anstelle einer URL.

getURLParameter(string, string)

Rufen Sie den URL-Parameter nach Name ab.

getURLPath(string)

Abrufen des URL-Pfads aus einer URL-Zeichenfolge.

getURLQueries(string)

Abrufen von URL-Abfrageschlüsselwertpaaren aus einer URL-Zeichenfolge.

padStart(string, number, undefined | string)

String.prototype.padStart()

setURLHost(string, string)

Legen Sie den URL-Host fest.

setURLParameter(string, string, undefined | string)

Legen Sie Name und Wert für URL-Parameter fest. Wenn name in URL-Parametern vorhanden ist, wird der alte Wert durch den Namensschlüssel ersetzt. Wenn kein Wert angegeben wird, wird der Parameter gelöscht.

truncatedISO8061Date(Date, undefined | false | true)

Rundet ein Datum auf Sekunden ab.

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Liest einen lesbaren Stream in den Puffer. Füllen Sie den Puffer von Offset nach Ende.

Details zur Funktion

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

NUR IN NODE.JS RUNTIME VERFÜGBAR. Generiert ein <xref:SASQueryParameters> -Objekt, das alle SAS-Abfrageparameter enthält, die zum Ausführen einer tatsächlichen REST-Anforderung erforderlich sind.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parameter

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Gibt zurück

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 wie berechtigungen, startTime und bezeichner direkt fest.

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

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parameter

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Gibt zurück

ipRangeToString(IIPRange)

Generieren sie eine IPRange-Formatzeichenfolge. Beispiel: "8.8.8.8" oder "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parameter

ipRange
IIPRange

Gibt zurück

string

rangeToString(IRange)

Generieren Sie eine Bereichszeichenfolge. Beispiel: "bytes=255-" oder "bytes=0-511"

function rangeToString(iRange: IRange)

Parameter

iRange
IRange

Gibt zurück

string

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

NUR IN BROWSERN VERFÜGBAR. Lädt ein Blob/File/ArrayBuffer/ArrayBufferView-Objekt im Browser in eine Azure-Datei hoch.

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

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.

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer oder ArrayBufferView

fileURL
FileURL

Gibt zurück

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | 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?: undefined | number, options?: IDownloadFromAzureFileOptions)

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

undefined | number

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)

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.

filePath

string

Vollständiger Pfad der lokalen Datei

fileURL
FileURL

Fileurl

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, ein Azure-Objekt zu erstellen, und beginnt dann mit dem Hochladen von Segmenten. Die Größe des Blocks wird durch den bufferSize 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 bufferSize-Parameter festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

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.

stream

Readable

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

size

number

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

fileURL
FileURL

FileURL-instance

bufferSize

number

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

maxBuffers

number

Max. Puffer werden während des Uploads zugeordnet, positive Korrelation mit maximaler Parallelität des Uploads

Gibt zurück

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parameter

Gibt zurück

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parameter

Gibt zurück

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parameter

Gibt zurück

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parameter

Gibt zurück

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parameter

Gibt zurück

validateFilePermissionOptions(undefined | string, undefined | string)

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Parameter

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

Eine Factorymethode, die verwendet wird, um eine RetryPolicy-Factory zu generieren.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parameter

retryOptions
IRetryOptions

Gibt zurück

RequestPolicyFactory

blobToArrayBuffer(Blob)

Konvertieren eines Browserblobobjekts in ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parameter

blob

Blob

Gibt zurück

Promise<ArrayBuffer>

appendToURLPath(string, string)

Fügen Sie eine Zeichenfolge an den URL-Pfad an. Entfernt doppeltes "/" vor der Zeichenfolge, wenn der URL-Pfad mit einem "/" endet.

function appendToURLPath(url: string, name: string)

Parameter

url

string

Quell-URL-Zeichenfolge

name

string

Zeichenfolge, die an die URL angefügt werden soll

Gibt zurück

string

Eine aktualisierte URL-Zeichenfolge

base64decode(string)

Base64-Decodierung.

function base64decode(encodedString: string)

Parameter

encodedString

string

Gibt zurück

string

base64encode(string)

Base64-Codierung.

function base64encode(content: string)

Parameter

content

string

Gibt zurück

string

delay(number, AbortSignalLike, Error)

Verzögert das angegebene Zeitintervall.

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Parameter

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Gibt zurück

Promise<unknown>

escapeURLPath(string)

Reservierte URL-Zeichen müssen für Speicherdienste wie Blob oder Datei ordnungsgemäß mit Escapezeichen versehen werden.

URL-Codierungs- und Escapestrategie für JSv10 SDKs

Wenn Kunden eine URL-Zeichenfolge an den XXXURL-Klassenkonstruktor übergeben, ist die URL-Zeichenfolge möglicherweise bereits URL-codiert oder nicht. Vor dem Senden an den Azure Storage-Server muss die URL jedoch codiert werden. Es ist jedoch schwierig für ein SDK zu erraten, ob die URL-Zeichenfolge codiert wurde oder nicht. Wir haben zwei potenzielle Strategien und haben strategie zwei für die XXXURL-Konstruktoren ausgewählt.

Strategie 1: Angenommen, die Kunden-URL-Zeichenfolge ist nicht codiert, und die URL-Zeichenfolge wird immer im SDK codiert.

Dies ist das Legacy-V2-SDK, einfach und funktioniert in den meisten Fällen.

  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b:"" lautet, codiert das SDK sie in "http://account.blob.core.windows.net/con/b%3A" und senden sie an den Server. Ein Blob mit dem Namen "b:" wird erstellt.
  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b%3A"" lautet, codiert das SDK sie in "http://account.blob.core.windows.net/con/b%253A" und senden sie an den Server. Ein Blob mit dem Namen "b%3A" wird erstellt.

Diese Strategie ermöglicht es jedoch nicht, ein Blob mit dem Namen "?" zu erstellen. Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/blob?name"" lautet, wird "?name" als URL-Paramter anstelle des Blobnamens behandelt. Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/blob%3Fname"" lautet, wird ein Blob mit dem Namen "blob%3Fname" erstellt. V2 SDK hat dieses Problem nicht, da es dem Kunden nicht erlaubt, eine vollständige URL zu übergeben, es akzeptiert einen separaten Blobnamen und encodeURIComponent dafür. Wir können nicht akzeptieren, dass ein SDK keinen Blobnamen mit "?" erstellen kann. Daher setzen wir Strategie zwei um:

Strategie 2: Das SDK geht nicht davon aus, dass die URL codiert wurde oder nicht. Es werden nur die Sonderzeichen mit Escapezeichen versehen.

Dies ist das V10 Blob Go SDK. Sie akzeptiert einen URL-Typ in Go und ruft url auf. EscapedPath(), um die sonderbaren Zeichen ohne Scaped zu escapen.

  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b:"" lautet, wird im SDK ":" wie "http://account.blob.core.windows.net/con/b%3A" und senden Sie an den Server. Es wird ein Blob mit dem Namen "b:" erstellt.
  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b%3A"" ist, gibt es keine Sonderzeichen, also senden Sie "http://account.blob.core.windows.net/con/b%3A" zum Server. Es wird ein Blob mit dem Namen "b:" erstellt.
  • Wenn die Kunden-URL-Zeichenfolge "http://account.blob.core.windows.net/con/b%253A"" ist, gibt es keine Sonderzeichen, also senden Sie "http://account.blob.core.windows.net/con/b%253A" zum Server. Es wird ein Blob mit dem Namen "b%3A" erstellt.

Diese Strategie gibt uns Flexibilität, mit beliebigen Sonderzeichen zu erstellen. "%" wird jedoch als Sonderzeichen behandelt. Wenn die URL-Zeichenfolge nicht codiert ist, sollte in der URL-Zeichenfolge kein "%" vorhanden sein, andernfalls ist die URL keine gültige URL. Wenn der Kunde ein Blob mit "%" im Blobnamen erstellen muss, verwenden Sie "%25" insead von "%". Genau wie oben 3. Beispiel. Die folgenden URL-Zeichenfolgen sind ungültig:

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Ein weiteres Sonderzeichen ist "?". Verwenden Sie "%2F", um einen Blobnamen mit "?" in einer URL-Zeichenfolge darzustellen.

Strategie für containerName, blobName oder andere spezifische XXXName-Parameter in Methoden wie BlobURL.fromContainerURL(containerURL, blobName)

Wir wenden Strategie 1 an und rufen encodeURIComponent für diese Parameter wie blobName auf. Denn was Kunden übergeben, ist ein einfacher Name anstelle einer URL.

function escapeURLPath(url: string)

Parameter

url

string

Gibt zurück

string

getURLParameter(string, string)

Rufen Sie den URL-Parameter nach Name ab.

function getURLParameter(url: string, name: string)

Parameter

url

string

name

string

Gibt zurück

string | string[] | undefined

getURLPath(string)

Abrufen des URL-Pfads aus einer URL-Zeichenfolge.

function getURLPath(url: string)

Parameter

url

string

Quell-URL-Zeichenfolge

Gibt zurück

string | undefined

getURLQueries(string)

Abrufen von URL-Abfrageschlüsselwertpaaren aus einer URL-Zeichenfolge.

function getURLQueries(url: string)

Parameter

url

string

Gibt zurück

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Parameter

currentString

string

targetLength

number

padString

undefined | string

Gibt zurück

string

setURLHost(string, string)

Legen Sie den URL-Host fest.

function setURLHost(url: string, host: string)

Parameter

url

string

Quell-URL-Zeichenfolge

host

string

Neue Hostzeichenfolge

Gibt zurück

string

Eine aktualisierte URL-Zeichenfolge

setURLParameter(string, string, undefined | string)

Legen Sie Name und Wert für URL-Parameter fest. Wenn name in URL-Parametern vorhanden ist, wird der alte Wert durch den Namensschlüssel ersetzt. Wenn kein Wert angegeben wird, wird der Parameter gelöscht.

function setURLParameter(url: string, name: string, value?: undefined | string)

Parameter

url

string

Quell-URL-Zeichenfolge

name

string

Parametername

value

undefined | string

Gibt zurück

string

Eine aktualisierte URL-Zeichenfolge

truncatedISO8061Date(Date, undefined | false | true)

Rundet ein Datum auf Sekunden ab.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Parameter

date

Date

withMilliseconds

undefined | false | true

Gibt zurück

string

Datumszeichenfolge im ISO8061 Format mit oder ohne Komponente von 7 Millisekunden

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Liest einen lesbaren Stream in den Puffer. Füllen Sie den Puffer von Offset nach Ende.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Parameter

stream

ReadableStream

Ein Node.js lesbarer Stream

buffer

Buffer

Puffer zu füllen, Länge muss >= Offset

offset

number

Von welcher Position im Puffer inklusive

end

number

An welcher Position im Puffer gefüllt werden soll, exklusiv

encoding

undefined | string

Gibt zurück

Promise<void>