@azure/storage-file-share package

Klasy

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 AccountSASSignatureValues obiektu. 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 powinna zostać zserializowana ciągiem toString i ustawiona jako pole zasobów na AccountSASSignatureValues obiektu. 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 AccountSASSignatureValues obiektu. Można skonstruować ciąg usług bez tej klasy, ale kolejność usług jest określona, a ta klasa gwarantuje poprawność.
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).
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).
BaseRequestPolicy	Klasa bazowa, z której pochodzą wszystkie zasady żądań.
Credential	Credential to abstrakcyjna klasa podpisywania żądań HTTP usługi Azure Storage. Ta klasa będzie hostować fabrykę credentialPolicyCreator, która generuje element CredentialPolicy.
CredentialPolicy	Zasady poświadczeń używane do podpisywania żądań HTTP(S) przed wysłaniem. Jest to abstrakcyjna klasa.
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 FileSASSignatureValues obiektu. 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. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-file#file-system-attributes
Pipeline	Klasa Potok zawierająca zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując newPipeline. Możesz też utworzyć potok przy użyciu własnych zasad przez konstruktor potoku. Przed wdrożeniem dostosowanego potoku zapoznaj się z tematem newPipeline i podano zasady.
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 on generowany tylko przez typy AccountSASSignatureValues i FileSASSignatureValue s. Po wygenerowaniu można je kodować w toString() i dołączać 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.
ShareClient	Obiekt ShareClient reprezentuje adres URL udziału usługi Azure Storage, który umożliwia manipulowanie jego katalogami i plikami.
ShareDirectoryClient	Obiekt ShareDirectoryClient reprezentuje adres URL katalogu usługi Azure Storage, który umożliwia manipulowanie jego plikami i katalogami.
ShareFileClient	Obiekt ShareFileClient reprezentuje adres URL pliku usługi Azure Storage.
ShareLeaseClient	Klient zarządzający dzierżawami ShareFileClient lub ShareClient. Zobacz https://learn.microsoft.com/rest/api/storageservices/lease-file i Zobacz https://learn.microsoft.com/rest/api/storageservices/lease-share
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 FileSASSignatureValues obiektu. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
ShareServiceClient	Obiekt ShareServiceClient reprezentuje adres URL usługi Plików usługi Azure Storage, co umożliwia manipulowanie udziałami plików.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageBrowserPolicy.
StorageRetryPolicy	Zasady ponawiania próby z implementacją ponawiania wykładniczego i ponawiania liniowego.
StorageRetryPolicyFactory	StorageRetryPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageRetryPolicy.
StorageSharedKeyCredential	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. StorageSharedKeyCredential na potrzeby autoryzacji klucza konta usługi Azure Storage.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy to zasady używane do podpisywania żądania HTTP przy użyciu klucza współużytkowanego.

Interfejsy

AccessPolicy	Zasady dostępu.
AccountSASSignatureValues	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. AccountSASSignatureValues 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 generateAccountSASQueryParameters, 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 sasQueryParameters istnieją, ponieważ były jest modyfikowalny i reprezentacja logiczna, podczas gdy drugi jest niezmienny i używany do generowania rzeczywistych żądań REST. Zobacz https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1, aby uzyskać więcej informacji koncepcyjnych na temat sygnatury dostępu współdzielonego zobacz https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas opisy parametrów, w tym wymagane
ClearRange
CloseHandlesInfo	Zamknij obsługuje informacje o wynikach.
CommonGenerateSasUrlOptions	Typowe opcje ShareGenerateSasUrlOptions i FileGenerateSasUrlOptions.
CommonOptions	Interfejs dla opcji typowych dla każdej operacji zdalnej.
CopyFileSmbInfo	Grupa parametrów
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.
DirectoryCloseHandlesHeaders	Dodatkowe wartości nagłówka odpowiedzi dla żądania zamknięcia dojść.
DirectoryCreateHeaders	Definiuje nagłówki dla operacji Directory_create.
DirectoryCreateIfNotExistsResponse	Zawiera dane odpowiedzi dla operacji createIfNotExists(DirectoryCreateOptions).
DirectoryCreateOptions	Opcje konfigurowania operacji tworzenia.
DirectoryDeleteHeaders	Definiuje nagłówki dla operacji Directory_delete.
DirectoryDeleteIfExistsResponse	Zawiera dane odpowiedzi dla operacji deleteIfExists(DirectoryDeleteOptions).
DirectoryDeleteOptions	Opcje konfigurowania operacji usuwania .
DirectoryExistsOptions	Opcje konfigurowania istnieją operacji.
DirectoryForceCloseHandlesHeaders	Definiuje nagłówki dla operacji Directory_forceCloseHandles.
DirectoryForceCloseHandlesOptions	Opcje konfigurowania forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Opcje konfigurowania katalogu — wymuszaj operacje segmentowania dojść zamkniętych. See: <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	Definiuje nagłówki dla operacji Directory_getProperties.
DirectoryGetPropertiesOptions	Opcje konfigurowania operacji getProperties.
DirectoryItem	Element katalogu na liście.
DirectoryListFilesAndDirectoriesOptions	Opcje konfigurowania listFilesAndDirectories operacji.
DirectoryListFilesAndDirectoriesSegmentHeaders	Definiuje nagłówki dla operacji Directory_listFilesAndDirectoriesSegment.
DirectoryListHandlesHeaders	Definiuje nagłówki dla operacji Directory_listHandles.
DirectoryListHandlesOptions	Opcje konfigurowania operacji listHandles.
DirectoryListHandlesSegmentOptions	Opcje konfigurowania katalogu — lista obsługuje operacje segmentu. See: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	Interfejs dla opcji typowych dla każdej operacji zdalnej.
DirectoryRenameHeaders	Definiuje nagłówki dla operacji Directory_rename.
DirectoryRenameOptions	Opcje konfigurowania operacji zmiany nazwy.
DirectorySetMetadataHeaders	Definiuje nagłówki dla operacji Directory_setMetadata.
DirectorySetMetadataOptions	Opcje konfigurowania setMetadata operacji.
DirectorySetPropertiesHeaders	Definiuje nagłówki dla operacji Directory_setProperties.
FileAbortCopyFromURLOptions	Opcje konfigurowania operacji abortCopyFromURL.
FileAbortCopyHeaders	Definiuje nagłówki dla operacji File_abortCopy.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Opcje konfigurowania operacji clearRange.
FileCloseHandlesHeaders	Dodatkowe wartości nagłówka odpowiedzi dla żądania zamknięcia dojść.
FileCreateHardLinkHeaders	Definiuje nagłówki dla operacji File_createHardLink.
FileCreateHardLinkOptions	Opcje konfigurowania pliku — tworzenie operacji łączenia twardego. See: createHardLink
FileCreateHeaders	Definiuje nagłówki dla operacji File_create.
FileCreateOptions	Opcje konfigurowania operacji tworzenia .
FileCreateSymbolicLinkHeaders	Definiuje nagłówki dla operacji File_createSymbolicLink.
FileCreateSymbolicLinkOptions	Opcje konfiguracji Plik - Utwórz operacje dowiązania symbolicznego. See: createSymbolicLink
FileDeleteHeaders	Definiuje nagłówki dla operacji File_delete.
FileDeleteIfExistsResponse	Zawiera dane odpowiedzi dla operacji deleteIfExists.
FileDeleteOptions	Opcje konfigurowania operacji usuwania .
FileDownloadHeaders	Definiuje nagłówki dla operacji File_download.
FileDownloadOptionalParams	Parametry opcjonalne.
FileDownloadOptions	Opcje konfigurowania plików — operacje pobierania. See: download downloadToFile
FileDownloadToBufferOptions	Interfejs opcji dla operacji downloadToBuffer.
FileExistsOptions	Opcje konfigurowania istnieją operacji.
FileForceCloseHandlesHeaders	Definiuje nagłówki dla operacji File_forceCloseHandles.
FileForceCloseHandlesOptions	Opcje konfigurowania pliku — wymuszanie operacji zamykania dojść. See: <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	Opcje konfigurowania generateSasUrl operacji.
FileGetPropertiesHeaders	Definiuje nagłówki dla operacji File_getProperties.
FileGetPropertiesOptions	Opcje konfigurowania operacji getProperties.
FileGetRangeListHeaders	Definiuje nagłówki dla operacji File_getRangeList.
FileGetRangeListOptions	Opcje konfigurowania operacji getRangeList.
FileGetSymbolicLinkHeaders	Definiuje nagłówki dla operacji File_getSymbolicLink.
FileGetSymbolicLinkOptions	Opcje konfiguracji operacji Plik — Pobierz dowiązanie symboliczne. See: getSymbolicLink
FileHttpHeaders
FileItem	Element pliku na liście.
FileListHandlesHeaders	Definiuje nagłówki dla operacji File_listHandles.
FileListHandlesOptions	Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileListHandlesSegmentOptions	Opcje konfigurowania operacji file — List Handles Segment operations (Opcje konfigurowania plików — lista dojść segmentów). See: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	Interfejs opcji dla pliku — operacje przekazywania See: uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	Właściwości NFS. Należy pamiętać, że te właściwości dotyczą tylko plików lub katalogów na kontach plików NFS w warstwie Premium.
FileProperties	Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileProperty	Właściwości pliku.
FileRenameHeaders	Definiuje nagłówki dla operacji File_rename.
FileRenameOptions	Opcje konfigurowania operacji zmiany nazwy.
FileResizeOptions	Opcje konfigurowania operacji zmiany rozmiaru .
FileSASSignatureValues	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. FileSASSignatureValues służy do generowania tokenów SAS usługi plików dla udziałów lub plików.
FileServiceProperties	Właściwości usługi Storage.
FileSetHTTPHeadersHeaders	Definiuje nagłówki dla operacji File_setHttpHeaders.
FileSetHttpHeadersOptions	Opcje konfigurowania setHttpHeaders operacji.
FileSetMetadataHeaders	Definiuje nagłówki dla operacji File_setMetadata.
FileSetMetadataOptions	Opcje konfigurowania setMetadata operacji.
FileStartCopyHeaders	Definiuje nagłówki dla operacji File_startCopy.
FileStartCopyOptions	Opcje konfigurowania operacji startCopyFromURL.
FileUploadRangeFromURLHeaders	Definiuje nagłówki dla operacji File_uploadRangeFromURL.
FileUploadRangeFromURLOptionalParams	Parametry opcjonalne.
FileUploadRangeFromURLOptions	Opcje konfigurowania operacji uploadRangeFromURL.
FileUploadRangeHeaders	Definiuje nagłówki dla operacji File_uploadRange.
FileUploadRangeOptions	Opcje konfigurowania operacji uploadRange.
FileUploadStreamOptions	Interfejs opcji dla shareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Abstrakcja dla wpisów, które można wymienić z katalogu.
HandleItem	Element dojścia do usługi Azure Storage na liście.
HttpAuthorization	Reprezentuje informacje uwierzytelniania w wartościach nagłówków Authorization, ProxyAuthorization, WWW-Authentication i Proxy-Authenticate.
HttpHeaders	Kolekcja par klucz/wartość nagłówka HTTP.
HttpOperationResponse	Odpowiedź HTTP zgodna z core-v1(core-http).
HttpResponse	Reprezentacja odpowiedzi HTTP, która zawiera odwołanie do żądania, które go pochodzi.
LeaseAccessConditions	Grupa parametrów
LeaseOperationOptions	opcje operacji dzierżawy.
LeaseOperationResponseHeaders	Szczegóły odpowiedzi dla określonej operacji dzierżawy.
ListFilesAndDirectoriesSegmentResponse	Wyliczenie katalogów i plików.
ListHandlesResponse	Wyliczenie dojść.
ListSharesResponse	Wyliczenie udziałów.
ListSharesResponseModel	Wyliczenie udziałów.
Metadata
Metrics	Metryki usługi Storage Analytics dla usługi plików.
NfsFileMode	Uprawnienia trybu pliku lub katalogu.
PipelineLike	Interfejs klasy potoku zawierający zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując newPipeline. Możesz też utworzyć potok przy użyciu własnych zasad przez konstruktor potoku. Przed wdrożeniem dostosowanego potoku zapoznaj się z tematem newPipeline i podano zasady.
PipelineOptions	Interfejs opcji konstruktora potoku.
PosixRolePermissions	Reprezentuje uprawnienia do plików dla określonej roli.
Range	Zakres operacji usługi. Zobacz https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Zakres plików usługi Azure Storage.
RequestPolicy	Zgodny interfejs zasad żądań core-http
RequestPolicyFactory	Interfejs umożliwiający zgodność z elementem RequestPolicyFactory core-http
RequestPolicyOptions	Interfejs umożliwiający zgodność z zasadami RequestPolicy
ResponseLike	Obiekt z prostą właściwością _response.
ResponseWithBody	Obiekt z właściwością _response, która ma już treść i nagłówki analizowane w znanych typach.
ResponseWithHeaders	Obiekt z właściwością _response, która ma nagłówki już analizowane w typowanym obiekcie.
RestError	Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.
RetentionPolicy	Zasady przechowywania.
SasIPRange	Dozwolony zakres adresów IP dla sygnatury dostępu współdzielonego.
ServiceClientOptions	Podzestaw `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opcje konfigurowania operacji generowania generateAccountSasUrl.
ServiceGetPropertiesHeaders	Definiuje nagłówki dla operacji Service_getProperties.
ServiceGetPropertiesOptions	Opcje konfigurowania operacji getProperties.
ServiceListSharesOptions	Opcje konfigurowania operacji listShares.
ServiceListSharesSegmentHeaders	Definiuje nagłówki dla operacji Service_listSharesSegment.
ServiceSetPropertiesHeaders	Definiuje nagłówki dla operacji Service_setProperties.
ServiceSetPropertiesOptions	Opcje konfigurowania operacji setProperties.
ServiceUndeleteShareOptions	Opcje konfigurowania operacji <xref:ShareServiceClient.undelete>.
SetPropertiesResponse	Zawiera dane odpowiedzi dla operacji setHttpHeaders.
ShareClientConfig
ShareCreateHeaders	Definiuje nagłówki dla operacji Share_create.
ShareCreateIfNotExistsResponse	Zawiera dane odpowiedzi dla operacji createIfNotExists.
ShareCreateOptions	Opcje konfigurowania operacji tworzenia .
ShareCreatePermissionHeaders	Definiuje nagłówki dla operacji Share_createPermission.
ShareCreatePermissionOptions	Opcje konfigurowania operacji createPermission.
ShareCreateSnapshotHeaders	Definiuje nagłówki dla operacji Share_createSnapshot.
ShareCreateSnapshotOptions	Opcje konfigurowania createSnapshot operacji.
ShareDeleteHeaders	Definiuje nagłówki dla operacji Share_delete.
ShareDeleteIfExistsResponse	Zawiera dane odpowiedzi dla operacji deleteIfExists.
ShareDeleteMethodOptions	Opcje konfigurowania operacji usuwania .
ShareExistsOptions	Opcje konfigurowania istnieją operacji.
ShareFileRangeList	Lista zakresów plików
ShareGenerateSasUrlOptions	Opcje konfigurowania generateSasUrl operacji.
ShareGetAccessPolicyHeaders	Definiuje nagłówki dla operacji Share_getAccessPolicy.
ShareGetAccessPolicyOptions	Opcje konfigurowania operacji getAccessPolicy.
ShareGetPermissionHeaders	Definiuje nagłówki dla operacji Share_getPermission.
ShareGetPermissionOptions	Opcje konfigurowania operacji getPermission.
ShareGetPropertiesHeaders	Definiuje nagłówki dla operacji Share_getProperties.
ShareGetPropertiesOptions	Opcje konfigurowania operacji getProperties.
ShareGetStatisticsHeaders	Definiuje nagłówki dla operacji Share_getStatistics.
ShareGetStatisticsOptions	Opcje konfigurowania operacji getStatistics.
ShareItem	Element udziału usługi Azure Storage na liście.
ShareItemInternal	Element udziału usługi Azure Storage na liście.
SharePermission	Uprawnienie (deskryptor zabezpieczeń) na poziomie udziału.
SharePropertiesInternal	Właściwości udziału.
ShareProtocolSettings	Ustawienia protokołu
ShareProtocols	Protokoły umożliwiające włączenie udziału. Na razie obsługują tylko protokół SMB lub NFS.
ShareSetAccessPolicyHeaders	Definiuje nagłówki dla operacji Share_setAccessPolicy.
ShareSetAccessPolicyOptions	Opcje konfigurowania setAccessPolicy operacji.
ShareSetMetadataHeaders	Definiuje nagłówki dla operacji Share_setMetadata.
ShareSetMetadataOptions	Opcje konfigurowania setMetadata operacji.
ShareSetPropertiesHeaders	Definiuje nagłówki dla operacji Share_setProperties.
ShareSetPropertiesOptions	Opcje konfigurowania operacji setProperties.
ShareSetQuotaOptions	Opcje konfigurowania operacji setQuota.
ShareSmbSettings	Ustawienia protokołu SMB.
ShareStats	Statystyki udziału.
SignedIdentifier	Podpisany identyfikator
SignedIdentifierModel	Podpisany identyfikator.
SmbMultichannel	Ustawienia wielokanałowego protokołu SMB
SourceModifiedAccessConditions	Grupa parametrów
StoragePipelineOptions	Interfejs opcji dla funkcji newPipeline.
StorageRetryOptions	Interfejs opcji ponawiania prób obiektu blob usługi Storage.
WebResource	Opis żądania HTTP, który ma zostać złożony na serwerze zdalnym.

Aliasy typu

CopyStatusType	Definiuje wartości copyStatusType.
DeleteSnapshotsOptionType	Definiuje wartości deleteSnapshotsOptionType.
DirectoryCreateResponse	Zawiera dane odpowiedzi dla operacji tworzenia.
DirectoryDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
DirectoryForceCloseHandlesResponse	Typ odpowiedzi dla forceCloseHandle.
DirectoryGetPropertiesResponse	Zawiera dane odpowiedzi dla operacji getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse	Zawiera dane odpowiedzi dla operacji listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse	Zawiera dane odpowiedzi dla operacji listHandles.
DirectoryRenameResponse	Zawiera dane odpowiedzi dla operacji zmiany nazwy.
DirectorySetMetadataResponse	Zawiera dane odpowiedzi dla operacji setMetadata.
DirectorySetPropertiesResponse	Zawiera dane odpowiedzi dla operacji setProperties.
FileAbortCopyResponse	Zawiera dane odpowiedzi dla operacji abortCopy.
FileAttributesPreserveType	Wskazuje, że istniejące atrybuty pliku pozostają niezmienione.
FileCreateHardLinkResponse	Zawiera dane odpowiedzi dla operacji tworzenia twardego łącza.
FileCreateResponse	Zawiera dane odpowiedzi dla operacji tworzenia.
FileCreateSymbolicLinkResponse	Zawiera dane odpowiedzi dla operacji tworzenia twardego łącza.
FileDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
FileDownloadResponseModel	Zawiera dane odpowiedzi dla operacji pobierania.
FileForceCloseHandlesResponse	Typ odpowiedzi dla forceCloseHandle.
FileGetPropertiesResponse	Zawiera dane odpowiedzi dla operacji getProperties.
FileGetRangeListDiffResponse	Zawiera dane odpowiedzi dla operacji getRangeList.
FileGetRangeListResponse	Zawiera dane odpowiedzi dla operacji getRangeList.
FileGetSymbolicLinkResponse	Zawiera dane odpowiedzi dla operacji tworzenia twardego łącza.
FileLastWrittenMode	Definiuje wartości parametru FileLastWrittenMode.
FileListHandlesResponse	Zawiera dane odpowiedzi dla operacji listHandles.
FilePermissionFormat	Definiuje wartości parametru FilePermissionFormat.
FilePermissionInheritType	Wskazuje dziedziczenie uprawnień do pliku z katalogu nadrzędnego.
FilePermissionPreserveType	Wskazuje, że istniejąca wartość uprawnień do pliku pozostaje niezmieniona.
FileRenameResponse	Zawiera dane odpowiedzi dla operacji zmiany nazwy.
FileSetHTTPHeadersResponse	Zawiera dane odpowiedzi dla operacji setHttpHeaders.
FileSetMetadataResponse	Zawiera dane odpowiedzi dla operacji setMetadata.
FileStartCopyResponse	Zawiera dane odpowiedzi dla operacji startCopy.
FileUploadRangeFromURLResponse	Zawiera dane odpowiedzi dla operacji uploadRangeFromURL.
FileUploadRangeResponse	Zawiera dane odpowiedzi dla operacji uploadRange.
HttpRequestBody	Typy ciał obsługiwanych na żądanie. NodeJS.ReadableStream i () => NodeJS.ReadableStream jest tylko węzłem. Blob, ReadableStream<Uint8Array> i () => ReadableStream<Uint8Array> są tylko przeglądarkami.
LeaseDurationType	Definiuje wartości typu LeaseDurationType.
LeaseOperationResponse	Zawiera dane odpowiedzi dotyczące operacji, które uzyskują, zmieniają, przerywają lub zwalniają dzierżawę. Zobacz ShareLeaseClient.
LeaseStateType	Definiuje wartości typu LeaseStateType.
LeaseStatusType	Definiuje wartości typu LeaseStatusType.
ListSharesIncludeType	Definiuje wartości listSharesIncludeType.
ModeCopyMode	Definiuje wartości trybu ModeCopyMode.
NfsFileType	Definiuje wartości NfsFileType. <xref:KnownNfsFileType> można używać zamiennie z NfsFileType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Regular Directory SymLink
OwnerCopyMode	Definiuje wartości elementu OwnerCopyMode.
PermissionCopyModeType	Definiuje wartości parametru PermissionCopyModeType.
RawFileDownloadResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ServiceGetPropertiesResponse	Zawiera dane odpowiedzi dla operacji getProperties.
ServiceListSharesSegmentResponse	Zawiera dane odpowiedzi dla operacji listShares.
ServiceSetPropertiesResponse	Zawiera dane odpowiedzi dla operacji setProperties.
ShareAccessTier	Definiuje wartości dla shareAccessTier.
ShareClientOptions
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 usuwania.
ShareFileHandleAccessRights	Definiuje wartości programu AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Zawiera dane odpowiedzi dla operacji getPermission.
ShareGetPropertiesResponse	Zawiera dane odpowiedzi dla operacji getProperties.
ShareGetPropertiesResponseModel	Zawiera dane odpowiedzi dla operacji getProperties.
ShareGetStatisticsResponse	Dane odpowiedzi dla getStatistics Operation.
ShareGetStatisticsResponseModel	Zawiera dane odpowiedzi dla operacji getStatistics.
ShareProperties	Właściwości udziału.
ShareRootSquash	Definiuje wartości shareRootSquash.
ShareSetAccessPolicyResponse	Zawiera dane odpowiedzi dla operacji setAccessPolicy.
ShareSetMetadataResponse	Zawiera dane odpowiedzi dla operacji setMetadata.
ShareSetPropertiesResponse	Zawiera dane odpowiedzi dla operacji setProperties.
ShareSetQuotaHeaders	Definiuje nagłówki dla operacji setQuota.
ShareSetQuotaResponse	Zawiera dane odpowiedzi dla operacji setQuota.
ShareTokenIntent	Definiuje wartości dla elementu ShareTokenIntent. KnownShareTokenIntent można używać zamiennie z funkcją ShareTokenIntent, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę backup
TimeNowType	Wskazuje ustawienie jako czas żądania.
TimePreserveType	Wskazuje, że istniejąca wartość czasu pozostaje niezmieniona.
WithResponse	Typ reprezentujący wynik operacji ze znaną właściwością _response.

Wyliczenia

KnownShareTokenIntent	Znane wartości ShareTokenIntent akceptowane przez usługę.
SASProtocol	Protokoły dla wygenerowanej sygnatury dostępu współdzielonego.
StorageFileAudience	Definiuje znanych odbiorców chmury dla usługi Storage.
StorageRetryPolicyType	Ponów typy zasad.

Funkcje

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Generuje obiekt SASQueryParameters zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST. Zobacz https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)	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, startOn i identyfikator. OSTRZEŻENIE: Jeśli nie podano identyfikatora, wymagane są uprawnienia i wygaśnięcieWłaściwej. Musisz przypisać wartość do identyfikatora lub wygaśnięćW & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.
getFileServiceAccountAudience(string)	Aby uzyskać odbiorców protokołu OAuth dla konta magazynu dla usługi plików.
isPipelineLike(unknown)	Pomocnik do podjęcia decyzji, czy dany argument spełnia kontrakt potoku
newPipeline(Credential \| TokenCredential, StoragePipelineOptions)	Tworzy nowy obiekt Potok z podanym poświadczenie.
parseOctalFileMode(string)	Przeanalizuj 4-cyfrowy ciąg ósemkowy reprezentujący tryb plików w strukturze NfsFileMode.
parseSymbolicFileMode(string)	Przeanalizuj 9-znakową reprezentację ciągu symbolicznego trybu pliku w strukturze NfsFileMode.
toOctalFileMode(NfsFileMode)	Przekonwertuj strukturę NfsFileMode na 4-cyfrową represenację ciągu ósemkowego.
toSymbolicFileMode(NfsFileMode)	Przekonwertuj NfsFileMod e na ciąg w notacji symbolicznej.

Szczegóły funkcji

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Generuje obiekt SASQueryParameters zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST.

Zobacz https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

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

Parametry

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Zwraca

SASQueryParameters

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, startOn i identyfikator.

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

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

Parametry

fileSASSignatureValues: FileSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Zwraca

SASQueryParameters

Aby uzyskać odbiorców protokołu OAuth dla konta magazynu dla usługi plików.

function getFileServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName: string

Zwraca

string

Pomocnik do podjęcia decyzji, czy dany argument spełnia kontrakt potoku

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline: unknown

Argument, który może być potokiem

Zwraca

pipeline

true, gdy argument spełnia kontrakt potoku

Tworzy nowy obiekt Potok z podanym poświadczenie.

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

Parametry

credential: Credential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

pipelineOptions: StoragePipelineOptions

Optional. Options.

Zwraca

Pipeline

Nowy obiekt Pipeline.

Przeanalizuj 4-cyfrowy ciąg ósemkowy reprezentujący tryb plików w strukturze NfsFileMode.

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

Parametry

input: string

Zwraca

NfsFileMode | undefined

Przeanalizuj 9-znakową reprezentację ciągu symbolicznego trybu pliku w strukturze NfsFileMode.

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

Parametry

input: string

Zwraca

NfsFileMode | undefined

Przekonwertuj strukturę NfsFileMode na 4-cyfrową represenację ciągu ósemkowego.

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

Parametry

input: NfsFileMode

Zwraca

string | undefined

Przekonwertuj NfsFileMod e na ciąg w notacji symbolicznej.

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

Parametry

input: NfsFileMode

Zwraca

string | undefined

Udostępnij za pomocą

@azure/storage-file-share package

Klasy

Interfejsy

Aliasy typu

Znane wartości obsługiwane przez usługę

Znane wartości obsługiwane przez usługę

Wyliczenia

Funkcje

Szczegóły funkcji

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parametry

Zwraca

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

Parametry

Zwraca

getFileServiceAccountAudience(string)

Parametry

Zwraca

isPipelineLike(unknown)

Parametry

Zwraca

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

Parametry

Zwraca

parseOctalFileMode(string)

Parametry

Zwraca

parseSymbolicFileMode(string)

Parametry

Zwraca

toOctalFileMode(NfsFileMode)

Parametry

Zwraca

toSymbolicFileMode(NfsFileMode)

Parametry

Zwraca