通过

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

@azure/storage-blob package

  • 参考

类

AccountSASPermissions

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

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

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

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

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

AppendBlobClient 定义一组适用于追加 blob 的操作。
BlobBatch

BlobBatch 表示对 Blob 的一组聚合操作。 目前仅 delete 支持 和 setAccessTier 。
BlobBatchClient

BlobBatchClient 允许向 Azure 存储 Blob 服务发出批量请求。
BlobClient

BlobClient 表示 Azure 存储 Blob 的 URL;blob 可以是块 Blob、追加 blob 或页 Blob。
BlobLeaseClient

管理 或 的租约 <xref:ContainerClient> 的 <xref:BlobClient>客户端。
BlobSASPermissions

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

BlobServiceClient 表示 Azure 存储 Blob 服务的客户端，允许你操作 Blob 容器。
BlockBlobClient

BlockBlobClient 定义了一组适用于块 Blob 的操作。
ContainerClient

ContainerClient 表示 Azure 存储容器的 URL，允许你操作其 blob。
ContainerSASPermissions

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

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

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

PageBlobClient 定义一组适用于页 Blob 的操作。
Pipeline

包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 <xref:newPipeline>创建默认管道。 或者，可以通过 Pipeline 的构造函数创建具有自己的策略的管道。 在实现自定义管道之前， <xref:newPipeline> 请参阅并提供的策略。
SASQueryParameters

表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 <xref:AccountSASSignatureValues> 和 <xref:BlobSASSignatureValues> 类型生成。 生成后，可以将其编码为 并 <xref:String> 直接追加到 URL (不过，如果存在现有的查询参数，这可能会影响) 追加这些查询参数的适当方式，但此处应小心谨慎。 注意：此类的实例是不可变的。
StorageBrowserPolicy

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

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

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

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

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

StorageClient 表示 、 <xref:ContainerClient> 等的<xref:BlobServiceClient>基于 URL 类。
StorageClientContext
StorageRetryPolicy

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

StorageRetryPolicyFactory 是一个工厂类，可帮助生成 <xref:StorageRetryPolicy> 对象。
StorageSharedKeyCredential

仅在 NODE.JS RUNTIME 中可用。 用于 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy

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

接口

AccessPolicy

访问策略
AccountSASPermissionsLike

类似于帐户 SAS 权限的类型。 在 中 <xref:AccountSASPermissions> 用于分析原始对象的 SAS 权限。
AccountSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。 AccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名 (SAS) 。 正确设置此处的所有值后，调用 <xref:generateAccountSASQueryParameters> 以获取实际上可应用于 Blob URL 的 SAS 表示形式。 注意：此类 和 <xref:SASQueryParameters> 都存在，因为前者是可变的，是逻辑表示形式，而后者是不可变的，用于生成实际的 REST 请求。
AppendBlobAppendBlockFromURLOptions

用于配置操作的选项 <xref:AppendBlobClient.appendBlockFromURL> 。
AppendBlobAppendBlockFromUrlHeaders

定义AppendBlob_appendBlockFromUrl操作的标头。
AppendBlobAppendBlockHeaders

定义AppendBlob_appendBlock操作的标头。
AppendBlobAppendBlockOptions

用于配置操作的选项 <xref:AppendBlobClient.appendBlock> 。
AppendBlobCreateHeaders

定义AppendBlob_create操作的标头。
AppendBlobCreateIfNotExistsOptions

用于配置 <xref:AppendBlobClient.createIfNotExists> 操作的选项。
AppendBlobCreateIfNotExistsResponse

包含操作的 <xref:appendBlobClient.createIfNotExists> 响应数据。
AppendBlobCreateOptions

用于配置 <xref:AppendBlobClient.create> 操作的选项。
AppendBlobRequestConditions

要添加到创建此追加 Blob 的条件。
AppendBlobSealOptions

用于配置 <xref:AppendBlobClient.seal> 操作的选项。
AppendPositionAccessConditions

参数组
BatchSubRequest

与批处理操作关联的请求。
BatchSubResponse

与批处理操作中的单个请求关联的响应数据。
BlobAbortCopyFromURLHeaders

定义Blob_abortCopyFromURL操作的标头。
BlobAbortCopyFromURLOptions

用于配置操作的选项 <xref:BlobClient.abortCopyFromURL> 。
BlobAcquireLeaseOptions

用于配置 Blob - 获取租约操作的选项。
BlobBatchSubmitBatchOptionalParams

用于配置服务 - 提交批处理可选参数的选项。
BlobBeginCopyFromURLOptions

用于配置操作的选项 <xref:BlobClient.beginCopyFromURL> 。
BlobBeginCopyFromURLResponse

包含操作的 <xref:BlobClient.beginCopyFromURL> 响应数据。
BlobBeginCopyFromUrlPollState

从 <xref:BlobClient.beginCopyFromURL>返回的轮询程序使用的状态。 每当检测到复制进度时，此状态将传递到用户指定的 onProgress 回调中。
BlobBreakLeaseOptions

用于配置 Blob - 中断租用操作的选项。
BlobChangeLeaseOptions

用于配置 Blob - 更改租约操作的选项。
BlobCopyFromURLHeaders

定义Blob_copyFromURL操作的标头。
BlobCreateSnapshotHeaders

定义Blob_createSnapshot操作的标头。
BlobCreateSnapshotOptions

用于配置操作的选项 <xref:BlobClient.createSnapshot> 。
BlobDeleteHeaders

定义Blob_delete操作的标头。
BlobDeleteIfExistsResponse

包含操作的 <xref:BlobClient.deleteIfExists> 响应数据。
BlobDeleteImmutabilityPolicyHeaders

定义Blob_deleteImmutabilityPolicy操作的标头。
BlobDeleteImmutabilityPolicyOptions

用于删除不可变性策略 <xref:BlobClient.deleteImmutabilityPolicy> 操作的选项。
BlobDeleteOptions

用于配置操作的选项 <xref:BlobClient.delete> 。
BlobDownloadHeaders

定义Blob_download操作的标头。
BlobDownloadOptionalParams

可选参数。
BlobDownloadOptions

用于配置操作的选项 <xref:BlobClient.download> 。
BlobDownloadResponseParsed

包含操作的 <xref:BlobClient.download> 响应数据。
BlobDownloadToBufferOptions

操作的选项接口 <xref:BlobClient.downloadToBuffer> 。
BlobExistsOptions

用于配置操作的选项 <xref:BlobClient.exists> 。
BlobFlatListSegment

表示 BlobFlatListSegment 的接口。
BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

用于配置 <xref:BlobClient.generateSasUrl> 操作的选项。
BlobGetPropertiesHeaders

定义Blob_getProperties操作的标头。
BlobGetPropertiesOptions

用于配置操作的选项 <xref:BlobClient.getProperties> 。
BlobGetPropertiesResponse

包含操作的 <xref:BlobClient.getProperties> 响应数据。
BlobGetTagsHeaders

定义Blob_getTags操作的标头。
BlobGetTagsOptions

用于配置操作的选项 <xref:BlobClient.getTags> 。
BlobHTTPHeaders

参数组
BlobHierarchyListSegment

表示 BlobHierarchyListSegment 的接口。
BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

描述 Blob 的不可变策略。
BlobItem

Azure 存储 Blob
BlobItemInternal

Azure 存储 Blob
BlobPrefix
BlobProperties

Blob 的属性
BlobQueryArrowConfiguration

使用 Apache 箭头格式查询 Blob 的选项。 仅对 <xref:BlockBlobQueryOptions.outputTextConfiguration>有效。
BlobQueryArrowField

描述 中的 <xref:BlobQueryArrowConfiguration>字段。
BlobQueryCsvTextConfiguration

使用 CSV 格式查询 Blob 的选项。
BlobQueryError

Blob 查询错误类型。
BlobQueryHeaders

定义Blob_query操作的标头。
BlobQueryJsonTextConfiguration

使用 JSON 格式查询 Blob 的选项。
BlobQueryParquetConfiguration

使用 Parquet 格式查询 Blob 的选项。 仅对 <xref:BlockBlobQueryOptions.inputTextConfiguration>有效。
BlobReleaseLeaseOptions

用于配置 Blob - 发布租约操作的选项。
BlobRenewLeaseOptions

用于配置 Blob - 续订租约操作的选项。
BlobRequestConditions

标准 HTTP 条件标头、标记条件和租用条件
BlobSASPermissionsLike

类似于 Blob SAS 权限的类型。 <xref:BlobSASPermissions>用于从原始对象分析 SAS 权限。
BlobSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。 BlobSASSignatureValues 用于帮助为容器或 Blob 生成 Blob 服务 SAS 令牌。
BlobServiceProperties

存储服务属性。
BlobServiceStatistics

存储服务的统计信息。
BlobSetHTTPHeadersHeaders

定义Blob_setHttpHeaders操作的标头。
BlobSetHTTPHeadersOptions

用于配置操作的选项 <xref:BlobClient.setHTTPHeaders> 。
BlobSetImmutabilityPolicyHeaders

定义Blob_setImmutabilityPolicy操作的标头。
BlobSetImmutabilityPolicyOptions

用于设置不可变性策略 <xref:BlobClient.setImmutabilityPolicy> 操作的选项。
BlobSetLegalHoldHeaders

定义Blob_setLegalHold操作的标头。
BlobSetLegalHoldOptions

用于设置法定保留 <xref:BlobClient.setLegalHold> 操作的选项。
BlobSetMetadataHeaders

定义Blob_setMetadata操作的标头。
BlobSetMetadataOptions

用于配置操作的选项 <xref:BlobClient.setMetadata> 。
BlobSetTagsHeaders

定义Blob_setTags操作的标头。
BlobSetTagsOptions

用于配置操作的选项 <xref:BlobClient.setTags> 。
BlobSetTierHeaders

定义Blob_setTier操作的标头。
BlobSetTierOptions

用于配置操作的选项 <xref:BlobClient.setAccessTier> 。
BlobStartCopyFromURLHeaders

定义Blob_startCopyFromURL操作的标头。
BlobStartCopyFromURLOptions

用于配置操作的选项 <xref:BlobClient.beginCopyFromURL> 。
BlobSyncCopyFromURLOptions

用于配置操作的选项 <xref:BlobClient.syncCopyFromURL> 。
BlobTag
BlobTags

Blob 标记
BlobUndeleteHeaders

定义Blob_undelete操作的标头。
BlobUndeleteOptions

用于配置操作的选项 <xref:BlobClient.undelete> 。
Block

表示块 Blob 中的单个块。 它描述了块的 ID 和大小。
BlockBlobCommitBlockListHeaders

定义BlockBlob_commitBlockList操作的标头。
BlockBlobCommitBlockListOptions

用于配置 <xref:BlockBlobClient.commitBlockList> 操作的选项。
BlockBlobGetBlockListHeaders

定义BlockBlob_getBlockList操作的标头。
BlockBlobGetBlockListOptions

用于配置 <xref:BlockBlobClient.getBlockList> 操作的选项。
BlockBlobParallelUploadOptions

和 <xref:BlockBlobClient.uploadSeekableStream>的选项<xref:BlockBlobClient.uploadFile>接口。
BlockBlobPutBlobFromUrlHeaders

定义BlockBlob_putBlobFromUrl操作的标头。
BlockBlobQueryOptions

用于配置 <xref:BlockBlobClient.query> 操作的选项。
BlockBlobStageBlockFromURLHeaders

定义BlockBlob_stageBlockFromURL操作的标头。
BlockBlobStageBlockFromURLOptions

用于配置 <xref:BlockBlobClient.stageBlockFromURL> 操作的选项。
BlockBlobStageBlockHeaders

定义BlockBlob_stageBlock操作的标头。
BlockBlobStageBlockOptions

用于配置 <xref:BlockBlobClient.stageBlock> 操作的选项。
BlockBlobSyncUploadFromURLOptions

用于配置 <xref:BlockBlobClient.syncUploadFromURL> 操作的选项。
BlockBlobUploadHeaders

定义BlockBlob_upload操作的标头。
BlockBlobUploadOptions

用于配置 <xref:BlockBlobClient.upload> 操作的选项。
BlockBlobUploadStreamOptions

操作的选项接口 <xref:BlockBlobClient.uploadStream> 。
BlockList
CommonGenerateSasUrlOptions

和 <xref:ContainerGenerateSasUrlOptions>的<xref:BlobGenerateSasUrlOptions>常见选项。
CommonOptions

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

用于配置容器 - 获取租约操作的选项。
ContainerBreakLeaseOptionalParams

可选参数。
ContainerBreakLeaseOptions

用于配置容器 - 中断租用操作的选项。
ContainerChangeLeaseOptions

用于配置容器 - 更改租约操作的选项。
ContainerCreateHeaders

定义Container_create操作的标头。
ContainerCreateIfNotExistsResponse

包含操作的 <xref:ContainerClient.createIfNotExists> 响应数据。
ContainerCreateOptions

用于配置 <xref:ContainerClient.create> 操作的选项。
ContainerDeleteBlobOptions

用于配置操作的选项 <xref:ContainerClient.deleteBlob> 。
ContainerDeleteHeaders

定义Container_delete操作的标头。
ContainerDeleteIfExistsResponse

包含操作的 <xref:ContainerClient.deleteIfExists> 响应数据。
ContainerDeleteMethodOptions

用于配置 <xref:ContainerClient.delete> 操作的选项。
ContainerEncryptionScope

参数组
ContainerExistsOptions

用于配置 <xref:ContainerClient.exists> 操作的选项。
ContainerGenerateSasUrlOptions

用于配置 <xref:ContainerClient.generateSasUrl> 操作的选项。
ContainerGetAccessPolicyHeaders

定义Container_getAccessPolicy操作的标头。
ContainerGetAccessPolicyOptions

用于配置 <xref:ContainerClient.getAccessPolicy> 操作的选项。
ContainerGetPropertiesHeaders

定义Container_getProperties操作的标头。
ContainerGetPropertiesOptions

用于配置 <xref:ContainerClient.getProperties> 操作的选项。
ContainerItem

Azure 存储容器
ContainerListBlobFlatSegmentHeaders

定义Container_listBlobFlatSegment操作的标头。
ContainerListBlobHierarchySegmentHeaders

定义Container_listBlobHierarchySegment操作的标头。
ContainerListBlobsOptions

用于配置容器 - 列出 Blob 操作的选项。 请参阅：

  • <xref:ContainerClient.listBlobsFlat>
  • <xref:ContainerClient.listBlobsByHierarchy>
ContainerProperties

容器的属性
ContainerReleaseLeaseOptions

用于配置容器 - 发布租约操作的选项。
ContainerRenameHeaders

定义Container_rename操作的标头。
ContainerRenewLeaseOptions

用于配置容器 - 续订租约操作的选项。
ContainerRequestConditions

容器要满足的条件。
ContainerSASPermissionsLike

类似于容器 SAS 权限的类型。 <xref:ContainerSASPermissions>用于从原始对象分析 SAS 权限。
ContainerSetAccessPolicyHeaders

定义Container_setAccessPolicy操作的标头。
ContainerSetAccessPolicyOptions

用于配置 <xref:ContainerClient.setAccessPolicy> 操作的选项。
ContainerSetMetadataHeaders

定义Container_setMetadata操作的标头。
ContainerSetMetadataOptions

用于配置 <xref:ContainerClient.setMetadata> 操作的选项。
ContainerUndeleteHeaders

定义Container_restore操作的标头。
CorsRule

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

参数组
FilterBlobItem

来自 的 Blob 信息 <xref:BlobServiceClient.findBlobsByTags>
FilterBlobItemModel

来自筛选器 Blob API 调用的 Blob 信息
FilterBlobSegment

操作的 <xref:BlobServiceClient.findBlobsByTags> 段响应。
FilterBlobSegmentModel

筛选器 Blob API 调用的结果
GeoReplication

Geo-Replication 辅助存储服务的信息
HttpAuthorization

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

特定租约的详细信息。
LeaseAccessConditions

参数组
LeaseOperationOptions

配置租用操作。
ListBlobsFlatSegmentResponse

Blob 枚举
ListBlobsFlatSegmentResponseModel

Blob 枚举
ListBlobsHierarchySegmentResponse

Blob 枚举
ListBlobsHierarchySegmentResponseModel

Blob 枚举
ListContainersSegmentResponse

容器的枚举
Logging

Azure Analytics 日志记录设置。
MatchConditions

指定基于 ETag 匹配的条件请求的 HTTP 选项。
Metadata

要与资源关联的名称/值对映射。
Metrics

Blob 按 API 分组的请求统计信息摘要（以小时或分钟聚合为单位）
ModificationConditions

根据修改时间指定条件请求的 HTTP 选项。
ModifiedAccessConditions

标准 HTTP 条件标头和标记条件。
ModifiedAccessConditionsModel

参数组
ObjectReplicationPolicy

包含对象复制策略 ID 和相应的 列表 <xref:ObjectReplicationRule>。 检索源 Blob 上的对象复制属性时，会使用此属性。 目标 Blob 的策略 ID 在各自的方法响应的 ObjectReplicationDestinationPolicyId 中设置， (例如 <xref:BlobProperties.ObjectReplicationDestinationPolicyId>。
ObjectReplicationRule

包含 Blob 的对象复制规则 ID 和 <xref:ObjectReplicationStatus> 。 下<xref:ObjectReplicationPolicy>可以<xref:ObjectReplicationRule>有多个 。
PageBlobClearPagesHeaders

定义PageBlob_clearPages操作的标头。
PageBlobClearPagesOptions

用于配置操作的选项 <xref:PageBlobClient.clearPages> 。
PageBlobCopyIncrementalHeaders

定义PageBlob_copyIncremental操作的标头。
PageBlobCreateHeaders

定义PageBlob_create操作的标头。
PageBlobCreateIfNotExistsOptions

用于配置操作的选项 <xref:PageBlobClient.createIfNotExists> 。
PageBlobCreateIfNotExistsResponse

包含操作的 <xref:PageBlobClient.createIfNotExists> 响应数据。
PageBlobCreateOptions

用于配置操作的选项 <xref:PageBlobClient.create> 。
PageBlobGetPageRangesDiffHeaders

定义PageBlob_getPageRangesDiff操作的标头。
PageBlobGetPageRangesDiffOptions

用于配置操作的选项 <xref:PageBlobClient.getRangesDiff> 。
PageBlobGetPageRangesDiffResponse

包含操作的 <xref:BlobClient.getPageRangesDiff> 响应数据。
PageBlobGetPageRangesHeaders

定义PageBlob_getPageRanges操作的标头。
PageBlobGetPageRangesOptions

用于配置操作的选项 <xref:PageBlobClient.getPageRanges> 。
PageBlobGetPageRangesResponse

包含操作的 <xref:BlobClient.getPageRanges> 响应数据。
PageBlobRequestConditions

要添加到此页 Blob 创建的条件。
PageBlobResizeHeaders

定义PageBlob_resize操作的标头。
PageBlobResizeOptions

用于配置 <xref:PageBlobClient.resize> 操作的选项。
PageBlobStartCopyIncrementalOptions

用于配置 <xref:PageBlobClient.startCopyIncremental> 操作的选项。
PageBlobUpdateSequenceNumberHeaders

定义PageBlob_updateSequenceNumber操作的标头。
PageBlobUpdateSequenceNumberOptions

用于配置 <xref:PageBlobClient.updateSequenceNumber> 操作的选项。
PageBlobUploadPagesFromURLHeaders

定义PageBlob_uploadPagesFromURL操作的标头。
PageBlobUploadPagesFromURLOptions

用于配置 <xref:PageBlobClient.uploadPagesFromURL> 操作的选项。
PageBlobUploadPagesHeaders

定义PageBlob_uploadPages操作的标头。
PageBlobUploadPagesOptions

用于配置操作的选项 <xref:PageBlobClient.uploadPages> 。
PageList

Blob 的页范围列表。
ParsedBatchResponse

包含每个子请求的响应的多部分/混合响应。
PipelineLike

包含 HTTP 请求策略的 <xref:Pipeline> 类的接口。 可以通过调用 <xref:newPipeline>创建默认管道。 或者，可以通过 Pipeline 的构造函数创建具有自己的策略的管道。 在实现自定义管道之前， <xref:newPipeline> 请参阅并提供的策略。
PipelineOptions

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

Blob 服务操作的范围。
RetentionPolicy

确定关联数据应保留多长时间的保留策略
SASQueryParametersOptions

用于构造 <xref:SASQueryParameters>的选项。
SasIPRange

SAS 的允许 IP 范围。
SequenceNumberAccessConditions

参数组
ServiceFilterBlobsHeaders

定义Service_filterBlobs操作的标头。
ServiceFindBlobByTagsOptions

用于配置操作的选项 <xref:BlobServiceClient.findBlobsByTags> 。
ServiceGenerateAccountSasUrlOptions

用于配置 <xref:BlobServiceClient.generateAccountSasUrl> 操作的选项。
ServiceGetAccountInfoHeaders

定义Service_getAccountInfo操作的标头。
ServiceGetAccountInfoOptions

用于配置操作的选项 <xref:BlobServiceClient.getAccountInfo> 。
ServiceGetPropertiesHeaders

定义Service_getProperties操作的标头。
ServiceGetPropertiesOptions

用于配置操作的选项 <xref:BlobServiceClient.getProperties> 。
ServiceGetStatisticsHeaders

定义Service_getStatistics操作的标头。
ServiceGetStatisticsOptions

用于配置操作的选项 <xref:BlobServiceClient.getStatistics> 。
ServiceGetUserDelegationKeyHeaders

定义Service_getUserDelegationKey操作的标头。
ServiceGetUserDelegationKeyOptions

用于配置服务的选项 - 获取用户委派密钥。
ServiceListContainersOptions

用于配置操作的选项 <xref:BlobServiceClient.listContainers> 。
ServiceListContainersSegmentHeaders

定义Service_listContainersSegment操作的标头。
ServiceRenameContainerOptions

用于配置 <xref:BlobServiceClient.renameContainer> 操作的选项。
ServiceSetPropertiesHeaders

定义Service_setProperties操作的标头。
ServiceSetPropertiesOptions

用于配置操作的选项 <xref:BlobServiceClient.setProperties> 。
ServiceSubmitBatchHeaders

定义Service_submitBatch操作的标头。
ServiceSubmitBatchOptionalParamsModel

可选参数。
ServiceUndeleteContainerOptions

用于配置 <xref:BlobServiceClient.undeleteContainer> 操作的选项。
SignedIdentifier

已签名的标识符。
SignedIdentifierModel

已签名标识符
StaticWebsite

使帐户能够托管静态网站的属性
StorageClientOptionalParams

可选参数。
StoragePipelineOptions

函数的选项接口 <xref:newPipeline> 。
StorageRetryOptions

存储 Blob 重试选项接口。
TagConditions

指定基于 Blob 标记的条件请求的 HTTP 选项。
UserDelegationKey

用户委派密钥。
UserDelegationKeyModel

用户委派密钥

类型别名

AccessTier

定义 AccessTier 的值。
AccountKind

定义 AccountKind 的值。
AppendBlobAppendBlockFromUrlResponse

包含 appendBlockFromUrl 操作的响应数据。
AppendBlobAppendBlockResponse

包含 appendBlock 操作的响应数据。
AppendBlobCreateResponse

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

定义 ArchiveStatus 的值。
BlobAbortCopyFromURLResponse

包含 abortCopyFromURL 操作的响应数据。
BlobBatchDeleteBlobsResponse

包含操作的 <xref:deleteBlobs> 响应数据。
BlobBatchSetBlobsAccessTierResponse

包含操作的 <xref:setBlobsAccessTier> 响应数据。
BlobBatchSubmitBatchResponse

包含 Blob 批处理操作的响应数据。
BlobCopyFromURLResponse

包含 copyFromURL 操作的响应数据。
BlobCreateSnapshotResponse

包含 createSnapshot 操作的响应数据。
BlobDeleteImmutabilityPolicyResponse

包含 deleteImmutabilityPolicy 操作的响应数据。
BlobDeleteResponse

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

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

包含 getProperties 操作的响应数据。
BlobGetTagsResponse

包含操作的 <xref:BlobClient.getTags> 响应数据。
BlobImmutabilityPolicyMode

定义 BlobImmutabilityPolicyMode 的值。
BlobQueryArrowFieldType

<xref:BlobQueryArrowField>的类型。
BlobQueryResponseModel

包含查询操作的响应数据。
BlobSetHTTPHeadersResponse

包含 setHttpHeaders 操作的响应数据。
BlobSetImmutabilityPolicyResponse

包含 setImmutabilityPolicy 操作的响应数据。
BlobSetLegalHoldResponse

包含 setLegalHold 操作的响应数据。
BlobSetMetadataResponse

包含 setMetadata 操作的响应数据。
BlobSetTagsResponse

包含 setTags 操作的响应数据。
BlobSetTierResponse

包含 setTier 操作的响应数据。
BlobStartCopyFromURLResponse

包含 startCopyFromURL 操作的响应数据。
BlobType

定义 BlobType 的值。
BlobUndeleteResponse

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

、 <xref:BlockBlobClient.uploadStream>和 <xref:BlockBlobClient.uploadBrowserDate>的<xref:BlockBlobClient.uploadFile>响应类型。
BlockBlobCommitBlockListResponse

包含 commitBlockList 操作的响应数据。
BlockBlobGetBlockListResponse

包含 getBlockList 操作的响应数据。
BlockBlobPutBlobFromUrlResponse

包含 putBlobFromUrl 操作的响应数据。
BlockBlobStageBlockFromURLResponse

包含 stageBlockFromURL 操作的响应数据。
BlockBlobStageBlockResponse

包含 stageBlock 操作的响应数据。
BlockBlobUploadResponse

包含上传操作的响应数据。
BlockListType

定义 BlockListType 的值。
ContainerCreateResponse

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

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

包含操作的 <xref:ContainerClient.getAccessPolicy> 响应数据。
ContainerGetPropertiesResponse

包含 getProperties 操作的响应数据。
ContainerListBlobFlatSegmentResponse

包含 listBlobFlatSegment 操作的响应数据。
ContainerListBlobHierarchySegmentResponse

包含 listBlobHierarchySegment 操作的响应数据。
ContainerRenameResponse

包含重命名操作的响应数据。
ContainerSetAccessPolicyResponse

包含 setAccessPolicy 操作的响应数据。
ContainerSetMetadataResponse

包含 setMetadata 操作的响应数据。
ContainerUndeleteResponse

包含还原操作的响应数据。
CopyPollerBlobClient

定义 返回 <xref:BlobClient> 的轮询器 <xref:BlobClient.beginCopyFromURL> 正常工作所需的 操作。
CopyStatusType

定义 CopyStatusType 的值。
CredentialPolicyCreator

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

定义 DeleteSnapshotsOptionType 的值。
EncryptionAlgorithmType

定义 EncryptionAlgorithmType 的值。
GeoReplicationStatusType

定义 GeoReplicationStatusType 的值。
LeaseDurationType

定义 LeaseDurationType 的值。
LeaseOperationResponse

包含创建、修改或删除租约的操作的响应数据。 请参阅 <xref:BlobLeaseClient>。
LeaseStateType

定义 LeaseStateType 的值。
LeaseStatusType

定义 LeaseStatusType 的值。
ListBlobsIncludeItem

定义 ListBlobsIncludeItem 的值。
ListContainersIncludeType

定义 ListContainersIncludeType 的值。
ObjectReplicationStatus

指定 Blob 的复制状态。 当存储帐户应用了对象复制策略 () 时，使用此方法。 请参见 <xref:ObjectReplicationPolicy> 和 <xref:ObjectReplicationRule>。
PageBlobClearPagesResponse

包含 clearPages 操作的响应数据。
PageBlobCopyIncrementalResponse

包含 copyIncremental 操作的响应数据。
PageBlobCreateResponse

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

包含调整大小操作的响应数据。
PageBlobUpdateSequenceNumberResponse

包含 updateSequenceNumber 操作的响应数据。
PageBlobUploadPagesFromURLResponse

包含 uploadPagesFromURL 操作的响应数据。
PageBlobUploadPagesResponse

包含 uploadPages 操作的响应数据。
PublicAccessType

定义 PublicAccessType 的值。
RehydratePriority

定义 RehydratePriority 的值。
SequenceNumberActionType

定义 SequenceNumberActionType 的值。
ServiceFindBlobsByTagsSegmentResponse

操作的 <xref:BlobServiceClient.findBlobsByTags> 响应。
ServiceGetAccountInfoResponse

包含 getAccountInfo 操作的响应数据。
ServiceGetPropertiesResponse

包含 getProperties 操作的响应数据。
ServiceGetStatisticsResponse

包含 getStatistics 操作的响应数据。
ServiceGetUserDelegationKeyResponse

包含操作的 <xref:getUserDelegationKey> 响应数据。
ServiceListContainersSegmentResponse

包含 listContainersSegment 操作的响应数据。
ServiceSetPropertiesResponse

包含 setProperties 操作的响应数据。
ServiceSubmitBatchResponseModel

包含 submitBatch 操作的响应数据。
SkuName

定义 SkuName 的值。
SyncCopyStatusType

定义 SyncCopyStatusType 的值。
Tags

Blob 标记。

枚举

BlockBlobTier

表示 Blob 上的访问层。 有关块 Blob 级别分层的详细信息 ，请参阅热、冷和存档存储层。
PremiumPageBlobTier

指定要将 Blob 设置为的页 Blob 层。 这仅适用于高级存储帐户上的页 Blob。 有关每个 PageBlobTier 的相应 IOPS 和吞吐量的详细信息，请参阅 此处 。
SASProtocol

生成的 SAS 的协议。
StorageRetryPolicyType

RetryPolicy 类型。

函数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。 生成一个 <xref:SASQueryParameters> 对象，其中包含发出实际 REST 请求所需的所有 SAS 查询参数。
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。

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

警告：如果未提供标识符，则需要权限和 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();
isPipelineLike(unknown)

用于确定给定参数是否满足管道协定的帮助程序
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

函数详细信息

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。 生成一个 <xref:SASQueryParameters> 对象，其中包含发出实际 REST 请求所需的所有 SAS 查询参数。

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

参数

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。

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

警告：如果未提供标识符，则需要权限和 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)

参数

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)

参数

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

的返回值 blobServiceClient.getUserDelegationKey()

accountName

string

返回

SASQueryParameters

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown)

参数

pipeline

unknown

可能是管道的参数

返回

boolean

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

参数

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

可选。 选项。

返回

Pipeline

一个新的 Pipeline 对象。