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

@azure/storage-blob 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 提供 credentialPolicyCreator 成员，用于创建 AnonymousCredentialPolicy 对象。 AnonymousCredentialPolicy 与 HTTP (S) 请求一起使用，这些请求读取公共资源或用于共享访问签名 (SAS) 。
AnonymousCredentialPolicy	AnonymousCredentialPolicy 与 HTTP (S) 请求一起使用，这些请求读取公共资源或用于共享访问签名 (SAS) 。
AppendBlobClient	AppendBlobClient 定义了一组适用于追加 blob 的操作。
BaseRequestPolicy	派生所有请求策略的基类。
BlobBatch	BlobBatch 表示对 Blob 的一组聚合操作。 目前仅 delete 支持 和 setAccessTier 。
BlobBatchClient	BlobBatchClient 允许对 Azure 存储 Blob 服务发出批处理请求。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
BlobClient	BlobClient 表示 Azure 存储 Blob 的 URL;blob 可以是块 Blob、追加 blob 或页 Blob。
BlobLeaseClient	管理 ContainerClient 或 BlobClient 的租约的客户端。
BlobSASPermissions	仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类，用于构造表示 ServiceSAS 授予 Blob 的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 BlobSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串，但权限的顺序是特定的，此类可以保证正确性。
BlobServiceClient	BlobServiceClient 表示 Azure 存储 Blob 服务的客户端，允许你操作 Blob 容器。
BlockBlobClient	BlockBlobClient 定义了一组适用于块 Blob 的操作。
ContainerClient	ContainerClient 表示 Azure 存储容器的 URL，可用于操作其 Blob。
ContainerSASPermissions	这是一个帮助程序类，用于构造表示 ServiceSAS 授予容器的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 BlobSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串，但权限的顺序是特定的，此类保证正确性。
Credential	Credential 是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管一个生成 CredentialPolicy 的 credentialPolicyCreator 工厂。
CredentialPolicy	用于在发送请求之前对 HTTP (S) 请求进行签名的凭据策略。 这是一个抽象类。
HttpHeaders	HTTP 标头键/值对的集合。
PageBlobClient	PageBlobClient 定义一组适用于页 Blob 的操作。
Pipeline	包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline 创建默认管道。 或者，可以通过 Pipeline 的构造函数使用自己的策略创建管道。 在实现自定义管道之前，请参阅 newPipeline 和提供的策略。
RequestPolicyOptions	创建 RequestPolicy 时可以使用的可选属性。
RestError	向服务终结点发出 HTTP 请求导致的错误。
SASQueryParameters	表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 BlobSASSignatureValues 类型生成。 生成后，可以将其编码为 toString() ，并直接 (追加到 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 RUNTIME 中可用。 用于 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy 是一种策略，用于使用共享密钥对 HTTP 请求进行签名。
WebResource	创建新的 WebResource 对象。 此类通过与库/实现无关并包装启动请求所需的属性来对 REST 调用进行抽象。

接口

AccessPolicy	访问策略
AccountSASPermissionsLike	类似于帐户 SAS 权限的类型。 在 AccountSASPermissions 中 用于分析原始对象的 SAS 权限。
AccountSASSignatureValues	仅在 NODE.JS RUNTIME 中可用。 AccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名 (SAS) 。 正确设置此处的所有值后，调用 generateAccountSASQueryParameters 以获取实际上可应用于 Blob 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 参数的说明，包括必需参数
AppendBlobAppendBlockFromURLOptions	用于配置 appendBlockFromURL 操作的选项。
AppendBlobAppendBlockFromUrlHeaders	定义AppendBlob_appendBlockFromUrl操作的标头。
AppendBlobAppendBlockHeaders	定义AppendBlob_appendBlock操作的标头。
AppendBlobAppendBlockOptions	用于配置 appendBlock 操作的选项。
AppendBlobCreateHeaders	定义AppendBlob_create操作的标头。
AppendBlobCreateIfNotExistsOptions	用于配置 createIfNotExists 操作的选项。
AppendBlobCreateIfNotExistsResponse	包含操作的 <xref:appendBlobClient.createIfNotExists> 响应数据。
AppendBlobCreateOptions	用于配置 创建 操作的选项。
AppendBlobRequestConditions	要添加到创建此追加 Blob 的条件。
AppendBlobSealOptions	用于配置 密封 操作的选项。
AppendPositionAccessConditions	参数组
BatchSubRequest	与批处理操作关联的请求。
BatchSubResponse	与批处理操作中的单个请求关联的响应数据。
BlobAbortCopyFromURLHeaders	定义Blob_abortCopyFromURL操作的标头。
BlobAbortCopyFromURLOptions	用于配置 abortCopyFromURL 操作的选项。
BlobAcquireLeaseOptions	用于配置 Blob - 获取租约操作的选项。
BlobBatchSubmitBatchOptionalParams	用于配置服务 - 提交批处理可选参数的选项。
BlobBeginCopyFromURLOptions	用于配置 beginCopyFromURL 操作的选项。
BlobBeginCopyFromURLResponse	包含 beginCopyFromURL 操作的响应数据。
BlobBeginCopyFromUrlPollState	从 beginCopyFromURL 返回的轮询程序使用的状态。 每当检测到复制进度时，此状态将传递到用户指定的 onProgress 回调中。
BlobBreakLeaseOptions	用于配置 Blob - 中断租约操作的选项。
BlobChangeLeaseOptions	用于配置 Blob - 更改租约操作的选项。
BlobCopyFromURLHeaders	定义Blob_copyFromURL操作的标头。
BlobCreateSnapshotHeaders	定义Blob_createSnapshot操作的标头。
BlobCreateSnapshotOptions	用于配置 createSnapshot 操作的选项 。
BlobDeleteHeaders	定义Blob_delete操作的标头。
BlobDeleteIfExistsResponse	包含 deleteIfExists 操作的响应数据。
BlobDeleteImmutabilityPolicyHeaders	定义Blob_deleteImmutabilityPolicy操作的标头。
BlobDeleteImmutabilityPolicyOptions	用于删除不可变性策略 deleteImmutabilityPolicy 操作的选项。
BlobDeleteOptions	用于配置 删除 操作的选项。
BlobDownloadHeaders	定义Blob_download操作的标头。
BlobDownloadOptionalParams	可选参数。
BlobDownloadOptions	用于配置 下载 操作的选项。
BlobDownloadResponseParsed	包含 下载 操作的响应数据。
BlobDownloadToBufferOptions	downloadToBuffer 操作的选项接口。
BlobExistsOptions	用于配置 exists 操作的选项。
BlobFlatListSegment	表示 BlobFlatListSegment 的接口。
BlobFlatListSegmentModel
BlobGenerateSasUrlOptions	用于配置 generateSasUrl 操作的选项。
BlobGetPropertiesHeaders	定义Blob_getProperties操作的标头。
BlobGetPropertiesOptions	用于配置 getProperties 操作的选项。
BlobGetPropertiesResponse	包含 getProperties 操作的响应数据。
BlobGetTagsHeaders	定义Blob_getTags操作的标头。
BlobGetTagsOptions	用于配置 getTags 操作的选项 。
BlobHTTPHeaders	参数组
BlobHierarchyListSegment	表示 BlobHierarchyListSegment 的接口。
BlobHierarchyListSegmentModel
BlobImmutabilityPolicy	描述 Blob 的不可变策略。
BlobItem	Azure 存储 Blob
BlobItemInternal	Azure 存储 Blob
BlobPrefix
BlobProperties	Blob 的属性
BlobQueryArrowConfiguration	使用 Apache 箭头格式查询 Blob 的选项。 仅对 outputTextConfiguration 有效。
BlobQueryArrowField	描述 BlobQueryArrowConfiguration 中的字段。
BlobQueryCsvTextConfiguration	使用 CSV 格式查询 Blob 的选项。
BlobQueryError	Blob 查询错误类型。
BlobQueryHeaders	定义Blob_query操作的标头。
BlobQueryJsonTextConfiguration	使用 JSON 格式查询 Blob 的选项。
BlobQueryParquetConfiguration	使用 Parquet 格式查询 Blob 的选项。 仅对 inputTextConfiguration 有效。
BlobReleaseLeaseOptions	用于配置 Blob - 发布租约操作的选项。
BlobRenewLeaseOptions	用于配置 Blob - 续订租约操作的选项。
BlobRequestConditions	标准 HTTP 条件标头、标记条件和租用条件
BlobSASPermissionsLike	类似于 Blob SAS 权限的类型。 在 BlobSASPermissions 中用于分析原始对象的 SAS 权限。
BlobSASSignatureValues	仅在 NODE.JS RUNTIME 中可用。 BlobSASSignatureValues 用于帮助为容器或 Blob 生成 Blob 服务 SAS 令牌。
BlobServiceProperties	存储服务属性。
BlobServiceStatistics	存储服务的统计信息。
BlobSetHTTPHeadersHeaders	定义Blob_setHttpHeaders操作的标头。
BlobSetHTTPHeadersOptions	用于配置 setHTTPHeaders 操作的选项。
BlobSetImmutabilityPolicyHeaders	定义Blob_setImmutabilityPolicy操作的标头。
BlobSetImmutabilityPolicyOptions	用于设置不可变性策略 setImmutabilityPolicy 操作的选项。
BlobSetLegalHoldHeaders	定义Blob_setLegalHold操作的标头。
BlobSetLegalHoldOptions	用于设置法定保留 setLegalHold 操作的选项。
BlobSetMetadataHeaders	定义Blob_setMetadata操作的标头。
BlobSetMetadataOptions	用于配置 setMetadata 操作的选项。
BlobSetTagsHeaders	定义Blob_setTags操作的标头。
BlobSetTagsOptions	用于配置 setTags 操作的选项 。
BlobSetTierHeaders	定义Blob_setTier操作的标头。
BlobSetTierOptions	用于配置 setAccessTier 操作的选项。
BlobStartCopyFromURLHeaders	定义Blob_startCopyFromURL操作的标头。
BlobStartCopyFromURLOptions	用于配置 beginCopyFromURL 操作的选项。
BlobSyncCopyFromURLOptions	用于配置 syncCopyFromURL 操作的选项。
BlobTag
BlobTags	Blob 标记
BlobUndeleteHeaders	定义Blob_undelete操作的标头。
BlobUndeleteOptions	用于配置 取消删除 操作的选项。
Block	表示块 Blob 中的单个块。 它描述了块的 ID 和大小。
BlockBlobCommitBlockListHeaders	定义BlockBlob_commitBlockList操作的标头。
BlockBlobCommitBlockListOptions	用于配置 commitBlockList 操作的选项。
BlockBlobGetBlockListHeaders	定义BlockBlob_getBlockList操作的标头。
BlockBlobGetBlockListOptions	用于配置 getBlockList 操作的选项。
BlockBlobParallelUploadOptions	uploadFile 和 <xref:BlockBlobClient.uploadSeekableStream>的选项接口。
BlockBlobPutBlobFromUrlHeaders	定义BlockBlob_putBlobFromUrl操作的标头。
BlockBlobQueryOptions	用于配置 查询 操作的选项。
BlockBlobStageBlockFromURLHeaders	定义BlockBlob_stageBlockFromURL操作的标头。
BlockBlobStageBlockFromURLOptions	用于配置 stageBlockFromURL 操作的选项。
BlockBlobStageBlockHeaders	定义BlockBlob_stageBlock操作的标头。
BlockBlobStageBlockOptions	用于配置 stageBlock 操作的选项。
BlockBlobSyncUploadFromURLOptions	用于配置 syncUploadFromURL 操作的选项。
BlockBlobUploadHeaders	定义BlockBlob_upload操作的标头。
BlockBlobUploadOptions	用于配置 上传 操作的选项。
BlockBlobUploadStreamOptions	uploadStream 操作的选项接口。
BlockList
CommonGenerateSasUrlOptions	BlobGenerateSasUrlOptions 和 ContainerGenerateSasUrlOptions 的常用选项。
CommonOptions	每个远程操作通用选项的接口。
ContainerAcquireLeaseOptions	用于配置容器 - 获取租约操作的选项。
ContainerBreakLeaseOptionalParams	可选参数。
ContainerBreakLeaseOptions	用于配置容器 - 中断租用操作的选项。
ContainerChangeLeaseOptions	用于配置容器 - 更改租约操作的选项。
ContainerCreateHeaders	定义Container_create操作的标头。
ContainerCreateIfNotExistsResponse	包含 createIfNotExists 操作的响应数据。
ContainerCreateOptions	用于配置 创建 操作的选项。
ContainerDeleteBlobOptions	用于配置 deleteBlob 操作的选项。
ContainerDeleteHeaders	定义Container_delete操作的标头。
ContainerDeleteIfExistsResponse	包含 deleteIfExists 操作的响应数据。
ContainerDeleteMethodOptions	用于配置 删除 操作的选项。
ContainerEncryptionScope	参数组
ContainerExistsOptions	用于配置 存在 操作的选项。
ContainerFilterBlobsHeaders	定义Container_filterBlobs操作的标头。
ContainerFindBlobByTagsOptions	用于配置 findBlobsByTags 操作的选项 。
ContainerGenerateSasUrlOptions	用于配置 generateSasUrl 操作的选项。
ContainerGetAccessPolicyHeaders	定义Container_getAccessPolicy操作的标头。
ContainerGetAccessPolicyOptions	用于配置 getAccessPolicy 操作的选项。
ContainerGetPropertiesHeaders	定义Container_getProperties操作的标头。
ContainerGetPropertiesOptions	用于配置 getProperties 操作的选项。
ContainerItem	Azure 存储容器
ContainerListBlobFlatSegmentHeaders	定义Container_listBlobFlatSegment操作的标头。
ContainerListBlobHierarchySegmentHeaders	定义Container_listBlobHierarchySegment操作的标头。
ContainerListBlobsOptions	用于配置容器的选项 - 列出 Blob 操作。 请参阅： listBlobsFlat listBlobsByHierarchy
ContainerProperties	容器的属性
ContainerReleaseLeaseOptions	用于配置容器 - 发布租用操作的选项。
ContainerRenameHeaders	定义Container_rename操作的标头。
ContainerRenewLeaseOptions	用于配置容器 - 续订租约操作的选项。
ContainerRequestConditions	容器要满足的条件。
ContainerSASPermissionsLike	类似于容器 SAS 权限的类型。 在 ContainerSASPermissions 中 用于分析原始对象的 SAS 权限。
ContainerSetAccessPolicyHeaders	定义Container_setAccessPolicy操作的标头。
ContainerSetAccessPolicyOptions	用于配置 setAccessPolicy 操作的选项。
ContainerSetMetadataHeaders	定义Container_setMetadata操作的标头。
ContainerSetMetadataOptions	用于配置 setMetadata 操作的选项。
ContainerUndeleteHeaders	定义Container_restore操作的标头。
CorsRule	CORS 是一项 HTTP 功能，使在一个域中运行的 Web 应用程序能够访问另一个域中的资源。 Web 浏览器实施称为同源策略的安全限制，防止网页调用不同域中的 API;CORS 提供了一种安全的方式，允许一个域 (源域) 调用另一个域中的 API
CpkInfo	参数组
FilterBlobItem	findBlobsByTags 中的 Blob 信息
FilterBlobItemModel	来自筛选器 Blob API 调用的 Blob 信息
FilterBlobSegment	findBlobsByTags 操作的段响应。
FilterBlobSegmentModel	筛选器 Blob API 调用的结果
GeoReplication	辅助存储服务的 Geo-Replication 信息
HttpAuthorization	表示 Authorization、ProxyAuthorization、WWW-Authneticate 和 Proxy-Authenticate 标头值中的验证信息。
HttpOperationResponse	http 请求和响应的包装器对象。 当以 JSON 或 XML 格式收到响应正文时，反序列化的对象存储在 parsedBody 属性中。
IHttpClient	可以发送 HttpRequests 并接收承诺的 HttpRespons 的接口。
Lease	特定租约的详细信息。
LeaseAccessConditions	参数组
LeaseOperationOptions	配置租用操作。
ListBlobsFlatSegmentResponse	Blob 枚举
ListBlobsFlatSegmentResponseModel	Blob 枚举
ListBlobsHierarchySegmentResponse	Blob 枚举
ListBlobsHierarchySegmentResponseModel	Blob 枚举
ListContainersSegmentResponse	容器枚举
Logging	Azure Analytics 日志记录设置。
MatchConditions	根据 ETag 匹配为条件请求指定 HTTP 选项。
Metadata	要与资源关联的名称/值对的映射。
Metrics	按 API 分组的请求统计信息摘要（以小时或分钟为单位）针对 Blob 的聚合
ModificationConditions	根据修改时间为条件请求指定 HTTP 选项。
ModifiedAccessConditions	标准 HTTP 条件标头和标记条件。
ModifiedAccessConditionsModel	参数组
ObjectReplicationPolicy	包含对象复制策略 ID 和 相应的 ObjectReplicationRule 列表。 检索源 Blob 上的对象复制属性时，会使用此属性。 目标 Blob 的策略 ID 在相应方法响应的 ObjectReplicationDestinationPolicyId 中设置， (例如 <xref:BlobProperties.ObjectReplicationDestinationPolicyId>。
ObjectReplicationRule	包含 Blob 的对象复制规则 ID 和 ObjectReplicationStatus 。 ObjectReplicationPolicy 下可以有多个 ObjectReplicationRule。
PageBlobClearPagesHeaders	定义PageBlob_clearPages操作的标头。
PageBlobClearPagesOptions	用于配置 clearPages 操作的选项 。
PageBlobCopyIncrementalHeaders	定义PageBlob_copyIncremental操作的标头。
PageBlobCreateHeaders	定义PageBlob_create操作的标头。
PageBlobCreateIfNotExistsOptions	用于配置 createIfNotExists 操作的选项。
PageBlobCreateIfNotExistsResponse	包含 createIfNotExists 操作的响应数据。
PageBlobCreateOptions	用于配置 创建 操作的选项。
PageBlobGetPageRangesDiffHeaders	定义PageBlob_getPageRangesDiff操作的标头。
PageBlobGetPageRangesDiffOptions	用于配置操作的选项 <xref:PageBlobClient.getRangesDiff> 。
PageBlobGetPageRangesDiffResponse	包含操作的 getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) 响应数据。
PageBlobGetPageRangesHeaders	定义PageBlob_getPageRanges操作的标头。
PageBlobGetPageRangesOptions	用于配置 getPageRanges 操作的选项 。
PageBlobGetPageRangesResponse	包含操作的 getPageRanges(number, number, PageBlobGetPageRangesOptions) 响应数据。
PageBlobListPageRangesDiffOptions	用于配置 listPageRangesDiff 操作的选项。
PageBlobListPageRangesOptions	用于配置 listPageRanges 操作的选项 。
PageBlobRequestConditions	要添加到创建此页 Blob 的条件。
PageBlobResizeHeaders	定义PageBlob_resize操作的标头。
PageBlobResizeOptions	用于配置 重设大小 操作的选项。
PageBlobStartCopyIncrementalOptions	用于配置 startCopyIncremental 操作的选项 。
PageBlobUpdateSequenceNumberHeaders	定义PageBlob_updateSequenceNumber操作的标头。
PageBlobUpdateSequenceNumberOptions	用于配置 updateSequenceNumber 操作的选项 。
PageBlobUploadPagesFromURLHeaders	定义PageBlob_uploadPagesFromURL操作的标头。
PageBlobUploadPagesFromURLOptions	用于配置 uploadPagesFromURL 操作的选项。
PageBlobUploadPagesHeaders	定义PageBlob_uploadPages操作的标头。
PageBlobUploadPagesOptions	用于配置 uploadPages 操作的选项 。
PageList	Blob 的页范围列表。
PageRangeInfo
ParsedBatchResponse	包含每个子请求的响应的多部分/混合响应。
PipelineLike	包含 HTTP 请求策略的 Pipeline 类的接口。 可以通过调用 newPipeline 创建默认管道。 或者，可以通过 Pipeline 的构造函数使用自己的策略创建管道。 在实现自定义管道之前，请参阅 newPipeline 和提供的策略。
PipelineOptions	管道构造函数的选项接口。
PollOperationState	PollOperationState 包含定义任何长时间运行的操作轮询程序所需的最小属性集的优化列表。 虽然 Poller 类充当本地控制机制来开始触发、等待并可能取消长时间运行的操作，但 PollOperationState 会记录远程长时间运行的操作的状态。 至少应在操作开始、完成和取消时更新它。 不过，实现可以具有任何其他数目的属性，这些属性可以因其他原因而更新。
PollerLike	轮询器抽象表示形式，旨在公开用户需要使用的最小 API。
PollerLikeWithCancellation	轮询器抽象表示形式，旨在公开用户需要使用的最小 API。
Range	Blob 服务操作的范围。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
RequestPolicy	请求策略的基础结构。
RetentionPolicy	确定关联数据应保留多长时间的保留策略
SASQueryParametersOptions	用于构造 SASQueryParameters 的选项。
SasIPRange	SAS 允许的 IP 范围。
SequenceNumberAccessConditions	参数组
ServiceFilterBlobsHeaders	定义Service_filterBlobs操作的标头。
ServiceFindBlobByTagsOptions	用于配置 findBlobsByTags 操作的选项 。
ServiceGenerateAccountSasUrlOptions	用于配置 generateAccountSasUrl 操作的选项。
ServiceGetAccountInfoHeaders	定义Service_getAccountInfo操作的标头。
ServiceGetAccountInfoOptions	用于配置 getAccountInfo 操作的选项。
ServiceGetPropertiesHeaders	定义Service_getProperties操作的标头。
ServiceGetPropertiesOptions	用于配置 getProperties 操作的选项。
ServiceGetStatisticsHeaders	定义Service_getStatistics操作的标头。
ServiceGetStatisticsOptions	用于配置 getStatistics 操作的选项 。
ServiceGetUserDelegationKeyHeaders	定义Service_getUserDelegationKey操作的标头。
ServiceGetUserDelegationKeyOptions	用于配置服务 - 获取用户委派密钥的选项。
ServiceListContainersOptions	用于配置 listContainers 操作的选项 。
ServiceListContainersSegmentHeaders	定义Service_listContainersSegment操作的标头。
ServiceRenameContainerOptions	用于配置 <xref:BlobServiceClient.renameContainer> 操作的选项。
ServiceSetPropertiesHeaders	定义Service_setProperties操作的标头。
ServiceSetPropertiesOptions	用于配置 setProperties 操作的选项。
ServiceSubmitBatchHeaders	定义Service_submitBatch操作的标头。
ServiceSubmitBatchOptionalParamsModel	可选参数。
ServiceUndeleteContainerOptions	用于配置 undeleteContainer 操作的选项。
SignedIdentifier	已签名的标识符。
SignedIdentifierModel	已签名标识符
StaticWebsite	使帐户能够托管静态网站的属性
StoragePipelineOptions	newPipeline 函数的选项接口。
StorageRetryOptions	存储 Blob 重试选项接口。
TagConditions	指定基于 Blob 标记的条件请求的 HTTP 选项。
UserDelegationKey	用户委托密钥。
UserDelegationKeyModel	用户委托密钥

类型别名

AccessTier	定义 AccessTier 的值。
AccountKind	定义 AccountKind 的值。
AppendBlobAppendBlockFromUrlResponse	包含 appendBlockFromUrl 操作的响应数据。
AppendBlobAppendBlockResponse	包含 appendBlock 操作的响应数据。
AppendBlobCreateResponse	包含创建操作的响应数据。
ArchiveStatus	定义 ArchiveStatus 的值。
BlobAbortCopyFromURLResponse	包含 abortCopyFromURL 操作的响应数据。
BlobBatchDeleteBlobsResponse	包含操作的 deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) 响应数据。
BlobBatchSetBlobsAccessTierResponse	包含操作的 setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) 响应数据。
BlobBatchSubmitBatchResponse	包含 Blob 批处理操作的响应数据。
BlobCopyFromURLResponse	包含 copyFromURL 操作的响应数据。
BlobCopySourceTags	定义 BlobCopySourceTags 的值。
BlobCreateSnapshotResponse	包含 createSnapshot 操作的响应数据。
BlobDeleteImmutabilityPolicyResponse	包含 deleteImmutabilityPolicy 操作的响应数据。
BlobDeleteResponse	包含删除操作的响应数据。
BlobDownloadResponseModel	包含下载操作的响应数据。
BlobGetPropertiesResponseModel	包含 getProperties 操作的响应数据。
BlobGetTagsResponse	包含 getTags 操作的响应数据。
BlobImmutabilityPolicyMode	定义 BlobImmutabilityPolicyMode 的值。
BlobQueryArrowFieldType	BlobQueryArrowField 的类型。
BlobQueryResponseModel	包含查询操作的响应数据。
BlobSetHTTPHeadersResponse	包含 setHttpHeaders 操作的响应数据。
BlobSetImmutabilityPolicyResponse	包含 setImmutabilityPolicy 操作的响应数据。
BlobSetLegalHoldResponse	包含 setLegalHold 操作的响应数据。
BlobSetMetadataResponse	包含 setMetadata 操作的响应数据。
BlobSetTagsResponse	包含 setTags 操作的响应数据。
BlobSetTierResponse	包含 setTier 操作的响应数据。
BlobStartCopyFromURLResponse	包含 startCopyFromURL 操作的响应数据。
BlobType	定义 BlobType 的值。
BlobUndeleteResponse	包含撤消删除操作的响应数据。
BlobUploadCommonResponse	uploadFile、uploadStream 和 的<xref:BlockBlobClient.uploadBrowserDate>响应类型。
BlockBlobCommitBlockListResponse	包含 commitBlockList 操作的响应数据。
BlockBlobGetBlockListResponse	包含 getBlockList 操作的响应数据。
BlockBlobPutBlobFromUrlResponse	包含 putBlobFromUrl 操作的响应数据。
BlockBlobStageBlockFromURLResponse	包含 stageBlockFromURL 操作的响应数据。
BlockBlobStageBlockResponse	包含 stageBlock 操作的响应数据。
BlockBlobUploadResponse	包含上传操作的响应数据。
BlockListType	定义 BlockListType 的值。
ContainerCreateResponse	包含创建操作的响应数据。
ContainerDeleteResponse	包含删除操作的响应数据。
ContainerFindBlobsByTagsSegmentResponse	findBlobsByTags 操作的响应。
ContainerGetAccessPolicyResponse	包含 getAccessPolicy 操作的响应数据。
ContainerGetPropertiesResponse	包含 getProperties 操作的响应数据。
ContainerListBlobFlatSegmentResponse	包含 listBlobFlatSegment 操作的响应数据。
ContainerListBlobHierarchySegmentResponse	包含 listBlobHierarchySegment 操作的响应数据。
ContainerRenameResponse	包含重命名操作的响应数据。
ContainerSetAccessPolicyResponse	包含 setAccessPolicy 操作的响应数据。
ContainerSetMetadataResponse	包含 setMetadata 操作的响应数据。
ContainerUndeleteResponse	包含还原操作的响应数据。
CopyPollerBlobClient	从 BlobClient 定义 beginCopyFromURL 返回的轮询器正常运行所需的操作。
CopyStatusType	定义 CopyStatusType 的值。
CredentialPolicyCreator	一个工厂函数，用于创建使用提供的 nextPolicy 的新 CredentialPolicy。
DeleteSnapshotsOptionType	定义 DeleteSnapshotsOptionType 的值。
EncryptionAlgorithmType	定义 EncryptionAlgorithmType 的值。 KnownEncryptionAlgorithmType 可与 EncryptionAlgorithmType 互换使用，此枚举包含服务支持的已知值。 了解服务支持的值 AES256
GeoReplicationStatusType	定义 GeoReplicationStatusType 的值。
HttpRequestBody	可能的 HTTP 请求正文类型
LeaseDurationType	定义 LeaseDurationType 的值。
LeaseOperationResponse	包含创建、修改或删除租约的操作的响应数据。 请参阅 BlobLeaseClient。
LeaseStateType	定义 LeaseStateType 的值。
LeaseStatusType	定义 LeaseStatusType 的值。
ObjectReplicationStatus	指定 Blob 的复制状态。 当存储帐户应用了对象复制策略 () 时，将使用此策略。 请参阅 ObjectReplicationPolicy 和 ObjectReplicationRule。
PageBlobClearPagesResponse	包含 clearPages 操作的响应数据。
PageBlobCopyIncrementalResponse	包含 copyIncremental 操作的响应数据。
PageBlobCreateResponse	包含创建操作的响应数据。
PageBlobGetPageRangesDiffResponseModel	包含 getPageRangesDiff 操作的响应数据。
PageBlobGetPageRangesResponseModel	包含 getPageRanges 操作的响应数据。
PageBlobResizeResponse	包含重设大小操作的响应数据。
PageBlobUpdateSequenceNumberResponse	包含 updateSequenceNumber 操作的响应数据。
PageBlobUploadPagesFromURLResponse	包含 uploadPagesFromURL 操作的响应数据。
PageBlobUploadPagesResponse	包含 uploadPages 操作的响应数据。
PublicAccessType	定义 PublicAccessType 的值。
RehydratePriority	定义 RehydratePriority 的值。
RequestPolicyFactory	为每个请求创建一个新的 RequestPolicy，该请求使用提供的 nextPolicy。
SequenceNumberActionType	定义 SequenceNumberActionType 的值。
ServiceFindBlobsByTagsSegmentResponse	findBlobsByTags 操作的响应。
ServiceGetAccountInfoResponse	包含 getAccountInfo 操作的响应数据。
ServiceGetPropertiesResponse	包含 getProperties 操作的响应数据。
ServiceGetStatisticsResponse	包含 getStatistics 操作的响应数据。
ServiceGetUserDelegationKeyResponse	包含操作的 getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) 响应数据。
ServiceListContainersSegmentResponse	包含 listContainersSegment 操作的响应数据。
ServiceSetPropertiesResponse	包含 setProperties 操作的响应数据。
ServiceSubmitBatchResponseModel	包含 submitBatch 操作的响应数据。
SkuName	定义 SkuName 的值。
SyncCopyStatusType	定义 SyncCopyStatusType 的值。
Tags	Blob 标记。

枚举

BlockBlobTier	表示 Blob 上的访问层。 有关块 Blob 级别分层的详细信息 ，请参阅热、冷和存档存储层。
KnownEncryptionAlgorithmType	服务接受的 EncryptionAlgorithmType 的已知值。
PremiumPageBlobTier	指定要将 Blob 设置为的页 Blob 层。 这仅适用于高级存储帐户上的页 Blob。 有关每个 PageBlobTier 的相应 IOPS 和吞吐量的详细信息，请参阅 此处 。
SASProtocol	生成的 SAS 的协议。
StorageBlobAudience	定义存储的已知云受众。
StorageRetryPolicyType	RetryPolicy 类型。

函数

deserializationPolicy(DeserializationContentTypes, SerializerOptions)	创建一个新的序列化 RequestPolicyCreator，它将在 HTTP 请求正文通过 HTTP 管道时序列化这些正文。
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	仅在 NODE.JS RUNTIME 中可用。 生成 SASQueryParameters 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)	仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。 仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如 permissions、startsOn 和 identifier。 警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给 identifier 或 expiresOn & 权限。 在运行以下代码片段之前，请填写所需的详细信息。 用法示例： // Generate service level SAS for a container const containerSAS = generateBlobSASQueryParameters({ containerName, // Required permissions: ContainerSASPermissions.parse("racwdl"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString(); 使用标识符的示例： // Generate service level SAS for a container with identifier // startsOn & permissions are optional when identifier is provided const identifier = "unique-id"; await containerClient.setAccessPolicy(undefined, [ { accessPolicy: { expiresOn: new Date(new Date().valueOf() + 86400), // Date type permissions: ContainerSASPermissions.parse("racwdl").toString(), startsOn: new Date() // Date type }, id: identifier } ]); const containerSAS = generateBlobSASQueryParameters( { containerName, // Required identifier // Required }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString(); 使用 Blob 名称的示例： // Generate service level SAS for a blob const blobSAS = generateBlobSASQueryParameters({ containerName, // Required blobName, // Required permissions: BlobSASPermissions.parse("racwd"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type cacheControl: "cache-control-override", // Optional contentDisposition: "content-disposition-override", // Optional contentEncoding: "content-encoding-override", // Optional contentLanguage: "content-language-override", // Optional contentType: "content-type-override", // Optional ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)	仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。 警告：生成用户委托 SAS 时，将忽略标识符，需要权限和 expiresOn。 用法示例： // Generate user delegation SAS for a container const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn); const containerSAS = generateBlobSASQueryParameters({ containerName, // Required permissions: ContainerSASPermissions.parse("racwdl"), // Required startsOn, // Optional. Date type expiresOn, // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS }, userDelegationKey, // UserDelegationKey accountName ).toString();
getBlobServiceAccountAudience(string)
isPipelineLike(unknown)	用于确定给定参数是否满足管道协定的帮助程序
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	使用提供的凭据创建新的 Pipeline 对象。

函数详细信息

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

创建一个新的序列化 RequestPolicyCreator，它将在 HTTP 请求正文通过 HTTP 管道时序列化这些正文。

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

参数

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

返回

RequestPolicyFactory

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

返回

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

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

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

在运行以下代码片段之前，请填写所需的详细信息。

用法示例：

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

使用标识符的示例：

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

使用 Blob 名称的示例：

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

参数

blobSASSignatureValues

BlobSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

返回

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。 警告：生成用户委托 SAS 时，将忽略标识符，需要权限和 expiresOn。

用法示例：

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

参数

blobSASSignatureValues

BlobSASSignatureValues

userDelegationKey

UserDelegationKey

的返回值 blobServiceClient.getUserDelegationKey()

accountName

string

返回

SASQueryParameters

getBlobServiceAccountAudience(string)

function getBlobServiceAccountAudience(storageAccountName: string): string

参数

storageAccountName

string

返回

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

参数

pipeline

unknown

可能是管道的参数

返回

pipeline

当参数满足管道协定时为 true

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

参数

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions

StoragePipelineOptions

可选。 选项。

返回

Pipeline

一个新的 Pipeline 对象。