Delen via


@azure/storage-file-share package

Klassen

AccountSASPermissions

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het maken van een tekenreeks die de machtigingen vertegenwoordigt die door een AccountSAS worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die gebruikmaakt van deze machtigingen machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingenveld voor een AccountSASSignatureValues-object . Het is mogelijk om de machtigingstekenreeks te maken zonder deze klasse, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

AccountSASResourceTypes

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het maken van een tekenreeks die de resources vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot dat resourcetype. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het veld resources in een AccountSASSignatureValues-object . Het is mogelijk om de tekenreeks van de resources te maken zonder deze klasse, maar de volgorde van de resources is bijzonder en deze klasse garandeert correctheid.

AccountSASServices

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de services vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot die service. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het veld services in een AccountSASSignatureValues-object . Het is mogelijk om de servicestekenreeks te maken zonder deze klasse, maar de volgorde van de services is bijzonder en deze klasse garandeert correctheid.

AnonymousCredential

AnonymousCredential biedt een credentialPolicyCreator-lid dat wordt gebruikt om AnonymousCredentialPolicy-objecten te maken. AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS).

AnonymousCredentialPolicy

AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS).

BaseRequestPolicy

De basisklasse waaruit alle aanvraagbeleidsregels zijn afgeleid.

Credential

Referentie is een abstracte klasse voor ondertekening van HTTP-aanvragen voor Azure Storage. Deze klasse host een credentialPolicyCreator-factory die CredentialPolicy genereert.

CredentialPolicy

Referentiebeleid dat wordt gebruikt om HTTP(S)-aanvragen te ondertekenen voordat deze worden verzonden. Dit is een abstracte klasse.

FileSASPermissions

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een bestand worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die gebruikmaakt van deze machtigingen machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingenveld voor een FileSASSignatureValues-object . Het is mogelijk om de machtigingstekenreeks te maken zonder deze klasse, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

FileSystemAttributes

Dit is een helperklasse voor het maken van een tekenreeks die de NTFS-kenmerken vertegenwoordigt voor een bestand of map.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes

Pipeline

Een pijplijnklasse met BELEID voor HTTP-aanvragen. U kunt een standaardpijplijn maken door newPipeline aan te roepen. U kunt ook een pijplijn met uw eigen beleid maken door de constructor van Pijplijn.

Raadpleeg newPipeline en opgegeven beleidsregels voordat u uw aangepaste pijplijn implementeert.

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

SASQueryParameters

Vertegenwoordigt de onderdelen waaruit de queryparameters van een Azure Storage SAS zijn opgebouwd. Dit type wordt niet rechtstreeks door de gebruiker samengesteld; deze wordt alleen gegenereerd door de typen AccountSASSignatureValues en FileSASSignatureValues . Zodra deze is gegenereerd, kan deze worden gecodeerd in een toString() en rechtstreeks aan een URL worden toegevoegd (hoewel u hier voorzichtig moet zijn als er bestaande queryparameters zijn, die van invloed kunnen zijn op de juiste manier om deze queryparameters toe te voegen).

OPMERKING: Exemplaren van deze klasse zijn onveranderbaar.

ShareClient

Een ShareClient vertegenwoordigt een URL naar de Azure Storage-share, zodat u de mappen en bestanden kunt bewerken.

ShareDirectoryClient

Een ShareDirectoryClient vertegenwoordigt een URL naar de Azure Storage-map, zodat u de bestanden en mappen kunt bewerken.

ShareFileClient

Een ShareFileClient vertegenwoordigt een URL naar een Azure Storage-bestand.

ShareLeaseClient

Een client die leases voor een ShareFileClient of ShareClient beheert.

Zien https://docs.microsoft.com/rest/api/storageservices/lease-file en zien https://docs.microsoft.com/rest/api/storageservices/lease-share

ShareSASPermissions

Dit is een helperklasse voor het maken van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een share worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die gebruikmaakt van deze machtigingen machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en worden ingesteld als het machtigingenveld voor een FileSASSignatureValues-object . Het is mogelijk om de machtigingstekenreeks te maken zonder deze klasse, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid.

ShareServiceClient

Een ShareServiceClient vertegenwoordigt een URL naar de Azure Storage File-service waarmee u bestandsshares kunt bewerken.

StorageBrowserPolicy

StorageBrowserPolicy verwerkt verschillen tussen Node.js en browserruntime, waaronder:

  1. Browsers plaatsen GET/HEAD-aanvragen in de cache door voorwaardelijke headers toe te voegen, zoals 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is een beleid dat wordt gebruikt om een tijdstempelquery toe te voegen aan de GET/HEAD-aanvraag-URL, waardoor de browsercache wordt vermeden.

  2. Cookieheader verwijderen voor beveiliging

  3. Koptekst met lengte van inhoud verwijderen om waarschuwingen van browsers te voorkomen

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory is een factory-klasse die helpt bij het genereren van StorageBrowserPolicy-objecten.

StorageRetryPolicy

Beleid voor opnieuw proberen met exponentiële nieuwe pogingen en lineaire nieuwe pogingen geïmplementeerd.

StorageRetryPolicyFactory

StorageRetryPolicyFactory is een factory-klasse die helpt bij het genereren van StorageRetryPolicy-objecten .

StorageSharedKeyCredential

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

StorageSharedKeyCredential voor accountsleutelautorisatie van de Azure Storage-service.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy is een beleid dat wordt gebruikt om een HTTP-aanvraag te ondertekenen met een gedeelde sleutel.

Interfaces

AccessPolicy

Een toegangsbeleid.

AccountSASSignatureValues

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

AccountSASSignatureValues wordt gebruikt voor het genereren van een Shared Access Signature (SAS) voor een Azure Storage-account. Zodra alle waarden hier correct zijn ingesteld, roept u generateAccountSASQueryParameters aan om een weergave van de SAS te verkrijgen die daadwerkelijk kan worden toegepast op bestands-URL's. Opmerking: deze klasse en SASQueryParameters bestaan omdat de eerste veranderlijk is en een logische weergave, terwijl de laatste onveranderbaar is en wordt gebruikt om werkelijke REST-aanvragen te genereren.

Zie https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 voor meer conceptuele informatie over SAS Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas voor beschrijvingen van de parameters, waaronder welke vereist zijn

ClearRange
CloseHandlesInfo

Resultaatgegevens sluiten.

CommonGenerateSasUrlOptions

Algemene opties van de ShareGenerateSasUrlOptions en FileGenerateSasUrlOptions.

CommonOptions

Een interface voor opties die gemeenschappelijk zijn voor elke externe bewerking.

CopyFileSmbInfo

Parametergroep

CorsRule

CORS is een HTTP-functie waarmee een webtoepassing die wordt uitgevoerd onder één domein, toegang kan krijgen tot resources in een ander domein. Webbrowsers implementeren een beveiligingsbeperking die bekend staat als same orgine-beleid waarmee wordt voorkomen dat een webpagina API's in een ander domein aanroept. CORS biedt een veilige manier om het ene domein (het oorspronkelijke domein) toe te staan om API's in een ander domein aan te roepen.

DirectoryCloseHandlesHeaders

Aanvullende antwoordheaderwaarden voor aanvraag voor het sluiten van ingangen.

DirectoryCreateHeaders

Hiermee definieert u headers voor Directory_create bewerking.

DirectoryCreateIfNotExistsResponse

Bevat antwoordgegevens voor de createIfNotExists(DirectoryCreateOptions) bewerking.

DirectoryCreateOptions

Opties voor het configureren van de maakbewerking .

DirectoryDeleteHeaders

Hiermee definieert u headers voor Directory_delete bewerking.

DirectoryDeleteIfExistsResponse

Bevat antwoordgegevens voor de deleteIfExists(DirectoryDeleteOptions) bewerking.

DirectoryDeleteOptions

Opties voor het configureren van de verwijderbewerking .

DirectoryExistsOptions

Opties voor het configureren van de exists-bewerking .

DirectoryForceCloseHandlesHeaders

Hiermee definieert u headers voor Directory_forceCloseHandles bewerking.

DirectoryForceCloseHandlesOptions

Opties voor het configureren van forceCloseHandle.

DirectoryForceCloseHandlesSegmentOptions

Opties voor het configureren van Directory - Segmentbewerkingen voor het sluiten van ingangen forceren.

Zie:

DirectoryGetPropertiesHeaders

Hiermee definieert u headers voor Directory_getProperties bewerking.

DirectoryGetPropertiesOptions

Opties voor het configureren van de bewerking getProperties .

DirectoryItem

Een vermeld mapitem.

DirectoryListFilesAndDirectoriesOptions

Opties voor het configureren van de bewerking listFilesAndDirectories .

DirectoryListFilesAndDirectoriesSegmentHeaders

Hiermee definieert u headers voor Directory_listFilesAndDirectoriesSegment bewerking.

DirectoryListHandlesHeaders

Hiermee definieert u headers voor Directory_listHandles bewerking.

DirectoryListHandlesOptions

Opties voor het configureren van de listHandles-bewerking .

DirectoryListHandlesSegmentOptions

Opties voor het configureren van bewerkingen in het segment Directory - List Handles.

Zie:

  • <xref:ShareDirectoryClient.listHandlesSegment>
  • <xref:ShareDirectoryClient.iterateHandleSegments>
  • <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties

Een interface voor opties die gemeenschappelijk zijn voor elke externe bewerking.

DirectoryRenameHeaders

Hiermee definieert u headers voor Directory_rename bewerking.

DirectoryRenameOptions

Opties voor het configureren van de naamswijziging .

DirectorySetMetadataHeaders

Hiermee definieert u headers voor Directory_setMetadata bewerking.

DirectorySetMetadataOptions

Opties voor het configureren van de bewerking setMetadata .

DirectorySetPropertiesHeaders

Hiermee definieert u headers voor Directory_setProperties bewerking.

FileAbortCopyFromURLOptions

Opties voor het configureren van de bewerking abortCopyFromURL .

FileAbortCopyHeaders

Hiermee definieert u headers voor File_abortCopy bewerking.

FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions

Opties voor het configureren van de clearRange-bewerking .

FileCloseHandlesHeaders

Aanvullende antwoordheaderwaarden voor aanvraag voor het sluiten van ingangen.

FileCreateHeaders

Hiermee definieert u headers voor File_create bewerking.

FileCreateOptions

Opties voor het configureren van de maakbewerking .

FileDeleteHeaders

Hiermee definieert u headers voor File_delete bewerking.

FileDeleteIfExistsResponse

Bevat antwoordgegevens voor de bewerking deleteIfExists .

FileDeleteOptions

Opties voor het configureren van de verwijderbewerking .

FileDownloadHeaders

Hiermee definieert u headers voor File_download bewerking.

FileDownloadOptionalParams

Optionele parameters.

FileDownloadOptions

Opties voor het configureren van Bestand - Downloadbewerkingen.

Zie:

FileDownloadToBufferOptions

Optie-interface voor de downloadToBuffer-bewerking .

FileExistsOptions

Opties voor het configureren van de exists-bewerking .

FileForceCloseHandlesHeaders

Hiermee definieert u headers voor File_forceCloseHandles bewerking.

FileForceCloseHandlesOptions

Opties voor het configureren van Bestand - Bewerkingen voor het sluiten van ingangen forceren.

Zie:

FileGenerateSasUrlOptions

Opties voor het configureren van de bewerking generateSasUrl .

FileGetPropertiesHeaders

Hiermee definieert u headers voor File_getProperties bewerking.

FileGetPropertiesOptions

Opties voor het configureren van de bewerking getProperties .

FileGetRangeListHeaders

Hiermee definieert u headers voor File_getRangeList bewerking.

FileGetRangeListOptions

Opties voor het configureren van de bewerking getRangeList .

FileHttpHeaders
FileItem

Een weergegeven bestandsitem.

FileListHandlesHeaders

Hiermee definieert u headers voor File_listHandles bewerking.

FileListHandlesOptions

Een interface voor opties die gemeenschappelijk zijn voor elke externe bewerking.

FileListHandlesSegmentOptions

Opties voor het configureren van bewerkingen in het segment Bestand - Lijstingangen.

Zie:

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

Optie-interface voor Bestand - Uploadbewerkingen

Zie:

  • uploadFile
  • <xref:ShareFileClient.uploadSeekableStream>
FileProperties

Een interface voor opties die gemeenschappelijk zijn voor elke externe bewerking.

FileProperty

Bestandseigenschappen.

FileRenameHeaders

Hiermee definieert u headers voor File_rename bewerking.

FileRenameOptions

Opties voor het configureren van de naamswijziging .

FileResizeOptions

Opties voor het configureren van de groottebewerking .

FileSASSignatureValues

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

FileSASSignatureValues wordt gebruikt voor het genereren van SAS-tokens voor bestandsservices voor shares of bestanden.

FileServiceProperties

Eigenschappen van opslagservice.

FileSetHTTPHeadersHeaders

Hiermee definieert u headers voor File_setHttpHeaders bewerking.

FileSetHttpHeadersOptions

Opties voor het configureren van de bewerking setHttpHeaders .

FileSetMetadataHeaders

Hiermee definieert u headers voor File_setMetadata bewerking.

FileSetMetadataOptions

Opties voor het configureren van de bewerking setMetadata .

FileStartCopyHeaders

Hiermee definieert u headers voor File_startCopy bewerking.

FileStartCopyOptions

Opties voor het configureren van de bewerking startCopyFromURL .

FileUploadRangeFromURLHeaders

Hiermee definieert u headers voor File_uploadRangeFromURL bewerking.

FileUploadRangeFromURLOptionalParams

Optionele parameters.

FileUploadRangeFromURLOptions

Opties voor het configureren van de bewerking uploadRangeFromURL .

FileUploadRangeHeaders

Hiermee definieert u headers voor File_uploadRange bewerking.

FileUploadRangeOptions

Opties voor het configureren van de bewerking uploadRange .

FileUploadStreamOptions

Optie-interface voor ShareFileClient.uploadStream().

FilesAndDirectoriesListSegment

Abstract voor vermeldingen die kunnen worden weergegeven vanuit directory.

HandleItem

Een vermeld Azure Storage-handle-item.

HttpAuthorization

Vertegenwoordigt verificatiegegevens in de waarden Authorization, ProxyAuthorization, WWW-Authenticate en Proxy-Authenticate header.

HttpHeaders

Een verzameling http-headersleutel-/waardeparen.

HttpOperationResponse

HTTP-antwoord dat compatibel is met core-v1 (core-http).

HttpResponse

Een weergave van een HTTP-antwoord met een verwijzing naar de aanvraag waaruit deze afkomstig is.

IHttpClient

Een compatibele interface voor core-http-aanvraagbeleid

LeaseAccessConditions

Parametergroep

LeaseOperationOptions

opties voor leasebewerkingen.

LeaseOperationResponseHeaders

De details van het antwoord voor een specifieke leasebewerking.

ListFilesAndDirectoriesSegmentResponse

Een opsomming van mappen en bestanden.

ListHandlesResponse

Een opsomming van ingangen.

ListSharesResponse

Een opsomming van aandelen.

ListSharesResponseModel

Een opsomming van aandelen.

Metadata
Metrics

Metrische gegevens van Storage Analytics voor bestandsservice.

PipelineLike

Een interface voor de pijplijnklasse met beleid voor HTTP-aanvragen. U kunt een standaardpijplijn maken door newPipeline aan te roepen. U kunt ook een pijplijn met uw eigen beleid maken door de constructor van Pijplijn.

Raadpleeg newPipeline en opgegeven beleidsregels voordat u uw aangepaste pijplijn implementeert.

PipelineOptions

Optie-interface voor pijplijnconstructor.

Range

Bereik voor servicebewerkingen.

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

RangeModel

Een Azure Storage-bestandsbereik.

RequestPolicyFactory

Een interface voor compatibiliteit met RequestPolicyFactory van core-http

RequestPolicyOptions

Een interface voor compatibiliteit met RequestPolicy

ResponseLike

Een object met een eenvoudige _response eigenschap.

ResponseWithBody

Een object met een _response eigenschap met hoofdtekst en kopteksten die al zijn geparseerd in bekende typen.

ResponseWithHeaders

Een object met een _response eigenschap met kopteksten die al zijn geparseerd in een getypt object.

RetentionPolicy

Het bewaarbeleid.

SasIPRange

Toegestaan IP-bereik voor een SAS.

ServiceClientOptions

Een subset van @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Opties voor het configureren van de bewerking generateAccountSasUrl .

ServiceGetPropertiesHeaders

Hiermee definieert u headers voor Service_getProperties bewerking.

ServiceGetPropertiesOptions

Opties voor het configureren van de bewerking getProperties .

ServiceListSharesOptions

Opties voor het configureren van de listShares-bewerking .

ServiceListSharesSegmentHeaders

Hiermee definieert u headers voor Service_listSharesSegment bewerking.

ServiceSetPropertiesHeaders

Hiermee definieert u headers voor Service_setProperties bewerking.

ServiceSetPropertiesOptions

Opties voor het configureren van de bewerking setProperties .

ServiceUndeleteShareOptions

Opties voor het configureren van de <xref:ShareServiceClient.undelete> bewerking.

SetPropertiesResponse

Bevat antwoordgegevens voor de bewerking setHttpHeaders.

ShareClientConfig
ShareCreateHeaders

Hiermee definieert u headers voor Share_create bewerking.

ShareCreateIfNotExistsResponse

Bevat antwoordgegevens voor de bewerking createIfNotExists .

ShareCreateOptions

Opties voor het configureren van de maakbewerking .

ShareCreatePermissionHeaders

Hiermee definieert u headers voor Share_createPermission bewerking.

ShareCreatePermissionOptions

Opties voor het configureren van de bewerking createPermission .

ShareCreateSnapshotHeaders

Hiermee definieert u headers voor Share_createSnapshot bewerking.

ShareCreateSnapshotOptions

Opties voor het configureren van de bewerking createSnapshot .

ShareDeleteHeaders

Hiermee definieert u headers voor Share_delete bewerking.

ShareDeleteIfExistsResponse

Bevat antwoordgegevens voor de bewerking deleteIfExists .

ShareDeleteMethodOptions

Opties voor het configureren van de verwijderbewerking .

ShareExistsOptions

Opties voor het configureren van de exists-bewerking .

ShareFileRangeList

De lijst met bestandsbereiken

ShareGenerateSasUrlOptions

Opties voor het configureren van de bewerking generateSasUrl .

ShareGetAccessPolicyHeaders

Hiermee definieert u headers voor Share_getAccessPolicy bewerking.

ShareGetAccessPolicyOptions

Opties voor het configureren van de bewerking getAccessPolicy .

ShareGetPermissionHeaders

Hiermee definieert u headers voor Share_getPermission bewerking.

ShareGetPermissionOptions

Opties voor het configureren van de bewerking getPermission .

ShareGetPropertiesHeaders

Hiermee definieert u headers voor Share_getProperties bewerking.

ShareGetPropertiesOptions

Opties voor het configureren van de bewerking getProperties .

ShareGetStatisticsHeaders

Hiermee definieert u headers voor Share_getStatistics bewerking.

ShareGetStatisticsOptions

Opties voor het configureren van de bewerking getStatistics .

ShareItem

Een vermeld Azure Storage-shareitem.

ShareItemInternal

Een vermeld Azure Storage-shareitem.

SharePermission

Een machtiging (een security descriptor) op het niveau van de share.

SharePropertiesInternal

Eigenschappen van een share.

ShareProtocolSettings

Protocolinstellingen

ShareProtocols

Protocollen om in te schakelen op de share. Op dit moment ondersteunt u alleen SMB of NFS.

ShareSetAccessPolicyHeaders

Hiermee definieert u headers voor Share_setAccessPolicy bewerking.

ShareSetAccessPolicyOptions

Opties voor het configureren van de bewerking setAccessPolicy .

ShareSetMetadataHeaders

Hiermee definieert u headers voor Share_setMetadata bewerking.

ShareSetMetadataOptions

Opties voor het configureren van de bewerking setMetadata .

ShareSetPropertiesHeaders

Hiermee definieert u headers voor Share_setProperties bewerking.

ShareSetPropertiesOptions

Opties voor het configureren van de bewerking setProperties .

ShareSetQuotaOptions

Opties voor het configureren van de bewerking setQuota .

ShareSmbSettings

Instellingen voor het SMB-protocol.

ShareStats

Statistieken voor het aandeel.

SignedIdentifier

Ondertekende id

SignedIdentifierModel

Ondertekende id.

SmbMultichannel

Instellingen voor SMB meerdere kanalen

SourceModifiedAccessConditions

Parametergroep

StoragePipelineOptions

Interface opties voor de functie newPipeline .

StorageRetryOptions

Interface voor opties voor opnieuw proberen van Opslagblob.

WebResource

Een beschrijving van een HTTP-aanvraag die moet worden ingediend bij een externe server.

Type-aliassen

CopyStatusType

Definieert waarden voor CopyStatusType.

CredentialPolicyCreator

Een factory-functie die een nieuwe CredentialPolicy maakt die gebruikmaakt van de opgegeven nextPolicy.

DeleteSnapshotsOptionType

Definieert waarden voor DeleteSnapshotsOptionType.

DirectoryCreateResponse

Bevat antwoordgegevens voor de maakbewerking.

DirectoryDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

DirectoryForceCloseHandlesResponse

Antwoordtype voor forceCloseHandle.

DirectoryGetPropertiesResponse

Bevat antwoordgegevens voor de bewerking getProperties.

DirectoryListFilesAndDirectoriesSegmentResponse

Bevat antwoordgegevens voor de bewerking listFilesAndDirectoriesSegment.

DirectoryListHandlesResponse

Bevat antwoordgegevens voor de listHandles-bewerking.

DirectoryRenameResponse

Bevat antwoordgegevens voor de naamswijzigingsbewerking.

DirectorySetMetadataResponse

Bevat antwoordgegevens voor de bewerking setMetadata.

DirectorySetPropertiesResponse

Bevat antwoordgegevens voor de bewerking setProperties.

FileAbortCopyResponse

Bevat antwoordgegevens voor de bewerking abortCopy.

FileAttributesPreserveType

Geeft aan dat bestaande bestandskenmerken ongewijzigd blijven.

FileCreateResponse

Bevat antwoordgegevens voor de maakbewerking.

FileDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

FileDownloadResponseModel

Bevat antwoordgegevens voor de downloadbewerking.

FileForceCloseHandlesResponse

Antwoordtype voor forceCloseHandle.

FileGetPropertiesResponse

Bevat antwoordgegevens voor de bewerking getProperties.

FileGetRangeListDiffResponse

Bevat antwoordgegevens voor de bewerking getRangeList.

FileGetRangeListResponse

Bevat antwoordgegevens voor de bewerking getRangeList .

FileLastWrittenMode

Definieert waarden voor FileLastWrittenMode.

FileListHandlesResponse

Bevat antwoordgegevens voor de listHandles-bewerking.

FilePermissionInheritType

Geeft aan dat de bestandsmachtiging van de bovenliggende map wordt overgenomen.

FilePermissionPreserveType

Geeft aan dat de bestaande bestandsmachtigingswaarde ongewijzigd blijft.

FileRenameResponse

Bevat antwoordgegevens voor de naamswijzigingsbewerking.

FileSetHTTPHeadersResponse

Bevat antwoordgegevens voor de bewerking setHttpHeaders.

FileSetMetadataResponse

Bevat antwoordgegevens voor de bewerking setMetadata.

FileStartCopyResponse

Bevat antwoordgegevens voor de startCopy-bewerking.

FileUploadRangeFromURLResponse

Bevat antwoordgegevens voor de bewerking uploadRangeFromURL.

FileUploadRangeResponse

Bevat antwoordgegevens voor de bewerking uploadRange.

HttpRequestBody

Typen instanties die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen Node. Blob, ReadableStream en () => ReadableStream zijn alleen browser.

LeaseDurationType

Definieert waarden voor LeaseDurationType.

LeaseOperationResponse

Bevat de antwoordgegevens voor bewerkingen die een lease verkrijgen, wijzigen, onderbreken of vrijgeven.

Zie ShareLeaseClient.

LeaseStateType

Definieert waarden voor LeaseStateType.

LeaseStatusType

Definieert waarden voor LeaseStatusType.

ListSharesIncludeType

Definieert waarden voor ListSharesIncludeType.

PermissionCopyModeType

Definieert waarden voor PermissionCopyModeType.

RawFileDownloadResponse

Bevat antwoordgegevens voor de downloadbewerking.

ServiceGetPropertiesResponse

Bevat antwoordgegevens voor de bewerking getProperties.

ServiceListSharesSegmentResponse

Bevat antwoordgegevens voor de listShares-bewerking .

ServiceSetPropertiesResponse

Bevat antwoordgegevens voor de bewerking setProperties.

ShareAccessTier

Definieert waarden voor ShareAccessTier.

ShareClientOptions
ShareCreatePermissionResponse

Bevat antwoordgegevens voor de bewerking createPermission.

ShareCreateResponse

Bevat antwoordgegevens voor de maakbewerking.

ShareCreateSnapshotResponse

Bevat antwoordgegevens voor de bewerking createSnapshot.

ShareDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

ShareFileHandleAccessRights

Definieert waarden voor AccessRight.

ShareGetAccessPolicyResponse
ShareGetPermissionResponse

Bevat antwoordgegevens voor de getPermission-bewerking.

ShareGetPropertiesResponse

Bevat antwoordgegevens voor de bewerking getProperties .

ShareGetPropertiesResponseModel

Bevat antwoordgegevens voor de bewerking getProperties.

ShareGetStatisticsResponse

Antwoordgegevens voor de bewerking getStatistics .

ShareGetStatisticsResponseModel

Bevat antwoordgegevens voor de bewerking getStatistics.

ShareProperties

Eigenschappen van een share.

ShareRootSquash

Definieert waarden voor ShareRootSquash.

ShareSetAccessPolicyResponse

Bevat antwoordgegevens voor de bewerking setAccessPolicy.

ShareSetMetadataResponse

Bevat antwoordgegevens voor de bewerking setMetadata.

ShareSetPropertiesResponse

Bevat antwoordgegevens voor de bewerking setProperties.

ShareSetQuotaHeaders

Definieert headers voor setQuota-bewerking.

ShareSetQuotaResponse

Bevat antwoordgegevens voor de bewerking setQuota.

ShareTokenIntent

Definieert waarden voor ShareTokenIntent.
KnownShareTokenIntent kan door elkaar worden gebruikt met ShareTokenIntent. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Backup

TimeNowType

Geeft instelling aan als de tijd van de aanvraag.

TimePreserveType

Geeft aan dat de bestaande tijdswaarde ongewijzigd blijft.

WithResponse

Een type dat een bewerkingsresultaat vertegenwoordigt met een bekende _response-eigenschap.

Enums

KnownShareTokenIntent

Bekende waarden van ShareTokenIntent die de service accepteert.

SASProtocol

Protocollen voor gegenereerde SAS.

StorageFileAudience

Definieert de bekende clouddoelgroepen voor Opslag.

StorageRetryPolicyType

RetryPolicy-typen.

Functies

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een SASQueryParameters-object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.

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

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee maakt u een exemplaar van SASQueryParameters.

Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen moet u de bijbehorende eigenschappen rechtstreeks instellen, zoals machtigingen, startsOn en id.

WAARSCHUWING: als de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET een waarde toewijzen aan id of verloopt bij & machtigingen handmatig als u deze constructor initieert.

getFileServiceAccountAudience(string)

De OAuth-doelgroep ophalen voor een opslagaccount voor bestandsservice.

isPipelineLike(unknown)

Een helper om te bepalen of een bepaald argument voldoet aan het pijplijncontract

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.

Functiedetails

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een SASQueryParameters-object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.

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

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

Parameters

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retouren

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee maakt u een exemplaar van SASQueryParameters.

Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen moet u de bijbehorende eigenschappen rechtstreeks instellen, zoals machtigingen, startsOn en id.

WAARSCHUWING: als de id niet is opgegeven, zijn machtigingen en expiresOn vereist. U MOET een waarde toewijzen aan id of verloopt bij & machtigingen handmatig als u deze constructor initieert.

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

Parameters

fileSASSignatureValues
FileSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retouren

getFileServiceAccountAudience(string)

De OAuth-doelgroep ophalen voor een opslagaccount voor bestandsservice.

function getFileServiceAccountAudience(storageAccountName: string): string

Parameters

storageAccountName

string

Retouren

string

isPipelineLike(unknown)

Een helper om te bepalen of een bepaald argument voldoet aan het pijplijncontract

function isPipelineLike(pipeline: unknown): pipeline

Parameters

pipeline

unknown

Een argument dat een pijplijn kan zijn

Retouren

pipeline

waar wanneer het argument voldoet aan het pijplijncontract

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een nieuw pijplijnobject met de opgegeven referentie.

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

Parameters

credential

Credential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

pipelineOptions
StoragePipelineOptions

Optioneel. Opties.

Retouren

Een nieuw pijplijnobject.