Udostępnij za pośrednictwem

@azure/storage-file package

Klasy

Aborter

Wystąpienie aborter implementuje interfejs AbortSignal, może przerwać żądania HTTP.

  • Wywołaj metodę Aborter.none, aby utworzyć nowe wystąpienie Aborter bez przekroczenia limitu czasu.
  • Wywołaj metodę Aborter.timeout(), aby utworzyć nowe wystąpienie Aborter z przekroczeniem limitu czasu.

W przypadku istniejącego przerwania wystąpienia:

  • Wywołaj metodę aborter.withTimeout(), aby utworzyć i zwrócić podrzędne wystąpienie Aborter z przekroczeniem limitu czasu.
  • Wywołaj metodę aborter.withValue(klucz, wartość), aby utworzyć i zwrócić podrzędne wystąpienie aborter z parą klucz/wartość.
  • Wywołaj metodę aborter.abort(), aby przerwać bieżące wystąpienie i wszystkie wystąpienia podrzędne.
  • Wywołaj metodę aborter.getValue(key), aby wyszukać i pobrać wartość z odpowiedniego klucza z bieżącego elementu aborter do wszystkich elementów nadrzędnych.
AccountSASPermissions

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego uprawnienia przyznane przez accountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w obiekcie <xref:IAccountSASSignatureValues>. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
AccountSASResourceTypes

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego zasoby dostępne dla kontaSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna dostęp do tego typu zasobu. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole zasobów w obiekcie <xref:IAccountSASSignatureValues>. Można utworzyć ciąg zasobów bez tej klasy, ale kolejność zasobów jest określona, a ta klasa gwarantuje poprawność.
AccountSASServices

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego usługi dostępne w usłudze AccountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna dostęp do tej usługi. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole usług na obiekcie <xref:IAccountSASSignatureValues>. Można skonstruować ciąg usług bez tej klasy, ale kolejność usług jest określona, a ta klasa gwarantuje poprawność.
BrowserPolicyFactory

BrowserPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów BrowserPolicy.
DirectoryURL

A DirectoryURL reprezentuje adres URL katalogu usługi Azure Storage, który umożliwia manipulowanie jego plikami i katalogami.
FileSASPermissions

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego uprawnienia przyznane przez usługę ServiceSAS do pliku. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w obiekcie <xref:IFileSASSignatureValues>. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
FileSystemAttributes

Jest to klasa pomocnika do konstruowania ciągu reprezentującego atrybuty NTFS do pliku lub katalogu.
FileURL

Element FileURL reprezentuje adres URL pliku usługi Azure Storage.
KeepAlivePolicyFactory

KeepAlivePolicyFactory to klasa fabryki ułatwiająca generowanie obiektów KeepAlivePolicy.
LoggingPolicyFactory

LoggingPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów LoggingPolicy.
Pipeline

Klasa Potok zawierająca zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując funkcję StorageURL.newPipeline(). Możesz też utworzyć potok przy użyciu własnych zasad przez konstruktor potoku. Przed wdrożeniem dostosowanego potoku zapoznaj się z artykułem StorageURL.newPipeline() i podano zasady jako odwołanie.
RetryPolicyFactory

RetryPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów RetryPolicy.
SASQueryParameters

Reprezentuje składniki tworzące parametry zapytania sygnatury dostępu współdzielonego usługi Azure Storage. Ten typ nie jest konstruowany bezpośrednio przez użytkownika; jest generowany tylko przez typy <xref:IAccountSASSignatureValues> i <xref:IFileSASSignatureValues>. Po wygenerowaniu można go zakodować w ciągu {@code} i dołączyć bezpośrednio do adresu URL (należy jednak zachować ostrożność w przypadku istnienia parametrów zapytania, co może mieć wpływ na odpowiednie środki dołączania tych parametrów zapytania). UWAGA: Wystąpienia tej klasy są niezmienne.
ServiceURL

Element ServiceURL reprezentuje adres URL usługi Plików usługi Azure Storage, co umożliwia manipulowanie udziałami plików.
ShareSASPermissions

Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego uprawnienia przyznane przez usługę ServiceSAS do udziału. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w obiekcie <xref:IFileSASSignatureValues>. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
ShareURL

Element ShareURL reprezentuje adres URL udziału usługi Azure Storage, który umożliwia manipulowanie jego katalogami i plikami.
StorageURL

Element ServiceURL reprezentuje klasę adresu URL opartą na klasie ServiceURL, ContainerURL i itp.
TelemetryPolicyFactory

TelemetryPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów TelemetryPolicy.
UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów UniqueRequestIDPolicy.
AnonymousCredential

Funkcja AnonymousCredential udostępnia element członkowski credentialPolicyCreator używany do tworzenia obiektów AnonymousCredentialPolicy. Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
Credential

Credential to abstrakcyjna klasa podpisywania żądań HTTP usługi Azure Storage. Ta klasa będzie hostować fabrykę credentialPolicyCreator, która generuje element CredentialPolicy.
SharedKeyCredential

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. SharedKeyCredential na potrzeby autoryzacji klucza konta usługi Azure Storage.
Directory

Klasa reprezentująca katalog.
File

Klasa reprezentująca plik.
Service

Klasa reprezentująca usługę.
Share

Klasa reprezentująca udział.
StorageClient
StorageClientContext
AnonymousCredentialPolicy

Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
BrowserPolicy

BrowserPolicy będzie obsługiwać różnice między Node.js a środowiskiem uruchomieniowym przeglądarki, w tym:

  1. Przeglądarki buforuje żądania GET/HEAD, dodając nagłówki warunkowe, takie jak "IF_MODIFIED_SINCE". BrowserPolicy to zasady służące do dodawania zapytania sygnatury czasowej do adresu URL żądania GET/HEAD, co pozwala uniknąć pamięci podręcznej przeglądarki.

  2. Usuń nagłówek pliku cookie na potrzeby zabezpieczeń

  3. Usuń nagłówek o długości zawartości, aby uniknąć ostrzeżenia przeglądarki
CredentialPolicy

Zasady poświadczeń używane do podpisywania żądań HTTP(S) przed wysłaniem. Jest to abstrakcyjna klasa.
KeepAlivePolicy

KeepAlivePolicy to zasady służące do kontrolowania ustawień zachowania aktywności dla każdego żądania.
LoggingPolicy

LoggingPolicy to zasady używane do rejestrowania żądań.
RetryPolicy

Zasady ponawiania próby z implementacją ponawiania wykładniczego i ponawiania liniowego.
SharedKeyCredentialPolicy

SharedKeyCredentialPolicy to zasady używane do podpisywania żądania HTTP przy użyciu klucza współużytkowanego.
TelemetryPolicy

TelemetryPolicy to zasady używane do tagowania nagłówka user-agent dla każdego żądania.
UniqueRequestIDPolicy

UniqueRequestIDPolicy generuje identyfikator UUID jako wartość nagłówka x-ms-request-id.
Batch

Usługa Batch zapewnia podstawowe wykonywanie równoległe z limitami współbieżności. Zatrzyma wykonywanie operacji po lewej stronie, gdy jedna z wykonanych operacji zgłasza błąd. Jednak usługa Batch nie może anulować bieżących operacji, musisz anulować je samodzielnie.
BufferScheduler

Ta klasa akceptuje strumień z możliwością odczytu Node.js jako dane wejściowe i odczytuje dane ze strumienia do wewnętrznej struktury buforu, dopóki nie osiągnie wartości maxBuffers. Każdy dostępny bufor spróbuje wyzwolić wychodzącą procedurę obsługi. Wewnętrzna struktura buforu zawiera tablicę buforu przychodzącego i macierz buforu wychodzącego. Tablica przychodzących zawiera "puste" mogą być wypełnione nowymi danymi przychodzącymi. Tablica wychodząca zawiera wypełnione, które mają być obsługiwane przez program outgoingHandler. Każdy powyższy rozmiar buforu jest definiowany przez parametr bufferSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers (maksymalna liczba)

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

  1. Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().
  2. Równoległość powinna ustawić mniejszą wartość niż maxBuffers, co jest pomocne w zmniejszeniu możliwości, gdy program obsługi wychodzącej czeka na dane strumienia. w takiej sytuacji programy obsługi wychodzącej są blokowane. Kolejka wychodząca nie powinna być pusta.
RetriableReadableStream

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Node.js ReadableStream będzie ponawiać próbę wewnętrzną po nieoczekiwanym zakończeniu wewnętrznej funkcji ReadableStream.

Interfejsy

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

Opcja jest definiowana jako parzystość definicji REST. Chociaż nie jest ona teraz gotowa do użycia, biorąc pod uwagę, że zawartość źródłowa Crc64 nie jest dostępna.
IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Funkcja IAccountSASSignatureValues służy do generowania sygnatury dostępu współdzielonego (SAS) dla konta usługi Azure Storage. Po odpowiednim ustawieniu wszystkich wartości wywołaj metodę generateSASQueryParameters(), aby uzyskać reprezentację sygnatury dostępu współdzielonego, która może być faktycznie stosowana do adresów URL plików. Uwaga: zarówno ta klasa, jak i <xref:SASQueryParameters> istnieją, ponieważ pierwsza jest modyfikowalna i logiczna reprezentacja, podczas gdy ta ostatnia jest niezmienna i używana do generowania rzeczywistych żądań REST.
IFileSASSignatureValues

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. IFileSASSignatureValues służy do generowania tokenów SAS usługi plików dla udziałów lub plików.
IIPRange

Dozwolony zakres adresów IP dla sygnatury dostępu współdzielonego.
IRange

Zakres operacji usługi.
IKeepAliveOptions

Interfejs opcji KeepAlivePolicy.
IRequestLogOptions

RequestLogOptions konfiguruje zachowanie zasad ponawiania.
IPipelineOptions

Interfejs opcji konstruktora potoku.
IRetryOptions

Interfejs opcji ponawiania prób.
IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Interfejs opcji dla metody Pipeline.newPipeline.
ITelemetryOptions

Interfejs opcji TelemetryPolicy.
AccessPolicy

Zasady dostępu.
CorsRule

MECHANIZM CORS to funkcja HTTP, która umożliwia aplikacji internetowej działającej w jednej domenie uzyskiwanie dostępu do zasobów w innej domenie. Przeglądarki sieci Web implementują ograniczenie zabezpieczeń znane jako zasady tego samego źródła, które uniemożliwia stronie internetowej wywoływanie interfejsów API w innej domenie; Mechanizm CORS zapewnia bezpieczny sposób zezwalania jednej domenie (domenie pochodzenia) na wywoływanie interfejsów API w innej domenie.
DirectoryCreateHeaders

Definiuje nagłówki dla operacji Tworzenia.
DirectoryCreateOptionalParams

Parametry opcjonalne.
DirectoryDeleteHeaders

Definiuje nagłówki dla operacji usuwania.
DirectoryDeleteMethodOptionalParams

Parametry opcjonalne.
DirectoryForceCloseHandlesHeaders

Definiuje nagłówki operacji ForceCloseHandles.
DirectoryForceCloseHandlesOptionalParams

Parametry opcjonalne.
DirectoryGetPropertiesHeaders

Definiuje nagłówki dla operacji GetProperties.
DirectoryGetPropertiesOptionalParams

Parametry opcjonalne.
DirectoryItem

Element katalogu na liście.
DirectoryListFilesAndDirectoriesSegmentHeaders

Definiuje nagłówki dla operacji ListFilesAndDirectoriesSegment.
DirectoryListFilesAndDirectoriesSegmentOptionalParams

Parametry opcjonalne.
DirectoryListHandlesHeaders

Definiuje nagłówki dla operacji ListHandles.
DirectoryListHandlesOptionalParams

Parametry opcjonalne.
DirectorySetMetadataHeaders

Definiuje nagłówki dla operacji SetMetadata.
DirectorySetMetadataOptionalParams

Parametry opcjonalne.
DirectorySetPropertiesHeaders

Definiuje nagłówki dla operacji SetProperties.
DirectorySetPropertiesOptionalParams

Parametry opcjonalne.
FileAbortCopyHeaders

Definiuje nagłówki dla operacji AbortCopy.
FileAbortCopyOptionalParams

Parametry opcjonalne.
FileCreateHeaders

Definiuje nagłówki dla operacji Tworzenia.
FileCreateOptionalParams

Parametry opcjonalne.
FileDeleteHeaders

Definiuje nagłówki dla operacji usuwania.
FileDeleteMethodOptionalParams

Parametry opcjonalne.
FileDownloadHeaders

Definiuje nagłówki dla operacji pobierania.
FileDownloadOptionalParams

Parametry opcjonalne.
FileForceCloseHandlesHeaders

Definiuje nagłówki operacji ForceCloseHandles.
FileForceCloseHandlesOptionalParams

Parametry opcjonalne.
FileGetPropertiesHeaders

Definiuje nagłówki dla operacji GetProperties.
FileGetPropertiesOptionalParams

Parametry opcjonalne.
FileGetRangeListHeaders

Definiuje nagłówki dla operacji GetRangeList.
FileGetRangeListOptionalParams

Parametry opcjonalne.
FileHTTPHeaders

Dodatkowe parametry dla zestawu operacji, takich jak: File_create, File_setHTTPHeaders.
FileItem

Element pliku na liście.
FileListHandlesHeaders

Definiuje nagłówki dla operacji ListHandles.
FileListHandlesOptionalParams

Parametry opcjonalne.
FileProperty

Właściwości pliku.
FileSetHTTPHeadersHeaders

Definiuje nagłówki dla operacji SetHTTPHeaders.
FileSetHTTPHeadersOptionalParams

Parametry opcjonalne.
FileSetMetadataHeaders

Definiuje nagłówki dla operacji SetMetadata.
FileSetMetadataOptionalParams

Parametry opcjonalne.
FileStartCopyHeaders

Definiuje nagłówki dla operacji StartCopy.
FileStartCopyOptionalParams

Parametry opcjonalne.
FileUploadRangeFromURLHeaders

Definiuje nagłówki dla operacji UploadRangeFromURL.
FileUploadRangeFromURLOptionalParams

Parametry opcjonalne.
FileUploadRangeHeaders

Definiuje nagłówki dla operacji UploadRange.
FileUploadRangeOptionalParams

Parametry opcjonalne.
FilesAndDirectoriesListSegment

Abstrakcja dla wpisów, które można wymienić z katalogu.
HandleItem

Element dojścia do usługi Azure Storage na liście.
ListFilesAndDirectoriesSegmentResponse

Wyliczenie katalogów i plików.
ListHandlesResponse

Wyliczenie dojść.
ListSharesResponse

Wyliczenie udziałów.
Metrics

Metryki usługi Storage Analytics dla usługi plików.
Permission

Uprawnienie (deskryptor zabezpieczeń) opisane w artykule Security Descriptor Definition Language(SDDL).
Range

Zakres plików usługi Azure Storage.
RetentionPolicy

Zasady przechowywania.
ServiceGetPropertiesHeaders

Definiuje nagłówki dla operacji GetProperties.
ServiceGetPropertiesOptionalParams

Parametry opcjonalne.
ServiceListSharesSegmentHeaders

Definiuje nagłówki dla operacji ListSharesSegment.
ServiceListSharesSegmentOptionalParams

Parametry opcjonalne.
ServiceSetPropertiesHeaders

Definiuje nagłówki dla operacji SetProperties.
ServiceSetPropertiesOptionalParams

Parametry opcjonalne.
ShareCreateHeaders

Definiuje nagłówki dla operacji Tworzenia.
ShareCreateOptionalParams

Parametry opcjonalne.
ShareCreatePermissionHeaders

Definiuje nagłówki dla operacji CreatePermission.
ShareCreatePermissionOptionalParams

Parametry opcjonalne.
ShareCreateSnapshotHeaders

Definiuje nagłówki dla operacji CreateSnapshot.
ShareCreateSnapshotOptionalParams

Parametry opcjonalne.
ShareDeleteHeaders

Definiuje nagłówki dla operacji usuwania.
ShareDeleteMethodOptionalParams

Parametry opcjonalne.
ShareGetAccessPolicyHeaders

Definiuje nagłówki dla operacji GetAccessPolicy.
ShareGetAccessPolicyOptionalParams

Parametry opcjonalne.
ShareGetPermissionHeaders

Definiuje nagłówki dla operacji GetPermission.
ShareGetPermissionOptionalParams

Parametry opcjonalne.
ShareGetPropertiesHeaders

Definiuje nagłówki dla operacji GetProperties.
ShareGetPropertiesOptionalParams

Parametry opcjonalne.
ShareGetStatisticsHeaders

Definiuje nagłówki dla operacji GetStatistics.
ShareGetStatisticsOptionalParams

Parametry opcjonalne.
ShareItem

Element udziału usługi Azure Storage na liście.
ShareProperties

Właściwości udziału.
ShareSetAccessPolicyHeaders

Definiuje nagłówki dla operacji SetAccessPolicy.
ShareSetAccessPolicyOptionalParams

Parametry opcjonalne.
ShareSetMetadataHeaders

Definiuje nagłówki dla operacji SetMetadata.
ShareSetMetadataOptionalParams

Parametry opcjonalne.
ShareSetQuotaHeaders

Definiuje nagłówki dla operacji SetQuota.
ShareSetQuotaOptionalParams

Parametry opcjonalne.
ShareStats

Statystyki udziału.
SignedIdentifier

Podpisany identyfikator.
SourceModifiedAccessConditions

Dodatkowe parametry dla operacji uploadRangeFromURL.
StorageError

Interfejs reprezentujący błąd StorageError.
StorageServiceProperties

Właściwości usługi Storage.
IDownloadFromAzureFileOptions

Interfejs opcji dla polecenia DownloadAzurefileToBuffer.
IUploadToAzureFileOptions

Interfejs opcji dla uploadFileToAzureFile i uploadSeekableStreamToAzureFile.
IUploadStreamToAzureFileOptions

Interfejs opcji dla uploadStreamToAzureFile.
IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Aliasy typu

FileDownloadResponse

Zawiera dane odpowiedzi dla operacji pobierania.
FileGetRangeListResponse

Zawiera dane odpowiedzi dla operacji getRangeList.
ShareGetAccessPolicyResponse

Zawiera dane odpowiedzi dla operacji getAccessPolicy.
ShareGetStatisticsResponse

Zawiera dane odpowiedzi dla operacji getStatistics.
CredentialPolicyCreator

Funkcja fabryki, która tworzy nową funkcję CredentialPolicy, która używa podanej metody NextPolicy.
CopyStatusType

Definiuje wartości copyStatusType. Możliwe wartości obejmują: "pending", "success", "aborted", "failed"
DeleteSnapshotsOptionType

Definiuje wartości deleteSnapshotsOptionType. Możliwe wartości to: "include"
DirectoryCreateResponse

Zawiera dane odpowiedzi dla operacji tworzenia.
DirectoryDeleteResponse

Zawiera dane odpowiedzi dla operacji deleteMethod.
DirectoryForceCloseHandlesResponse

Zawiera dane odpowiedzi dla operacji forceCloseHandles.
DirectoryGetPropertiesResponse

Zawiera dane odpowiedzi dla operacji getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse

Zawiera dane odpowiedzi dla operacji listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse

Zawiera dane odpowiedzi dla operacji listHandles.
DirectorySetMetadataResponse

Zawiera dane odpowiedzi dla operacji setMetadata.
DirectorySetPropertiesResponse

Zawiera dane odpowiedzi dla operacji setProperties.
FileAbortCopyResponse

Zawiera dane odpowiedzi dla operacji abortCopy.
FileCreateResponse

Zawiera dane odpowiedzi dla operacji tworzenia.
FileDeleteResponse

Zawiera dane odpowiedzi dla operacji deleteMethod.
FileForceCloseHandlesResponse

Zawiera dane odpowiedzi dla operacji forceCloseHandles.
FileGetPropertiesResponse

Zawiera dane odpowiedzi dla operacji getProperties.
FileListHandlesResponse

Zawiera dane odpowiedzi dla operacji listHandles.
FileRangeWriteType

Definiuje wartości fileRangeWriteType. Możliwe wartości obejmują: "update", "clear"
FileSetHTTPHeadersResponse

Zawiera dane odpowiedzi dla operacji setHTTPHeaders.
FileSetMetadataResponse

Zawiera dane odpowiedzi dla operacji setMetadata.
FileStartCopyResponse

Zawiera dane odpowiedzi dla operacji startCopy.
FileType

Definiuje wartości parametru FileType. Możliwe wartości to: "Plik"
FileUploadRangeFromURLResponse

Zawiera dane odpowiedzi dla operacji uploadRangeFromURL.
FileUploadRangeResponse

Zawiera dane odpowiedzi dla operacji uploadRange.
ListSharesIncludeType

Definiuje wartości listSharesIncludeType. Możliwe wartości obejmują: "migawki", "metadane"
ServiceGetPropertiesResponse

Zawiera dane odpowiedzi dla operacji getProperties.
ServiceListSharesSegmentResponse

Zawiera dane odpowiedzi dla operacji listSharesSegment.
ServiceSetPropertiesResponse

Zawiera dane odpowiedzi dla operacji setProperties.
ShareCreatePermissionResponse

Zawiera dane odpowiedzi dla operacji createPermission.
ShareCreateResponse

Zawiera dane odpowiedzi dla operacji tworzenia.
ShareCreateSnapshotResponse

Zawiera dane odpowiedzi dla operacji createSnapshot.
ShareDeleteResponse

Zawiera dane odpowiedzi dla operacji deleteMethod.
ShareGetPermissionResponse

Zawiera dane odpowiedzi dla operacji getPermission.
ShareGetPropertiesResponse

Zawiera dane odpowiedzi dla operacji getProperties.
ShareSetAccessPolicyResponse

Zawiera dane odpowiedzi dla operacji setAccessPolicy.
ShareSetMetadataResponse

Zawiera dane odpowiedzi dla operacji setMetadata.
ShareSetQuotaResponse

Zawiera dane odpowiedzi dla operacji setQuota.
StorageErrorCode

Definiuje wartości dla elementu StorageErrorCode. Możliwe wartości obejmują: "AccountAlreadyExists", "AccountBeingCreated", "AccountIsDisabled", "AuthenticationFailed", "AuthorizationFailure", "ConditionHeadersNotSupported", "ConditionNotMet", "EmptyMetadataKey", "InsufficientAccountPermissions", "InternalError", "InvalidAuthenticationInfo", "InvalidHeaderValue", "InvalidHttpVerb", "InvalidInput", "InvalidMd5", "InvalidMetadata", "InvalidQueryParameterValue", "InvalidRange", "InvalidResourceName", "InvalidUri", "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

Wskazuje, że istniejące atrybuty pliku pozostają niezmienione.
FilePermissionInheritType

Wskazuje dziedziczenie uprawnień do pliku z katalogu nadrzędnego.
FilePermissionPreserveType

Wskazuje, że istniejąca wartość uprawnień do pliku pozostaje niezmieniona.
TimeNowType

Wskazuje ustawienie jako czas żądania.
TimePreserveType

Wskazuje, że istniejąca wartość czasu pozostaje niezmieniona.
Operation

Operacja to funkcja asynchronizowana, która ma być wykonywana i zarządzana przez usługę Batch.
OutgoingHandler

OutgoingHandler to funkcja asynchronizna wyzwalana przez bufferScheduler.
ReadableStreamGetter

Wyliczenia

SASProtocol

Protokoły dla wygenerowanej sygnatury dostępu współdzielonego.
RetryPolicyType

Typy RetryPolicy.

Funkcje

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Generuje obiekt <xref:SASQueryParameters> zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST.
generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Tworzy wystąpienie parametrów SASQueryParameters.

Akceptuje tylko wymagane ustawienia wymagane do utworzenia sygnatury dostępu współdzielonego. W przypadku ustawień opcjonalnych ustaw odpowiednie właściwości bezpośrednio, takie jak uprawnienia, startTime i identyfikator.

OSTRZEŻENIE: Jeśli nie podano identyfikatora, wymagane są uprawnienia i czas wygaśnięcia. Musisz przypisać wartość do identyfikatora lub wygaśnięciaTime & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.
ipRangeToString(IIPRange)

Generowanie ciągu formatu IPRange. Na przykład: "8.8.8.8" lub "1.1.1.1-255.255.255.255"
rangeToString(IRange)

Generowanie ciągu zakresu. Na przykład: "bytes=255-" lub "bytes=0-511"
uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

DOSTĘPNE TYLKO W PRZEGLĄDARKACH. Przekazuje obiekt Blob/File/ArrayBuffer/ArrayBufferView przeglądarki do pliku platformy Azure.
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera plik platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby pobrać cały plik.
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje plik lokalny do pliku platformy Azure.
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje strumień z możliwością odczytu Node.js do pliku platformy Azure. Ta metoda spróbuje utworzyć platformę Azure, a następnie rozpocznie przekazywanie fragmentu według fragmentu. Rozmiar fragmentu jest definiowany przez parametr bufferSize. Upewnij się, że potencjalny rozmiar strumienia nie przekracza rozmiaru pliku.

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

  • Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

Metoda fabryki używana do generowania fabryki RetryPolicy.
blobToArrayBuffer(Blob)

Przekonwertuj obiekt blob przeglądarki na arrayBuffer.
appendToURLPath(string, string)

Dołącz ciąg do ścieżki adresu URL. Spowoduje usunięcie zduplikowanego ciągu "/" przed ciągiem, gdy ścieżka adresu URL kończy się ciągiem "/".
base64decode(string)

Dekodowanie base64.
base64encode(string)

Kodowanie base64.
delay(number, AbortSignalLike, Error)

Opóźnienie określonego interwału czasu.
escapeURLPath(string)

Znaki zastrzeżonego adresu URL muszą być poprawnie ucieczki dla usług storage, takich jak Blob lub File.

Kodowanie adresów URL i strategia ucieczki dla zestawów SDK JSv10

Gdy klienci przekazują ciąg adresu URL do konstruktora klas XXXURL, ciąg adresu URL może być już zakodowany w adresie URL lub nie. Jednak przed wysłaniem do serwera usługi Azure Storage adres URL musi być zakodowany. Jednak trudno jest odgadnąć, czy ciąg adresu URL został zakodowany, czy nie. Mamy 2 potencjalne strategie i wybraliśmy strategię 2 dla konstruktorów XXXURL.

Strategia pierwsza: Załóżmy, że ciąg adresu URL klienta nie jest zakodowany i zawsze koduje ciąg adresu URL w zestawie SDK.

Jest to, co robi starszy zestaw SDK w wersji 2, prosty i działa w większości przypadków.

  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b:", zestaw SDK zakoduje go do "http://account.blob.core.windows.net/con/b%3A" i wyślij do serwera. Zostanie utworzony obiekt blob o nazwie "b:".
  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b%3A", zestaw SDK zakoduje go do "http://account.blob.core.windows.net/con/b%253A" i wyślij do serwera. Zostanie utworzony obiekt blob o nazwie "b%3A".

Jednak ta strategia uniemożliwi utworzenie obiektu blob o nazwie "?". Ponieważ gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/blob?name", parametr "?name" będzie traktowany jako parametr adresu URL zamiast nazwy obiektu blob. Jeśli ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/blob%3Fname", zostanie utworzony obiekt blob o nazwie "blob%3Fname". Zestaw SDK w wersji 2 nie ma tego problemu, ponieważ nie zezwala klientowi na przekazywanie pełnego adresu URL, akceptuje oddzielną nazwę obiektu blob i kodowanie identyfikatoraURIComponent. Nie można zaakceptować zestawu SDK nie można utworzyć nazwy obiektu blob o nazwie "?". W związku z tym wdrażamy strategię 2:

Strategia druga: zestaw SDK nie zakłada, że adres URL został zakodowany lub nie. Po prostu uniknie znaków specjalnych.

Jest to zestaw SDK języka Go w wersji 10. Akceptuje typ adresu URL w języku Go i wywołuje adres URL. EscapedPath(), aby uciec przed specjalnymi znakami niezaobejmowanym.

  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b:", zestaw SDK zostanie uniknięci ciągu ":", na przykład "http://account.blob.core.windows.net/con/b%3A" i wyślij do serwera. Zostanie utworzony obiekt blob o nazwie "b:".
  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b%3A", nie ma znaków specjalnych, więc wyślij "http://account.blob.core.windows.net/con/b%3A" na serwer. Zostanie utworzony obiekt blob o nazwie "b:".
  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b%253A", nie ma znaków specjalnych, więc wyślij "http://account.blob.core.windows.net/con/b%253A" na serwer. Zostanie utworzony obiekt blob o nazwie "b%3A".

Ta strategia zapewnia elastyczność tworzenia z dowolnymi znakami specjalnymi. Ale "%" będzie traktowany jako znaki specjalne, jeśli ciąg adresu URL nie jest zakodowany, nie powinien istnieć znak "%" w ciągu adresu URL, w przeciwnym razie adres URL nie jest prawidłowym adresem URL. Jeśli klient musi utworzyć obiekt blob z wartością "%" w nazwie obiektu blob, użyj ciągu "%25" insead of "%". Podobnie jak powyżej przykładu 3. Następujące ciągi adresów URL są nieprawidłowe:

  • "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"

Innym znakiem specjalnym jest "?", użyj znaku "%2F", aby reprezentować nazwę obiektu blob z znakiem "?" w ciągu adresu URL.

Strategia dla parametrów containerName, blobName lub innych określonych parametrów XXXName w metodach, takich jak BlobURL.fromContainerURL(containerURL, blobName)

Zastosujemy strategię jedną i wywołamy metodę encodeURIComponent dla tych parametrów, takich jak blobName. Ponieważ to, co klienci przekazują, to zwykła nazwa zamiast adresu URL.
getURLParameter(string, string)

Pobierz parametr adresu URL według nazwy.
getURLPath(string)

Pobierz ścieżkę adresu URL z ciągu adresu URL.
getURLQueries(string)

Pobierz pary wartości klucza zapytania adresu URL z ciągu adresu URL.
padStart(string, number, undefined | string)

String.prototype.padStart()
setURLHost(string, string)

Ustaw hosta adresu URL.
setURLParameter(string, string, undefined | string)

Ustaw nazwę i wartość parametru adresu URL. Jeśli nazwa istnieje w parametrach adresu URL, stara wartość zostanie zastąpiona przez klucz nazwy. Jeśli nie podaj wartości, parametr zostanie usunięty.
truncatedISO8061Date(Date, undefined | false | true)

Zaokrągla datę do sekund.
streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Odczytuje strumień czytelny do buforu. Wypełnij bufor z przesunięcia na koniec.

Szczegóły funkcji

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Generuje obiekt <xref:SASQueryParameters> zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametry

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Zwraca

SASQueryParameters

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Tworzy wystąpienie parametrów SASQueryParameters.

Akceptuje tylko wymagane ustawienia wymagane do utworzenia sygnatury dostępu współdzielonego. W przypadku ustawień opcjonalnych ustaw odpowiednie właściwości bezpośrednio, takie jak uprawnienia, startTime i identyfikator.

OSTRZEŻENIE: Jeśli nie podano identyfikatora, wymagane są uprawnienia i czas wygaśnięcia. Musisz przypisać wartość do identyfikatora lub wygaśnięciaTime & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametry

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Zwraca

SASQueryParameters

ipRangeToString(IIPRange)

Generowanie ciągu formatu IPRange. Na przykład: "8.8.8.8" lub "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parametry

ipRange
IIPRange

Zwraca

string

rangeToString(IRange)

Generowanie ciągu zakresu. Na przykład: "bytes=255-" lub "bytes=0-511"

function rangeToString(iRange: IRange)

Parametry

iRange
IRange

Zwraca

string

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

DOSTĘPNE TYLKO W PRZEGLĄDARKACH. Przekazuje obiekt Blob/File/ArrayBuffer/ArrayBufferView przeglądarki do pliku platformy Azure.

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

Parametry

aborter
Aborter

Tworzenie nowego wystąpienia Aborter z elementem Aborter.none lub Aborter.timeout(), goto documents of Aborter (Goto documents of Aborter), aby uzyskać więcej przykładów na temat anulowania żądania

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer lub ArrayBufferView

fileURL
FileURL
options
IUploadToAzureFileOptions

Zwraca

Promise<void>

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

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera plik platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby pobrać cały plik.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

Parametry

aborter
Aborter

Tworzenie nowego wystąpienia Aborter z elementem Aborter.none lub Aborter.timeout(), goto documents of Aborter (Goto documents of Aborter), aby uzyskać więcej przykładów na temat anulowania żądania

buffer

Buffer

Bufor do wypełnienia, musi mieć długość większą niż liczba

fileURL
FileURL

Obiekt FileURL

offset

number

Z której pozycji pliku platformy Azure do pobrania

count

undefined | number

options
IDownloadFromAzureFileOptions

Zwraca

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje plik lokalny do pliku platformy Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parametry

aborter
Aborter

Tworzenie nowego wystąpienia Aborter z elementem Aborter.none lub Aborter.timeout(), goto documents of Aborter (Goto documents of Aborter), aby uzyskać więcej przykładów na temat anulowania żądania

filePath

string

Pełna ścieżka pliku lokalnego

fileURL
FileURL

FileURL

options
IUploadToAzureFileOptions

Zwraca

Promise<void>

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

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje strumień z możliwością odczytu Node.js do pliku platformy Azure. Ta metoda spróbuje utworzyć platformę Azure, a następnie rozpocznie przekazywanie fragmentu według fragmentu. Rozmiar fragmentu jest definiowany przez parametr bufferSize. Upewnij się, że potencjalny rozmiar strumienia nie przekracza rozmiaru pliku.

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

  • Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Parametry

aborter
Aborter

Tworzenie nowego wystąpienia Aborter z elementem Aborter.none lub Aborter.timeout(), goto documents of Aborter (Goto documents of Aborter), aby uzyskać więcej przykładów na temat anulowania żądania

stream

Readable

Node.js strumienia z możliwością odczytu. Musi być mniejszy lub równy rozmiarowi pliku.

size

number

Rozmiar pliku do utworzenia. Maksymalny dozwolony rozmiar to 1 TB. Jeśli ta wartość jest większa niż rozmiar strumienia, w ogonie pliku będą puste bajty.

fileURL
FileURL

Wystąpienie fileURL

bufferSize

number

Rozmiar każdego buforu przydzielonego w bajtach, a także rozmiar fragmentu/zakresu podczas przekazywania pliku. Rozmiar musi być > 0 i <= 4 * 1024 * 1024 (4 MB)

maxBuffers

number

Maksymalna liczba zostanie przydzielona podczas przekazywania, dodatnia korelacja z maksymalną współbieżnością przekazywania

options
IUploadStreamToAzureFileOptions

Zwraca

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType) 

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parametry

fileAttributes

FileSystemAttributes | FileAttributesPreserveType

Zwraca

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType) 

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametry

time

Date | TimeNowType | TimePreserveType

Zwraca

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType) 

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametry

time

Date | TimeNowType | TimePreserveType

Zwraca

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions) 

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parametry

options
IFileAndDirectoryCreateCommonOptions

Zwraca

IFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions) 

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parametry

options
IFileAndDirectorySetPropertiesCommonOptions

Zwraca

IFileAndDirectorySetPropertiesCommonOptions

validateFilePermissionOptions(undefined | string, undefined | string) 

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

Parametry

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

Metoda fabryki używana do generowania fabryki RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parametry

retryOptions
IRetryOptions

Zwraca

RequestPolicyFactory

blobToArrayBuffer(Blob)

Przekonwertuj obiekt blob przeglądarki na arrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parametry

blob

Blob

Zwraca

Promise<ArrayBuffer>

appendToURLPath(string, string)

Dołącz ciąg do ścieżki adresu URL. Spowoduje usunięcie zduplikowanego ciągu "/" przed ciągiem, gdy ścieżka adresu URL kończy się ciągiem "/".

function appendToURLPath(url: string, name: string)

Parametry

url

string

Ciąg źródłowego adresu URL

name

string

Ciąg do dołączenia do adresu URL

Zwraca

string

Zaktualizowany ciąg adresu URL

base64decode(string)

Dekodowanie base64.

function base64decode(encodedString: string)

Parametry

encodedString

string

Zwraca

string

base64encode(string)

Kodowanie base64.

function base64encode(content: string)

Parametry

content

string

Zwraca

string

delay(number, AbortSignalLike, Error)

Opóźnienie określonego interwału czasu.

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

Parametry

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Zwraca

Promise<unknown>

escapeURLPath(string)

Znaki zastrzeżonego adresu URL muszą być poprawnie ucieczki dla usług storage, takich jak Blob lub File.

Kodowanie adresów URL i strategia ucieczki dla zestawów SDK JSv10

Gdy klienci przekazują ciąg adresu URL do konstruktora klas XXXURL, ciąg adresu URL może być już zakodowany w adresie URL lub nie. Jednak przed wysłaniem do serwera usługi Azure Storage adres URL musi być zakodowany. Jednak trudno jest odgadnąć, czy ciąg adresu URL został zakodowany, czy nie. Mamy 2 potencjalne strategie i wybraliśmy strategię 2 dla konstruktorów XXXURL.

Strategia pierwsza: Załóżmy, że ciąg adresu URL klienta nie jest zakodowany i zawsze koduje ciąg adresu URL w zestawie SDK.

Jest to, co robi starszy zestaw SDK w wersji 2, prosty i działa w większości przypadków.

  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b:", zestaw SDK zakoduje go do "http://account.blob.core.windows.net/con/b%3A" i wyślij do serwera. Zostanie utworzony obiekt blob o nazwie "b:".
  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b%3A", zestaw SDK zakoduje go do "http://account.blob.core.windows.net/con/b%253A" i wyślij do serwera. Zostanie utworzony obiekt blob o nazwie "b%3A".

Jednak ta strategia uniemożliwi utworzenie obiektu blob o nazwie "?". Ponieważ gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/blob?name", parametr "?name" będzie traktowany jako parametr adresu URL zamiast nazwy obiektu blob. Jeśli ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/blob%3Fname", zostanie utworzony obiekt blob o nazwie "blob%3Fname". Zestaw SDK w wersji 2 nie ma tego problemu, ponieważ nie zezwala klientowi na przekazywanie pełnego adresu URL, akceptuje oddzielną nazwę obiektu blob i kodowanie identyfikatoraURIComponent. Nie można zaakceptować zestawu SDK nie można utworzyć nazwy obiektu blob o nazwie "?". W związku z tym wdrażamy strategię 2:

Strategia druga: zestaw SDK nie zakłada, że adres URL został zakodowany lub nie. Po prostu uniknie znaków specjalnych.

Jest to zestaw SDK języka Go w wersji 10. Akceptuje typ adresu URL w języku Go i wywołuje adres URL. EscapedPath(), aby uciec przed specjalnymi znakami niezaobejmowanym.

  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b:", zestaw SDK zostanie uniknięci ciągu ":", na przykład "http://account.blob.core.windows.net/con/b%3A" i wyślij do serwera. Zostanie utworzony obiekt blob o nazwie "b:".
  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b%3A", nie ma znaków specjalnych, więc wyślij "http://account.blob.core.windows.net/con/b%3A" na serwer. Zostanie utworzony obiekt blob o nazwie "b:".
  • Gdy ciąg adresu URL klienta to "http://account.blob.core.windows.net/con/b%253A", nie ma znaków specjalnych, więc wyślij "http://account.blob.core.windows.net/con/b%253A" na serwer. Zostanie utworzony obiekt blob o nazwie "b%3A".

Ta strategia zapewnia elastyczność tworzenia z dowolnymi znakami specjalnymi. Ale "%" będzie traktowany jako znaki specjalne, jeśli ciąg adresu URL nie jest zakodowany, nie powinien istnieć znak "%" w ciągu adresu URL, w przeciwnym razie adres URL nie jest prawidłowym adresem URL. Jeśli klient musi utworzyć obiekt blob z wartością "%" w nazwie obiektu blob, użyj ciągu "%25" insead of "%". Podobnie jak powyżej przykładu 3. Następujące ciągi adresów URL są nieprawidłowe:

  • "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"

Innym znakiem specjalnym jest "?", użyj znaku "%2F", aby reprezentować nazwę obiektu blob z znakiem "?" w ciągu adresu URL.

Strategia dla parametrów containerName, blobName lub innych określonych parametrów XXXName w metodach, takich jak BlobURL.fromContainerURL(containerURL, blobName)

Zastosujemy strategię jedną i wywołamy metodę encodeURIComponent dla tych parametrów, takich jak blobName. Ponieważ to, co klienci przekazują, to zwykła nazwa zamiast adresu URL.

function escapeURLPath(url: string)

Parametry

url

string

Zwraca

string

getURLParameter(string, string)

Pobierz parametr adresu URL według nazwy.

function getURLParameter(url: string, name: string)

Parametry

url

string

name

string

Zwraca

string | string[] | undefined

getURLPath(string)

Pobierz ścieżkę adresu URL z ciągu adresu URL.

function getURLPath(url: string)

Parametry

url

string

Ciąg źródłowego adresu URL

Zwraca

string | undefined

getURLQueries(string)

Pobierz pary wartości klucza zapytania adresu URL z ciągu adresu URL.

function getURLQueries(url: string)

Parametry

url

string

Zwraca

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

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

Parametry

currentString

string

targetLength

number

padString

undefined | string

Zwraca

string

setURLHost(string, string)

Ustaw hosta adresu URL.

function setURLHost(url: string, host: string)

Parametry

url

string

Ciąg źródłowego adresu URL

host

string

Nowy ciąg hosta

Zwraca

string

Zaktualizowany ciąg adresu URL

setURLParameter(string, string, undefined | string)

Ustaw nazwę i wartość parametru adresu URL. Jeśli nazwa istnieje w parametrach adresu URL, stara wartość zostanie zastąpiona przez klucz nazwy. Jeśli nie podaj wartości, parametr zostanie usunięty.

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

Parametry

url

string

Ciąg źródłowego adresu URL

name

string

Nazwa parametru

value

undefined | string

Zwraca

string

Zaktualizowany ciąg adresu URL

truncatedISO8061Date(Date, undefined | false | true)

Zaokrągla datę do sekund.

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

Parametry

date

Date

withMilliseconds

undefined | false | true

Zwraca

string

Ciąg daty w formacie ISO8061 z składnikiem 7 milisekund lub bez

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

Odczytuje strumień czytelny do buforu. Wypełnij bufor z przesunięcia na koniec.

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

Parametry

stream

ReadableStream

Strumień z możliwością odczytu Node.js

buffer

Buffer

Bufor do wypełnienia, długość musi >= przesunięcie

offset

number

Z której pozycji w buforze do wypełnienia, włącznie

end

number

Do której pozycji w buforze do wypełnienia, wyłączność

encoding

undefined | string

Zwraca

Promise<void>