使用英语阅读

通过


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/storage-file package

Aborter

aborter 实例实现 AbortSignal 接口,可以中止 HTTP 请求。

  • 调用 Aborter.none 以在不超时的情况下创建新的 Aborter 实例。
  • 调用 Aborter.timeout () 以创建具有超时的新 Aborter 实例。

对于现有实例中止程序:

  • 调用 aborter.withTimeout () 以创建并返回具有超时值的子 Aborter 实例。
  • 调用 aborter.withValue (键,值) 创建并返回具有键/值对的子 Aborter 实例。
  • 调用 aborter.abort () 以中止当前实例和所有子实例。
  • 调用 aborter.getValue (密钥) 以搜索并获取当前中止器中所有父级的相应密钥的值。

示例

// Abort without timeout
await fileURL.uploadRange(Aborter.none, buf, 0, buf.length);

示例

// Abort container create in 1000ms
await fileURL.uploadRange(Aborter.timeout(1000), buf, 0, buf.length);

示例

// Share aborter cross multiple operations in 30s
// Upload the same data to 2 different data centers at the same time, abort another when any of them is finished
const aborter = Aborter.timeout(30 * 1000);
fileURL1.uploadRange(aborter, buf, 0, buf.length).then(aborter.abort);
fileURL2.uploadRange(aborter, buf, 0, buf.length).then(aborter.abort);

示例

// Cascaded aborting
// All operations can't take more than 30 seconds
const aborter = Aborter.timeout(30 * 1000);

// Following 2 operations can't take more than 25 seconds
await fileURL.uploadRange(aborter.withTimeout(25 * 1000), buf, 0, buf.length);
await fileURL.uploadRange(aborter.withTimeout(25 * 1000), buf, 0, buf.length);
AccountSASPermissions

仅在 NODE.JS RUNTIME 中可用。

这是一个帮助程序类,用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IAccountSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类保证正确性。

AccountSASResourceTypes

仅在 NODE.JS RUNTIME 中可用。

这是一个帮助程序类,用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IAccountSASSignatureValues 对象上的资源字段。 可以在没有此类的情况下构造资源字符串,但资源的顺序是特殊的,此类保证正确性。

AccountSASServices

仅在 NODE.JS RUNTIME 中可用。

这是一个帮助程序类,用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IAccountSASSignatureValues 对象上的服务字段。 可以在没有此类的情况下构造服务字符串,但服务的顺序是特殊的,此类保证正确性。

AnonymousCredential

AnonymousCredential 提供用于创建 AnonymousCredentialPolicy 对象的 credentialPolicyCreator 成员。 AnonymousCredentialPolicy 与读取公共资源的 HTTP (S) 请求一起使用,或用于共享访问签名 (SAS) 。

AnonymousCredentialPolicy

AnonymousCredentialPolicy 与读取公共资源的 HTTP (S) 请求一起使用,或用于共享访问签名 (SAS) 。

BaseRequestPolicy
BrowserPolicyFactory

BrowserPolicyFactory 是一个工厂类,可帮助生成 BrowserPolicy 对象。

Credential

Credential 是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管一个生成 CredentialPolicy 的 credentialPolicyCreator 工厂。

CredentialPolicy

用于在发送请求之前对 HTTP (S) 请求进行签名的凭据策略。 这是一个抽象类。

DirectoryURL

DirectoryURL 表示 Azure 存储目录的 URL,可用于操作其文件和目录。

FileSASPermissions

仅在 NODE.JS RUNTIME 中可用。

这是一个帮助程序类,用于构造表示 ServiceSAS 授予对文件的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IFileSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类保证正确性。

FileSystemAttributes

这是一个帮助程序类,用于构造表示文件或目录的 NTFS 属性的字符串。

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

FileURL

FileURL 表示 Azure 存储文件的 URL。

HttpHeaders

HTTP 标头键/值对的集合。

LoggingPolicyFactory

LoggingPolicyFactory 是一个工厂类,可帮助生成 LoggingPolicy 对象。

Pipeline

包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 StorageURL.newPipeline () 来创建默认管道。 或者,可以通过 Pipeline 的构造函数创建具有自己的策略的管道。 在实现自定义管道之前,请参阅 StorageURL.newPipeline () 和提供的策略作为参考。

RequestPolicyOptions

创建 RequestPolicy 时可以使用的可选属性。

RestError
RetryPolicyFactory

RetryPolicyFactory 是一个工厂类,可帮助生成 RetryPolicy 对象。

SASQueryParameters

表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 IAccountSASSignatureValuesIFileSASSignatureValues 类型生成。 生成后,它可以编码为 {@code String} 并直接追加到 URL (不过,如果存在现有查询参数,这可能会影响) 追加这些查询参数的适当方式,但此处应小心谨慎。

注意:此类的实例是不可变的。

ServiceURL

ServiceURL 表示用于操作文件共享的 Azure 存储文件服务的 URL。

ShareSASPermissions

这是一个帮助程序类,用于构造表示 ServiceSAS 授予共享的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IFileSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类可以保证正确性。

ShareURL

ShareURL 表示 Azure 存储共享的 URL,允许你操作其目录和文件。

SharedKeyCredential

仅在 NODE.JS RUNTIME 中可用。

用于 Azure 存储服务的帐户密钥授权的 SharedKeyCredential。

SharedKeyCredentialPolicy

SharedKeyCredentialPolicy 是一种策略,用于使用共享密钥对 HTTP 请求进行签名。

StorageURL

ServiceURL 表示 ServiceURL、ContainerURL 等的基于 URL 类。

TelemetryPolicyFactory

TelemetryPolicyFactory 是一个工厂类,可帮助生成 TelemetryPolicy 对象。

UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory 是一个工厂类,可帮助生成 UniqueRequestIDPolicy 对象。

WebResource

创建新的 WebResource 对象。

此类通过与库/实现无关并包装启动请求所需的属性来提供 REST 调用的抽象。

接口

AccessPolicy

访问策略。

CorsRule

CORS 是一项 HTTP 功能,使在一个域中运行的 Web 应用程序能够访问另一个域中的资源。 Web 浏览器实施一种称为同源策略的安全限制,以防止网页调用另一个域中的 API;CORS 提供了一种安全的方法来允许一个域(源域)调用另一个域中的 API。

DirectoryCreateHeaders

定义创建操作的标头。

DirectoryCreateOptionalParams

可选参数。

DirectoryDeleteHeaders

定义 Delete 操作的标头。

DirectoryDeleteMethodOptionalParams

可选参数。

DirectoryForceCloseHandlesHeaders

定义 ForceCloseHandles 操作的标头。

DirectoryForceCloseHandlesOptionalParams

可选参数。

DirectoryGetPropertiesHeaders

定义 GetProperties 操作的标头。

DirectoryGetPropertiesOptionalParams

可选参数。

DirectoryItem

列出的目录项。

DirectoryListFilesAndDirectoriesSegmentHeaders

定义 ListFilesAndDirectoriesSegment 操作的标头。

DirectoryListFilesAndDirectoriesSegmentOptionalParams

可选参数。

DirectoryListHandlesHeaders

定义 ListHandles 操作的标头。

DirectoryListHandlesOptionalParams

可选参数。

DirectorySetMetadataHeaders

定义 SetMetadata 操作的标头。

DirectorySetMetadataOptionalParams

可选参数。

DirectorySetPropertiesHeaders

定义 SetProperties 操作的标头。

DirectorySetPropertiesOptionalParams

可选参数。

FileAbortCopyHeaders

定义 AbortCopy 操作的标头。

FileAbortCopyOptionalParams

可选参数。

FileCreateHeaders

定义创建操作的标头。

FileCreateOptionalParams

可选参数。

FileDeleteHeaders

定义 Delete 操作的标头。

FileDeleteMethodOptionalParams

可选参数。

FileDownloadHeaders

定义下载操作的标头。

FileDownloadOptionalParams

可选参数。

FileForceCloseHandlesHeaders

定义 ForceCloseHandles 操作的标头。

FileForceCloseHandlesOptionalParams

可选参数。

FileGetPropertiesHeaders

定义 GetProperties 操作的标头。

FileGetPropertiesOptionalParams

可选参数。

FileGetRangeListHeaders

定义 GetRangeList 操作的标头。

FileGetRangeListOptionalParams

可选参数。

FileHTTPHeaders

一组操作的其他参数,例如:File_create、File_setHTTPHeaders。

FileItem

列出的文件项。

FileListHandlesHeaders

定义 ListHandles 操作的标头。

FileListHandlesOptionalParams

可选参数。

FileProperty

文件属性。

FilesAndDirectoriesListSegment

可从 Directory 中列出条目的摘要。

FileSetHTTPHeadersHeaders

定义 SetHTTPHeaders 操作的标头。

FileSetHTTPHeadersOptionalParams

可选参数。

FileSetMetadataHeaders

定义 SetMetadata 操作的标头。

FileSetMetadataOptionalParams

可选参数。

FileStartCopyHeaders

定义 StartCopy 操作的标头。

FileStartCopyOptionalParams

可选参数。

FileUploadRangeFromURLHeaders

定义 UploadRangeFromURL 操作的标头。

FileUploadRangeFromURLOptionalParams

可选参数。

FileUploadRangeHeaders

定义 UploadRange 操作的标头。

FileUploadRangeOptionalParams

可选参数。

HandleItem

列出的 Azure 存储句柄项。

ListFilesAndDirectoriesSegmentResponse

目录和文件的枚举。

ListHandlesResponse

句柄的枚举。

ListSharesResponse

共享的枚举。

Metrics

存储分析文件服务的指标。

Permission

安全描述符定义语言 (SDDL) 中所述 (安全描述符) 权限。

Range

Azure 存储文件范围。

RetentionPolicy

保留策略。

ServiceGetPropertiesHeaders

定义 GetProperties 操作的标头。

ServiceGetPropertiesOptionalParams

可选参数。

ServiceListSharesSegmentHeaders

定义 ListSharesSegment 操作的标头。

ServiceListSharesSegmentOptionalParams

可选参数。

ServiceSetPropertiesHeaders

定义 SetProperties 操作的标头。

ServiceSetPropertiesOptionalParams

可选参数。

ShareCreateHeaders

定义创建操作的标头。

ShareCreateOptionalParams

可选参数。

ShareCreatePermissionHeaders

定义 CreatePermission 操作的标头。

ShareCreatePermissionOptionalParams

可选参数。

ShareCreateSnapshotHeaders

定义 CreateSnapshot 操作的标头。

ShareCreateSnapshotOptionalParams

可选参数。

ShareDeleteHeaders

定义 Delete 操作的标头。

ShareDeleteMethodOptionalParams

可选参数。

ShareGetAccessPolicyHeaders

定义 GetAccessPolicy 操作的标头。

ShareGetAccessPolicyOptionalParams

可选参数。

ShareGetPermissionHeaders

定义 GetPermission 操作的标头。

ShareGetPermissionOptionalParams

可选参数。

ShareGetPropertiesHeaders

定义 GetProperties 操作的标头。

ShareGetPropertiesOptionalParams

可选参数。

ShareGetStatisticsHeaders

定义 GetStatistics 操作的标头。

ShareGetStatisticsOptionalParams

可选参数。

ShareItem

列出的 Azure 存储共享项。

ShareProperties

共享的属性。

ShareSetAccessPolicyHeaders

定义 SetAccessPolicy 操作的标头。

ShareSetAccessPolicyOptionalParams

可选参数。

ShareSetMetadataHeaders

定义 SetMetadata 操作的标头。

ShareSetMetadataOptionalParams

可选参数。

ShareSetQuotaHeaders

定义 SetQuota 操作的标头。

ShareSetQuotaOptionalParams

可选参数。

ShareStats

共享的统计信息。

SignedIdentifier

已签名的标识符。

SourceModifiedAccessConditions

uploadRangeFromURL 操作的其他参数。

StorageError

表示 StorageError 的接口。

StorageServiceProperties

存储服务属性。

HttpOperationResponse

http 请求和响应的包装器对象。 当以 JSON 或 XML 格式收到响应正文时,反序列化的对象存储在 parsedBody 属性中。

IAccountSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。

IAccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名 (SAS) 。 正确设置此处的所有值后,调用 generateSASQueryParameters () 以获取实际上可应用于文件 URL 的 SAS 表示形式。 注意:此类和 SASQueryParameters 都存在,因为前者是可变的,是逻辑表示形式,而后者是不可变的,用于生成实际的 REST 请求。

有关 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 SAS 的更多概念性信息,请参阅 有关 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas 参数的说明,包括必需参数

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IDownloadFromAzureFileOptions

DownloadAzurefileToBuffer 的选项接口。

IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

选项定义为与 REST 定义的奇偶校验。 虽然它现在还没有准备好使用,但考虑到源内容的 Crc64 不可访问。

IFileListHandlesSegmentOptions
IFileProperties
IFileSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。

IFileSASSignatureValues 用于帮助为共享或文件生成文件服务 SAS 令牌。

IFileStartCopyOptions
IFileUploadRangeOptions
IHttpClient

可以发送 HttpRequests 并接收承诺的 HttpRespons 的接口。

IHttpPipelineLogger

可添加到 HttpPipeline 的记录器。 这使每个 RequestPolicy 能够记录可用于调试目的的消息。

IIPRange

SAS 允许的 IP 范围。

INewPipelineOptions

Pipeline.newPipeline 方法的选项接口。

IPipelineOptions

管道构造函数的选项接口。

IRange

服务操作的范围。

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

IRequestLogOptions

RequestLogOptions 配置重试策略的行为。

IRetryOptions

重试选项接口。

IServiceListSharesSegmentOptions
ISetPropertiesResponse

包含 setHTTPHeaders 操作的响应数据。

IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
ITelemetryOptions

TelemetryPolicy 选项的接口。

IUploadStreamToAzureFileOptions

uploadStreamToAzureFile 的选项接口。

IUploadToAzureFileOptions

uploadFileToAzureFile 和 uploadSeekableStreamToAzureFile 的选项接口。

RequestPolicy

类型别名

CopyStatusType

定义 CopyStatusType 的值。 可能的值包括:“pending”、“success”、“aborted”、“failed”

DeleteSnapshotsOptionType

定义 DeleteSnapshotsOptionType 的值。 可能的值包括:“include”

DirectoryCreateResponse

包含创建操作的响应数据。

DirectoryDeleteResponse

包含 deleteMethod 操作的响应数据。

DirectoryForceCloseHandlesResponse

包含 forceCloseHandles 操作的响应数据。

DirectoryGetPropertiesResponse

包含 getProperties 操作的响应数据。

DirectoryListFilesAndDirectoriesSegmentResponse

包含 listFilesAndDirectoriesSegment 操作的响应数据。

DirectoryListHandlesResponse

包含 listHandles 操作的响应数据。

DirectorySetMetadataResponse

包含 setMetadata 操作的响应数据。

DirectorySetPropertiesResponse

包含 setProperties 操作的响应数据。

FileAbortCopyResponse

包含 abortCopy 操作的响应数据。

FileCreateResponse

包含创建操作的响应数据。

FileDeleteResponse

包含 deleteMethod 操作的响应数据。

FileDownloadResponse

包含下载操作的响应数据。

FileForceCloseHandlesResponse

包含 forceCloseHandles 操作的响应数据。

FileGetPropertiesResponse

包含 getProperties 操作的响应数据。

FileGetRangeListResponse

包含 getRangeList 操作的响应数据。

FileListHandlesResponse

包含 listHandles 操作的响应数据。

FileRangeWriteType

定义 FileRangeWriteType 的值。 可能的值包括:“update”、“clear”

FileSetHTTPHeadersResponse

包含 setHTTPHeaders 操作的响应数据。

FileSetMetadataResponse

包含 setMetadata 操作的响应数据。

FileStartCopyResponse

包含 startCopy 操作的响应数据。

FileType

定义 FileType 的值。 可能的值包括:“File”

FileUploadRangeFromURLResponse

包含 uploadRangeFromURL 操作的响应数据。

FileUploadRangeResponse

包含 uploadRange 操作的响应数据。

ListSharesIncludeType

定义 ListSharesIncludeType 的值。 可能的值包括:“snapshots”、“metadata”

ServiceGetPropertiesResponse

包含 getProperties 操作的响应数据。

ServiceListSharesSegmentResponse

包含 listSharesSegment 操作的响应数据。

ServiceSetPropertiesResponse

包含 setProperties 操作的响应数据。

ShareCreatePermissionResponse

包含 createPermission 操作的响应数据。

ShareCreateResponse

包含创建操作的响应数据。

ShareCreateSnapshotResponse

包含 createSnapshot 操作的响应数据。

ShareDeleteResponse

包含 deleteMethod 操作的响应数据。

ShareGetAccessPolicyResponse

包含 getAccessPolicy 操作的响应数据。

ShareGetPermissionResponse

包含 getPermission 操作的响应数据。

ShareGetPropertiesResponse

包含 getProperties 操作的响应数据。

ShareGetStatisticsResponse

包含 getStatistics 操作的响应数据。

ShareSetAccessPolicyResponse

包含 setAccessPolicy 操作的响应数据。

ShareSetMetadataResponse

包含 setMetadata 操作的响应数据。

ShareSetQuotaResponse

包含 setQuota 操作的响应数据。

StorageErrorCode

定义 StorageErrorCode 的值。 可能的值包括:“AccountAlreadyExists”、“AccountBeingCreated”、“AccountIsDisabled”、“AuthenticationFailed”、“AuthorizationFailure”、“ConditionHeadersNotSupported”、 “ConditionNotMet”、“EmptyMetadataKey”、“InsufficientAccountPermissions”、“InternalError”、“InvalidAuthenticationInfo”、“InvalidHeaderValue”、“InvalidHttpVerb”、“InvalidInput”、“InvalidMd5”、“InvalidMetadata”、“InvalidQueryParameterValue”、“InvalidRange”、“InvalidResourceName”、“InvalidUri”、“'InvalidXmlDocument“、”InvalidXmlNodeValue“、”Md5Mismatch“、”MetadataTooLarge“、”MissingContentLengthHeader“、”MissingRequiredQueryParameter“、”MissingRequiredHeader“、”MissingRequiredXmlNode“, ”MultipleConditionHeadersNotSupported“、”OperationTimedOut“、”OutOfRangeInput“、”OutOfRangeQueryParameterValue“、”RequestBodyTooLarge“、”ResourceTypeMismatch“、”RequestUrlFailedToParse“、”ResourceAlreadyExists“、”ResourceNotFound“、”ServerBusy“、”UnsupportedHeader“、UnsupportedXmlNode、“UnsupportedQueryParameter”、“UnsupportedHttpVerb”、“CannotDeleteFileOrDirectory”、“ClientCacheFlushDelay”、“DeletePending”、“DirectoryNotEmpty”、“FileLockConflict”、“InvalidFileOrDirectoryPathName”、 “ParentNotFound”、“ReadOnlyAttribute”、“ShareAlreadyExists”、“ShareBeingDeleted”、“ShareDisabled”、“ShareNotFound”、“SharingViolation”、“ShareSnapshotInProgress”、“ShareSnapshotCountExceeded”、“ShareSnapshotOperationNotSupported”、ShareHasSnapshots', 'ContainerQuotaDowngradeNotAllowed'

CredentialPolicyCreator

一个工厂函数,用于创建使用提供的 nextPolicy 的新 CredentialPolicy。

FileAttributesPreserveType

指示保持现有文件属性不变。

FileGetRangeListResponse

包含 getRangeList 操作的响应数据。

FilePermissionInheritType

指示从父目录继承文件权限。

FilePermissionPreserveType

指示保持现有文件权限值不变。

HttpRequestBody
RequestPolicyFactory

为每个请求创建一个新的 RequestPolicy,该请求使用提供的 nextPolicy。

ShareGetAccessPolicyResponse
ShareGetStatisticsResponse
TimeNowType

指示设置作为请求的时间。

TimePreserveType

指示保持现有时间值不变。

枚举

HttpPipelineLogLevel

可与 HttpPipelineLogger 一起使用的不同级别的日志。

RetryPolicyType

RetryPolicy 类型。

SASProtocol

生成的 SAS 的协议。

函数

deserializationPolicy(DeserializationContentTypes)

创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。

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

仅在 NODE.JS RUNTIME 中可用。

将 Azure 文件并行下载到缓冲区。 偏移量和计数是可选的,两者都传递 0 以下载整个文件。

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

生成 SASQueryParameters 对象,该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。

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

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

仅接受创建 SAS 所需的设置。 对于可选设置,请直接设置相应的属性,例如权限、startTime 和标识符。

警告:如果未提供标识符,则需要权限和 expiryTime。 如果最初使用此构造函数,则必须手动为 identifier 或 expiryTime & 权限分配值。

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

仅在浏览器中可用。

将浏览器 Blob/文件/ArrayBuffer/ArrayBufferView 对象上传到 Azure 文件。

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

仅在 NODE.JS RUNTIME 中可用。

将本地文件上传到 Azure 文件。

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

仅在 NODE.JS RUNTIME 中可用。

将 Node.js 可读流上传到 Azure 文件中。 此方法将尝试创建 Azure,然后开始逐个区块上传。 区块的大小由 bufferSize 参数定义。 请确保流的潜在大小不超过文件大小。

性能改进提示:

  • 输入流 highWaterMark 最好使用 bufferSize 参数设置相同的值,这将避免 Buffer.concat () 操作。

函数详细信息

deserializationPolicy(DeserializationContentTypes)

创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

参数

deserializationContentTypes
DeserializationContentTypes

返回

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

仅在 NODE.JS RUNTIME 中可用。

将 Azure 文件并行下载到缓冲区。 偏移量和计数是可选的,两者都传递 0 以下载整个文件。

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: number, options?: IDownloadFromAzureFileOptions): Promise<void>

参数

aborter
Aborter

使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例,有关请求取消的更多示例,请转到 Aborter 的文档

buffer

Buffer

要填充的缓冲区,长度必须大于计数

fileURL
FileURL

FileURL 对象

offset

number

要从哪个位置下载 Azure 文件

count

number

要下载的数据量。 传递 undefined 时将下载到末尾

返回

Promise<void>

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

生成 SASQueryParameters 对象,该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。

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

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential): SASQueryParameters

参数

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

返回

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

仅接受创建 SAS 所需的设置。 对于可选设置,请直接设置相应的属性,例如权限、startTime 和标识符。

警告:如果未提供标识符,则需要权限和 expiryTime。 如果最初使用此构造函数,则必须手动为 identifier 或 expiryTime & 权限分配值。

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential): SASQueryParameters

参数

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

返回

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

仅在浏览器中可用。

将浏览器 Blob/文件/ArrayBuffer/ArrayBufferView 对象上传到 Azure 文件。

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

参数

aborter
Aborter

使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例,有关请求取消的更多示例,请转到 Aborter 的文档

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob、文件、ArrayBuffer 或 ArrayBufferView

fileURL
FileURL

返回

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

仅在 NODE.JS RUNTIME 中可用。

将本地文件上传到 Azure 文件。

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions): Promise<void>

参数

aborter
Aborter

使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例,有关请求取消的更多示例,请转到 Aborter 的文档

filePath

string

本地文件的完整路径

fileURL
FileURL

FileURL

返回

Promise<void>

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

仅在 NODE.JS RUNTIME 中可用。

将 Node.js 可读流上传到 Azure 文件中。 此方法将尝试创建 Azure,然后开始逐个区块上传。 区块的大小由 bufferSize 参数定义。 请确保流的潜在大小不超过文件大小。

性能改进提示:

  • 输入流 highWaterMark 最好使用 bufferSize 参数设置相同的值,这将避免 Buffer.concat () 操作。
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions): Promise<void>

参数

aborter
Aborter

使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例,有关请求取消的更多示例,请转到 Aborter 的文档

stream

Readable

Node.js 可读流。 必须小于或等于文件大小。

size

number

要创建的文件大小。 允许的最大大小为 1TB。 如果此值大于流大小,则文件尾部将存在空字节。

fileURL
FileURL

FileURL 实例

bufferSize

number

每个分配的缓冲区的大小(以字节为单位),也是上传文件时的区块/范围大小。 大小必须为 > 0 且 <= 4 * 1024 * 1024 (4MB)

maxBuffers

number

上传期间将分配的最大缓冲区,与最大上传并发性正相关

返回

Promise<void>