QueueClient class

Crea un'istanza di QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametri

Crea un'istanza di QueueClient.

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

Parametri

Crea un'istanza di QueueClient.

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

Parametri

Nome della coda.

string name

Valore della proprietà

accountName: string

Valore della proprietà

Ereditato da StorageClient.accountName

Valore stringa URL.

url: string

Valore della proprietà

Ereditato da StorageClient.url

Cancella elimina tutti i messaggi da una coda.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/clear-messages

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

Parametri

Restituisce

Dati di risposta per l'operazione di cancellazione dei messaggi.

Crea una nuova coda nell'account specificato.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Parametri

Restituisce

Dati di risposta per l'operazione di creazione coda.

Example usage:

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

Crea una nuova coda nell'account specificato, se non esiste già. Se la coda esiste già, non viene modificata.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Parametri

Restituisce

Elimina definitivamente la coda specificata.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Parametri

Restituisce

Dati di risposta per l'operazione di eliminazione coda.

Example usage:

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

Elimina la coda specificata in modo permanente, se presente.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Parametri

Restituisce

deleteMessage rimuove definitivamente il messaggio specificato dalla coda.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/delete-message2

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

Parametri

Restituisce

Dati di risposta per l'operazione di eliminazione del messaggio.

Restituisce true se la coda specificata esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché una coda esistente potrebbe essere eliminata da altri client o applicazioni. Viceversa, è possibile aggiungere nuove code da altri client o applicazioni al termine di questa funzione.

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

Parametri

Restituisce

Disponibile solo per QueueClient costruito con credenziali chiave condivise.

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Disponibile solo per QueueClient costruito con credenziali chiave condivise.

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Ottiene informazioni dettagliate sui criteri di accesso archiviati specificati nella coda che possono essere usati con firme di accesso condiviso.

AVVISO: La data JavaScript potrebbe perdere precisione durante l'analisi della stringa di inizio e di scadenza. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/get-queue-acl

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

Parametri

Restituisce

Dati di risposta per l'operazione dei criteri di accesso get queue.

Ottiene tutti i metadati e le proprietà di sistema definiti dall'utente per la coda specificata. I metadati sono associati alla coda come coppie nome-valore.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata

AVVISO: l'oggetto metadata restituito nella risposta avrà le relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dal metodo listQueues di QueueServiceClient usando l'opzione includeMetadata, che manterrà la combinazione di maiuscole e minuscole originali.

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

Parametri

Restituisce

Dati di risposta per l'operazione Di recupero delle proprietà queue.

peekMessages recupera uno o più messaggi dalla parte anteriore della coda, ma non modifica la visibilità del messaggio.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/peek-messages

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

Parametri

Restituisce

Dati di risposta per l'operazione di visualizzazione dei messaggi.

Example usage:

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 uno o più messaggi dalla parte anteriore della coda.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/get-messages

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

Parametri

Restituisce

Dati di risposta per l'operazione di ricezione dei messaggi.

Example usage:

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 aggiunge un nuovo messaggio alla parte posteriore di una coda. Il timeout di visibilità specifica per quanto tempo il messaggio deve essere invisibile alle operazioni Dequeue e Peek. Il contenuto del messaggio è di dimensioni fino a 64 KB e deve essere in un formato che può essere incluso in una richiesta XML con codifica UTF-8. Per includere markup nel messaggio, il contenuto del messaggio deve essere con escape XML o con codifica Base64.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/put-message

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

Parametri

Restituisce

Dati di risposta per l'operazione di invio dei messaggi.

Example usage:

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

Imposta i criteri di accesso archiviati per la coda che può essere usata con firme di accesso condiviso.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/set-queue-acl

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

Parametri

Restituisce

Dati di risposta per l'operazione dei criteri di accesso del set di code.

Imposta una o più coppie nome-valore definite dall'utente per la coda specificata.

Se non viene specificata alcuna opzione o nessun metadati definito nel parametro di opzione, i metadati della coda verranno rimossi.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata

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

Parametri

Restituisce

Dati di risposta per l'operazione di metadati del set di code.

Aggiorna modifica il timeout e il contenuto della visibilità di un messaggio. Il contenuto del messaggio è di dimensioni fino a 64 KB e deve essere in un formato che può essere incluso in una richiesta XML con codifica UTF-8. Per includere markup nel messaggio, il contenuto del messaggio deve essere con escape XML o con codifica Base64.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/update-message

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

Parametri

Restituisce

Dati di risposta per l'operazione di aggiornamento del messaggio.