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

@azure/storage-file-share package

AccountSASPermissions

仅在 NODE.JS RUNTIME 中可用。

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

AccountSASResourceTypes

仅在 NODE.JS RUNTIME 中可用。

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

AccountSASServices

仅在 NODE.JS RUNTIME 中可用。

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

AnonymousCredential

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

AnonymousCredentialPolicy

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

BaseRequestPolicy

从中派生所有请求策略的基类。

Credential

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

CredentialPolicy

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

FileSASPermissions

仅在 NODE.JS RUNTIME 中可用。

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

FileSystemAttributes

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

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

Pipeline

包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline 创建默认管道。 或者,可以通过 Pipeline 的构造函数创建具有自己的策略的管道。

在实现自定义管道之前,请参阅 newPipeline 和提供的策略。

RestError

失败管道请求的自定义错误类型。

SASQueryParameters

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

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

ShareClient

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

ShareDirectoryClient

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

ShareFileClient

ShareFileClient 表示 Azure 存储文件的 URL。

ShareLeaseClient

管理 ShareFileClient 或 ShareClient 的租约 客户端。

查看 https://docs.microsoft.com/rest/api/storageservices/lease-file 和查看 https://docs.microsoft.com/rest/api/storageservices/lease-share

ShareSASPermissions

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

ShareServiceClient

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

StorageBrowserPolicy

StorageBrowserPolicy 将处理 Node.js 与浏览器运行时之间的差异,包括:

  1. 浏览器通过添加条件标头(如“IF_MODIFIED_SINCE”)来缓存 GET/HEAD 请求。 StorageBrowserPolicy 是一种策略,用于将时间戳查询添加到 GET/HEAD 请求 URL,从而避免浏览器缓存。

  2. 删除 Cookie 标头以保障安全性

  3. 删除内容长度标头以避免浏览器警告

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory 是一个工厂类,可帮助生成 StorageBrowserPolicy 对象。

StorageRetryPolicy

实现指数重试和线性重试的重试策略。

StorageRetryPolicyFactory

StorageRetryPolicyFactory 是一个工厂类,可帮助生成 StorageRetryPolicy 对象。

StorageSharedKeyCredential

仅在 NODE.JS RUNTIME 中可用。

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

StorageSharedKeyCredentialPolicy

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

接口

AccessPolicy

访问策略。

AccountSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。

AccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名 (SAS) 。 正确设置此处的所有值后,调用 generateAccountSASQueryParameters 以获取实际上可应用于文件 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 参数的说明,包括必需参数

ClearRange
CloseHandlesInfo

Close 处理结果信息。

CommonGenerateSasUrlOptions

ShareGenerateSasUrlOptionsFileGenerateSasUrlOptions 的常用选项。

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

用于配置 exists 操作的选项。

DirectoryForceCloseHandlesHeaders

定义Directory_forceCloseHandles操作的标头。

DirectoryForceCloseHandlesOptions

用于配置 forceCloseHandle 的选项

DirectoryForceCloseHandlesSegmentOptions

用于配置目录 - 强制关闭句柄段操作的选项。

请参阅:

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

关闭句柄请求的其他响应标头值。

FileCreateHeaders

定义File_create操作的标头。

FileCreateOptions

用于配置 创建 操作的选项。

FileDeleteHeaders

定义File_delete操作的标头。

FileDeleteIfExistsResponse

包含 deleteIfExists 操作的响应数据。

FileDeleteOptions

用于配置 删除 操作的选项。

FileDownloadHeaders

定义File_download操作的标头。

FileDownloadOptionalParams

可选参数。

FileDownloadOptions

用于配置文件 - 下载操作的选项。

请参阅:

FileDownloadToBufferOptions

downloadToBuffer 操作的选项接口。

FileExistsOptions

用于配置 exists 操作的选项。

FileForceCloseHandlesHeaders

定义File_forceCloseHandles操作的标头。

FileForceCloseHandlesOptions

用于配置文件 - 强制关闭句柄操作的选项。

请参阅:

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>
FileProperties

每个远程操作通用选项的接口。

FileProperty

文件属性。

FileRenameHeaders

定义File_rename操作的标头。

FileRenameOptions

用于配置 重命名 操作的选项。

FileResizeOptions

用于配置 重设大小 操作的选项。

FileSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。

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

可从目录列出的条目的摘要。

HandleItem

列出的 Azure 存储句柄项。

HttpAuthorization

表示 Authorization、ProxyAuthorization、WWW-Authneticate 和 Proxy-Authenticate 标头值中的验证信息。

HttpHeaders

HTTP 标头键/值对的集合。

HttpOperationResponse

与 core-v1 兼容的 Http 响应 (core-http) 。

HttpResponse

HTTP 响应的表示形式,包括对发起该响应的请求的引用。

IHttpClient

适用于 core-http 请求策略的兼容接口

LeaseAccessConditions

参数组

LeaseOperationOptions

租用操作选项。

LeaseOperationResponseHeaders

特定租约操作的响应的详细信息。

ListFilesAndDirectoriesSegmentResponse

目录和文件的枚举。

ListHandlesResponse

句柄的枚举。

ListSharesResponse

共享的枚举。

ListSharesResponseModel

共享的枚举。

Metadata
Metrics

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

PipelineLike

包含 HTTP 请求策略的 Pipeline 类的接口。 可以通过调用 newPipeline 创建默认管道。 或者,可以通过 Pipeline 的构造函数创建具有自己的策略的管道。

在实现自定义管道之前,请参阅 newPipeline 和提供的策略。

PipelineOptions

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

Range

服务操作的范围。

请参见https://docs.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

ServiceClientOptions 的 @azure/core-http 子集

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

用于配置 exists 操作的选项。

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

包含 abortCopy 操作的响应数据。

FileAttributesPreserveType

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

FileCreateResponse

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

FileDeleteResponse

包含删除操作的响应数据。

FileDownloadResponseModel

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

FileForceCloseHandlesResponse

forceCloseHandle 的响应类型。

FileGetPropertiesResponse

包含 getProperties 操作的响应数据。

FileGetRangeListDiffResponse

包含 getRangeList 操作的响应数据。

FileGetRangeListResponse

包含 getRangeList 操作的响应数据。

FileLastWrittenMode

定义 FileLastWrittenMode 的值。

FileListHandlesResponse

包含 listHandles 操作的响应数据。

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 的值。

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 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

backup

TimeNowType

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

TimePreserveType

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

WithResponse

表示具有已知_response属性的操作结果的类型。

枚举

KnownShareTokenIntent

服务接受的 ShareTokenIntent 的已知值。

SASProtocol

生成的 SAS 的协议。

StorageFileAudience

定义存储的已知云受众。

StorageRetryPolicyType

RetryPolicy 类型。

函数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

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

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

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

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

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

getFileServiceAccountAudience(string)

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

isPipelineLike(unknown)

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

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

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

函数详细信息

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

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

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

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

参数

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

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

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

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

参数

fileSASSignatureValues
FileSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

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 对象。