Share via

QueueClient class

  • Referência
Pacote:
@azure/storage-queue

Um QueueClient representa uma URL para as mensagens de uma Fila de Armazenamento do Azure, permitindo que você manipule suas mensagens.

Extends

StorageClient

Construtores

QueueClient(string, Pipeline)

Cria uma instância do QueueClient.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância do QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Cria uma instância do QueueClient.

Propriedades

name

O nome da fila.

Propriedades herdadas

accountName
url

Valor da cadeia de caracteres de URL.

Métodos

clearMessages(QueueClearMessagesOptions)

Limpar exclui todas as mensagens de uma fila.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
create(QueueCreateOptions)

Cria uma nova fila na conta especificada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)

Exclui a fila especificada permanentemente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)

Exclui a fila especificada permanentemente se ela existir.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage remove permanentemente a mensagem especificada de sua fila.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)

Retornará true se a fila especificada existir; caso contrário, false.

OBSERVAÇÃO: use essa função com cuidado, pois uma fila existente pode ser excluída por outros clientes ou aplicativos. Vice-versa, novas filas podem ser adicionadas por outros clientes ou aplicativos após a conclusão dessa função.
generateSasUrl(QueueGenerateSasUrlOptions)

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

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)

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

AVISO: a Data do JavaScript potencialmente 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://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)

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 de nome-valor.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata

AVISO: o metadata objeto retornado na resposta terá suas chaves em letras minúsculas, mesmo que elas originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo listQueues método de QueueServiceClient usando a opção includeMetadata , que manterá o uso de maiúsculas e minúsculas original.
peekMessages(QueuePeekMessagesOptions)

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)

receiveMessages recupera uma ou mais mensagens da frente da fila.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)

sendMessage adiciona uma nova mensagem à parte de trás 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 uma marcação na mensagem, os conteúdos da mensagem devem ser ignorados por XML ou codificados como Base64.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Define políticas de acesso armazenadas para a fila que podem ser usadas com assinaturas de acesso compartilhadas.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)

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

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)

A atualização altera o tempo limite e o conteúdo da visibilidade 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 uma marcação na mensagem, os conteúdos da mensagem devem ser ignorados por XML ou codificados como Base64.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

Detalhes do construtor

QueueClient(string, Pipeline)

Cria uma instância do QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para a fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net/myqueue". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

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

Cria uma instância do QueueClient.

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

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para a fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net/myqueue". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

options
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

QueueClient(string, string, StoragePipelineOptions)

Cria uma instância do QueueClient.

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

Parâmetros

connectionString

string

Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS runtime. ] Exemplo de cadeia de conexão de conta –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de conexão 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

Nome da fila.

options
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Detalhes da propriedade

name

O nome da fila.

string name

Valor da propriedade

string

Detalhes das propriedades herdadas

accountName 

accountName: string

Valor da propriedade

string

Herdado de StorageClient.accountName

url

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

Herdado de StorageClient.url

Detalhes do método

clearMessages(QueueClearMessagesOptions)

Limpar exclui todas as mensagens de uma fila.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages

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

Parâmetros

options
QueueClearMessagesOptions

Opções para limpar a operação de mensagens.

Retornos

Promise<MessagesClearResponse>

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

create(QueueCreateOptions)

Cria uma nova fila na conta especificada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Parâmetros

options
QueueCreateOptions

Opções para a operação de criação de fila.

Retornos

Promise<QueueCreateResponse>

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

Exemplo de uso:

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

createIfNotExists(QueueCreateOptions)

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Parâmetros

options
QueueCreateOptions

Retornos

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Exclui a fila especificada permanentemente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Parâmetros

options
QueueDeleteOptions

Opções para a operação de exclusão de fila.

Retornos

Promise<QueueDeleteResponse>

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

Exemplo de uso:

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

deleteIfExists(QueueDeleteOptions)

Exclui a fila especificada permanentemente se ela existir.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Parâmetros

options
QueueDeleteOptions

Retornos

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage remove permanentemente a mensagem especificada de sua fila.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2

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

Parâmetros

messageId

string

ID da mensagem.

popReceipt

string

Um valor de recibo pop válido retornado de uma chamada anterior para a operação de receber mensagens ou atualizar mensagens.

options
QueueDeleteMessageOptions

Opções para excluir a operação de mensagem.

Retornos

Promise<MessageIdDeleteResponse>

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

exists(QueueExistsOptions)

Retornará true se a fila especificada existir; caso contrário, false.

OBSERVAÇÃO: use essa função com cuidado, pois uma fila existente pode ser excluída por outros clientes ou aplicativos. 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

options
QueueExistsOptions

opções para a operação Exists.

Retornos

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

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

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parâmetros

options
QueueGenerateSasUrlOptions

Parâmetros opcionais.

Retornos

string

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

getAccessPolicy(QueueGetAccessPolicyOptions)

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

AVISO: a Data do JavaScript potencialmente 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://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl

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

Parâmetros

options
QueueGetAccessPolicyOptions

Opções para Enfileirar obter operação de política de acesso.

Retornos

Promise<QueueGetAccessPolicyResponse>

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

getProperties(QueueGetPropertiesOptions)

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 de nome-valor.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata

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

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

Parâmetros

options
QueueGetPropertiesOptions

Opções para a operação Obter propriedades da fila.

Retornos

Promise<QueueGetPropertiesResponse>

Dados de resposta para a operação Obter propriedades da fila.

peekMessages(QueuePeekMessagesOptions)

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages

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

Parâmetros

options
QueuePeekMessagesOptions

Opções para espiar a operação de mensagens.

Retornos

Promise<QueuePeekMessagesResponse>

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

Exemplo de uso:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages recupera uma ou mais mensagens da frente da fila.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages

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

Parâmetros

options
QueueReceiveMessageOptions

Opções para receber a operação de mensagens.

Retornos

Promise<QueueReceiveMessageResponse>

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

Exemplo de uso:

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 adiciona uma nova mensagem à parte de trás 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 uma marcação na mensagem, os conteúdos da mensagem devem ser ignorados por XML ou codificados como Base64.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/put-message

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

Parâmetros

messageText

string

Texto da mensagem a ser enviada

options
QueueSendMessageOptions

Opções para enviar a operação de mensagens.

Retornos

Promise<QueueSendMessageResponse>

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

Exemplo de uso:

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)

Define políticas de acesso armazenadas para a fila que podem ser usadas com assinaturas de acesso compartilhadas.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl

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

Parâmetros

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Opções para a operação de política de acesso de conjunto de filas.

Retornos

Promise<QueueSetAccessPolicyResponse>

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

setMetadata(Metadata, QueueSetMetadataOptions)

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

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata

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

Parâmetros

metadata
Metadata

Se nenhum metadado for fornecido, todos os metadados existentes serão removidos.

options
QueueSetMetadataOptions

Opções para a operação de metadados de conjunto de filas.

Retornos

Promise<QueueSetMetadataResponse>

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

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

A atualização altera o tempo limite e o conteúdo da visibilidade 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 uma marcação na mensagem, os conteúdos da mensagem devem ser ignorados por XML ou codificados como Base64.

Veja 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>

Parâmetros

messageId

string

Id da mensagem

popReceipt

string

Um valor de recibo pop válido retornado de uma chamada anterior para a operação de receber mensagens ou atualizar mensagem.

message

string

Mensagem a ser atualizada. Se esse parâmetro for indefinido, o conteúdo da mensagem não será atualizado.

visibilityTimeout

number

Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação à hora do servidor. O novo valor deve ser maior ou igual a 0 e não pode ser maior que sete dias. O tempo limite de visibilidade de uma mensagem não pode ser definido como um valor posterior à data de expiração. É possível atualizar uma mensagem até que seja excluída ou expirar.

options
QueueUpdateMessageOptions

Opções para atualizar a operação de mensagem.

Retornos

Promise<MessageIdUpdateResponse>

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