QueueClient class

Pacchetto:: @azure/storage-queue

QueueClient rappresenta un URL per i messaggi di una coda di archiviazione di Azure che consente 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à

accountName
name	Nome della coda.
url	Valore stringa URL.

Metodi

clearMessages(QueueClearMessagesOptions)	Cancella elimina tutti i messaggi da una coda.
create(QueueCreateOptions)	Crea una nuova coda nell'account specificato.
createIfNotExists(QueueCreateOptions)	Crea una nuova coda nell'account specificato, se non esiste già. Se la coda esiste già, non viene modificata.
delete(QueueDeleteOptions)	Elimina definitivamente la coda specificata.
deleteIfExists(QueueDeleteOptions)	Elimina la coda specificata in modo permanente, se presente.
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage rimuove definitivamente il messaggio specificato dalla coda.
exists(QueueExistsOptions)	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.
generateSasUrl(QueueGenerateSasUrlOptions)	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.
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 di scadenza. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".
getProperties(QueueGetPropertiesOptions)	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.
peekMessages(QueuePeekMessagesOptions)	peekMessages recupera uno o più messaggi dalla parte anteriore della coda, ma non modifica la visibilità del messaggio.
receiveMessages(QueueReceiveMessageOptions)	receiveMessages recupera uno o più messaggi dalla parte anteriore della coda.
sendMessage(string, QueueSendMessageOptions)	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.
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Imposta i criteri di accesso archiviati per la coda che può essere usata con firme di accesso condiviso.
setMetadata(Metadata, QueueSetMetadataOptions)	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.
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	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.

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato 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 in NODE.JS runtime. ] Esempio di stringa di connessione dell'account - Esempio di stringa di connessione sas 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

Nome coda.

options: StoragePipelineOptions

Opzioni per configurare la pipeline HTTP.

Dettagli proprietà

accountName

accountName: string

Valore della proprietà

string

name

Nome della coda.

string name

Valore della proprietà

string

url

Valore stringa URL.

url: string

Valore della proprietà

string

Dettagli metodo

clearMessages(QueueClearMessagesOptions)

Cancella elimina tutti i messaggi da una coda.

function clearMessages(options?: QueueClearMessagesOptions)

Parametri

options: QueueClearMessagesOptions

Opzioni per cancellare l'operazione dei messaggi.

Restituisce

Promise<QueueClearMessagesResponse>

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

create(QueueCreateOptions)

Crea una nuova coda nell'account specificato.

function create(options?: QueueCreateOptions)

Parametri

options: QueueCreateOptions

Opzioni per accodare l'operazione di creazione.

Restituisce

Promise<QueueCreateResponse>

Dati di risposta per l'operazione di creazione 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.

function createIfNotExists(options?: QueueCreateOptions)

Parametri

options: QueueCreateOptions

Restituisce

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Elimina definitivamente la coda specificata.

function delete(options?: QueueDeleteOptions)

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 la coda specificata in modo permanente, se presente.

function deleteIfExists(options?: QueueDeleteOptions)

Parametri

options: QueueDeleteOptions

Restituisce

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage rimuove definitivamente il messaggio specificato dalla coda.

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions)

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

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

exists(QueueExistsOptions)

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)

Parametri

options: QueueExistsOptions

opzioni per l'operazione Exists.

Restituisce

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

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.

function generateSasUrl(options: QueueGenerateSasUrlOptions)

Parametri

options: QueueGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

string

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

function getAccessPolicy(options?: QueueGetAccessPolicyOptions)

Parametri

options: QueueGetAccessPolicyOptions

Opzioni per accodare l'operazione di recupero dei criteri di accesso.

Restituisce

Promise<QueueGetAccessPolicyResponse>

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

getProperties(QueueGetPropertiesOptions)

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.

function getProperties(options?: QueueGetPropertiesOptions)

Parametri

options: QueueGetPropertiesOptions

Opzioni per l'operazione Di accodamento delle proprietà get.

Restituisce

Promise<QueueGetPropertiesResponse>

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

peekMessages(QueuePeekMessagesOptions)

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

function peekMessages(options?: QueuePeekMessagesOptions)

Parametri

options: QueuePeekMessagesOptions

Opzioni per visualizzare l'operazione 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.

function receiveMessages(options?: QueueReceiveMessageOptions)

Parametri

options: QueueReceiveMessageOptions

Opzioni per la ricezione di messaggi.

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

function sendMessage(messageText: string, options?: QueueSendMessageOptions)

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 che può essere usata con firme di accesso condiviso.

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions)

Parametri

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

Opzioni per impostare l'operazione dei criteri di accesso per l'impostazione della 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 viene specificata alcuna opzione o nessun metadati definito nel parametro di opzione, i metadati della coda verranno rimossi.

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions)

Parametri

metadata: Metadata

Se non vengono forniti metadati, tutti i metadati esistenti verranno rimossi.

options: QueueSetMetadataOptions

Opzioni per l'operazione di impostazione dei metadati della coda.

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

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions)

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à, espresso in secondi, rispetto al tempo del server. Il nuovo valore deve essere maggiore o uguale a 0 e non può essere maggiore di 7 giorni. Il timeout di visibilità di un messaggio non può essere impostato su un valore successivo all'ora di scadenza. Un messaggio può essere aggiornato fino a quando non è stato eliminato o è scaduto.

options: QueueUpdateMessageOptions

Opzioni per aggiornare l'operazione del messaggio.

Restituisce

Promise<QueueUpdateMessageResponse>

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

Commenti e suggerimenti

Questa pagina è stata utile?

Condividi tramite

QueueClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

QueueClient(string, Pipeline)

Parametri

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

Parametri

QueueClient(string, string, StoragePipelineOptions)

Parametri

Dettagli proprietà

accountName

Valore della proprietà

name

Valore della proprietà

url

Valore della proprietà

Dettagli metodo

clearMessages(QueueClearMessagesOptions)

Parametri

Restituisce

create(QueueCreateOptions)

Parametri

Restituisce

createIfNotExists(QueueCreateOptions)

Parametri

Restituisce

delete(QueueDeleteOptions)

Parametri

Restituisce

deleteIfExists(QueueDeleteOptions)

Parametri

Restituisce

deleteMessage(string, string, QueueDeleteMessageOptions)

Parametri

Restituisce

exists(QueueExistsOptions)

Parametri

Restituisce

generateSasUrl(QueueGenerateSasUrlOptions)

Parametri

Restituisce

getAccessPolicy(QueueGetAccessPolicyOptions)

Parametri

Restituisce

getProperties(QueueGetPropertiesOptions)

Parametri

Restituisce

peekMessages(QueuePeekMessagesOptions)

Parametri

Restituisce

receiveMessages(QueueReceiveMessageOptions)

Parametri

Restituisce

sendMessage(string, QueueSendMessageOptions)

Parametri

Restituisce

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Parametri

Restituisce

setMetadata(Metadata, QueueSetMetadataOptions)

Parametri

Restituisce

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

Parametri

Restituisce

Commenti e suggerimenti