@azure/storage-file-share package

Klasser

AccountSASPermissions	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett AccountSASSignatureValues-objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
AccountSASResourceTypes	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de resurser som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den resurstypen. När alla värden har angetts ska detta serialiseras med toString och anges som resursfält på ett AccountSASSignatureValues-objekt. Det går att konstruera resurssträngen utan den här klassen, men resursordningen är speciell och den här klassen garanterar korrekthet.
AccountSASServices	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfält på ett AccountSASSignatureValues-objekt. Det går att konstruera tjänstesträngen utan den här klassen, men ordningen på tjänsterna är speciell och den här klassen garanterar korrekthet.
AnonymousCredential	AnonymousCredential tillhandahåller en credentialPolicyCreator-medlem som används för att skapa AnonymousCredentialPolicy-objekt. AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
BaseRequestPolicy	Basklassen som alla begärandeprinciper härleds från.
Credential	Autentiseringsuppgifter är en abstrakt klass för signering av HTTP-begäranden i Azure Storage. Den här klassen är värd för en credentialPolicyCreator-fabrik som genererar CredentialPolicy.
CredentialPolicy	Princip för autentiseringsuppgifter som används för att signera HTTP-begäranden (S) innan de skickas. Det här är en abstrakt klass.
FileSASPermissions	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en fil. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett FileSASSignatureValues-objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
FileSystemAttributes	Det här är en hjälpklass för att konstruera en sträng som representerar NTFS-attributen till en fil eller katalog. Se https://learn.microsoft.com/rest/api/storageservices/create-file#file-system-attributes
Pipeline	En Pipeline-klass som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa newPipeline. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Läs nyaPipeline- och tillhandahållna principer innan du implementerar din anpassade pipeline.
SASQueryParameters	Representerar de komponenter som utgör en Azure Storage SAS-frågeparametrar. Den här typen skapas inte direkt av användaren. den genereras endast av AccountSASSignatureValues och FileSASSignatureValues typer. När den har genererats kan den kodas till en toString() och läggas till direkt i en URL (även om försiktighet bör vidtas här om det finns befintliga frågeparametrar, vilket kan påverka lämpliga sätt att lägga till dessa frågeparametrar). Obs! Instanser av den här klassen är oföränderliga.
ShareClient	En ShareClient representerar en URL till Azure Storage-resursen så att du kan ändra dess kataloger och filer.
ShareDirectoryClient	En ShareDirectoryClient representerar en URL till Azure Storage-katalogen så att du kan ändra dess filer och kataloger.
ShareFileClient	En ShareFileClient representerar en URL till en Azure Storage-fil.
ShareLeaseClient	En klient som hanterar lån för en ShareFileClient- eller ShareClient. Se https://learn.microsoft.com/rest/api/storageservices/lease-file och Se https://learn.microsoft.com/rest/api/storageservices/lease-share
ShareSASPermissions	Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en resurs. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett FileSASSignatureValues-objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
ShareServiceClient	En ShareServiceClient representerar en URL till Azure Storage File-tjänsten så att du kan ändra filresurser.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory är en fabriksklass som hjälper till att generera StorageBrowserPolicy-objekt.
StorageRetryPolicy	Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.
StorageRetryPolicyFactory	StorageRetryPolicyFactory är en fabriksklass som hjälper till att generera StorageRetryPolicy objekt.
StorageSharedKeyCredential	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. StorageSharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy är en princip som används för att signera HTTP-begäran med en delad nyckel.

Gränssnitt

AccessPolicy	En åtkomstprincip.
AccountSASSignatureValues	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. AccountSASSignatureValues används för att generera en signatur för delad åtkomst (SAS) för ett Azure Storage-konto. När alla värden här har angetts på rätt sätt anropar du genereraAccountSASQueryParameters för att få en representation av SAS som faktiskt kan tillämpas på fil-URL:er. Obs! Att både den här klassen och SASQueryParameters finns eftersom den förra är föränderlig och en logisk representation medan den senare är oföränderlig och används för att generera faktiska REST-begäranden. Se https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 för mer konceptuell information om SAS Se https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas för beskrivningar av parametrarna, inklusive vilka som krävs
ClearRange
CloseHandlesInfo	Close hanterar resultatinformation.
CommonGenerateSasUrlOptions	Vanliga alternativ för ShareGenerateSasUrlOptions och FileGenerateSasUrlOptions.
CommonOptions	Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
CopyFileSmbInfo	Parameter grupp
CorsRule	CORS är en HTTP-funktion som gör att ett webbprogram som körs under en domän kan komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som kallas samma ursprungsprincip som förhindrar att en webbsida anropar API:er i en annan domän. CORS är ett säkert sätt att tillåta att en domän (ursprungsdomänen) anropar API:er i en annan domän.
DirectoryCloseHandlesHeaders	Ytterligare svarshuvudvärden för begäran om nära handtag.
DirectoryCreateHeaders	Definierar rubriker för Directory_create åtgärd.
DirectoryCreateIfNotExistsResponse	Innehåller svarsdata för åtgärden createIfNotExists(DirectoryCreateOptions).
DirectoryCreateOptions	Alternativ för att konfigurera skapa åtgärd.
DirectoryDeleteHeaders	Definierar rubriker för Directory_delete åtgärd.
DirectoryDeleteIfExistsResponse	Innehåller svarsdata för åtgärden deleteIfExists(DirectoryDeleteOptions).
DirectoryDeleteOptions	Alternativ för att konfigurera åtgärden ta bort.
DirectoryExistsOptions	Alternativ för att konfigurera finns åtgärd.
DirectoryForceCloseHandlesHeaders	Definierar rubriker för Directory_forceCloseHandles åtgärd.
DirectoryForceCloseHandlesOptions	Alternativ för att konfigurera forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Alternativ för att konfigurera Katalog – Framtvinga åtgärder för att stänga hanterar segment. See: <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	Definierar rubriker för Directory_getProperties åtgärd.
DirectoryGetPropertiesOptions	Alternativ för att konfigurera åtgärden getProperties.
DirectoryItem	Ett katalogobjekt i listan.
DirectoryListFilesAndDirectoriesOptions	Alternativ för att konfigurera listFilesAndDirectories åtgärd.
DirectoryListFilesAndDirectoriesSegmentHeaders	Definierar rubriker för Directory_listFilesAndDirectoriesSegment åtgärd.
DirectoryListHandlesHeaders	Definierar rubriker för Directory_listHandles åtgärd.
DirectoryListHandlesOptions	Alternativ för att konfigurera listHandles åtgärd.
DirectoryListHandlesSegmentOptions	Alternativ för att konfigurera Katalog – Listan hanterar segmentåtgärder. See: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
DirectoryRenameHeaders	Definierar rubriker för Directory_rename åtgärd.
DirectoryRenameOptions	Alternativ för att konfigurera byta namn på åtgärd.
DirectorySetMetadataHeaders	Definierar rubriker för Directory_setMetadata åtgärd.
DirectorySetMetadataOptions	Alternativ för att konfigurera åtgärden setMetadata.
DirectorySetPropertiesHeaders	Definierar rubriker för Directory_setProperties åtgärd.
FileAbortCopyFromURLOptions	Alternativ för att konfigurera åtgärden abortCopyFromURL.
FileAbortCopyHeaders	Definierar rubriker för File_abortCopy åtgärd.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Alternativ för att konfigurera åtgärden clearRange.
FileCloseHandlesHeaders	Ytterligare svarshuvudvärden för begäran om nära handtag.
FileCreateHardLinkHeaders	Definierar rubriker för File_createHardLink åtgärd.
FileCreateHardLinkOptions	Alternativ för att konfigurera Fil – Skapa hårdlänksåtgärder. See: createHardLink
FileCreateHeaders	Definierar rubriker för File_create åtgärd.
FileCreateOptions	Alternativ för att konfigurera åtgärden skapa.
FileCreateSymbolicLinkHeaders	Definierar rubriker för File_createSymbolicLink åtgärd.
FileCreateSymbolicLinkOptions	Alternativ för att konfigurera åtgärderna Fil – Skapa symbolisk länk. See: createSymbolicLink
FileDeleteHeaders	Definierar rubriker för File_delete åtgärd.
FileDeleteIfExistsResponse	Innehåller svarsdata för åtgärden deleteIfExists.
FileDeleteOptions	Alternativ för att konfigurera åtgärden ta bort.
FileDownloadHeaders	Definierar rubriker för File_download åtgärd.
FileDownloadOptionalParams	Valfria parametrar.
FileDownloadOptions	Alternativ för att konfigurera Fil – Ladda ned åtgärder. See: download downloadToFile
FileDownloadToBufferOptions	Alternativgränssnitt för åtgärden downloadToBuffer.
FileExistsOptions	Alternativ för att konfigurera finns åtgärd.
FileForceCloseHandlesHeaders	Definierar rubriker för File_forceCloseHandles åtgärd.
FileForceCloseHandlesOptions	Alternativ för att konfigurera åtgärder för fil – Framtvinga stängningshandtag. See: <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	Alternativ för att konfigurera genereraSasUrl- åtgärd.
FileGetPropertiesHeaders	Definierar rubriker för File_getProperties åtgärd.
FileGetPropertiesOptions	Alternativ för att konfigurera åtgärden getProperties.
FileGetRangeListHeaders	Definierar rubriker för File_getRangeList åtgärd.
FileGetRangeListOptions	Alternativ för att konfigurera åtgärden getRangeList.
FileGetSymbolicLinkHeaders	Definierar rubriker för File_getSymbolicLink åtgärd.
FileGetSymbolicLinkOptions	Alternativ för att konfigurera åtgärder för att konfigurera Fil – Hämta symbolisk länk. See: getSymbolicLink
FileHttpHeaders
FileItem	Ett angivet filobjekt.
FileListHandlesHeaders	Definierar rubriker för File_listHandles åtgärd.
FileListHandlesOptions	Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
FileListHandlesSegmentOptions	Alternativ för att konfigurera Fil – Listan hanterar segmentåtgärder. See: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	Alternativgränssnitt för Fil – Uppladdningsåtgärder See: uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	NFS-egenskaper. Observera att dessa egenskaper endast gäller för filer eller kataloger i Premium NFS-filkonton.
FileProperties	Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.
FileProperty	Egenskaper för filer.
FileRenameHeaders	Definierar rubriker för File_rename åtgärd.
FileRenameOptions	Alternativ för att konfigurera byta namn på åtgärd.
FileResizeOptions	Alternativ för att konfigurera ändra storlek på åtgärd.
FileSASSignatureValues	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. FileSASSignatureValues används för att generera SAS-token för filtjänsten för resurser eller filer.
FileServiceProperties	Egenskaper för lagringstjänsten.
FileSetHTTPHeadersHeaders	Definierar rubriker för File_setHttpHeaders åtgärd.
FileSetHttpHeadersOptions	Alternativ för att konfigurera setHttpHeaders åtgärd.
FileSetMetadataHeaders	Definierar rubriker för File_setMetadata åtgärd.
FileSetMetadataOptions	Alternativ för att konfigurera åtgärden setMetadata.
FileStartCopyHeaders	Definierar rubriker för File_startCopy åtgärd.
FileStartCopyOptions	Alternativ för att konfigurera åtgärden startCopyFromURL.
FileUploadRangeFromURLHeaders	Definierar rubriker för File_uploadRangeFromURL åtgärd.
FileUploadRangeFromURLOptionalParams	Valfria parametrar.
FileUploadRangeFromURLOptions	Alternativ för att konfigurera åtgärden uploadRangeFromURL.
FileUploadRangeHeaders	Definierar rubriker för File_uploadRange åtgärd.
FileUploadRangeOptions	Alternativ för att konfigurera åtgärden uploadRange.
FileUploadStreamOptions	Alternativgränssnitt för ShareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Abstrakt för poster som kan visas i katalogen.
HandleItem	Ett azure storage-referensobjekt i listan.
HttpAuthorization	Representerar autentiseringsinformation i Auktorisering, ProxyAuthorization, WWW-Authenticate och Proxy-Authenticate rubrikvärden.
HttpHeaders	En samling HTTP-huvudnyckel/värdepar.
HttpOperationResponse	Http-svar som är kompatibelt med core-v1(core-http).
HttpResponse	En representation av ett HTTP-svar som innehåller en referens till den begäran som kom från den.
LeaseAccessConditions	Parameter grupp
LeaseOperationOptions	alternativ för låneåtgärder.
LeaseOperationResponseHeaders	Information om svaret för en specifik låneåtgärd.
ListFilesAndDirectoriesSegmentResponse	En uppräkning av kataloger och filer.
ListHandlesResponse	En uppräkning av referenser.
ListSharesResponse	En uppräkning av resurser.
ListSharesResponseModel	En uppräkning av resurser.
Metadata
Metrics	Mått för Lagringsanalys för filtjänsten.
NfsFileMode	Lägesbehörigheterna för filen eller katalogen.
PipelineLike	Ett gränssnitt för klassen Pipeline som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa newPipeline. Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Läs nyaPipeline- och tillhandahållna principer innan du implementerar din anpassade pipeline.
PipelineOptions	Alternativgränssnitt för pipelinekonstruktor.
PosixRolePermissions	Representerar filbehörigheter för en specifik roll.
Range	Intervall för tjänståtgärder. Se https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Ett Azure Storage-filintervall.
RequestPolicy	Ett kompatibelt gränssnitt för core-http-begärandeprinciper
RequestPolicyFactory	Ett gränssnitt för kompatibilitet med Core-HTTP:s RequestPolicyFactory
RequestPolicyOptions	Ett gränssnitt för kompatibilitet med RequestPolicy
ResponseLike	Ett objekt med en enkel egenskap för _response.
ResponseWithBody	Ett objekt med en _response egenskap som har brödtext och rubriker som redan parsats i kända typer.
ResponseWithHeaders	Ett objekt med en _response egenskap som redan har rubriker parsade i ett typat objekt.
RestError	En anpassad feltyp för misslyckade pipelinebegäranden.
RetentionPolicy	Kvarhållningsprincipen.
SasIPRange	Tillåtna IP-intervall för en SAS.
ServiceClientOptions	En delmängd av `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Alternativ för att konfigurera genereraAccountSasUrl åtgärd.
ServiceGetPropertiesHeaders	Definierar rubriker för Service_getProperties åtgärd.
ServiceGetPropertiesOptions	Alternativ för att konfigurera åtgärden getProperties.
ServiceListSharesOptions	Alternativ för att konfigurera -listanResurser åtgärd.
ServiceListSharesSegmentHeaders	Definierar rubriker för Service_listSharesSegment åtgärd.
ServiceSetPropertiesHeaders	Definierar rubriker för Service_setProperties åtgärd.
ServiceSetPropertiesOptions	Alternativ för att konfigurera setProperties åtgärd.
ServiceUndeleteShareOptions	Alternativ för att konfigurera åtgärden <xref:ShareServiceClient.undelete>.
SetPropertiesResponse	Innehåller svarsdata för setHttpHeaders-åtgärden.
ShareClientConfig
ShareCreateHeaders	Definierar rubriker för Share_create åtgärd.
ShareCreateIfNotExistsResponse	Innehåller svarsdata för åtgärden createIfNotExists.
ShareCreateOptions	Alternativ för att konfigurera åtgärden skapa.
ShareCreatePermissionHeaders	Definierar rubriker för Share_createPermission åtgärd.
ShareCreatePermissionOptions	Alternativ för att konfigurera åtgärden createPermission.
ShareCreateSnapshotHeaders	Definierar rubriker för Share_createSnapshot åtgärd.
ShareCreateSnapshotOptions	Alternativ för att konfigurera åtgärden createSnapshot.
ShareDeleteHeaders	Definierar rubriker för Share_delete åtgärd.
ShareDeleteIfExistsResponse	Innehåller svarsdata för åtgärden deleteIfExists.
ShareDeleteMethodOptions	Alternativ för att konfigurera åtgärden ta bort.
ShareExistsOptions	Alternativ för att konfigurera finns åtgärd.
ShareFileRangeList	Listan över filintervall
ShareGenerateSasUrlOptions	Alternativ för att konfigurera genereraSasUrl- åtgärd.
ShareGetAccessPolicyHeaders	Definierar rubriker för Share_getAccessPolicy åtgärd.
ShareGetAccessPolicyOptions	Alternativ för att konfigurera åtgärden getAccessPolicy.
ShareGetPermissionHeaders	Definierar rubriker för Share_getPermission åtgärd.
ShareGetPermissionOptions	Alternativ för att konfigurera åtgärden getPermission.
ShareGetPropertiesHeaders	Definierar rubriker för Share_getProperties åtgärd.
ShareGetPropertiesOptions	Alternativ för att konfigurera åtgärden getProperties.
ShareGetStatisticsHeaders	Definierar rubriker för Share_getStatistics åtgärd.
ShareGetStatisticsOptions	Alternativ för att konfigurera åtgärden getStatistics.
ShareItem	Ett listat Azure Storage-resursobjekt.
ShareItemInternal	Ett listat Azure Storage-resursobjekt.
SharePermission	En behörighet (en säkerhetsbeskrivning) på resursnivå.
SharePropertiesInternal	Egenskaper för en resurs.
ShareProtocolSettings	Inställningar för protokoll
ShareProtocols	Protokoll som ska aktiveras på resursen. För tillfället stöder endast SMB eller NFS.
ShareSetAccessPolicyHeaders	Definierar rubriker för Share_setAccessPolicy åtgärd.
ShareSetAccessPolicyOptions	Alternativ för att konfigurera åtgärden setAccessPolicy.
ShareSetMetadataHeaders	Definierar rubriker för Share_setMetadata åtgärd.
ShareSetMetadataOptions	Alternativ för att konfigurera åtgärden setMetadata.
ShareSetPropertiesHeaders	Definierar rubriker för Share_setProperties åtgärd.
ShareSetPropertiesOptions	Alternativ för att konfigurera setProperties åtgärd.
ShareSetQuotaOptions	Alternativ för att konfigurera åtgärden setQuota.
ShareSmbSettings	Inställningar för SMB-protokoll.
ShareStats	Statistik för aktien.
SignedIdentifier	Signerad identifierare
SignedIdentifierModel	Signerad identifierare.
SmbMultichannel	Inställningar för SMB multichannel
SourceModifiedAccessConditions	Parameter grupp
StoragePipelineOptions	Alternativgränssnittet för funktionen newPipeline.
StorageRetryOptions	Alternativ för återförsök av lagringsblob.
WebResource	En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Typalias

CopyStatusType	Definierar värden för CopyStatusType.
DeleteSnapshotsOptionType	Definierar värden för DeleteSnapshotsOptionType.
DirectoryCreateResponse	Innehåller svarsdata för skapandeåtgärden.
DirectoryDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
DirectoryForceCloseHandlesResponse	Svarstyp för forceCloseHandle.
DirectoryGetPropertiesResponse	Innehåller svarsdata för åtgärden getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse	Innehåller svarsdata för åtgärden listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse	Innehåller svarsdata för listHandles-åtgärden.
DirectoryRenameResponse	Innehåller svarsdata för åtgärden byt namn.
DirectorySetMetadataResponse	Innehåller svarsdata för setMetadata-åtgärden.
DirectorySetPropertiesResponse	Innehåller svarsdata för åtgärden setProperties.
FileAbortCopyResponse	Innehåller svarsdata för abortCopy-åtgärden.
FileAttributesPreserveType	Anger att befintliga filattribut ska vara oförändrade.
FileCreateHardLinkResponse	Innehåller svarsdata för åtgärden skapa hård länk.
FileCreateResponse	Innehåller svarsdata för skapandeåtgärden.
FileCreateSymbolicLinkResponse	Innehåller svarsdata för åtgärden skapa hård länk.
FileDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
FileDownloadResponseModel	Innehåller svarsdata för nedladdningsåtgärden.
FileForceCloseHandlesResponse	Svarstyp för forceCloseHandle.
FileGetPropertiesResponse	Innehåller svarsdata för åtgärden getProperties.
FileGetRangeListDiffResponse	Innehåller svarsdata för åtgärden getRangeList.
FileGetRangeListResponse	Innehåller svarsdata för åtgärden getRangeList.
FileGetSymbolicLinkResponse	Innehåller svarsdata för åtgärden skapa hård länk.
FileLastWrittenMode	Definierar värden för FileLastWrittenMode.
FileListHandlesResponse	Innehåller svarsdata för listHandles-åtgärden.
FilePermissionFormat	Definierar värden för FilePermissionFormat.
FilePermissionInheritType	Anger ärvd filbehörighet från den överordnade katalogen.
FilePermissionPreserveType	Anger att det befintliga filbehörighetsvärdet ska vara oförändrat.
FileRenameResponse	Innehåller svarsdata för åtgärden byt namn.
FileSetHTTPHeadersResponse	Innehåller svarsdata för setHttpHeaders-åtgärden.
FileSetMetadataResponse	Innehåller svarsdata för setMetadata-åtgärden.
FileStartCopyResponse	Innehåller svarsdata för startCopy-åtgärden.
FileUploadRangeFromURLResponse	Innehåller svarsdata för åtgärden uploadRangeFromURL.
FileUploadRangeResponse	Innehåller svarsdata för uploadRange-åtgärden.
HttpRequestBody	Typer av organ som stöds i begäran. NodeJS.ReadableStream och () => NodeJS.ReadableStream är endast Node. Blob, ReadableStream<Uint8Array> och () => ReadableStream<Uint8Array> är endast webbläsare.
LeaseDurationType	Definierar värden för LeaseDurationType.
LeaseOperationResponse	Innehåller svarsdata för åtgärder som hämtar, ändrar, bryter eller släpper ett lån. Se ShareLeaseClient.
LeaseStateType	Definierar värden för LeaseStateType.
LeaseStatusType	Definierar värden för LeaseStatusType.
ListSharesIncludeType	Definierar värden för ListSharesIncludeType.
ModeCopyMode	Definierar värden för ModeCopyMode.
NfsFileType	Definierar värden för NfsFileType. <xref:KnownNfsFileType> kan användas omväxlande med NfsFileType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Regular Directory SymLink
OwnerCopyMode	Definierar värden för OwnerCopyMode.
PermissionCopyModeType	Definierar värden för PermissionCopyModeType.
RawFileDownloadResponse	Innehåller svarsdata för nedladdningsåtgärden.
ServiceGetPropertiesResponse	Innehåller svarsdata för åtgärden getProperties.
ServiceListSharesSegmentResponse	Innehåller svarsdata för åtgärden listShares.
ServiceSetPropertiesResponse	Innehåller svarsdata för åtgärden setProperties.
ShareAccessTier	Definierar värden för ShareAccessTier.
ShareClientOptions
ShareCreatePermissionResponse	Innehåller svarsdata för åtgärden createPermission.
ShareCreateResponse	Innehåller svarsdata för skapandeåtgärden.
ShareCreateSnapshotResponse	Innehåller svarsdata för åtgärden createSnapshot.
ShareDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
ShareFileHandleAccessRights	Definierar värden för AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Innehåller svarsdata för åtgärden getPermission.
ShareGetPropertiesResponse	Innehåller svarsdata för åtgärden getProperties.
ShareGetPropertiesResponseModel	Innehåller svarsdata för åtgärden getProperties.
ShareGetStatisticsResponse	Svarsdata för getStatistics Operation.
ShareGetStatisticsResponseModel	Innehåller svarsdata för åtgärden getStatistics.
ShareProperties	Egenskaper för en resurs.
ShareRootSquash	Definierar värden för ShareRootSquash.
ShareSetAccessPolicyResponse	Innehåller svarsdata för setAccessPolicy-åtgärden.
ShareSetMetadataResponse	Innehåller svarsdata för setMetadata-åtgärden.
ShareSetPropertiesResponse	Innehåller svarsdata för åtgärden setProperties.
ShareSetQuotaHeaders	Definierar rubriker för setQuota-åtgärden.
ShareSetQuotaResponse	Innehåller svarsdata för setQuota-åtgärden.
ShareTokenIntent	Definierar värden för ShareTokenIntent. KnownShareTokenIntent kan användas utbytbart med ShareTokenIntent innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten backup
TimeNowType	Anger inställningen som tidpunkten för begäran.
TimePreserveType	Anger att det befintliga tidsvärdet ska vara oförändrat.
WithResponse	En typ som representerar ett åtgärdsresultat med en känd _response egenskap.

Uppräkningar

KnownShareTokenIntent	Kända värden för ShareTokenIntent som tjänsten accepterar.
SASProtocol	Protokoll för genererad SAS.
StorageFileAudience	Definierar kända molnmålgrupper för Lagring.
StorageRetryPolicyType	RetryPolicy-typer.

Funktioner

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar en SASQueryParameters objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran. Se https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters. Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare. VARNING! När identifieraren inte har angetts krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.
getFileServiceAccountAudience(string)	Hämta OAuth-målgruppen för ett lagringskonto för filtjänsten.
isPipelineLike(unknown)	En hjälp för att avgöra om ett visst argument uppfyller pipelinekontraktet
newPipeline(Credential \| TokenCredential, StoragePipelineOptions)	Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter.
parseOctalFileMode(string)	Parsa en 4-siffrig oktal strängrepresentation av ett filläge till en NfsFileMode struktur.
parseSymbolicFileMode(string)	Parsa en symbolisk strängrepresentation med 9 tecken för ett filläge till en NfsFileMode struktur.
toOctalFileMode(NfsFileMode)	Konvertera NfsFileMode struktur till en 4-siffrig oktal strängreresenation.
toSymbolicFileMode(NfsFileMode)	Konvertera en NfsFileMode- till en sträng i symbolisk notation.

Funktionsinformation

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Genererar en SASQueryParameters objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.

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

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

Parametrar

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Returer

SASQueryParameters

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters.

Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startsOn och identifierare.

VARNING! När identifieraren inte har angetts krävs behörigheter och expiresOn. Du MÅSTE tilldela värdet till identifieraren eller förfallerPå & behörigheter manuellt om du börjar med den här konstruktorn.

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

Parametrar

fileSASSignatureValues: FileSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Returer

SASQueryParameters

Hämta OAuth-målgruppen för ett lagringskonto för filtjänsten.

function getFileServiceAccountAudience(storageAccountName: string): string

Parametrar

storageAccountName: string

Returer

string

En hjälp för att avgöra om ett visst argument uppfyller pipelinekontraktet

function isPipelineLike(pipeline: unknown): pipeline

Parametrar

pipeline: unknown

Ett argument som kan vara en pipeline

Returer

pipeline

sant när argumentet uppfyller pipelinekontraktet

Skapar ett nytt pipelineobjekt med angivna autentiseringsuppgifter.

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

Parametrar

credential: Credential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

pipelineOptions: StoragePipelineOptions

Optional. Options.

Returer

Pipeline

Ett nytt pipelineobjekt.

Parsa en 4-siffrig oktal strängrepresentation av ett filläge till en NfsFileMode struktur.

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

Parametrar

input: string

Returer

NfsFileMode | undefined

Parsa en symbolisk strängrepresentation med 9 tecken för ett filläge till en NfsFileMode struktur.

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

Parametrar

input: string

Returer

NfsFileMode | undefined

Konvertera NfsFileMode struktur till en 4-siffrig oktal strängreresenation.

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

Parametrar

input: NfsFileMode

Returer

string | undefined

Konvertera en NfsFileMode- till en sträng i symbolisk notation.

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

Parametrar

input: NfsFileMode

Returer

string | undefined

Dela via

@azure/storage-file-share package

Klasser

Gränssnitt

Typalias

Kända värden som stöds av tjänsten

Kända värden som stöds av tjänsten

Uppräkningar

Funktioner

Funktionsinformation

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parametrar

Returer

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

Parametrar

Returer

getFileServiceAccountAudience(string)

Parametrar

Returer

isPipelineLike(unknown)

Parametrar

Returer

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

Parametrar

Returer

parseOctalFileMode(string)

Parametrar

Returer

parseSymbolicFileMode(string)

Parametrar

Returer

toOctalFileMode(NfsFileMode)

Parametrar

Returer

toSymbolicFileMode(NfsFileMode)

Parametrar

Returer