Condividi tramite

QueueClient class

  • Riferimento
Pacchetto:
@azure/storage-queue

QueueClient rappresenta un URL per i messaggi della coda di archiviazione di Azure che consentono di modificare i messaggi.

Extends

StorageClient

Costruttori

QueueClient(string, Pipeline)

Crea un'istanza di QueueClient.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un'istanza di QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Crea un'istanza di QueueClient.

Proprietà

name

Nome della coda.

Proprietà ereditate

accountName
url

Valore stringa URL.

Metodi

clearMessages(QueueClearMessagesOptions)

Cancella elimina tutti i messaggi da una coda.

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

Crea una nuova coda nell'account specificato.

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

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
delete(QueueDeleteOptions)

Elimina definitivamente la coda specificata.

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

Elimina definitivamente la coda specificata se esiste.

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

deleteMessage rimuove definitivamente il messaggio specificato dalla coda.

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

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.
generateSasUrl(QueueGenerateSasUrlOptions)

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
getAccessPolicy(QueueGetAccessPolicyOptions)

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
getProperties(QueueGetPropertiesOptions)

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.
peekMessages(QueuePeekMessagesOptions)

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
receiveMessages(QueueReceiveMessageOptions)

receiveMessages recupera uno o più messaggi dalla parte anteriore della coda.

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

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
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

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
setMetadata(Metadata, QueueSetMetadataOptions)

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
updateMessage(string, string, string, number, QueueUpdateMessageOptions)

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

Dettagli costruttore

QueueClient(string, Pipeline)

Crea un'istanza di QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametri

url

string

Stringa URL che punta alla coda di Archiviazione di Azure, ad esempio "https://myaccount.queue.core.windows.net/myqueue". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

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

Crea un'istanza di QueueClient.

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

Parametri

url

string

Stringa URL che punta alla coda di Archiviazione di Azure, ad esempio "https://myaccount.queue.core.windows.net/myqueue". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del @azure/identity pacchetto per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene usata AnonymousCredential.

options
StoragePipelineOptions

Opzioni per configurare la pipeline HTTP.

QueueClient(string, string, StoragePipelineOptions)

Crea un'istanza di QueueClient.

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

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione SAS di un account di archiviazione di Azure. [ Nota : la stringa di connessione dell'account può essere usata solo nel runtime di NODE.JS. ] Esempio di stringa di connessione account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Esempio di stringa di connessione 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 coda.

options
StoragePipelineOptions

Opzioni per configurare la pipeline HTTP.

Dettagli proprietà

name

Nome della coda.

string name

Valore della proprietà

string

Dettagli proprietà ereditate

accountName 

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

url

Valore stringa URL.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

clearMessages(QueueClearMessagesOptions)

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

options
QueueClearMessagesOptions

Opzioni per cancellare l'operazione dei messaggi.

Restituisce

Promise<MessagesClearResponse>

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

create(QueueCreateOptions)

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

options
QueueCreateOptions

Opzioni per la creazione della coda.

Restituisce

Promise<QueueCreateResponse>

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();

createIfNotExists(QueueCreateOptions)

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

options
QueueCreateOptions

Restituisce

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Elimina definitivamente la coda specificata.

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

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

Parametri

options
QueueDeleteOptions

Opzioni per l'operazione di eliminazione coda.

Restituisce

Promise<QueueDeleteResponse>

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
);

deleteIfExists(QueueDeleteOptions)

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

options
QueueDeleteOptions

Restituisce

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

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

messageId

string

ID del messaggio.

popReceipt

string

Valore della ricevuta pop valido restituito da una chiamata precedente all'operazione di ricezione o aggiornamento del messaggio.

options
QueueDeleteMessageOptions

Opzioni per eliminare l'operazione di messaggio.

Restituisce

Promise<MessageIdDeleteResponse>

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

exists(QueueExistsOptions)

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

options
QueueExistsOptions

opzioni per l'operazione Esiste.

Restituisce

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

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

options
QueueGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

string

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

getAccessPolicy(QueueGetAccessPolicyOptions)

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

options
QueueGetAccessPolicyOptions

Opzioni per la coda ottenere l'operazione dei criteri di accesso.

Restituisce

Promise<QueueGetAccessPolicyResponse>

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

getProperties(QueueGetPropertiesOptions)

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

options
QueueGetPropertiesOptions

Opzioni per ottenere le proprietà della coda.

Restituisce

Promise<QueueGetPropertiesResponse>

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

peekMessages(QueuePeekMessagesOptions)

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

options
QueuePeekMessagesOptions

Opzioni per visualizzare le operazioni dei messaggi.

Restituisce

Promise<QueuePeekMessagesResponse>

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(QueueReceiveMessageOptions)

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

options
QueueReceiveMessageOptions

Opzioni per ricevere messaggi operazione.

Restituisce

Promise<QueueReceiveMessageResponse>

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(string, QueueSendMessageOptions)

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

messageText

string

Testo del messaggio da inviare

options
QueueSendMessageOptions

Opzioni per l'invio di messaggi.

Restituisce

Promise<QueueSendMessageResponse>

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
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

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

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Opzioni per impostare l'operazione dei criteri di accesso per la coda.

Restituisce

Promise<QueueSetAccessPolicyResponse>

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

setMetadata(Metadata, QueueSetMetadataOptions)

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

metadata
Metadata

Se non sono stati forniti metadati, tutti i metadati esistenti verranno rimossi.

options
QueueSetMetadataOptions

Opzioni per impostare l'operazione di metadati del set di metadati.

Restituisce

Promise<QueueSetMetadataResponse>

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

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

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

messageId

string

ID del messaggio.

popReceipt

string

Valore della ricevuta pop valido restituito da una chiamata precedente all'operazione di ricezione o aggiornamento del messaggio.

message

string

Messaggio da aggiornare. Se questo parametro non è definito, il contenuto del messaggio non verrà aggiornato.

visibilityTimeout

number

Specifica il nuovo valore di timeout di visibilità, in secondi, rispetto all'ora del server. Il nuovo valore deve essere maggiore o uguale a 0 e non può essere superiore a 7 giorni. Il timeout di visibilità di un messaggio non può essere impostato su un valore successivo all'ora di scadenza. È possibile aggiornare un messaggio finché non scade o non viene eliminato.

options
QueueUpdateMessageOptions

Opzioni per aggiornare l'operazione del messaggio.

Restituisce

Promise<MessageIdUpdateResponse>

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