Поделиться через

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://learn.microsoft.com/rest/api/storageservices/clear-messages
create(QueueCreateOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)

Удаляет указанную очередь окончательно.

См. https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)

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

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующая очередь может быть удалена другими клиентами или приложениями. Наоборот, новые очереди могут быть добавлены другими клиентами или приложениями после завершения этой функции.
generateSasStringToSign(QueueGenerateSasUrlOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(QueueGenerateSasUrlOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

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

См. https://learn.microsoft.com/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://learn.microsoft.com/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методом listQueuesQueueServiceClient с помощью параметра includeMetadata, который будет хранить исходный регистр.
peekMessages(QueuePeekMessagesOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)

sendMessage добавляет новое сообщение в спину очереди. Время ожидания видимости указывает, сколько времени сообщение должно быть невидимым для операций Dequeue и Peek. Содержимое сообщения составляет до 64 КБ и должно быть в формате, который может быть включен в XML-запрос с кодировкой UTF-8. Чтобы включить разметку в сообщение, содержимое сообщения должно быть xml-escaped или Base64-кодирование.

См. https://learn.microsoft.com/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)

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

См. https://learn.microsoft.com/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". При использовании AnonymousCredential можно добавить SAS, например "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

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

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. ] Пример строки подключения учетной записи — пример строки подключения SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — 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://learn.microsoft.com/rest/api/storageservices/clear-messages

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

Параметры

options
QueueClearMessagesOptions

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

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

Promise<MessagesClearResponse>

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

create(QueueCreateOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Параметры

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}`,
);

createIfNotExists(QueueCreateOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Параметры

options
QueueCreateOptions

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

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Удаляет указанную очередь окончательно.

См. https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Параметры

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}`,
);

deleteIfExists(QueueDeleteOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Параметры

options
QueueDeleteOptions

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

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

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

См. https://learn.microsoft.com/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

параметры операции "Существует".

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

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Параметры

options
QueueGenerateSasUrlOptions

Необязательные параметры.

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

string

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

generateSasUrl(QueueGenerateSasUrlOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Параметры

options
QueueGenerateSasUrlOptions

Необязательные параметры.

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

string

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

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: QueueGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Параметры

options
QueueGenerateSasUrlOptions

Необязательные параметры.

userDelegationKey
UserDelegationKey

ключ для делегирования пользователя, используемый для подписания SAS URI

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

string

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

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

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

См. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationStringToSign(options: QueueGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Параметры

options
QueueGenerateSasUrlOptions

Необязательные параметры.

userDelegationKey
UserDelegationKey

ключ для делегирования пользователя, используемый для подписания SAS URI

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

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://learn.microsoft.com/rest/api/storageservices/get-queue-acl

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

Параметры

options
QueueGetAccessPolicyOptions

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

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

Promise<QueueGetAccessPolicyResponse>

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

getProperties(QueueGetPropertiesOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методом listQueuesQueueServiceClient с помощью параметра includeMetadata, который будет хранить исходный регистр.

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

Параметры

options
QueueGetPropertiesOptions

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

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

Promise<QueueGetPropertiesResponse>

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

peekMessages(QueuePeekMessagesOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/peek-messages

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

Параметры

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(QueueReceiveMessageOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/get-messages

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

Параметры

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

sendMessage добавляет новое сообщение в спину очереди. Время ожидания видимости указывает, сколько времени сообщение должно быть невидимым для операций Dequeue и Peek. Содержимое сообщения составляет до 64 КБ и должно быть в формате, который может быть включен в XML-запрос с кодировкой UTF-8. Чтобы включить разметку в сообщение, содержимое сообщения должно быть xml-escaped или Base64-кодирование.

См. https://learn.microsoft.com/rest/api/storageservices/put-message

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

Параметры

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}`,
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/set-queue-acl

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

Параметры

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

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

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

Promise<QueueSetAccessPolicyResponse>

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

setMetadata(Metadata, QueueSetMetadataOptions)

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

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

См. https://learn.microsoft.com/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-escaped или Base64-кодирование.

См. https://learn.microsoft.com/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>

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