你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/storage-blob package
类
AccountSASPermissions |
仅在NODE.JS运行时中可用。 这是一个帮助程序类,用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后,应使用 toString 序列化此值,并将其设置为 <xref:AccountSASSignatureValues> 对象的权限字段。 可以构造不带此类的权限字符串,但权限的顺序是特定的,此类保证正确性。 |
AccountSASResourceTypes |
仅在NODE.JS运行时中可用。 这是一个帮助程序类,用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后,应使用 toString 序列化此值,并将其设置为 <xref:AccountSASSignatureValues> 对象上的资源字段。 可以构造没有此类的资源字符串,但资源的顺序是特定的,此类保证正确性。 |
AccountSASServices |
仅在NODE.JS运行时中可用。 这是一个帮助程序类,用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后,应使用 toString 序列化此值,并将其设置为 <xref:AccountSASSignatureValues> 对象上的服务字段。 可以构造没有此类的服务字符串,但服务的顺序是特定的,此类保证正确性。 |
AnonymousCredential |
AnonymousCredential 提供 credentialPolicyCreator 成员,用于创建 AnonymousCredentialPolicy 对象。 AnonymousCredentialPolicy 与 HTTP(S) 请求一起使用,这些请求读取公共资源或用于共享访问签名(SAS)。 |
AnonymousCredentialPolicy |
AnonymousCredentialPolicy 与 HTTP(S) 请求一起使用,这些请求读取公共资源或用于共享访问签名(SAS)。 |
AppendBlobClient |
AppendBlobClient 定义一组适用于追加 blob 的作。 |
BlobBatch |
BlobBatch 表示对 Blob 的聚合作集。
目前仅支持 |
BlobBatchClient |
BlobBatchClient 允许向 Azure 存储 Blob 服务发出批处理请求。 |
BlobClient |
BlobClient 表示 Azure 存储 Blob 的 URL;blob 可以是块 blob、追加 Blob 或页 Blob。 |
BlobLeaseClient |
管理 <xref:ContainerClient> 或 <xref:BlobClient>租约的客户端。 |
BlobSASPermissions |
仅在NODE.JS运行时中可用。 这是一个帮助程序类,用于构造表示 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 |
凭据是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。 |
CredentialPolicy |
用于在发送之前对 HTTP(S) 请求进行签名的凭据策略。 这是一个抽象类。 |
PageBlobClient |
PageBlobClient 定义一组适用于页 Blob 的作。 |
Pipeline |
包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 <xref:newPipeline>来创建默认管道。 或者,可以通过管道构造函数创建自己的策略的管道。 在实现自定义管道之前,请参阅 <xref:newPipeline> 和提供的策略。 |
SASQueryParameters |
表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 <xref:AccountSASSignatureValues> 和 <xref:BlobSASSignatureValues> 类型生成。 生成后,可以将其编码为 <xref:String> 并直接追加到 URL(不过,如果存在现有的查询参数,这可能会影响追加这些查询参数的适当方式),应谨慎使用。 注意:此类的实例是不可变的。 |
StorageBrowserPolicy |
StorageBrowserPolicy 将处理 Node.js 和浏览器运行时之间的差异,包括:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory 是帮助生成 StorageBrowserPolicy 对象的工厂类。 |
StorageClient |
StorageClient 表示 <xref:BlobServiceClient>、<xref:ContainerClient> 等的基于 URL 类。 |
StorageClientContext | |
StorageRetryPolicy |
实现指数重试和线性重试的重试策略。 |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory 是一个工厂类,可帮助生成 <xref:StorageRetryPolicy> 对象。 |
StorageSharedKeyCredential |
仅在NODE.JS运行时中可用。 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。 |
StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy 是用于使用共享密钥对 HTTP 请求进行签名的策略。 |
接口
AccessPolicy |
访问策略 |
AccountSASPermissionsLike |
类似于帐户 SAS 权限的类型。 用于 <xref:AccountSASPermissions> 分析原始对象的 SAS 权限。 |
AccountSASSignatureValues |
仅在NODE.JS运行时中可用。 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>返回的状态。
每当检测到复制进度时,此状态将传递到用户指定的 |
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 Arrow 格式查询 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运行时中可用。 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.uploadFile> 和 <xref:BlockBlobClient.uploadSeekableStream>的选项接口。 |
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:BlobGenerateSasUrlOptions> 和 <xref:ContainerGenerateSasUrlOptions>的常见选项。 |
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作。 看:
|
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 |
来自 <xref:BlobServiceClient.findBlobsByTags> 的 Blob 信息 |
FilterBlobItemModel |
筛选器 Blob API 调用中的 Blob 信息 |
FilterBlobSegment |
<xref:BlobServiceClient.findBlobsByTags>作的分段响应。 |
FilterBlobSegmentModel |
筛选器 Blob API 调用的结果 |
GeoReplication |
辅助存储服务的 Geo-Replication 信息 |
HttpAuthorization |
表示 Authorization、ProxyAuthorization、WWW-Authenticate 和 Proxy-Authenticate 标头值中的身份验证信息。 |
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 和 <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>来创建默认管道。 或者,可以通过管道构造函数创建自己的策略的管道。 在实现自定义管道之前,请参阅 <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.uploadFile>、<xref:BlockBlobClient.uploadStream>和 <xref:BlockBlobClient.uploadBrowserDate>的响应类型。 |
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.beginCopyFromURL> 返回的轮询程序正常工作所需的 <xref:BlobClient> 的作。 |
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 类型。 |
函数
generate |
仅在NODE.JS运行时中可用。 生成一个 <xref:SASQueryParameters> 对象,该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。 |
generate |
仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。 仅接受创建 SAS 所需的设置。 对于可选设置,请直接设置相应的属性,例如权限、startsOn 和标识符。 警告:如果未提供标识符,则需要权限和 expiresOn。 如果最初使用此构造函数,则必须将值分配给标识符或 expiresOn & 权限。 在运行以下代码片段之前填写所需的详细信息。 示例用法:
使用标识符的示例:
使用 Blob 名称的示例:
|
generate |
仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。 警告:生成用户委派 SAS、权限和 expiresOn 时,将忽略标识符。 示例用法:
|
is |
确定给定参数是否满足管道协定的帮助程序 |
new |
使用提供的凭据创建新的 Pipeline 对象。 |
函数详细信息
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
仅在NODE.JS运行时中可用。 生成一个 <xref:SASQueryParameters> 对象,该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
参数
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
返回
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。
仅接受创建 SAS 所需的设置。 对于可选设置,请直接设置相应的属性,例如权限、startsOn 和标识符。
警告:如果未提供标识符,则需要权限和 expiresOn。 如果最初使用此构造函数,则必须将值分配给标识符或 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
返回
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
仅在NODE.JS运行时中可用。 创建 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
返回
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 对象。