QueueClient class

Cria uma instância de QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parâmetros

Cria uma instância de QueueClient.

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

Parâmetros

Cria uma instância de QueueClient.

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

Parâmetros

O nome da fila.

string name

Valor de Propriedade

accountName: string

Valor de Propriedade

herdado de StorageClient.accountName

Valor da cadeia de caracteres de URL.

url: string

Valor de Propriedade

herdado de StorageClient.url

Clear exclui todas as mensagens de uma fila.

Veja https://learn.microsoft.com/rest/api/storageservices/clear-messages

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

Parâmetros

Devoluções

Dados de resposta para a operação de mensagens claras.

Cria uma nova fila na conta especificada.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação de criação de fila.

Exemplo de uso:

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

Cria uma nova fila na conta especificada se ela ainda não existir. Se a fila já existir, ela não será alterada.

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

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

Parâmetros

Devoluções

Exclui a fila especificada permanentemente.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação de exclusão de fila.

Exemplo de uso:

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

Exclui a fila especificada permanentemente se ela existir.

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

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

Parâmetros

Devoluções

deleteMessage remove permanentemente a mensagem especificada de sua fila.

Veja https://learn.microsoft.com/rest/api/storageservices/delete-message2

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

Parâmetros

Devoluções

Dados de resposta para a operação de exclusão de mensagem.

Retorna true se a fila especificada existir; falso caso contrário.

NOTA: utilize esta função com cuidado, uma vez que uma fila existente pode ser eliminada por outros clientes ou aplicações. Vice-versa, novas filas podem ser adicionadas por outros clientes ou aplicativos após a conclusão dessa função.

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

Parâmetros

Devoluções

Disponível apenas para QueueClient construído com uma credencial de chave compartilhada.

Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. O SAS é assinado pela credencial de chave compartilhada do cliente.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Disponível apenas para QueueClient construído com uma credencial de chave compartilhada.

Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Obtém detalhes sobre quaisquer políticas de acesso armazenado especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado.

AVISO: JavaScript Date perderá a precisão ao analisar a cadeia de caracteres de início e expiração. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

Veja https://learn.microsoft.com/rest/api/storageservices/get-queue-acl

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

Parâmetros

Devoluções

Dados de resposta para a operação da política de acesso de obtenção de fila.

Obtém todos os metadados definidos pelo usuário e as propriedades do sistema para a fila especificada. Os metadados são associados à fila como pares nome-valores.

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

AVISO: O objeto metadata retornado na resposta terá suas teclas em minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo método listQueues de QueueServiceClient usando a opção includeMetadata, que manterá seu invólucro original.

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

Parâmetros

Devoluções

Dados de resposta para a operação Queue get properties.

peekMessages recupera uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação de mensagens de visualização.

Exemplo de uso:

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 recupera uma ou mais mensagens da frente da fila.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação de recebimento de mensagens.

Exemplo de uso:

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 adiciona uma nova mensagem ao fim de uma fila. O tempo limite de visibilidade especifica por quanto tempo a mensagem deve ficar invisível para as operações Dequeue e Peek. O conteúdo da mensagem tem até 64 KB de tamanho e deve estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. Para incluir marcação na mensagem, o conteúdo da mensagem deve ser com escape de XML ou código Base64.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação de envio de mensagens.

Exemplo de uso:

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

Define políticas de acesso armazenado para a fila que podem ser usadas com Assinaturas de Acesso Compartilhado.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação da política de acesso do conjunto de filas.

Define um ou mais pares nome-valor definidos pelo usuário para a fila especificada.

Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro option, os metadados da fila serão removidos.

Veja https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata

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

Parâmetros

Devoluções

Dados de resposta para a operação de metadados do conjunto de filas.

A atualização altera o tempo limite de visibilidade e o conteúdo de uma mensagem. O conteúdo da mensagem tem até 64 KB de tamanho e deve estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. Para incluir marcação na mensagem, o conteúdo da mensagem deve ser com escape de XML ou código Base64.

Veja https://learn.microsoft.com/rest/api/storageservices/update-message

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

Parâmetros

Devoluções

Dados de resposta para a operação de mensagem de atualização.