Dela via

QueueClient class

  • Referens
Paket:
@azure/storage-queue

En QueueClient representerar en URL till en Azure Storage-kös meddelanden så att du kan ändra dess meddelanden.

Extends

StorageClient

Konstruktorer

QueueClient(string, Pipeline)

Skapar en instans av QueueClient.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar en instans av QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Skapar en instans av QueueClient.

Egenskaper

name

Namnet på kön.

Ärvda egenskaper

accountName
url

URL-strängvärde.

Metoder

clearMessages(QueueClearMessagesOptions)

Rensa tar bort alla meddelanden från en kö.

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

Skapar en ny kö under det angivna kontot.

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

Skapar en ny kö under det angivna kontot om den inte redan finns. Om kön redan finns ändras den inte.

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

Tar bort den angivna kön permanent.

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

Tar bort den angivna kön permanent om den finns.

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

deleteMessage tar bort det angivna meddelandet permanent från kön.

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

Returnerar sant om den angivna kön finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig kö kan tas bort av andra klienter eller program. Vice versa nya köer kan läggas till av andra klienter eller program när den här funktionen har slutförts.
generateSasStringToSign(QueueGenerateSasUrlOptions)

Endast tillgängligt för QueueClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

Endast tillgängligt för QueueClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

Hämtar information om lagrade åtkomstprinciper som anges i kön som kan användas med signaturer för delad åtkomst.

VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

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

Hämtar alla användardefinierade metadata och systemegenskaper för den angivna kön. Metadata associeras med kön som namn/värden-par.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoden listQueues för QueueServiceClient med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.
peekMessages(QueuePeekMessagesOptions)

peekMessages hämtar ett eller flera meddelanden längst fram i kön, men ändrar inte meddelandets synlighet.

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

receiveMessages hämtar ett eller flera meddelanden längst fram i kön.

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

sendMessage lägger till ett nytt meddelande på baksidan av en kö. Tidsgränsen för synlighet anger hur länge meddelandet ska vara osynligt för åtgärderna Dequeue och Peek. Meddelandeinnehållet är upp till 64 KB stort och måste vara i ett format som kan ingå i en XML-begäran med UTF-8-kodning. Om du vill inkludera markering i meddelandet måste innehållet i meddelandet antingen vara XML-escape eller Base64-encode.

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

Anger lagrade åtkomstprinciper för kön som kan användas med signaturer för delad åtkomst.

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

Anger ett eller flera användardefinierade namn/värde-par för den angivna kön.

Om inget alternativ har angetts, eller om inga metadata har definierats i alternativparametern, tas kömetadata bort.

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

Uppdatera ändrar ett meddelandes synlighetstimeout och innehåll. Meddelandeinnehållet är upp till 64 KB stort och måste vara i ett format som kan ingå i en XML-begäran med UTF-8-kodning. Om du vill inkludera markering i meddelandet måste innehållet i meddelandet antingen vara XML-escape eller Base64-encode.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/update-message

Konstruktorinformation

QueueClient(string, Pipeline)

Skapar en instans av QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-kön, till exempel "https://myaccount.queue.core.windows.net/myqueue". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av QueueClient.

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

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-kön, till exempel "https://myaccount.queue.core.windows.net/myqueue". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

options
StoragePipelineOptions

Alternativ för att konfigurera HTTP-pipelinen.

QueueClient(string, string, StoragePipelineOptions)

Skapar en instans av QueueClient.

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

Parametrar

connectionString

string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

Könamn.

options
StoragePipelineOptions

Alternativ för att konfigurera HTTP-pipelinen.

Egenskapsinformation

name

Namnet på kön.

string name

Egenskapsvärde

string

Information om ärvda egenskaper

accountName 

accountName: string

Egenskapsvärde

string

ärvd från StorageClient.accountName

url

URL-strängvärde.

url: string

Egenskapsvärde

string

ärvd från StorageClient.url

Metodinformation

clearMessages(QueueClearMessagesOptions)

Rensa tar bort alla meddelanden från en kö.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/clear-messages

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

Parametrar

options
QueueClearMessagesOptions

Alternativ för att rensa meddelanden.

Returer

Promise<MessagesClearResponse>

Svarsdata för åtgärden rensa meddelanden.

create(QueueCreateOptions)

Skapar en ny kö under det angivna kontot.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Parametrar

options
QueueCreateOptions

Alternativ för att skapa köåtgärd.

Returer

Promise<QueueCreateResponse>

Svarsdata för åtgärden Skapa kö.

Exempel på användning:

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

createIfNotExists(QueueCreateOptions)

Skapar en ny kö under det angivna kontot om den inte redan finns. Om kön redan finns ändras den inte.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Parametrar

options
QueueCreateOptions

Returer

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Tar bort den angivna kön permanent.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Parametrar

options
QueueDeleteOptions

Alternativ för borttagning av kö.

Returer

Promise<QueueDeleteResponse>

Svarsdata för borttagningsåtgärden Kö.

Exempel på användning:

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

deleteIfExists(QueueDeleteOptions)

Tar bort den angivna kön permanent om den finns.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Parametrar

options
QueueDeleteOptions

Returer

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage tar bort det angivna meddelandet permanent från kön.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/delete-message2

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

Parametrar

messageId

string

Id för meddelandet.

popReceipt

string

Ett giltigt pop-kvittovärde som returnerades från ett tidigare anrop till åtgärden ta emot meddelanden eller uppdatera meddelanden.

options
QueueDeleteMessageOptions

Alternativ för att ta bort meddelandeåtgärden.

Returer

Promise<MessageIdDeleteResponse>

Svarsdata för åtgärden ta bort meddelande.

exists(QueueExistsOptions)

Returnerar sant om den angivna kön finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig kö kan tas bort av andra klienter eller program. Vice versa nya köer kan läggas till av andra klienter eller program när den här funktionen har slutförts.

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

Parametrar

options
QueueExistsOptions

alternativ för åtgärden Finns.

Returer

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

Endast tillgängligt för QueueClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parametrar

options
QueueGenerateSasUrlOptions

Valfria parametrar.

Returer

string

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

generateSasUrl(QueueGenerateSasUrlOptions)

Endast tillgängligt för QueueClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametrar

options
QueueGenerateSasUrlOptions

Valfria parametrar.

Returer

string

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

getAccessPolicy(QueueGetAccessPolicyOptions)

Hämtar information om lagrade åtkomstprinciper som anges i kön som kan användas med signaturer för delad åtkomst.

VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

Se https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-acl

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

Parametrar

options
QueueGetAccessPolicyOptions

Alternativ för att köa hämta åtkomstprincipåtgärd.

Returer

Promise<QueueGetAccessPolicyResponse>

Svarsdata för åtgärden Queue get access policy (Hämta åtkomstprincip).

getProperties(QueueGetPropertiesOptions)

Hämtar alla användardefinierade metadata och systemegenskaper för den angivna kön. Metadata associeras med kön som namn/värden-par.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoden listQueues för QueueServiceClient med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.

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

Parametrar

options
QueueGetPropertiesOptions

Alternativ för att köa åtgärden Hämta egenskaper.

Returer

Promise<QueueGetPropertiesResponse>

Svarsdata för åtgärden Hämta egenskaper i kön.

peekMessages(QueuePeekMessagesOptions)

peekMessages hämtar ett eller flera meddelanden längst fram i kön, men ändrar inte meddelandets synlighet.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/peek-messages

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

Parametrar

options
QueuePeekMessagesOptions

Alternativ för att granska meddelanden.

Returer

Promise<QueuePeekMessagesResponse>

Svarsdata för åtgärden granska meddelanden.

Exempel på användning:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages hämtar ett eller flera meddelanden längst fram i kön.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/get-messages

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

Parametrar

options
QueueReceiveMessageOptions

Alternativ för att ta emot meddelanden.

Returer

Promise<QueueReceiveMessageResponse>

Svarsdata för åtgärden ta emot meddelanden.

Exempel på användning:

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 lägger till ett nytt meddelande på baksidan av en kö. Tidsgränsen för synlighet anger hur länge meddelandet ska vara osynligt för åtgärderna Dequeue och Peek. Meddelandeinnehållet är upp till 64 KB stort och måste vara i ett format som kan ingå i en XML-begäran med UTF-8-kodning. Om du vill inkludera markering i meddelandet måste innehållet i meddelandet antingen vara XML-escape eller Base64-encode.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/put-message

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

Parametrar

messageText

string

Text på meddelandet som ska skickas

options
QueueSendMessageOptions

Alternativ för att skicka meddelanden.

Returer

Promise<QueueSendMessageResponse>

Svarsdata för åtgärden skicka meddelanden.

Exempel på användning:

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)

Anger lagrade åtkomstprinciper för kön som kan användas med signaturer för delad åtkomst.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-acl

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

Parametrar

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Alternativ för att ange åtkomstprincipåtgärd i kö.

Returer

Promise<QueueSetAccessPolicyResponse>

Svarsdata för åtkomstprincipåtgärden Köuppsättning.

setMetadata(Metadata, QueueSetMetadataOptions)

Anger ett eller flera användardefinierade namn/värde-par för den angivna kön.

Om inget alternativ har angetts, eller om inga metadata har definierats i alternativparametern, tas kömetadata bort.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata

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

Parametrar

metadata
Metadata

Om inga metadata tillhandahålls tas alla befintliga metadata bort.

options
QueueSetMetadataOptions

Alternativ för att ställa in metadataåtgärd i kö.

Returer

Promise<QueueSetMetadataResponse>

Svarsdata för metadataåtgärden Köuppsättning.

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

Uppdatera ändrar ett meddelandes synlighetstimeout och innehåll. Meddelandeinnehållet är upp till 64 KB stort och måste vara i ett format som kan ingå i en XML-begäran med UTF-8-kodning. Om du vill inkludera markering i meddelandet måste innehållet i meddelandet antingen vara XML-escape eller Base64-encode.

Se https://learn.microsoft.com/en-us/rest/api/storageservices/update-message

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

Parametrar

messageId

string

ID för meddelandet

popReceipt

string

Ett giltigt pop-kvittovärde som returnerades från ett tidigare anrop till åtgärden ta emot meddelanden eller uppdatera meddelanden.

message

string

Meddelande som ska uppdateras. Om den här parametern är odefinierad uppdateras inte innehållet i meddelandet.

visibilityTimeout

number

Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertid. Det nya värdet måste vara större än eller lika med 0 och får inte vara större än 7 dagar. Tidsgränsen för synlighet för ett meddelande kan inte anges till ett värde senare än förfallotiden. Ett meddelande kan uppdateras tills det har tagits bort eller har upphört att gälla.

options
QueueUpdateMessageOptions

Alternativ för att uppdatera meddelandeåtgärden.

Returer

Promise<MessageIdUpdateResponse>

Svarsdata för uppdateringsmeddelandeåtgärden.