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.

Свойства

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

Методы

clearMessages(QueueClearMessagesOptions)	Очистка удаляет все сообщения из очереди.
create(QueueCreateOptions)	Создает новую очередь под указанной учетной записью.
createIfNotExists(QueueCreateOptions)	Создает новую очередь под указанной учетной записью, если она еще не существует. Если очередь уже существует, она не изменяется.
delete(QueueDeleteOptions)	Удаляет указанную очередь окончательно.
deleteIfExists(QueueDeleteOptions)	Удаляет указанную очередь окончательно, если она существует.
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage окончательно удаляет указанное сообщение из очереди.
exists(QueueExistsOptions)	Возвращает значение true, если указанная очередь существует; False в противном случае. ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующая очередь может быть удалена другими клиентами или приложениями. Наоборот, новые очереди могут быть добавлены другими клиентами или приложениями после завершения этой функции.
generateSasUrl(QueueGenerateSasUrlOptions)	Доступно только для QueueClient, созданного с использованием учетных данных общего ключа. Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.
getAccessPolicy(QueueGetAccessPolicyOptions)	Получает сведения о любых хранимых политиках доступа, указанных в очереди, которая может использоваться с подписанными URL-адресами. ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript может потерять точность при анализе строки начала и истечения срока действия. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".
getProperties(QueueGetPropertiesOptions)	Возвращает все пользовательские метаданные и системные свойства для указанной очереди. Метаданные связаны с очередью как пары "значения имен".
peekMessages(QueuePeekMessagesOptions)	PeekMessages извлекает одно или несколько сообщений из передней части очереди, но не изменяет видимость сообщения.
receiveMessages(QueueReceiveMessageOptions)	receiveMessages получает одно или несколько сообщений из передней части очереди.
sendMessage(string, QueueSendMessageOptions)	sendMessage добавляет новое сообщение в спину очереди. Время ожидания видимости указывает, сколько времени сообщение должно быть невидимым для операций Dequeue и Peek. Содержимое сообщения составляет до 64 КБ и должно быть в формате, который может быть включен в XML-запрос с кодировкой UTF-8. Чтобы включить разметку в сообщение, содержимое сообщения должно быть xml-escaped или Base64-кодирование.
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Задает хранимые политики доступа для очереди, которая может использоваться с подписанными URL-адресами.
setMetadata(Metadata, QueueSetMetadataOptions)	Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной очереди. Если параметр не указан или метаданные, определенные в параметре параметра, метаданные очереди будут удалены.
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	Обновление изменяет время ожидания видимости сообщения и содержимое. Содержимое сообщения составляет до 64 КБ и должно быть в формате, который может быть включен в XML-запрос с кодировкой UTF-8. Чтобы включить разметку в сообщение, содержимое сообщения должно быть xml-escaped или Base64-кодирование.

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

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

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.

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

accountName

accountName: string

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

string

name

Имя очереди.

string name

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

string

url

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

url: string

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

string

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

clearMessages(QueueClearMessagesOptions)

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

function clearMessages(options?: QueueClearMessagesOptions)

Параметры

options: QueueClearMessagesOptions

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

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

Promise<QueueClearMessagesResponse>

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

create(QueueCreateOptions)

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

function create(options?: QueueCreateOptions)

Параметры

options: QueueCreateOptions

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

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

Promise<QueueCreateResponse>

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

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

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

createIfNotExists(QueueCreateOptions)

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

function createIfNotExists(options?: QueueCreateOptions)

Параметры

options: QueueCreateOptions

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

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

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

function delete(options?: QueueDeleteOptions)

Параметры

options: QueueDeleteOptions

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

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

Promise<QueueDeleteResponse>

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

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

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

deleteIfExists(QueueDeleteOptions)

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

function deleteIfExists(options?: QueueDeleteOptions)

Параметры

options: QueueDeleteOptions

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

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

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

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions)

Параметры

messageId: string

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

popReceipt: string

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

options: QueueDeleteMessageOptions

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

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

Promise<QueueDeleteMessageResponse>

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

exists(QueueExistsOptions)

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

function exists(options?: QueueExistsOptions)

Параметры

options: QueueExistsOptions

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

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

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

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

function generateSasUrl(options: QueueGenerateSasUrlOptions)

Параметры

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".

function getAccessPolicy(options?: QueueGetAccessPolicyOptions)

Параметры

options: QueueGetAccessPolicyOptions

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

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

Promise<QueueGetAccessPolicyResponse>

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

getProperties(QueueGetPropertiesOptions)

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

function getProperties(options?: QueueGetPropertiesOptions)

Параметры

options: QueueGetPropertiesOptions

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

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

Promise<QueueGetPropertiesResponse>

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

peekMessages(QueuePeekMessagesOptions)

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

function peekMessages(options?: QueuePeekMessagesOptions)

Параметры

options: QueuePeekMessagesOptions

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

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

Promise<QueuePeekMessagesResponse>

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

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

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

receiveMessages(QueueReceiveMessageOptions)

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

function receiveMessages(options?: QueueReceiveMessageOptions)

Параметры

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

function sendMessage(messageText: string, options?: QueueSendMessageOptions)

Параметры

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)

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

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions)

Параметры

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

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

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

Promise<QueueSetAccessPolicyResponse>

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

setMetadata(Metadata, QueueSetMetadataOptions)

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

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions)

Параметры

metadata: Metadata

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

options: QueueSetMetadataOptions

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

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

Promise<QueueSetMetadataResponse>

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

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

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

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions)

Параметры

messageId: string

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

popReceipt: string

message: string

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

visibilityTimeout: number

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

options: QueueUpdateMessageOptions

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

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

Promise<QueueUpdateMessageResponse>

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

Обратная связь

Были ли сведения на этой странице полезными?

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

QueueClient class

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

Свойства

Методы

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

QueueClient(string, Pipeline)

Параметры

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

Параметры

QueueClient(string, string, StoragePipelineOptions)

Параметры

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

accountName

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

name

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

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)

Параметры

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

Обратная связь