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

@azure/storage-queue 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 提供用于创建 <xref:CredentialPolicyCreator> 对象的 <xref:AnonymousCredentialPolicy> 成员。 <xref:AnonymousCredentialPolicy> 与 HTTP(S) 请求一起使用,这些请求读取公共资源或用于共享访问签名(SAS)。

AnonymousCredentialPolicy

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

Credential

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

CredentialPolicy

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

Pipeline

包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline()创建默认管道。 或者,可以通过管道构造函数创建自己的策略的管道。 在实现自定义管道之前,请参阅 newPipeline()并提供的策略作为参考。

QueueClient

QueueClient 表示 Azure 存储队列消息的 URL,允许你作其消息。

QueueSASPermissions

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

QueueServiceClient

QueueServiceClient 表示 Azure 存储队列服务的 URL,允许你作队列。

SASQueryParameters

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

StorageBrowserPolicy

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

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

  2. 删除 Cookie 标头以安全

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

StorageBrowserPolicyFactory

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

StorageClient

StorageClient 表示 <xref:QueueServiceClient>、<xref:QueueClient> 等的基于客户端类。

StorageClientContext
StorageRetryPolicy

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

StorageRetryPolicyFactory

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

StorageSharedKeyCredential

仅在NODE.JS运行时中可用。 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。

StorageSharedKeyCredentialPolicy

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

接口

AccessPolicy

访问策略

AccountSASSignatureValues

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

CommonOptions

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

CorsRule

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

DequeuedMessageItem

在队列上调用“获取消息”时,QueueMessageList 数组中返回的对象。

EnqueuedMessage

在队列上调用 Put Message 时在 QueueMessageList 数组中返回的对象

GeoReplication

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

ListQueuesSegmentResponse

在队列服务上调用列表队列时返回的对象。

Logging

Azure Analytics 日志记录设置。

MessageIdDeleteHeaders

定义MessageId_delete作的标头。

MessageIdUpdateHeaders

定义MessageId_update作的标头。

MessagesClearHeaders

定义Messages_clear作的标头。

MessagesDequeueHeaders

定义Messages_dequeue作的标头。

MessagesDequeueOptionalParams

可选参数。

MessagesEnqueueHeaders

定义Messages_enqueue作的标头。

MessagesEnqueueOptionalParams

可选参数。

MessagesPeekHeaders

定义Messages_peek作的标头。

MessagesPeekOptionalParams

可选参数。

Metadata

键值字符串对的集合。

Metrics

表示指标的接口。

PeekedMessageItem

在队列上调用速览消息时,QueueMessageList 数组中返回的对象

PipelineOptions

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

QueueClearMessagesOptions

配置 <xref:QueueClient.clearMessages>作的选项

QueueCreateHeaders

定义Queue_create作的标头。

QueueCreateIfNotExistsResponse

包含 <xref:QueueClient.createIfNotExists>作的响应数据。

QueueCreateOptions

配置 <xref:QueueClient.create>作的选项

QueueDeleteHeaders

定义Queue_delete作的标头。

QueueDeleteIfExistsResponse

包含 <xref:QueueClient.deleteIfExists>作的响应数据。

QueueDeleteMessageOptions

配置 <xref:QueueClient.deleteMessage>作的选项

QueueDeleteOptions

配置 <xref:QueueClient.delete>作的选项

QueueExistsOptions

配置 <xref:QueueClient.exists>作的选项

QueueGenerateSasUrlOptions

用于配置 <xref:QueueClient.generateSasUrl>作的选项。

QueueGetAccessPolicyHeaders

定义Queue_getAccessPolicy作的标头。

QueueGetAccessPolicyOptions

配置 <xref:QueueClient.getAccessPolicy>作的选项

QueueGetPropertiesHeaders

定义Queue_getProperties作的标头。

QueueGetPropertiesOptions

配置 <xref:QueueClient.getProperties>作的选项

QueueItem

Azure 存储队列。

QueuePeekMessagesOptions

配置 <xref:QueueClient.peekMessages>作的选项

QueueReceiveMessageOptions

配置 <xref:QueueClient.receiveMessages>作的选项

QueueSASSignatureValues

仅在NODE.JS运行时中可用。 QueueSASSignatureValues 用于帮助为队列生成队列服务 SAS 令牌。

QueueSendMessageOptions

配置 <xref:QueueClient.sendMessage>作的选项

QueueServiceProperties

存储服务属性。

QueueServiceStatistics

存储服务的统计信息。

QueueSetAccessPolicyHeaders

定义Queue_setAccessPolicy作的标头。

QueueSetAccessPolicyOptions

配置 <xref:QueueClient.setAccessPolicy>作的选项

QueueSetMetadataHeaders

定义Queue_setMetadata作的标头。

QueueSetMetadataOptions

配置 <xref:QueueClient.setMetadata>作的选项

QueueUpdateMessageOptions

配置 <xref:QueueClient.updateMessage>作的选项

RetentionPolicy

保留策略

SasIPRange

SAS 允许的 IP 范围。

ServiceGenerateAccountSasUrlOptions

用于配置 <xref:QueueServiceClient.generateAccountSasUrl>作的选项。

ServiceGetPropertiesHeaders

定义Service_getProperties作的标头。

ServiceGetPropertiesOptions

配置 <xref:QueueServiceClient.getProperties>作的选项

ServiceGetStatisticsHeaders

定义Service_getStatistics作的标头。

ServiceGetStatisticsOptions

配置 <xref:QueueServiceClient.getStatistics>作的选项

ServiceListQueuesOptions

配置 <xref:QueueServiceClient.listQueues>作的选项

ServiceListQueuesSegmentHeaders

定义Service_listQueuesSegment作的标头。

ServiceSetPropertiesHeaders

定义Service_setProperties作的标头。

ServiceSetPropertiesOptions

配置 <xref:QueueServiceClient.setProperties>作的选项

SignedIdentifier

已签名的标识符。

SignedIdentifierModel

已签名标识符

StorageClientOptionalParams

可选参数。

StoragePipelineOptions

newPipeline() 方法的选项接口。

StorageRetryOptions

存储队列重试选项接口。

类型别名

CredentialPolicyCreator

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

GeoReplicationStatusType

定义 GeoReplicationStatusType 的值。

ListQueuesIncludeType

定义 ListQueuesIncludeType 的值。 可能的值包括:“metadata”

MessageIdDeleteResponse

包含删除作的响应数据。

MessageIdUpdateResponse

包含更新作的响应数据。

MessagesClearResponse

包含清除作的响应数据。

QueueClearMessagesResponse

包含 <xref:QueueClient.clearMessages>作的响应数据。

QueueCreateResponse

包含创建作的响应数据。

QueueDeleteMessageResponse

包含 <xref:QueueClient.deleteMessage>作的响应数据。

QueueDeleteResponse

包含删除作的响应数据。

QueueGetAccessPolicyResponse

包含 <xref:QueueClient.getAccessPolicy>作的响应数据。

QueueGetPropertiesResponse

包含 getProperties作的响应数据。

QueuePeekMessagesResponse

包含 <xref:QueueClient.peekMessages>作的响应数据。

QueueReceiveMessageResponse

包含 <xref:QueueClient.receiveMessages>作的响应数据。

QueueSendMessageResponse

包含 <xref:QueueClient.sendMessage>作的响应数据。

QueueSetAccessPolicyResponse

包含 setAccessPolicy作的响应数据。

QueueSetMetadataResponse

包含 setMetadata作的响应数据。

QueueUpdateMessageResponse

包含 <xref:QueueClient.updateMessage>作的响应数据。

ReceivedMessageItem

调用 receivedMessageItems时在 <xref:QueueClient.receiveMessages> 数组中返回的对象。 请参阅:<xref:QueueReceiveMessageResponse>

ServiceGetPropertiesResponse

包含 getProperties作的响应数据。

ServiceGetStatisticsResponse

包含 getStatistics作的响应数据。

ServiceListQueuesSegmentResponse

包含 listQueuesSegment作的响应数据。

ServiceSetPropertiesResponse

包含 setProperties作的响应数据。

枚举

SASProtocol

生成的 SAS 的协议。

StorageRetryPolicyType

RetryPolicy 类型。

函数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。

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

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

函数详细信息

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

参数

accountSASSignatureValues
AccountSASSignatureValues

帐户的 SAS 签名值

sharedKeyCredential
StorageSharedKeyCredential

共享密钥凭据。

返回

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。

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

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

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

参数

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

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