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

@azure/storage-queue package

AccountSASPermissions

仅在 NODE.JS RUNTIME 中可用。

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

AccountSASResourceTypes

仅在 NODE.JS RUNTIME 中可用。

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

AccountSASServices

仅在 NODE.JS RUNTIME 中可用。

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

AnonymousCredential

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

AnonymousCredentialPolicy

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

BaseRequestPolicy

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

Credential

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

CredentialPolicy

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

Pipeline

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

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

QueueClient

QueueClient 表示 Azure 存储队列的消息的 URL,可用于操作其消息。

QueueSASPermissions

仅在 NODE.JS RUNTIME 中可用。

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

QueueServiceClient

QueueServiceClient 表示用于操作队列的 Azure 存储队列服务的 URL。

RestError

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

SASQueryParameters

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

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

StorageBrowserPolicy

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

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

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

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

StorageBrowserPolicyFactory

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

StorageRetryPolicy

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

StorageRetryPolicyFactory

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

StorageSharedKeyCredential

仅在 NODE.JS RUNTIME 中可用。

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

StorageSharedKeyCredentialPolicy

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

接口

AccessPolicy

访问策略

AccountSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。

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

CommonOptions

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

CorsRule

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

DequeuedMessageItem

对队列调用 Get Messages 时,QueueMessageList 数组中返回的对象。

EnqueuedMessage

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

GeoReplication

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

HttpHeaders

HTTP 标头键/值对的集合。

HttpOperationResponse

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

HttpResponse

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

IHttpClient

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

ListQueuesSegmentResponse

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

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 数组中返回的对象

PipelineLike

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

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

PipelineOptions

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

QueueClearMessagesOptions

用于配置 clearMessages 操作的选项

QueueCreateHeaders

定义Queue_create操作的标头。

QueueCreateIfNotExistsResponse

包含 createIfNotExists 操作的响应数据。

QueueCreateOptions

用于配置 创建 操作的选项

QueueDeleteHeaders

定义Queue_delete操作的标头。

QueueDeleteIfExistsResponse

包含 deleteIfExists 操作的响应数据。

QueueDeleteMessageOptions

用于配置 deleteMessage 操作的选项

QueueDeleteOptions

用于配置 删除 操作的选项

QueueExistsOptions

用于配置 存在 操作的选项

QueueGenerateSasUrlOptions

用于配置 generateSasUrl 操作的选项。

QueueGetAccessPolicyHeaders

定义Queue_getAccessPolicy操作的标头。

QueueGetAccessPolicyOptions

用于配置 getAccessPolicy 操作的选项

QueueGetPropertiesHeaders

定义Queue_getProperties操作的标头。

QueueGetPropertiesOptions

用于配置 getProperties 操作的选项

QueueItem

Azure 存储队列。

QueuePeekMessagesOptions

用于配置 peekMessages 操作的选项

QueueReceiveMessageOptions

用于配置 receiveMessages 操作的选项

QueueSASSignatureValues

仅在 NODE.JS RUNTIME 中可用。

QueueSASSignatureValues 用于帮助生成队列的队列服务 SAS 令牌。

QueueSendMessageOptions

用于配置 sendMessage 操作的选项

QueueServiceProperties

存储服务属性。

QueueServiceStatistics

存储服务的统计信息。

QueueSetAccessPolicyHeaders

定义Queue_setAccessPolicy操作的标头。

QueueSetAccessPolicyOptions

用于配置 setAccessPolicy 操作的选项

QueueSetMetadataHeaders

定义Queue_setMetadata操作的标头。

QueueSetMetadataOptions

用于配置 setMetadata 操作的选项

QueueUpdateMessageOptions

用于配置 updateMessage 操作的选项

RequestPolicyFactory

与 core-http 的 RequestPolicyFactory 兼容的接口

RequestPolicyOptions

用于与 RequestPolicy 兼容的接口

ResponseLike

具有简单_response属性的对象。

ResponseWithBody

具有_response属性的对象,该属性的正文和标头已分析为已知类型。

ResponseWithHeaders

具有 _response 属性的对象,该属性的标头已分析为类型化对象。

RetentionPolicy

保留策略

SasIPRange

SAS 的允许 IP 范围。

ServiceClientOptions

ServiceClientOptions 的 @azure/core-http 子集

ServiceGenerateAccountSasUrlOptions

用于配置 generateAccountSasUrl 操作的选项。

ServiceGetPropertiesHeaders

定义Service_getProperties操作的标头。

ServiceGetPropertiesOptions

用于配置 getProperties 操作的选项

ServiceGetStatisticsHeaders

定义Service_getStatistics操作的标头。

ServiceGetStatisticsOptions

用于配置 getStatistics 操作的选项

ServiceListQueuesOptions

用于配置 listQueues 操作的选项

ServiceListQueuesSegmentHeaders

定义Service_listQueuesSegment操作的标头。

ServiceSetPropertiesHeaders

定义Service_setProperties操作的标头。

ServiceSetPropertiesOptions

用于配置 setProperties 操作的选项

SignedIdentifier

已签名的标识符。

SignedIdentifierModel

已签名标识符

StoragePipelineOptions

newPipeline 函数的选项接口。

StorageRetryOptions

存储 Blob 重试选项接口。

WebResource

要向远程服务器发出的 HTTP 请求的说明。

类型别名

CredentialPolicyCreator

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

GeoReplicationStatusType

定义 GeoReplicationStatusType 的值。

HttpRequestBody

请求支持的正文类型。 NodeJS.ReadableStream 和 () => NodeJS.ReadableStream 仅限 Node。 Blob、ReadableStream 和 () => ReadableStream 仅限浏览器。

ListQueuesIncludeType

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

MessageIdDeleteResponse

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

MessageIdUpdateResponse

包含更新操作的响应数据。

MessagesClearResponse

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

QueueClearMessagesResponse

包含 clearMessages 操作的响应数据。

QueueCreateResponse

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

QueueDeleteMessageResponse

包含 deleteMessage 操作的响应数据。

QueueDeleteResponse

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

QueueGetAccessPolicyResponse

包含 getAccessPolicy 操作的响应数据。

QueueGetPropertiesResponse

包含 getProperties 操作的响应数据。

QueuePeekMessagesResponse

包含 peekMessages 操作的响应数据。

QueueReceiveMessageResponse

包含 receiveMessages 操作的响应数据。

QueueSendMessageResponse

包含 sendMessage 操作的响应数据。

QueueSetAccessPolicyResponse

包含 setAccessPolicy 操作的响应数据。

QueueSetMetadataResponse

包含 setMetadata 操作的响应数据。

QueueUpdateMessageResponse

包含 updateMessage 操作的响应数据。

ReceivedMessageItem

调用 receiveMessages 时在receivedMessageItems数组中返回的对象。

请参阅: QueueReceiveMessageResponse

ServiceGetPropertiesResponse

包含 getProperties 操作的响应数据。

ServiceGetStatisticsResponse

包含 getStatistics 操作的响应数据。

ServiceListQueuesSegmentResponse

包含 listQueuesSegment 操作的响应数据。

ServiceSetPropertiesResponse

包含 setProperties 操作的响应数据。

WithResponse

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

枚举

SASProtocol

生成的 SAS 的协议。

StorageQueueAudience

定义存储的已知云受众。

StorageRetryPolicyType

RetryPolicy 类型。

函数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

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

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

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

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

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

getQueueServiceAccountAudience(string)

获取队列服务的存储帐户的 OAuth 受众。

isPipelineLike(unknown)

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

函数详细信息

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

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

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

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

参数

accountSASSignatureValues
AccountSASSignatureValues

帐户的 SAS 签名值

sharedKeyCredential
StorageSharedKeyCredential

共享密钥凭据。

返回

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

仅在 NODE.JS RUNTIME 中可用。

创建 SASQueryParameters 的实例。

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

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

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

参数

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

getQueueServiceAccountAudience(string)

获取队列服务的存储帐户的 OAuth 受众。

function getQueueServiceAccountAudience(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 对象。