Dela via


@azure/storage-file-share package

Klasser

AccountSASPermissions

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält för ett AccountSASSignatureValues-objekt . Det går att skapa 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 skapa 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 i ett AccountSASSignatureValues-objekt . Det går att skapa 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 skapa en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfält i ett AccountSASSignatureValues-objekt . Det går att konstruera tjänststrä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(S)-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(S)-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).

BaseRequestPolicy

Basklassen från vilken alla begärandeprinciper härleds.

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(S)-begäranden 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 skapa en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en fil. Om du anger ett värde till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfält i ett FileSASSignatureValues-objekt . Det går att skapa 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 skapa en sträng som representerar NTFS-attributen till en fil eller katalog.

Se https://docs.microsoft.com/en-us/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.

Se newPipeline och tillhandahållna principer innan du implementerar din anpassade pipeline.

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

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 typerna AccountSASSignatureValues och FileSASSignatureValues . När den har genererats kan den kodas till en toString() och läggas till i en URL direkt (även om försiktighet bör iakttas 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://docs.microsoft.com/rest/api/storageservices/lease-file och se https://docs.microsoft.com/rest/api/storageservices/lease-share

ShareSASPermissions

Det här är en hjälpklass för att skapa en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en resurs. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för den åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet för ett FileSASSignatureValues-objekt . Det går att skapa 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.

StorageBrowserPolicy

StorageBrowserPolicy hanterar skillnader mellan Node.js och webbläsarkörning, inklusive:

  1. Webbläsare cachelagrar GET/HEAD-begäranden genom att lägga till villkorsstyrda rubriker som "IF_MODIFIED_SINCE". StorageBrowserPolicy är en princip som används för att lägga till en tidsstämpelfråga i URL:en för GET/HEAD-begäran och därmed undvika webbläsarens cacheminne.

  2. Ta bort cookierubrik för säkerhet

  3. Ta bort innehållslängdsrubriken för att undvika varningar från webbläsare

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 korrekt anropar du generateAccountSASQueryParameters för att hämta en representation av SAS som faktiskt kan tillämpas på fil-URL:er. Obs! Det finns både den här klassen och SASQueryParameters 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.

Mer https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 konceptuell information om SAS finns https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas i 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

Parametergrupp

CorsRule

CORS är en HTTP-funktion som gör det möjligt för ett webbprogram som körs i en domän att komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som har 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 en domän (ursprungsdomänen) att anropa 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 skapandeå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 borttagningsåtgärden .

DirectoryExistsOptions

Alternativ för att konfigurera den existerande åtgärden.

DirectoryForceCloseHandlesHeaders

Definierar rubriker för Directory_forceCloseHandles åtgärd.

DirectoryForceCloseHandlesOptions

Alternativ för att konfigurera forceCloseHandle.

DirectoryForceCloseHandlesSegmentOptions

Alternativ för att konfigurera Katalog – Tvinga stängningshandtag segmentåtgärder.

Se:

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ärden .

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ärden .

DirectoryListHandlesSegmentOptions

Alternativ för att konfigurera Katalog – Listan hanterar segmentåtgärder.

Se:

  • <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 namnbytesåtgärden .

DirectorySetMetadataHeaders

Definierar rubriker för Directory_setMetadata åtgärd.

DirectorySetMetadataOptions

Alternativ för att konfigurera setMetadata-åtgärden .

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 clearRange-åtgärden .

FileCloseHandlesHeaders

Ytterligare svarshuvudvärden för begäran om nära handtag.

FileCreateHeaders

Definierar rubriker för File_create åtgärd.

FileCreateOptions

Alternativ för att konfigurera skapandeåtgärden .

FileDeleteHeaders

Definierar rubriker för File_delete åtgärd.

FileDeleteIfExistsResponse

Innehåller svarsdata för åtgärden deleteIfExists .

FileDeleteOptions

Alternativ för att konfigurera borttagningsåtgärden .

FileDownloadHeaders

Definierar rubriker för File_download åtgärd.

FileDownloadOptionalParams

Valfria parametrar.

FileDownloadOptions

Alternativ för att konfigurera Fil – Nedladdningsåtgärder.

Se:

FileDownloadToBufferOptions

Alternativgränssnitt för åtgärden downloadToBuffer .

FileExistsOptions

Alternativ för att konfigurera den existerande åtgärden.

FileForceCloseHandlesHeaders

Definierar rubriker för File_forceCloseHandles åtgärd.

FileForceCloseHandlesOptions

Alternativ för att konfigurera åtgärder för fil – Framtvinga stängningshandtag.

Se:

FileGenerateSasUrlOptions

Alternativ för att konfigurera åtgärden generateSasUrl .

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 .

FileHttpHeaders
FileItem

Ett filobjekt i listan.

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.

Se:

  • <xref:ShareFileClient.listHandlesSegment>
  • <xref:ShareFileClient.iterateHandleSegments>
  • <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions

Alternativgränssnitt för Fil – Ladda upp åtgärder

Se:

  • uploadFile
  • <xref:ShareFileClient.uploadSeekableStream>
FileProperties

Ett gränssnitt för alternativ som är gemensamma för varje fjärråtgärd.

FileProperty

Filegenskaper.

FileRenameHeaders

Definierar rubriker för File_rename åtgärd.

FileRenameOptions

Alternativ för att konfigurera namnbytesåtgärden .

FileResizeOptions

Alternativ för att konfigurera storleksändringsåtgärden .

FileSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

FileSASSignatureValues används för att generera SAS-token för filtjänster 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ärden .

FileSetMetadataHeaders

Definierar rubriker för File_setMetadata åtgärd.

FileSetMetadataOptions

Alternativ för att konfigurera setMetadata-åtgärden .

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ärde-par.

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.

IHttpClient

Ett kompatibelt gränssnitt för core-http-begärandeprinciper

LeaseAccessConditions

Parametergrupp

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

Lagringsanalysmått för filtjänsten.

PipelineLike

Ett gränssnitt för pipelineklassen 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.

Se newPipeline och tillhandahållna principer innan du implementerar din anpassade pipeline.

PipelineOptions

Alternativgränssnitt för pipelinekonstruktor.

Range

Intervall för tjänståtgärder.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations

RangeModel

Ett Azure Storage-filintervall.

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

ResponseWithBody

Ett objekt med en _response-egenskap som redan har brödtext och rubriker som redan parsats i kända typer.

ResponseWithHeaders

Ett objekt med en _response egenskap som redan har rubriker som redan parsats till ett typifierat objekt.

RetentionPolicy

Kvarhållningsprincipen.

SasIPRange

Tillåtet IP-intervall för en SAS.

ServiceClientOptions

En delmängd av @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Alternativ för att konfigurera åtgärden generateAccountSasUrl .

ServiceGetPropertiesHeaders

Definierar rubriker för Service_getProperties åtgärd.

ServiceGetPropertiesOptions

Alternativ för att konfigurera åtgärden getProperties .

ServiceListSharesOptions

Alternativ för att konfigurera åtgärden listShares .

ServiceListSharesSegmentHeaders

Definierar rubriker för Service_listSharesSegment åtgärd.

ServiceSetPropertiesHeaders

Definierar rubriker för Service_setProperties åtgärd.

ServiceSetPropertiesOptions

Alternativ för att konfigurera åtgärden setProperties .

ServiceUndeleteShareOptions

Alternativ för att konfigurera åtgärden <xref:ShareServiceClient.undelete> .

SetPropertiesResponse

Innehåller svarsdata för åtgärden setHttpHeaders.

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 skapandeåtgärden .

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ärden.

ShareDeleteIfExistsResponse

Innehåller svarsdata för åtgärden deleteIfExists .

ShareDeleteMethodOptions

Alternativ för att konfigurera borttagningsåtgärden .

ShareExistsOptions

Alternativ för att konfigurera den existerande åtgärden.

ShareFileRangeList

Listan över filintervall

ShareGenerateSasUrlOptions

Alternativ för att konfigurera åtgärden generateSasUrl .

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 getStatistics-åtgärden .

ShareItem

Ett Azure Storage-resursobjekt i listan.

ShareItemInternal

Ett Azure Storage-resursobjekt i listan.

SharePermission

En behörighet (en säkerhetsbeskrivning) på resursnivå.

SharePropertiesInternal

Egenskaper för en resurs.

ShareProtocolSettings

Protokollinställningar

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 setAccessPolicy-åtgärden .

ShareSetMetadataHeaders

Definierar rubriker för Share_setMetadata åtgärd.

ShareSetMetadataOptions

Alternativ för att konfigurera setMetadata-åtgärden .

ShareSetPropertiesHeaders

Definierar rubriker för Share_setProperties åtgärd.

ShareSetPropertiesOptions

Alternativ för att konfigurera åtgärden setProperties .

ShareSetQuotaOptions

Alternativ för att konfigurera setQuota-åtgärden .

ShareSmbSettings

Inställningar för SMB-protokoll.

ShareStats

Statistik för resursen.

SignedIdentifier

Signerad identifierare

SignedIdentifierModel

Signerad identifierare.

SmbMultichannel

Inställningar för SMB multichannel

SourceModifiedAccessConditions

Parametergrupp

StoragePipelineOptions

Alternativgränssnitt för funktionen newPipeline .

StorageRetryOptions

Gränssnitt för alternativ för återförsök i Storage Blob.

WebResource

En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Typalias

CopyStatusType

Definierar värden för CopyStatusType.

CredentialPolicyCreator

En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy.

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 namnbytesåtgärden.

DirectorySetMetadataResponse

Innehåller svarsdata för setMetadata-åtgärden.

DirectorySetPropertiesResponse

Innehåller svarsdata för setProperties-åtgärden.

FileAbortCopyResponse

Innehåller svarsdata för abortCopy-åtgärden.

FileAttributesPreserveType

Anger att befintliga filattribut ska vara oförändrade.

FileCreateResponse

Innehåller svarsdata för skapandeåtgärden.

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 .

FileLastWrittenMode

Definierar värden för FileLastWrittenMode.

FileListHandlesResponse

Innehåller svarsdata för listHandles-åtgärden.

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 namnbytesåtgärden.

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 åtgärden uploadRange.

HttpRequestBody

Typer av organ som stöds i begäran. NodeJS.ReadableStream och () => NodeJS.ReadableStream är endast Node. Blob, ReadableStream och () => ReadableStream ä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.

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 getPermission-åtgärden.

ShareGetPropertiesResponse

Innehåller svarsdata för åtgärden getProperties .

ShareGetPropertiesResponseModel

Innehåller svarsdata för åtgärden getProperties.

ShareGetStatisticsResponse

Svarsdata för getStatistics-åtgärden .

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 åtgärden setMetadata.

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 synonymt med ShareTokenIntent. Den här uppräkningen innehåller 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 tiden 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 Storage.

StorageRetryPolicyType

RetryPolicy-typer.

Funktioner

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters.

Accepterar endast de 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 anges 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älpkomponent som bestämmer om ett visst argument uppfyller pipelinekontraktet

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Skapar ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

Funktionsinformation

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

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

Parametrar

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returer

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en instans av SASQueryParameters.

Accepterar endast de 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 anges 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

getFileServiceAccountAudience(string)

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

function getFileServiceAccountAudience(storageAccountName: string): string

Parametrar

storageAccountName

string

Returer

string

isPipelineLike(unknown)

En hjälpkomponent som bestämmer om ett visst argument uppfyller pipelinekontraktet

function isPipelineLike(pipeline: unknown): pipeline

Parametrar

pipeline

unknown

Ett argument som kan vara en pipeline

Returer

pipeline

true när argumentet uppfyller pipelinekontraktet

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Skapar ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

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

Parametrar

credential

Credential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Valfritt. Alternativ.

Returer

Ett nytt Pipeline-objekt.