Compartir a través de

QueueClient class

  • Referencia
Paquete:
@azure/storage-queue

QueueClient representa una dirección URL a los mensajes de una cola de Azure Storage que le permite manipular sus mensajes.

Extends

StorageClient

Constructores

QueueClient(string, Pipeline)

Crea una instancia de QueueClient.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea una instancia de QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Crea una instancia de QueueClient.

Propiedades

name

Nombre de la cola.

Propiedades heredadas

accountName
url

Valor de cadena de dirección URL.

Métodos

clearMessages(QueueClearMessagesOptions)

Borrar elimina todos los mensajes de una cola.

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

Crea una nueva cola en la cuenta especificada.

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

Crea una nueva cola en la cuenta especificada si aún no existe. Si la cola ya existe, no se cambia.

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

Elimina la cola especificada de forma permanente.

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

Elimina la cola especificada de forma permanente si existe.

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

deleteMessage quita permanentemente el mensaje especificado de su cola.

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

Devuelve true si existe la cola especificada; False en caso contrario.

NOTA: Use esta función con cuidado, ya que otros clientes o aplicaciones pueden eliminar una cola existente. Viceversa, es posible que otros clientes o aplicaciones agreguen nuevas colas después de que se complete esta función.
generateSasStringToSign(QueueGenerateSasUrlOptions)

Solo está disponible para QueueClient construido con una credencial de clave compartida.

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de servicio en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

Vea https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateSasUrl(QueueGenerateSasUrlOptions)

Solo está disponible para QueueClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de servicio basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

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

Obtiene detalles sobre las directivas de acceso almacenadas especificadas en la cola que se pueden usar con firmas de acceso compartido.

ADVERTENCIA: La fecha de JavaScript podría perder precisión al analizar la cadena de inicio y expiración. Por ejemplo, new Date("2018-12-31T03:44:23.8827891Z").toISOString() obtendrá "2018-12-31T03:44:23.882Z".

Vea https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl.
getProperties(QueueGetPropertiesOptions)

Obtiene todos los metadatos definidos por el usuario y las propiedades del sistema de la cola especificada. Los metadatos están asociados a la cola como pares de valores de nombre.

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

ADVERTENCIA: El objeto metadata devuelto en la respuesta tendrá sus claves en minúsculas, incluso si originalmente contenían caracteres en mayúsculas. Esto difiere de las claves de metadatos devueltas por el método listQueues de QueueServiceClient mediante la opción includeMetadata, que conservará su mayúscula y minúscula original.
peekMessages(QueuePeekMessagesOptions)

peekMessages recupera uno o varios mensajes desde la parte frontal de la cola, pero no modifica la visibilidad del mensaje.

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

receiveMessages recupera uno o varios mensajes desde la parte frontal de la cola.

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

sendMessage agrega un nuevo mensaje a la parte posterior de una cola. El tiempo de espera de visibilidad especifica cuánto tiempo debe ser invisible el mensaje para las operaciones Dequeue y Peek. El contenido del mensaje tiene un tamaño de hasta 64 KB y debe estar en un formato que se pueda incluir en una solicitud XML con codificación UTF-8. Para incluir el marcado en el mensaje, el contenido del mensaje debe tener un escape XML o codificación Base64.

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

Establece directivas de acceso almacenadas para la cola que se pueden usar con firmas de acceso compartido.

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

Establece uno o varios pares de nombre-valor definidos por el usuario para la cola especificada.

Si no se proporciona ninguna opción o ningún metadato definido en el parámetro de opción, se quitarán los metadatos de la cola.

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

La actualización cambia el tiempo de espera y el contenido de visibilidad de un mensaje. El contenido del mensaje tiene un tamaño de hasta 64 KB y debe estar en un formato que se pueda incluir en una solicitud XML con codificación UTF-8. Para incluir el marcado en el mensaje, el contenido del mensaje debe tener un escape XML o codificación Base64.

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

Detalles del constructor

QueueClient(string, Pipeline)

Crea una instancia de QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parámetros

url

string

Cadena de dirección URL que apunta a la cola de Azure Storage, como "https://myaccount.queue.core.windows.net/myqueue". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Llame a newPipeline() para crear una canalización predeterminada o proporcionar una canalización personalizada.

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

Crea una instancia de QueueClient.

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

Parámetros

url

string

Cadena de dirección URL que apunta a la cola de Azure Storage, como "https://myaccount.queue.core.windows.net/myqueue". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

options
StoragePipelineOptions

Opciones para configurar la canalización HTTP.

QueueClient(string, string, StoragePipelineOptions)

Crea una instancia de QueueClient.

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

Parámetros

connectionString

string

Cadena de conexión de la cuenta o una cadena de conexión saS de una cuenta de almacenamiento de Azure. [ Nota: la cadena de conexión de la cuenta solo se puede usar en NODE.JS tiempo de ejecución. ] Ejemplo de cadena de conexión de cuenta: ejemplo de cadena de conexión saS de 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

Nombre de la cola.

options
StoragePipelineOptions

Opciones para configurar la canalización HTTP.

Detalles de las propiedades

name

Nombre de la cola.

string name

Valor de propiedad

string

Detalles de las propiedades heredadas

accountName 

accountName: string

Valor de propiedad

string

Heredado de StorageClient.accountName

url

Valor de cadena de dirección URL.

url: string

Valor de propiedad

string

se hereda de StorageClient.url

Detalles del método

clearMessages(QueueClearMessagesOptions)

Borrar elimina todos los mensajes de una cola.

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

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

Parámetros

options
QueueClearMessagesOptions

Opciones para borrar la operación de mensajes.

Devoluciones

Promise<MessagesClearResponse>

Datos de respuesta para la operación borrar mensajes.

create(QueueCreateOptions)

Crea una nueva cola en la cuenta especificada.

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

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

Parámetros

options
QueueCreateOptions

Opciones para la operación de creación de colas.

Devoluciones

Promise<QueueCreateResponse>

Datos de respuesta para la operación de creación de colas.

Uso de ejemplo:

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

createIfNotExists(QueueCreateOptions)

Crea una nueva cola en la cuenta especificada si aún no existe. Si la cola ya existe, no se cambia.

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

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

Parámetros

options
QueueCreateOptions

Devoluciones

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Elimina la cola especificada de forma permanente.

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

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

Parámetros

options
QueueDeleteOptions

Opciones para la operación de eliminación de colas.

Devoluciones

Promise<QueueDeleteResponse>

Datos de respuesta para la operación de eliminación de colas.

Uso de ejemplo:

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

deleteIfExists(QueueDeleteOptions)

Elimina la cola especificada de forma permanente si existe.

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

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

Parámetros

options
QueueDeleteOptions

Devoluciones

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage quita permanentemente el mensaje especificado de su cola.

Vea 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. del mensaje.

popReceipt

string

Valor de recibo emergente válido devuelto desde una llamada anterior a la operación de recepción de mensajes o actualización de mensajes.

options
QueueDeleteMessageOptions

Opciones para eliminar la operación del mensaje.

Devoluciones

Promise<MessageIdDeleteResponse>

Datos de respuesta para la operación de eliminación de mensajes.

exists(QueueExistsOptions)

Devuelve true si existe la cola especificada; False en caso contrario.

NOTA: Use esta función con cuidado, ya que otros clientes o aplicaciones pueden eliminar una cola existente. Viceversa, es posible que otros clientes o aplicaciones agreguen nuevas colas después de que se complete esta función.

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

Parámetros

options
QueueExistsOptions

opciones para la operación Exists.

Devoluciones

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

Solo está disponible para QueueClient construido con una credencial de clave compartida.

Genera una cadena para firmar un URI de firma de acceso compartido (SAS) de servicio en función de las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parámetros

options
QueueGenerateSasUrlOptions

Parámetros opcionales.

Devoluciones

string

El URI de SAS que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

generateSasUrl(QueueGenerateSasUrlOptions)

Solo está disponible para QueueClient construido con una credencial de clave compartida.

Genera un URI de firma de acceso compartido (SAS) de servicio basado en las propiedades y parámetros del cliente pasados. La SAS está firmada por la credencial de clave compartida del cliente.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parámetros

options
QueueGenerateSasUrlOptions

Parámetros opcionales.

Devoluciones

string

El URI de SAS que consta del URI del recurso representado por este cliente, seguido del token de SAS generado.

getAccessPolicy(QueueGetAccessPolicyOptions)

Obtiene detalles sobre las directivas de acceso almacenadas especificadas en la cola que se pueden usar con firmas de acceso compartido.

ADVERTENCIA: La fecha de JavaScript podría perder precisión al analizar la cadena de inicio y expiración. Por ejemplo, new Date("2018-12-31T03:44:23.8827891Z").toISOString() obtendrá "2018-12-31T03:44:23.882Z".

Vea https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl.

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

Parámetros

options
QueueGetAccessPolicyOptions

Opciones para poner en cola la operación de la directiva de acceso.

Devoluciones

Promise<QueueGetAccessPolicyResponse>

Datos de respuesta para la operación de directiva de acceso De obtención de acceso de cola.

getProperties(QueueGetPropertiesOptions)

Obtiene todos los metadatos definidos por el usuario y las propiedades del sistema de la cola especificada. Los metadatos están asociados a la cola como pares de valores de nombre.

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

ADVERTENCIA: El objeto metadata devuelto en la respuesta tendrá sus claves en minúsculas, incluso si originalmente contenían caracteres en mayúsculas. Esto difiere de las claves de metadatos devueltas por el método listQueues de QueueServiceClient mediante la opción includeMetadata, que conservará su mayúscula y minúscula original.

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

Parámetros

options
QueueGetPropertiesOptions

Opciones para la operación De obtención de propiedades en cola.

Devoluciones

Promise<QueueGetPropertiesResponse>

Datos de respuesta para la operación De obtención de propiedades de cola.

peekMessages(QueuePeekMessagesOptions)

peekMessages recupera uno o varios mensajes desde la parte frontal de la cola, pero no modifica la visibilidad del mensaje.

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

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

Parámetros

options
QueuePeekMessagesOptions

Opciones para ver la operación de mensajes.

Devoluciones

Promise<QueuePeekMessagesResponse>

Datos de respuesta para la operación de inspección de mensajes.

Uso de ejemplo:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages recupera uno o varios mensajes desde la parte frontal de la cola.

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

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

Parámetros

options
QueueReceiveMessageOptions

Opciones para recibir la operación de mensajes.

Devoluciones

Promise<QueueReceiveMessageResponse>

Datos de respuesta para la operación de recepción de mensajes.

Uso de ejemplo:

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 agrega un nuevo mensaje a la parte posterior de una cola. El tiempo de espera de visibilidad especifica cuánto tiempo debe ser invisible el mensaje para las operaciones Dequeue y Peek. El contenido del mensaje tiene un tamaño de hasta 64 KB y debe estar en un formato que se pueda incluir en una solicitud XML con codificación UTF-8. Para incluir el marcado en el mensaje, el contenido del mensaje debe tener un escape XML o codificación Base64.

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

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

Parámetros

messageText

string

Texto del mensaje que se va a enviar

options
QueueSendMessageOptions

Opciones para enviar la operación de mensajes.

Devoluciones

Promise<QueueSendMessageResponse>

Datos de respuesta para la operación de envío de mensajes.

Uso de ejemplo:

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)

Establece directivas de acceso almacenadas para la cola que se pueden usar con firmas de acceso compartido.

Vea 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

Opciones para poner en cola la operación de directiva de acceso establecida.

Devoluciones

Promise<QueueSetAccessPolicyResponse>

Datos de respuesta para la operación de directiva de acceso del conjunto de colas.

setMetadata(Metadata, QueueSetMetadataOptions)

Establece uno o varios pares de nombre-valor definidos por el usuario para la cola especificada.

Si no se proporciona ninguna opción o ningún metadato definido en el parámetro de opción, se quitarán los metadatos de la cola.

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

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

Parámetros

metadata
Metadata

Si no se proporcionan metadatos, se quitarán todos los metadatos existentes.

options
QueueSetMetadataOptions

Opciones para la operación de metadatos del conjunto de colas.

Devoluciones

Promise<QueueSetMetadataResponse>

Datos de respuesta para la operación de metadatos del conjunto de colas.

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

La actualización cambia el tiempo de espera y el contenido de visibilidad de un mensaje. El contenido del mensaje tiene un tamaño de hasta 64 KB y debe estar en un formato que se pueda incluir en una solicitud XML con codificación UTF-8. Para incluir el marcado en el mensaje, el contenido del mensaje debe tener un escape XML o codificación Base64.

Vea 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

Identificador del mensaje

popReceipt

string

Valor de recibo emergente válido devuelto desde una llamada anterior a la operación de recepción de mensajes o actualización de mensajes.

message

string

Mensaje que se va a actualizar. Si este parámetro no está definido, no se actualizará el contenido del mensaje.

visibilityTimeout

number

Especifica el nuevo valor de tiempo de espera de visibilidad, en segundos, en relación con la hora del servidor. El nuevo valor debe ser mayor o igual que 0 y no puede ser mayor que 7 días. El tiempo de espera de visibilidad de un mensaje no se puede establecer en un valor posterior a la hora de expiración. Un mensaje se puede actualizar hasta que se haya eliminado o haya expirado.

options
QueueUpdateMessageOptions

Opciones para actualizar la operación del mensaje.

Devoluciones

Promise<MessageIdUpdateResponse>

Datos de respuesta para la operación del mensaje de actualización.