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.

Vedere https://docs.microsoft.com/en-us/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.

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

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

Parametri

Restituisce

Dati di risposta per l'operazione di creazione della coda.

Esempio di utilizzo:

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

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

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

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

Parametri

Restituisce

Elimina definitivamente la coda specificata.

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

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

Parametri

Restituisce

Dati di risposta per l'operazione di eliminazione coda.

Esempio di utilizzo:

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

Elimina definitivamente la coda specificata se esiste.

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

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

Parametri

Restituisce

deleteMessage rimuove definitivamente il messaggio specificato dalla coda.

Vedere https://docs.microsoft.com/en-us/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 esiste la coda specificata; false in caso contrario.

NOTA: usare questa funzione con attenzione poiché una coda esistente potrebbe essere eliminata da altri client o applicazioni. Viceversa, le nuove code potrebbero essere aggiunte da altri client o applicazioni al termine di questa funzione.

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

Parametri

Restituisce

Disponibile solo per QueueClient costruito con una credenziale di chiave condivisa.

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

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI alla 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 scadenza. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".

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

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

Parametri

Restituisce

Dati di risposta per l'operazione dei criteri di accesso della coda.

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

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

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

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

Parametri

Restituisce

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

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

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

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

Parametri

Restituisce

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

Esempio di utilizzo:

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.

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

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

Parametri

Restituisce

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

Esempio di utilizzo:

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 quanto tempo il messaggio deve essere invisibile alle operazioni Dequeue e Peek. Il contenuto del messaggio è pari a 64 KB di dimensioni e deve essere incluso in un formato che può essere incluso in una richiesta XML con codifica UTF-8. Per includere commenti nel messaggio, il contenuto del messaggio deve essere in formato XML con caratteri escape o con codifica Base64.

Vedere https://docs.microsoft.com/en-us/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.

Esempio di utilizzo:

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 da utilizzare con firme di accesso condiviso.

Vedere https://docs.microsoft.com/en-us/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 è stata fornita alcuna opzione o nessun metadati definito nel parametro dell'opzione, i metadati della coda verranno rimossi.

Vedere https://docs.microsoft.com/en-us/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 è pari a 64 KB di dimensioni e deve essere incluso in un formato che può essere incluso in una richiesta XML con codifica UTF-8. Per includere commenti nel messaggio, il contenuto del messaggio deve essere in formato XML con caratteri escape o con codifica Base64.

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

Parametri

Restituisce

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