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

@azure/storage-file-share package

类

AccountSASPermissions	仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
AccountSASResourceTypes	仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象上的资源字段。 可以构造没有此类的资源字符串，但资源的顺序是特定的，此类保证正确性。
AccountSASServices	仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象的服务字段。 可以构造没有此类的服务字符串，但服务的顺序是特定的，此类保证正确性。
AnonymousCredential	AnonymousCredential 提供 credentialPolicyCreator 成员，用于创建 AnonymousCredentialPolicy 对象。 AnonymousCredentialPolicy 与 HTTP（S） 请求一起使用，这些请求读取公共资源或用于共享访问签名（SAS）。
AnonymousCredentialPolicy	AnonymousCredentialPolicy 与 HTTP（S） 请求一起使用，这些请求读取公共资源或用于共享访问签名（SAS）。
BaseRequestPolicy	从中派生所有请求策略的基类。
Credential	凭据是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。
CredentialPolicy	用于在发送之前对 HTTP（S） 请求进行签名的凭据策略。 这是一个抽象类。
FileSASPermissions	仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 ServiceSAS 授予文件的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 FileSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
FileSystemAttributes	这是一个帮助程序类，用于构造表示文件或目录的 NTFS 属性的字符串。 请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
Pipeline	包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline来创建默认管道。 或者，可以通过管道构造函数创建自己的策略的管道。 在实施自定义管道之前，请参阅 newPipeline 和提供的策略。
RestError	失败管道请求的自定义错误类型。
SASQueryParameters	表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 FileSASSignatureValues 类型生成。 生成后，可以将其编码为 toString() 并直接追加到 URL（不过，如果存在现有的查询参数，这可能会影响追加这些查询参数的适当方式），应谨慎使用。 注意：此类的实例是不可变的。
ShareClient	ShareClient 表示 Azure 存储共享的 URL，允许你作其目录和文件。
ShareDirectoryClient	ShareDirectoryClient 表示 Azure 存储目录的 URL，允许你作其文件和目录。
ShareFileClient	ShareFileClient 表示 Azure 存储文件的 URL。
ShareLeaseClient	管理 ShareFileClient 或 ShareClient租约的客户端。 请参阅 https://learn.microsoft.com/rest/api/storageservices/lease-file 并查看 https://learn.microsoft.com/rest/api/storageservices/lease-share
ShareSASPermissions	这是一个帮助程序类，用于构造表示 ServiceSAS 授予共享的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 FileSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
ShareServiceClient	ShareServiceClient 表示 Azure 存储文件服务的 URL，允许你作文件共享。
StorageBrowserPolicy	StorageBrowserPolicy 将处理 Node.js 和浏览器运行时之间的差异，包括： 浏览器通过添加条件标头（如“IF_MODIFIED_SINCE”）来缓存 GET/HEAD 请求。 StorageBrowserPolicy 是一种策略，用于将时间戳查询添加到 GET/HEAD 请求 URL，从而避免浏览器缓存。 删除 Cookie 标头以安全 删除内容长度标头以避免浏览器警告
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory 是帮助生成 StorageBrowserPolicy 对象的工厂类。
StorageRetryPolicy	实现指数重试和线性重试的重试策略。
StorageRetryPolicyFactory	StorageRetryPolicyFactory 是一个工厂类，可帮助生成 StorageRetryPolicy 对象。
StorageSharedKeyCredential	仅在NODE.JS运行时中可用。 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy 是用于使用共享密钥对 HTTP 请求进行签名的策略。

接口

AccessPolicy	访问策略。
AccountSASSignatureValues	仅在NODE.JS运行时中可用。 AccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名（SAS）。 正确设置此处的所有值后，调用 generateAccountSASQueryParameters 以获取实际可应用于文件 URL 的 SAS 表示形式。 注意：此类和 SASQueryParameters 存在，因为前者是可变的，逻辑表示形式，而后者是不可变的，用于生成实际的 REST 请求。 有关 SAS 的更多概念性信息，请参阅 https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas，了解参数的说明，包括所需的参数
ClearRange
CloseHandlesInfo	关闭处理结果信息。
CommonGenerateSasUrlOptions	ShareGenerateSasUrlOptions 和 FileGenerateSasUrlOptions的常见选项。
CommonOptions	每个远程作通用选项的接口。
CopyFileSmbInfo	参数组
CorsRule	CORS 是一项 HTTP 功能，它使 Web 应用程序能够在一个域下运行，以访问另一个域中的资源。 Web 浏览器实施安全限制，称为同源策略，防止网页在不同的域中调用 API;CORS 提供了一种安全的方法，允许一个域（源域）在另一个域中调用 API。
DirectoryCloseHandlesHeaders	关闭句柄请求的其他响应标头值。
DirectoryCreateHeaders	定义Directory_create作的标头。
DirectoryCreateIfNotExistsResponse	包含 createIfNotExists(DirectoryCreateOptions)作的响应数据。
DirectoryCreateOptions	用于配置 创建作的选项。
DirectoryDeleteHeaders	定义Directory_delete作的标头。
DirectoryDeleteIfExistsResponse	包含 deleteIfExists(DirectoryDeleteOptions)作的响应数据。
DirectoryDeleteOptions	用于配置 删除作的选项。
DirectoryExistsOptions	配置 的选项作存在。
DirectoryForceCloseHandlesHeaders	定义Directory_forceCloseHandles作的标头。
DirectoryForceCloseHandlesOptions	用于配置 forceCloseHandle的选项。
DirectoryForceCloseHandlesSegmentOptions	用于配置目录的选项 - 强制关闭句柄段作。 看： <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	定义Directory_getProperties作的标头。
DirectoryGetPropertiesOptions	用于配置 getProperties作的选项。
DirectoryItem	列出的目录项。
DirectoryListFilesAndDirectoriesOptions	用于配置 listFilesAndDirectories 作 选项。
DirectoryListFilesAndDirectoriesSegmentHeaders	定义Directory_listFilesAndDirectoriesSegment作的标头。
DirectoryListHandlesHeaders	定义Directory_listHandles作的标头。
DirectoryListHandlesOptions	用于配置 listHandles作的选项。
DirectoryListHandlesSegmentOptions	用于配置目录的选项 - 列出句柄段作。 看： <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	每个远程作通用选项的接口。
DirectoryRenameHeaders	定义Directory_rename作的标头。
DirectoryRenameOptions	配置 重命名作的选项。
DirectorySetMetadataHeaders	定义Directory_setMetadata作的标头。
DirectorySetMetadataOptions	用于配置 setMetadata作的选项。
DirectorySetPropertiesHeaders	定义Directory_setProperties作的标头。
FileAbortCopyFromURLOptions	用于配置 abortCopyFromURL作的选项。
FileAbortCopyHeaders	定义File_abortCopy作的标头。
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	用于配置 clearRange作的选项。
FileCloseHandlesHeaders	关闭句柄请求的其他响应标头值。
FileCreateHardLinkHeaders	定义File_createHardLink作的标头。
FileCreateHardLinkOptions	配置文件 - 创建硬链接作的选项。 看： createHardLink
FileCreateHeaders	定义File_create作的标头。
FileCreateOptions	用于配置 创建作的选项。
FileDeleteHeaders	定义File_delete作的标头。
FileDeleteIfExistsResponse	包含 deleteIfExists作的响应数据。
FileDeleteOptions	用于配置 删除作的选项。
FileDownloadHeaders	定义File_download作的标头。
FileDownloadOptionalParams	可选参数。
FileDownloadOptions	配置文件 - 下载作的选项。 看： 下载 downloadToFile
FileDownloadToBufferOptions	downloadToBuffer作的选项接口。
FileExistsOptions	配置 的选项作存在。
FileForceCloseHandlesHeaders	定义File_forceCloseHandles作的标头。
FileForceCloseHandlesOptions	用于配置文件的选项 - 强制关闭句柄作。 看： <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	用于配置 generateSasUrl作的选项。
FileGetPropertiesHeaders	定义File_getProperties作的标头。
FileGetPropertiesOptions	用于配置 getProperties作的选项。
FileGetRangeListHeaders	定义File_getRangeList作的标头。
FileGetRangeListOptions	用于配置 getRangeList作的选项。
FileHttpHeaders
FileItem	列出的文件项。
FileListHandlesHeaders	定义File_listHandles作的标头。
FileListHandlesOptions	每个远程作通用选项的接口。
FileListHandlesSegmentOptions	用于配置文件的选项 - 列出句柄段作。 看： <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	文件的选项接口 - 上传作 看： uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	NFS 属性。 请注意，这些属性仅适用于高级 NFS 文件帐户中的文件或目录。
FileProperties	每个远程作通用选项的接口。
FileProperty	文件属性。
FileRenameHeaders	定义File_rename作的标头。
FileRenameOptions	配置 重命名作的选项。
FileResizeOptions	用于配置 调整作大小的选项。
FileSASSignatureValues	仅在NODE.JS运行时中可用。 FileSASSignatureValues 用于帮助为共享或文件生成文件服务 SAS 令牌。
FileServiceProperties	存储服务属性。
FileSetHTTPHeadersHeaders	定义File_setHttpHeaders作的标头。
FileSetHttpHeadersOptions	用于配置 setHttpHeaders作的选项。
FileSetMetadataHeaders	定义File_setMetadata作的标头。
FileSetMetadataOptions	用于配置 setMetadata作的选项。
FileStartCopyHeaders	定义File_startCopy作的标头。
FileStartCopyOptions	用于配置 startCopyFromURL作的选项。
FileUploadRangeFromURLHeaders	定义File_uploadRangeFromURL作的标头。
FileUploadRangeFromURLOptionalParams	可选参数。
FileUploadRangeFromURLOptions	配置 uploadRangeFromURL作的选项。
FileUploadRangeHeaders	定义File_uploadRange作的标头。
FileUploadRangeOptions	配置 uploadRange作的选项。
FileUploadStreamOptions	ShareFileClient.uploadStream（） 的选项接口。
FilesAndDirectoriesListSegment	可从 Directory 列出的条目的摘要。
HandleItem	列出的 Azure 存储句柄项。
HttpAuthorization	表示 Authorization、ProxyAuthorization、WWW-Authenticate 和 Proxy-Authenticate 标头值中的身份验证信息。
HttpHeaders	HTTP 标头键/值对的集合。
HttpOperationResponse	与 core-v1（core-http）兼容的 Http 响应。
HttpResponse	HTTP 响应的表示形式，其中包括对发起请求的引用。
IHttpClient	core-http 请求策略的兼容接口
LeaseAccessConditions	参数组
LeaseOperationOptions	租用作选项。
LeaseOperationResponseHeaders	特定租约作的响应的详细信息。
ListFilesAndDirectoriesSegmentResponse	目录和文件的枚举。
ListHandlesResponse	句柄的枚举。
ListSharesResponse	共享的枚举。
ListSharesResponseModel	共享的枚举。
Metadata
Metrics	文件服务的存储分析指标。
NfsFileMode	文件或目录的模式权限。
PipelineLike	包含 HTTP 请求策略的 Pipeline 类的接口。 可以通过调用 newPipeline来创建默认管道。 或者，可以通过管道构造函数创建自己的策略的管道。 在实施自定义管道之前，请参阅 newPipeline 和提供的策略。
PipelineOptions	管道构造函数的选项接口。
PosixRolePermissions	表示特定角色的文件权限。
Range	服务作的范围。 请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Azure 存储文件范围。
RequestPolicyFactory	与 core-http 的 RequestPolicyFactory 兼容的接口
RequestPolicyOptions	与 RequestPolicy 兼容的接口
ResponseLike	具有简单_response属性的对象。
ResponseWithBody	具有_response属性的对象，该属性具有已分析为已知类型的正文和标头。
ResponseWithHeaders	具有已分析为类型化对象的_response属性的对象。
RetentionPolicy	保留策略。
SasIPRange	SAS 允许的 IP 范围。
ServiceClientOptions	@azure/core-http ServiceClientOptions 的子集
ServiceGenerateAccountSasUrlOptions	用于配置 generateAccountSasUrl作的选项。
ServiceGetPropertiesHeaders	定义Service_getProperties作的标头。
ServiceGetPropertiesOptions	用于配置 getProperties作的选项。
ServiceListSharesOptions	用于配置 listShares作的选项。
ServiceListSharesSegmentHeaders	定义Service_listSharesSegment作的标头。
ServiceSetPropertiesHeaders	定义Service_setProperties作的标头。
ServiceSetPropertiesOptions	用于配置 setProperties作的选项。
ServiceUndeleteShareOptions	用于配置 <xref:ShareServiceClient.undelete>作的选项。
SetPropertiesResponse	包含 setHttpHeaders作的响应数据。
ShareClientConfig
ShareCreateHeaders	定义Share_create作的标头。
ShareCreateIfNotExistsResponse	包含 createIfNotExists作的响应数据。
ShareCreateOptions	用于配置 创建作的选项。
ShareCreatePermissionHeaders	定义Share_createPermission作的标头。
ShareCreatePermissionOptions	用于配置 createPermission作的选项。
ShareCreateSnapshotHeaders	定义Share_createSnapshot作的标头。
ShareCreateSnapshotOptions	用于配置 createSnapshot作的选项。
ShareDeleteHeaders	定义Share_delete作的标头。
ShareDeleteIfExistsResponse	包含 deleteIfExists作的响应数据。
ShareDeleteMethodOptions	用于配置 删除作的选项。
ShareExistsOptions	配置 的选项作存在。
ShareFileRangeList	文件范围列表
ShareGenerateSasUrlOptions	用于配置 generateSasUrl作的选项。
ShareGetAccessPolicyHeaders	定义Share_getAccessPolicy作的标头。
ShareGetAccessPolicyOptions	用于配置 getAccessPolicy作的选项。
ShareGetPermissionHeaders	定义Share_getPermission作的标头。
ShareGetPermissionOptions	用于配置 getPermission作的选项。
ShareGetPropertiesHeaders	定义Share_getProperties作的标头。
ShareGetPropertiesOptions	用于配置 getProperties作的选项。
ShareGetStatisticsHeaders	定义Share_getStatistics作的标头。
ShareGetStatisticsOptions	用于配置 getStatistics作的选项。
ShareItem	列出的 Azure 存储共享项。
ShareItemInternal	列出的 Azure 存储共享项。
SharePermission	共享级别的权限（安全描述符）。
SharePropertiesInternal	共享的属性。
ShareProtocolSettings	协议设置
ShareProtocols	在共享上启用的协议。 目前，仅支持 SMB 或 NFS。
ShareSetAccessPolicyHeaders	定义Share_setAccessPolicy作的标头。
ShareSetAccessPolicyOptions	用于配置 setAccessPolicy作的选项。
ShareSetMetadataHeaders	定义Share_setMetadata作的标头。
ShareSetMetadataOptions	用于配置 setMetadata作的选项。
ShareSetPropertiesHeaders	定义Share_setProperties作的标头。
ShareSetPropertiesOptions	用于配置 setProperties作的选项。
ShareSetQuotaOptions	用于配置 setQuota作的选项。
ShareSmbSettings	SMB 协议的设置。
ShareStats	共享的统计信息。
SignedIdentifier	已签名标识符
SignedIdentifierModel	已签名的标识符。
SmbMultichannel	SMB 多通道的设置
SourceModifiedAccessConditions	参数组
StoragePipelineOptions	newPipeline 函数的选项接口。
StorageRetryOptions	存储 Blob 重试选项接口。
WebResource	要向远程服务器发出的 HTTP 请求的说明。

类型别名

CopyStatusType	定义 CopyStatusType 的值。
CredentialPolicyCreator	一个工厂函数，用于创建使用提供的 nextPolicy 的新 CredentialPolicy。
DeleteSnapshotsOptionType	定义 DeleteSnapshotsOptionType 的值。
DirectoryCreateResponse	包含创建作的响应数据。
DirectoryDeleteResponse	包含删除作的响应数据。
DirectoryForceCloseHandlesResponse	forceCloseHandle的响应类型。
DirectoryGetPropertiesResponse	包含 getProperties作的响应数据。
DirectoryListFilesAndDirectoriesSegmentResponse	包含 listFilesAndDirectoriesSegment作的响应数据。
DirectoryListHandlesResponse	包含 listHandles作的响应数据。
DirectoryRenameResponse	包含重命名作的响应数据。
DirectorySetMetadataResponse	包含 setMetadata作的响应数据。
DirectorySetPropertiesResponse	包含 setProperties作的响应数据。
FileAbortCopyResponse	包含中止Copy作的响应数据。
FileAttributesPreserveType	指示保持现有文件属性不变。
FileCreateHardLinkResponse	包含用于创建硬链接作的响应数据。
FileCreateResponse	包含创建作的响应数据。
FileDeleteResponse	包含删除作的响应数据。
FileDownloadResponseModel	包含下载作的响应数据。
FileForceCloseHandlesResponse	forceCloseHandle的响应类型。
FileGetPropertiesResponse	包含 getProperties作的响应数据。
FileGetRangeListDiffResponse	包含 getRangeList作的响应数据。
FileGetRangeListResponse	包含 getRangeList作的响应数据。
FileLastWrittenMode	定义 FileLastWrittenMode 的值。
FileListHandlesResponse	包含 listHandles作的响应数据。
FilePermissionFormat	定义 FilePermissionFormat 的值。
FilePermissionInheritType	指示从父目录继承文件权限。
FilePermissionPreserveType	指示保持现有文件权限值不变。
FileRenameResponse	包含重命名作的响应数据。
FileSetHTTPHeadersResponse	包含 setHttpHeaders作的响应数据。
FileSetMetadataResponse	包含 setMetadata作的响应数据。
FileStartCopyResponse	包含 startCopy作的响应数据。
FileUploadRangeFromURLResponse	包含 uploadRangeFromURL作的响应数据。
FileUploadRangeResponse	包含 uploadRange作的响应数据。
HttpRequestBody	请求支持的类型。 NodeJS.ReadableStream 和 （） => NodeJS.ReadableStream 仅是 Node。 Blob、ReadableStream 和 （） => ReadableStream 仅浏览器。
LeaseDurationType	定义 LeaseDurationType 的值。
LeaseOperationResponse	包含获取、更改、中断或释放租约的作的响应数据。 请参阅 ShareLeaseClient。
LeaseStateType	定义 LeaseStateType 的值。
LeaseStatusType	定义 LeaseStatusType 的值。
ListSharesIncludeType	定义 ListSharesIncludeType 的值。
ModeCopyMode	定义 ModeCopyMode 的值。
NfsFileType	定义 NfsFileType 的值。 <xref:KnownNfsFileType> 可与 NfsFileType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 常规 Directory SymLink
OwnerCopyMode	定义 OwnerCopyMode 的值。
PermissionCopyModeType	定义 PermissionCopyModeType 的值。
RawFileDownloadResponse	包含下载作的响应数据。
ServiceGetPropertiesResponse	包含 getProperties作的响应数据。
ServiceListSharesSegmentResponse	包含 listShares作的响应数据。
ServiceSetPropertiesResponse	包含 setProperties作的响应数据。
ShareAccessTier	定义 ShareAccessTier 的值。
ShareClientOptions
ShareCreatePermissionResponse	包含 createPermission作的响应数据。
ShareCreateResponse	包含创建作的响应数据。
ShareCreateSnapshotResponse	包含 createSnapshot作的响应数据。
ShareDeleteResponse	包含删除作的响应数据。
ShareFileHandleAccessRights	定义 AccessRight 的值。
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	包含 getPermission作的响应数据。
ShareGetPropertiesResponse	包含 getProperties作的响应数据。
ShareGetPropertiesResponseModel	包含 getProperties作的响应数据。
ShareGetStatisticsResponse	getStatistics作的响应数据。
ShareGetStatisticsResponseModel	包含 getStatistics作的响应数据。
ShareProperties	共享的属性。
ShareRootSquash	定义 ShareRootSquash 的值。
ShareSetAccessPolicyResponse	包含 setAccessPolicy作的响应数据。
ShareSetMetadataResponse	包含 setMetadata作的响应数据。
ShareSetPropertiesResponse	包含 setProperties作的响应数据。
ShareSetQuotaHeaders	定义 setQuota作的标头。
ShareSetQuotaResponse	包含 setQuota作的响应数据。
ShareTokenIntent	定义 ShareTokenIntent 的值。 KnownShareTokenIntent 可与 ShareTokenIntent 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 备份
TimeNowType	指示设置为请求的时间。
TimePreserveType	指示保持现有时间值不变。
WithResponse	一种类型，表示具有已知_response属性的作结果。

枚举

KnownShareTokenIntent	服务的 ShareTokenIntent 的已知值。
SASProtocol	生成的 SAS 的协议。
StorageFileAudience	定义存储的已知云受众。
StorageRetryPolicyType	RetryPolicy 类型。

函数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	仅在NODE.JS运行时中可用。 生成 SASQueryParameters 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。 请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)	仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。 仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如权限、startsOn 和标识符。 警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给标识符或 expiresOn & 权限。
getFileServiceAccountAudience(string)	获取文件服务的存储帐户的 OAuth 受众。
isPipelineLike(unknown)	确定给定参数是否满足管道协定的帮助程序
newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)	使用提供的凭据创建新的 Pipeline 对象。
parseOctalFileMode(string)	将文件模式的 4 位八进制字符串表示形式分析为 NfsFileMode 结构。
parseSymbolicFileMode(string)	将文件模式的 9 个字符符号字符串表示形式分析为 NfsFileMode 结构。
toOctalFileMode(NfsFileMode)	将 NfsFileMode 结构转换为 4 位八进制字符串重新表示。
toSymbolicFileMode(NfsFileMode)	将 NfsFileMode 转换为符号表示法中的字符串。

函数详细信息

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。

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

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

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

参数

accountSASSignatureValues

AccountSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

返回

SASQueryParameters

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。

创建 SASQueryParameters 的实例。

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

警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给标识符或 expiresOn & 权限。

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

参数

fileSASSignatureValues

FileSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

返回

SASQueryParameters

getFileServiceAccountAudience(string)

获取文件服务的存储帐户的 OAuth 受众。

function getFileServiceAccountAudience(storageAccountName: string): string

参数

storageAccountName

string

返回

string

isPipelineLike(unknown)

确定给定参数是否满足管道协定的帮助程序

function isPipelineLike(pipeline: unknown): pipeline

参数

pipeline

unknown

可以是管道的参数

返回

pipeline

如果参数满足管道协定，则为 true

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

使用提供的凭据创建新的 Pipeline 对象。

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

参数

credential

Credential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何来自 @azure/identity 包的凭据，用于对服务的请求进行身份验证。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。

pipelineOptions

StoragePipelineOptions

自选。 选项。

返回

Pipeline

新的 Pipeline 对象。

parseOctalFileMode(string)

将文件模式的 4 位八进制字符串表示形式分析为 NfsFileMode 结构。

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

参数

input

string

返回

NfsFileMode | undefined

parseSymbolicFileMode(string)

将文件模式的 9 个字符符号字符串表示形式分析为 NfsFileMode 结构。

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

参数

input

string

返回

NfsFileMode | undefined

toOctalFileMode(NfsFileMode)

将 NfsFileMode 结构转换为 4 位八进制字符串重新表示。

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

参数

input

NfsFileMode

返回

string | undefined

toSymbolicFileMode(NfsFileMode)

将 NfsFileMode 转换为符号表示法中的字符串。

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

参数

input

NfsFileMode

返回

string | undefined