QueueClient class

创建 QueueClient 的实例。

new QueueClient(url: string, pipeline: Pipeline)

参数

创建 QueueClient 的实例。

new QueueClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

参数

创建 QueueClient 的实例。

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions)

参数

队列的名称。

string name

属性值

accountName: string

属性值

继承自 StorageClient.accountName

URL 字符串值。

url: string

属性值

继承自 StorageClient.url

清除从队列中删除所有消息。

请参见https://free.blessedness.top/rest/api/storageservices/clear-messages

function clearMessages(options?: QueueClearMessagesOptions): Promise<MessagesClearResponse>

参数

返回

清除消息操作的响应数据。

在指定的帐户下创建新队列。

请参见https://free.blessedness.top/rest/api/storageservices/create-queue4

function create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

参数

返回

队列创建操作的响应数据。

示例用法：

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

如果指定的帐户尚不存在，则创建一个新队列。 如果队列已存在，则不会更改。

请参见https://free.blessedness.top/rest/api/storageservices/create-queue4

function createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>

参数

返回

永久删除指定的队列。

请参见https://free.blessedness.top/rest/api/storageservices/delete-queue3

function delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

参数

返回

队列删除操作的响应数据。

示例用法：

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const deleteQueueResponse = await queueClient.delete();
console.log(
  `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
);

如果指定队列存在，则永久删除该队列。

请参见https://free.blessedness.top/rest/api/storageservices/delete-queue3

function deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>

参数

返回

deleteMessage 永久删除其队列中的指定消息。

请参见https://free.blessedness.top/rest/api/storageservices/delete-message2

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<MessageIdDeleteResponse>

参数

返回

删除消息操作的响应数据。

如果指定的队列存在，则返回 true;否则为 false。

注意：请谨慎使用此函数，因为现有队列可能被其他客户端或应用程序删除。 反之亦然，此函数完成后，其他客户端或应用程序可能会添加新队列。

function exists(options?: QueueExistsOptions): Promise<boolean>

参数

返回

仅适用于使用共享密钥凭据构造的 QueueClient。

根据传入的客户端属性和参数，生成用于为服务共享访问签名 （SAS） URI 签名的字符串。 SAS 由客户端的共享密钥凭据签名。

请参见https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

参数

返回

由此客户端表示的资源的 URI 组成的 SAS URI，后跟生成的 SAS 令牌。

仅适用于使用共享密钥凭据构造的 QueueClient。

基于传入的客户端属性和参数生成服务共享访问签名 （SAS） URI。 SAS 由客户端的共享密钥凭据签名。

请参见https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

参数

返回

由此客户端表示的资源的 URI 组成的 SAS URI，后跟生成的 SAS 令牌。

获取有关可用于共享访问签名的队列上指定的任何存储访问策略的详细信息。

警告：分析起始字符串和过期字符串时，JavaScript 日期可能会丢失精度。 例如，新日期（“2018-12-31T03：44：23.8827891Z”）将获取“2018-12-31T03：44：23.882Z”。

请参见https://free.blessedness.top/rest/api/storageservices/get-queue-acl

function getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

参数

返回

队列的响应数据获取访问策略操作。

获取指定队列的所有用户定义的元数据和系统属性。 元数据与队列关联为名称值对。

请参见https://free.blessedness.top/rest/api/storageservices/get-queue-metadata

警告：响应中返回的 metadata 对象将具有小写形式的键，即使它们最初包含大写字符也是如此。 这不同于使用 listQueues 选项 QueueServiceClientincludeMetadata 方法返回的元数据键，该方法将保留其原始大小写。

function getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

参数

返回

队列获取属性操作的响应数据。

peekMessages 从队列前面检索一个或多个消息，但不改变消息的可见性。

请参见https://free.blessedness.top/rest/api/storageservices/peek-messages

function peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

参数

返回

速览消息操作的响应数据。

示例用法：

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const peekMessagesResponse = await queueClient.peekMessages();
console.log(`The peeked message is: ${peekMessagesResponse.peekedMessageItems[0].messageText}`);

receiveMessages 从队列前面检索一个或多个消息。

请参见https://free.blessedness.top/rest/api/storageservices/get-messages

function receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

参数

返回

接收消息操作的响应数据。

示例用法：

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length === 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log(`Processing & deleting message with content: ${receivedMessageItem.messageText}`);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt,
  );
  console.log(
    `Delete message successfully, service assigned request Id: ${deleteMessageResponse.requestId}`,
  );
}

sendMessage 将新消息添加到队列的后面。 可见性超时指定消息对 Dequeue 和 Peek 操作不可见的时间。 消息内容的大小最大为 64KB，并且必须采用可以包含在采用 UTF-8 编码的 XML 请求中的格式。 若要在消息中包含标记，消息的内容必须是 XML 转义或 Base64 编码。

请参见https://free.blessedness.top/rest/api/storageservices/put-message

function sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

参数

返回

发送消息操作的响应数据。

示例用法：

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
// Send a message into the queue using the sendMessage method.
const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`,
);

设置可用于共享访问签名的队列的存储访问策略。

请参见https://free.blessedness.top/rest/api/storageservices/set-queue-acl

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

参数

返回

队列集访问策略操作的响应数据。

为指定的队列设置一个或多个用户定义的名称值对。

如果未提供任何选项，或者未在选项参数中定义元数据，则会删除队列元数据。

请参见https://free.blessedness.top/rest/api/storageservices/set-queue-metadata

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

参数

返回

队列集元数据操作的响应数据。

更新消息的可见性超时和内容更改。 消息内容的大小最大为 64KB，并且必须采用可以包含在采用 UTF-8 编码的 XML 请求中的格式。 若要在消息中包含标记，消息的内容必须是 XML 转义或 Base64 编码。

请参见https://free.blessedness.top/rest/api/storageservices/update-message

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions): Promise<MessageIdUpdateResponse>

参数

返回

更新消息操作的响应数据。