你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/storage-file package
Aborter |
aborter 实例实现 AbortSignal 接口,可以中止 HTTP 请求。
对于现有实例中止程序:
示例
示例
示例
示例
|
Account |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类,用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IAccountSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类保证正确性。 |
Account |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类,用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IAccountSASSignatureValues 对象上的资源字段。 可以在没有此类的情况下构造资源字符串,但资源的顺序是特殊的,此类保证正确性。 |
Account |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类,用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IAccountSASSignatureValues 对象上的服务字段。 可以在没有此类的情况下构造服务字符串,但服务的顺序是特殊的,此类保证正确性。 |
Anonymous |
AnonymousCredential 提供用于创建 AnonymousCredentialPolicy 对象的 credentialPolicyCreator 成员。 AnonymousCredentialPolicy 与读取公共资源的 HTTP (S) 请求一起使用,或用于共享访问签名 (SAS) 。 |
Anonymous |
AnonymousCredentialPolicy 与读取公共资源的 HTTP (S) 请求一起使用,或用于共享访问签名 (SAS) 。 |
Base |
|
Browser |
BrowserPolicyFactory 是一个工厂类,可帮助生成 BrowserPolicy 对象。 |
Credential |
Credential 是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管一个生成 CredentialPolicy 的 credentialPolicyCreator 工厂。 |
Credential |
用于在发送请求之前对 HTTP (S) 请求进行签名的凭据策略。 这是一个抽象类。 |
DirectoryURL |
DirectoryURL 表示 Azure 存储目录的 URL,可用于操作其文件和目录。 |
File |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类,用于构造表示 ServiceSAS 授予对文件的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IFileSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类保证正确性。 |
File |
这是一个帮助程序类,用于构造表示文件或目录的 NTFS 属性的字符串。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes |
FileURL |
FileURL 表示 Azure 存储文件的 URL。 |
Http |
HTTP 标头键/值对的集合。 |
Logging |
LoggingPolicyFactory 是一个工厂类,可帮助生成 LoggingPolicy 对象。 |
Pipeline |
包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 StorageURL.newPipeline () 来创建默认管道。 或者,可以通过 Pipeline 的构造函数创建具有自己的策略的管道。 在实现自定义管道之前,请参阅 StorageURL.newPipeline () 和提供的策略作为参考。 |
Request |
创建 RequestPolicy 时可以使用的可选属性。 |
Rest |
|
Retry |
RetryPolicyFactory 是一个工厂类,可帮助生成 RetryPolicy 对象。 |
SASQuery |
表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 IAccountSASSignatureValues 和 IFileSASSignatureValues 类型生成。 生成后,它可以编码为 {@code String} 并直接追加到 URL (不过,如果存在现有查询参数,这可能会影响) 追加这些查询参数的适当方式,但此处应小心谨慎。 注意:此类的实例是不可变的。 |
ServiceURL |
ServiceURL 表示用于操作文件共享的 Azure 存储文件服务的 URL。 |
Share |
这是一个帮助程序类,用于构造表示 ServiceSAS 授予共享的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 IFileSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类可以保证正确性。 |
ShareURL |
ShareURL 表示 Azure 存储共享的 URL,允许你操作其目录和文件。 |
Shared |
仅在 NODE.JS RUNTIME 中可用。 用于 Azure 存储服务的帐户密钥授权的 SharedKeyCredential。 |
Shared |
SharedKeyCredentialPolicy 是一种策略,用于使用共享密钥对 HTTP 请求进行签名。 |
StorageURL |
ServiceURL 表示 ServiceURL、ContainerURL 等的基于 URL 类。 |
Telemetry |
TelemetryPolicyFactory 是一个工厂类,可帮助生成 TelemetryPolicy 对象。 |
Unique |
UniqueRequestIDPolicyFactory 是一个工厂类,可帮助生成 UniqueRequestIDPolicy 对象。 |
Web |
创建新的 WebResource 对象。 此类通过与库/实现无关并包装启动请求所需的属性来提供 REST 调用的抽象。 |
Copy |
定义 CopyStatusType 的值。 可能的值包括:“pending”、“success”、“aborted”、“failed” |
Delete |
定义 DeleteSnapshotsOptionType 的值。 可能的值包括:“include” |
Directory |
包含创建操作的响应数据。 |
Directory |
包含 deleteMethod 操作的响应数据。 |
Directory |
包含 forceCloseHandles 操作的响应数据。 |
Directory |
包含 getProperties 操作的响应数据。 |
Directory |
包含 listFilesAndDirectoriesSegment 操作的响应数据。 |
Directory |
包含 listHandles 操作的响应数据。 |
Directory |
包含 setMetadata 操作的响应数据。 |
Directory |
包含 setProperties 操作的响应数据。 |
File |
包含 abortCopy 操作的响应数据。 |
File |
包含创建操作的响应数据。 |
File |
包含 deleteMethod 操作的响应数据。 |
File |
包含下载操作的响应数据。 |
File |
包含 forceCloseHandles 操作的响应数据。 |
File |
包含 getProperties 操作的响应数据。 |
File |
包含 getRangeList 操作的响应数据。 |
File |
包含 listHandles 操作的响应数据。 |
File |
定义 FileRangeWriteType 的值。 可能的值包括:“update”、“clear” |
File |
包含 setHTTPHeaders 操作的响应数据。 |
File |
包含 setMetadata 操作的响应数据。 |
File |
包含 startCopy 操作的响应数据。 |
File |
定义 FileType 的值。 可能的值包括:“File” |
File |
包含 uploadRangeFromURL 操作的响应数据。 |
File |
包含 uploadRange 操作的响应数据。 |
List |
定义 ListSharesIncludeType 的值。 可能的值包括:“snapshots”、“metadata” |
Service |
包含 getProperties 操作的响应数据。 |
Service |
包含 listSharesSegment 操作的响应数据。 |
Service |
包含 setProperties 操作的响应数据。 |
Share |
包含 createPermission 操作的响应数据。 |
Share |
包含创建操作的响应数据。 |
Share |
包含 createSnapshot 操作的响应数据。 |
Share |
包含 deleteMethod 操作的响应数据。 |
Share |
包含 getAccessPolicy 操作的响应数据。 |
Share |
包含 getPermission 操作的响应数据。 |
Share |
包含 getProperties 操作的响应数据。 |
Share |
包含 getStatistics 操作的响应数据。 |
Share |
包含 setAccessPolicy 操作的响应数据。 |
Share |
包含 setMetadata 操作的响应数据。 |
Share |
包含 setQuota 操作的响应数据。 |
Storage |
定义 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' |
Credential |
一个工厂函数,用于创建使用提供的 nextPolicy 的新 CredentialPolicy。 |
File |
指示保持现有文件属性不变。 |
File |
包含 getRangeList 操作的响应数据。 |
File |
指示从父目录继承文件权限。 |
File |
指示保持现有文件权限值不变。 |
Http |
|
Request |
为每个请求创建一个新的 RequestPolicy,该请求使用提供的 nextPolicy。 |
Share |
|
Share |
|
Time |
指示设置作为请求的时间。 |
Time |
指示保持现有时间值不变。 |
Http |
可与 HttpPipelineLogger 一起使用的不同级别的日志。 |
Retry |
RetryPolicy 类型。 |
SASProtocol |
生成的 SAS 的协议。 |
deserialization |
创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。 |
download |
仅在 NODE.JS RUNTIME 中可用。 将 Azure 文件并行下载到缓冲区。 偏移量和计数是可选的,两者都传递 0 以下载整个文件。 |
generate |
仅在 NODE.JS RUNTIME 中可用。 生成 SASQueryParameters 对象,该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。 仅接受创建 SAS 所需的设置。 对于可选设置,请直接设置相应的属性,例如权限、startTime 和标识符。 警告:如果未提供标识符,则需要权限和 expiryTime。 如果最初使用此构造函数,则必须手动为 identifier 或 expiryTime & 权限分配值。 |
upload |
仅在浏览器中可用。 将浏览器 Blob/文件/ArrayBuffer/ArrayBufferView 对象上传到 Azure 文件。 |
upload |
仅在 NODE.JS RUNTIME 中可用。 将本地文件上传到 Azure 文件。 |
upload |
仅在 NODE.JS RUNTIME 中可用。 将 Node.js 可读流上传到 Azure 文件中。
此方法将尝试创建 Azure,然后开始逐个区块上传。
区块的大小由 性能改进提示:
|
创建新的序列化 RequestPolicyCreator,用于在 HTTP 管道中传递时序列化 HTTP 请求正文。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory
参数
- deserializationContentTypes
- DeserializationContentTypes
返回
仅在 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 时将下载到末尾
- options
- IDownloadFromAzureFileOptions
返回
Promise<void>
仅在 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
返回
仅在 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
- options
- IUploadToAzureFileOptions
返回
Promise<void>
仅在 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
- options
- IUploadToAzureFileOptions
返回
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
上传期间将分配的最大缓冲区,与最大上传并发性正相关
- options
- IUploadStreamToAzureFileOptions
返回
Promise<void>