QueueClient class

Ссылка

Пакет:: @azure/storage-queue

QueueClient представляет URL-адрес сообщений очереди службы хранилища Azure, что позволяет управлять ее сообщениями.

Extends: StorageClient

Конструкторы

QueueClient(string, Pipeline)	Создает экземпляр QueueClient.
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Создает экземпляр QueueClient.
QueueClient(string, string, StoragePipelineOptions)	Создает экземпляр QueueClient.

Свойства

name	Имя очереди.

Унаследованные свойства

accountName
url	Значение строки URL-адреса.

Методы

clearMessages(QueueClearMessagesOptions)	Очистка удаляет все сообщения из очереди. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
create(QueueCreateOptions)	Создает новую очередь в указанной учетной записи. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)	Создает новую очередь в указанной учетной записи, если она еще не существует. Если очередь уже существует, она не изменяется. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)	Удаляет указанную очередь без возможности восстановления. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)	Удаляет указанную очередь без возможности восстановления, если она существует. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)	DeleteMessage окончательно удаляет указанное сообщение из своей очереди. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)	Возвращает значение true, если указанная очередь существует; В противном случае значение false. Примечание. Используйте эту функцию с осторожностью, так как существующая очередь может быть удалена другими клиентами или приложениями. Наоборот, новые очереди могут добавляться другими клиентами или приложениями после завершения этой функции.
generateSasUrl(QueueGenerateSasUrlOptions)	Доступно только для QueueClient, созданного с учетными данными общего ключа. Создает URI подписанного URL-адреса службы (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)	Возвращает сведения о всех хранимых политиках доступа, указанных в очереди, которые могут использоваться с подписанными URL-адресами. ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript может потерять точность при синтаксическом анализе строки начала и срока действия. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z". См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)	Возвращает все определяемые пользователем метаданные и системные свойства для указанной очереди. Метаданные связаны с очередью в виде пар "имя-значение". См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata ВНИМАНИЕ! Ключи `metadata` объекта, возвращенного в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методом `listQueues`QueueServiceClient с параметром `includeMetadata` , который сохранит исходный регистр.
peekMessages(QueuePeekMessagesOptions)	функция peekMessages извлекает одно или несколько сообщений из передней части очереди, но не изменяет видимость сообщения. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)	receiveMessages извлекает одно или несколько сообщений из передней части очереди. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)	sendMessage добавляет новое сообщение в заднюю часть очереди. Время ожидания видимости указывает, как долго сообщение должно быть невидимым для операций вывода из очереди и просмотра. Размер содержимого сообщения составляет до 64 КБ и должен иметь формат, который можно включить в XML-запрос с кодировкой UTF-8. Для включения в сообщение разметки содержимое сообщения должно быть либо экранировано XML-тегами, либо иметь кодировку Base64. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Задает хранимые политики доступа для очереди, которая может быть использована с подписями коллективного доступа. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)	Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной очереди. Если параметр не указан или метаданные не определены в параметре option, метаданные очереди будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	Обновление изменяет время ожидания и содержимое видимости сообщения. Размер содержимого сообщения составляет до 64 КБ и должен быть в формате, который может быть включен в XML-запрос с кодировкой UTF-8. Для включения в сообщение разметки содержимое сообщения должно быть либо экранировано XML-тегами, либо иметь кодировку Base64. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

Сведения о конструкторе

QueueClient(string, Pipeline)

Создает экземпляр QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Параметры

url: string

Строка URL-адреса, указывающая на очередь службы хранилища Azure, например "https://myaccount.queue.core.windows.net/myqueue"". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.queue.core.windows.net/myqueue?sasString"".

pipeline: Pipeline

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает экземпляр QueueClient.

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

Параметры

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект , реализующий интерфейс TokenCredential. Если значение не указано, используется AnonymousCredential.

options: StoragePipelineOptions

Параметры для настройки конвейера HTTP.

QueueClient(string, string, StoragePipelineOptions)

Создает экземпляр QueueClient.

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

Параметры

connectionString: string

Строка подключения к учетной записи или строка подключения SAS учетной записи хранения Azure. [ Примечание. Строка подключения учетной записи может использоваться только в NODE.JS среде выполнения. ] Пример строки подключения учетной записи —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Пример строки подключения SAS — BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

queueName: string

Имя очереди.

options: StoragePipelineOptions

Параметры для настройки конвейера HTTP.

Сведения о свойстве

name

Имя очереди.

string name

Значение свойства

string

Сведения об унаследованном свойстве

accountName

accountName: string

Значение свойства

string

Наследуется от StorageClient.accountName

url

Значение строки URL-адреса.

url: string

Значение свойства

string

Наследуется от StorageClient.url

Сведения о методе

clearMessages(QueueClearMessagesOptions)

Очистка удаляет все сообщения из очереди.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages

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

Параметры

options: QueueClearMessagesOptions

Параметры операции очистки сообщений.

Возвращаемое значение

Promise<MessagesClearResponse>

Данные ответа для операции очистки сообщений.

create(QueueCreateOptions)

Создает новую очередь в указанной учетной записи.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Параметры

options: QueueCreateOptions

Параметры для операции создания очереди.

Возвращаемое значение

Promise<QueueCreateResponse>

Данные ответа для операции создания очереди.

Пример использования:

const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();

createIfNotExists(QueueCreateOptions)

Создает новую очередь в указанной учетной записи, если она еще не существует. Если очередь уже существует, она не изменяется.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Параметры

options: QueueCreateOptions

Возвращаемое значение

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Удаляет указанную очередь без возможности восстановления.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Параметры

options: QueueDeleteOptions

Параметры для операции удаления в очередь.

Возвращаемое значение

Promise<QueueDeleteResponse>

Данные ответа для операции удаления очереди.

Пример использования:

const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);

deleteIfExists(QueueDeleteOptions)

Удаляет указанную очередь без возможности восстановления, если она существует.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Параметры

options: QueueDeleteOptions

Возвращаемое значение

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

DeleteMessage окончательно удаляет указанное сообщение из своей очереди.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2

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

Параметры

messageId: string

Идентификатор сообщения.

popReceipt: string

Допустимое значение всплывающего уведомления, возвращенное в результате предыдущего вызова операции получения сообщений или обновления сообщений.

options: QueueDeleteMessageOptions

Параметры операции удаления сообщения.

Возвращаемое значение

Promise<MessageIdDeleteResponse>

Данные ответа для операции удаления сообщения.

exists(QueueExistsOptions)

Возвращает значение true, если указанная очередь существует; В противном случае значение false.

Примечание. Используйте эту функцию с осторожностью, так как существующая очередь может быть удалена другими клиентами или приложениями. Наоборот, новые очереди могут добавляться другими клиентами или приложениями после завершения этой функции.

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

Параметры

options: QueueExistsOptions

параметров для операции Exists.

Возвращаемое значение

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

Доступно только для QueueClient, созданного с учетными данными общего ключа.

Создает URI подписанного URL-адреса службы (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Параметры

options: QueueGenerateSasUrlOptions

Дополнительные параметры.

Возвращаемое значение

string

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

getAccessPolicy(QueueGetAccessPolicyOptions)

Возвращает сведения о всех хранимых политиках доступа, указанных в очереди, которые могут использоваться с подписанными URL-адресами.

ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript может потерять точность при синтаксическом анализе строки начала и срока действия. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl

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

Параметры

options: QueueGetAccessPolicyOptions

Параметры для операции получения доступа в очередь.

Возвращаемое значение

Promise<QueueGetAccessPolicyResponse>

Данные ответа для операции политики получения очереди.

getProperties(QueueGetPropertiesOptions)

Возвращает все определяемые пользователем метаданные и системные свойства для указанной очереди. Метаданные связаны с очередью в виде пар "имя-значение".

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata

ВНИМАНИЕ! Ключи metadata объекта, возвращенного в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методом listQueuesQueueServiceClient с параметром includeMetadata , который сохранит исходный регистр.

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

Параметры

options: QueueGetPropertiesOptions

Параметры для операции получения свойств в очередь.

Возвращаемое значение

Promise<QueueGetPropertiesResponse>

Данные ответа для операции получения свойств очереди.

peekMessages(QueuePeekMessagesOptions)

функция peekMessages извлекает одно или несколько сообщений из передней части очереди, но не изменяет видимость сообщения.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages

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

Параметры

options: QueuePeekMessagesOptions

Параметры для операции просмотра сообщений.

Возвращаемое значение

Promise<QueuePeekMessagesResponse>

Данные ответа для операции просмотра сообщений.

Пример использования:

const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);

receiveMessages(QueueReceiveMessageOptions)

receiveMessages извлекает одно или несколько сообщений из передней части очереди.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages

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

Параметры

options: QueueReceiveMessageOptions

Параметры для операции получения сообщений.

Возвращаемое значение

Promise<QueueReceiveMessageResponse>

Данные ответа для операции получения сообщений.

Пример использования:

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(string, QueueSendMessageOptions)

sendMessage добавляет новое сообщение в заднюю часть очереди. Время ожидания видимости указывает, как долго сообщение должно быть невидимым для операций вывода из очереди и просмотра. Размер содержимого сообщения составляет до 64 КБ и должен иметь формат, который можно включить в XML-запрос с кодировкой UTF-8. Для включения в сообщение разметки содержимое сообщения должно быть либо экранировано XML-тегами, либо иметь кодировку Base64.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/put-message

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

Параметры

messageText: string

Текст отправляемого сообщения

options: QueueSendMessageOptions

Параметры операции отправки сообщений.

Возвращаемое значение

Promise<QueueSendMessageResponse>

Данные ответа для операции отправки сообщений.

Пример использования:

const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Задает хранимые политики доступа для очереди, которая может быть использована с подписями коллективного доступа.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl

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

Параметры

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

Параметры для операции установки очереди политики доступа.

Возвращаемое значение

Promise<QueueSetAccessPolicyResponse>

Данные ответа для операции политики доступа для задания очереди.

setMetadata(Metadata, QueueSetMetadataOptions)

Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной очереди.

Если параметр не указан или метаданные не определены в параметре option, метаданные очереди будут удалены.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata

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

Параметры

metadata: Metadata

Если метаданные не указаны, все существующие метаданные будут удалены.

options: QueueSetMetadataOptions

Параметры операции постановки метаданных в очередь.

Возвращаемое значение

Promise<QueueSetMetadataResponse>

Данные ответа для операции метаданных набора очередей.

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

Обновление изменяет время ожидания и содержимое видимости сообщения. Размер содержимого сообщения составляет до 64 КБ и должен быть в формате, который может быть включен в XML-запрос с кодировкой UTF-8. Для включения в сообщение разметки содержимое сообщения должно быть либо экранировано XML-тегами, либо иметь кодировку Base64.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

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

Параметры

messageId: string

Идентификатор сообщения

popReceipt: string

Допустимое значение всплывающего уведомления, возвращенное при предыдущем вызове для получения сообщений или операции обновления сообщений.

message: string

Сообщение для обновления. Если этот параметр не определен, содержимое сообщения обновляться не будет.

visibilityTimeout: number

Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Новое значение должно быть больше или равно 0 и не может превышать 7 дней. Для времени ожидания видимости сообщения нельзя задать значение позже истечения срока. Сообщения можно обновлять, пока оно не будет удалено или пока не кончится срок его действия.

options: QueueUpdateMessageOptions

Параметры для операции обновления сообщений.

Возвращаемое значение

Promise<MessageIdUpdateResponse>

Данные ответа для операции обновления сообщения.

QueueClient class

Конструкторы

Свойства

Унаследованные свойства

Методы

Сведения о конструкторе

QueueClient(string, Pipeline)

Параметры

QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Параметры

QueueClient(string, string, StoragePipelineOptions)

Параметры

Сведения о свойстве

name

Значение свойства

Сведения об унаследованном свойстве

accountName

Значение свойства

url

Значение свойства

Сведения о методе

clearMessages(QueueClearMessagesOptions)

Параметры

Возвращаемое значение

create(QueueCreateOptions)

Параметры

Возвращаемое значение

createIfNotExists(QueueCreateOptions)

Параметры

Возвращаемое значение

delete(QueueDeleteOptions)

Параметры

Возвращаемое значение

deleteIfExists(QueueDeleteOptions)

Параметры

Возвращаемое значение

deleteMessage(string, string, QueueDeleteMessageOptions)

Параметры

Возвращаемое значение

exists(QueueExistsOptions)

Параметры

Возвращаемое значение

generateSasUrl(QueueGenerateSasUrlOptions)

Параметры

Возвращаемое значение

getAccessPolicy(QueueGetAccessPolicyOptions)

Параметры

Возвращаемое значение

getProperties(QueueGetPropertiesOptions)

Параметры

Возвращаемое значение

peekMessages(QueuePeekMessagesOptions)

Параметры

Возвращаемое значение

receiveMessages(QueueReceiveMessageOptions)

Параметры

Возвращаемое значение

sendMessage(string, QueueSendMessageOptions)

Параметры

Возвращаемое значение

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Параметры

Возвращаемое значение

setMetadata(Metadata, QueueSetMetadataOptions)

Параметры

Возвращаемое значение

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

Параметры

Возвращаемое значение

Дополнительные ресурсы