QueueClient class

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

Um QueueClient representa um URL para as mensagens de uma Fila de Armazenamento do Azure que lhe permite manipular as respetivas mensagens.

Extends

StorageClient

Construtores

QueueClient(string, Pipeline)

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

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

Cria uma instância de QueueClient.

Propriedades

name

O nome da fila.

Propriedades Herdadas

accountName
url

Valor da cadeia de URL.

Métodos

clearMessages(QueueClearMessagesOptions)

Limpar elimina 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)

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

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

Elimina permanentemente a fila especificada.

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

Elimina permanentemente a fila especificada, se existir.

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

deleteMessage remove permanentemente a mensagem especificada da respetiva fila.

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

Devolve 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. As novas filas vice-versa podem ser adicionadas por outros clientes ou aplicações após a conclusão desta função.
generateSasUrl(QueueGenerateSasUrlOptions)

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

Gera um URI de Assinatura de Acesso Partilhado do Serviço (SAS) com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada 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 utilizadas com Assinaturas de Acesso Partilhado.

AVISO: a Data de JavaScript poderá perder a precisão ao analisar a cadeia de início e de 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 utilizador e propriedades do sistema para a fila especificada. Os metadados estão associados à fila como pares name-values.

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

AVISO: O metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelo listQueues método queueServiceClient com a opção includeMetadata , que irá manter a sua caixa original.
peekMessages(QueuePeekMessagesOptions)

peekMessages obtém 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 obtém 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 quanto tempo a mensagem deve ser invisível para as operações Dequeue e Peek. O conteúdo da mensagem tem até 64 KB de tamanho e tem de estar num formato que possa ser incluído num pedido XML com codificação UTF-8. Para incluir a marcação na mensagem, o conteúdo da mensagem tem de ser XML-escapeed ou Base64-encode.

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 utilizadas com Assinaturas de Acesso Partilhado.

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 utilizador para a fila especificada.

Se não for fornecida nenhuma opção ou se não forem definidos metadados 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 de visibilidade de uma mensagem. O conteúdo da mensagem tem até 64 KB de tamanho e tem de estar num formato que possa ser incluído num pedido XML com codificação UTF-8. Para incluir marcações na mensagem, o conteúdo da mensagem tem de ser XML escaped ou Base64-encode.

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

Detalhes do Construtor

QueueClient(string, Pipeline)

Cria uma instância de QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de URL a apontar para a fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net/myqueue". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.

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

Cria uma instância de QueueClient.

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

Parâmetros

url

string

Uma cadeia de URL a apontar para a fila do Armazenamento do Azure, como "https://myaccount.queue.core.windows.net/myqueue". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

options
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

QueueClient(string, string, StoragePipelineOptions)

Cria uma instância de QueueClient.

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

Parâmetros

connectionString

string

Cadeia de ligação de conta ou uma cadeia de ligação SAS de uma conta de armazenamento do Azure. [ Nota - a cadeia de ligação da conta só pode ser utilizada no NODE.JS runtime. ] Exemplo de cadeia de ligação de conta -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de ligaçã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 de Propriedade

name

O nome da fila.

string name

Valor de Propriedade

string

Detalhes da Propriedade Herdada

accountName 

accountName: string

Valor de Propriedade

string

Herdado de StorageClient.accountName

url

Valor da cadeia de URL.

url: string

Valor de Propriedade

string

Herdado de StorageClient.url

Detalhes de Método

clearMessages(QueueClearMessagesOptions)

Limpar elimina 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.

Devoluções

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

Devoluções

Promise<QueueCreateResponse>

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

Utilização de exemplo: 

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

createIfNotExists(QueueCreateOptions)

Cria uma nova fila na conta especificada, se ainda não existir. Se a fila já existir, 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

Devoluções

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Elimina permanentemente a fila especificada.

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 eliminação de filas.

Devoluções

Promise<QueueDeleteResponse>

Dados de resposta para a operação Eliminação de filas.

Utilização de exemplo: 

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

deleteIfExists(QueueDeleteOptions)

Elimina permanentemente a fila especificada, se existir.

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

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

Parâmetros

options
QueueDeleteOptions

Devoluções

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage remove permanentemente a mensagem especificada da respetiva 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 devolvido de uma chamada anterior para a operação receber mensagens ou atualizar mensagens.

options
QueueDeleteMessageOptions

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

Devoluções

Promise<MessageIdDeleteResponse>

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

exists(QueueExistsOptions)

Devolve 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. As novas filas vice-versa podem ser adicionadas por outros clientes ou aplicações após a conclusão desta função.

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

Parâmetros

options
QueueExistsOptions

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

Devoluções

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

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

Gera um URI de Assinatura de Acesso Partilhado do Serviço (SAS) com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada 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.

Devoluções

string

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

getAccessPolicy(QueueGetAccessPolicyOptions)

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

AVISO: a Data de JavaScript poderá perder a precisão ao analisar a cadeia de início e de 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 Colocar em fila a operação de política de acesso.

Devoluções

Promise<QueueGetAccessPolicyResponse>

Dados de resposta para a operação Fila obter política de acesso.

getProperties(QueueGetPropertiesOptions)

Obtém todos os metadados definidos pelo utilizador e propriedades do sistema para a fila especificada. Os metadados estão associados à fila como pares name-values.

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

AVISO: O metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelo listQueues método queueServiceClient com a opção includeMetadata , que irá manter a sua caixa original.

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

Parâmetros

options
QueueGetPropertiesOptions

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

Devoluções

Promise<QueueGetPropertiesResponse>

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

peekMessages(QueuePeekMessagesOptions)

peekMessages obtém 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 pré-visualizar a operação de mensagens.

Devoluções

Promise<QueuePeekMessagesResponse>

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

Utilização de exemplo: 

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages obtém 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.

Devoluções

Promise<QueueReceiveMessageResponse>

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

Utilização de exemplo: 

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 quanto tempo a mensagem deve ser invisível para as operações Dequeue e Peek. O conteúdo da mensagem tem até 64 KB de tamanho e tem de estar num formato que possa ser incluído num pedido XML com codificação UTF-8. Para incluir a marcação na mensagem, o conteúdo da mensagem tem de ser XML-escapeed ou Base64-encode.

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 enviar

options
QueueSendMessageOptions

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

Devoluções

Promise<QueueSendMessageResponse>

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

Utilização de exemplo: 

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 utilizadas com Assinaturas de Acesso Partilhado.

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 definir fila.

Devoluções

Promise<QueueSetAccessPolicyResponse>

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

setMetadata(Metadata, QueueSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo utilizador para a fila especificada.

Se não for fornecida nenhuma opção ou se não forem definidos metadados 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 não forem fornecidos metadados, todos os metadados existentes serão removidos.

options
QueueSetMetadataOptions

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

Devoluções

Promise<QueueSetMetadataResponse>

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

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

A atualização altera o tempo limite e o conteúdo de visibilidade de uma mensagem. O conteúdo da mensagem tem até 64 KB de tamanho e tem de estar num formato que possa ser incluído num pedido XML com codificação UTF-8. Para incluir marcações na mensagem, o conteúdo da mensagem tem de ser XML escaped ou Base64-encode.

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 devolvido a partir de uma chamada anterior para a operação receber mensagens ou atualizar mensagens.

message

string

Mensagem a atualizar. Se este 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 tem de ser maior ou igual a 0 e não pode ser superior a 7 dias. O tempo limite de visibilidade de uma mensagem não pode ser definido para um valor posterior ao tempo de expiração. Uma mensagem pode ser atualizada até que tenha sido eliminada ou expirada.

options
QueueUpdateMessageOptions

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

Devoluções

Promise<MessageIdUpdateResponse>

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