Delen via

QueueClient class

  • Referentie
Pakket:
@azure/storage-queue

Een QueueClient vertegenwoordigt een URL naar de berichten van een Azure Storage-wachtrij, zodat u de bijbehorende berichten kunt bewerken.

Extends

StorageClient

Constructors

QueueClient(string, Pipeline)

Hiermee maakt u een exemplaar van QueueClient.
QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van QueueClient.

Eigenschappen

name

De naam van de wachtrij.

Overgenomen eigenschappen

accountName
url

Waarde van URL-tekenreeks.

Methoden

clearMessages(QueueClearMessagesOptions)

Wissen verwijdert alle berichten uit een wachtrij.

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

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account.

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

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account als deze nog niet bestaat. Als de wachtrij al bestaat, wordt deze niet gewijzigd.

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

Hiermee verwijdert u de opgegeven wachtrij permanent.

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

Hiermee verwijdert u de opgegeven wachtrij permanent als deze bestaat.

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

deleteMessage verwijdert het opgegeven bericht definitief uit de wachtrij.

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

Retourneert true als de opgegeven wachtrij bestaat; anders onwaar.

OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaande wachtrij mogelijk wordt verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe wachtrijen worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
generateSasUrl(QueueGenerateSasUrlOptions)

Alleen beschikbaar voor QueueClient die is samengesteld met een gedeelde sleutelreferentie.

Genereert een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

Hiermee haalt u details op over opgeslagen toegangsbeleidsregels die zijn opgegeven in de wachtrij die kunnen worden gebruikt met Shared Access Signatures.

WAARSCHUWING: JavaScript-datum kan de precisie verloren gaan bij het parseren van de begin- en verloopreeks. Nieuwe Date("2018-12-31T03:44:23.8827891Z"). toISOString() krijgt bijvoorbeeld "2018-12-31T03:44:23.882Z".

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

Hiermee haalt u alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven wachtrij op. Metagegevens zijn gekoppeld aan de wachtrij als naam-waardenparen.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de listQueues methode van QueueServiceClient met behulp van de optie, die hun includeMetadata oorspronkelijke hoofdletters behouden.
peekMessages(QueuePeekMessagesOptions)

peekMessages haalt een of meer berichten op van de voorkant van de wachtrij, maar wijzigt de zichtbaarheid van het bericht niet.

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

receiveMessages haalt een of meer berichten op van de voorkant van de wachtrij.

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

sendMessage voegt een nieuw bericht toe aan de achterkant van een wachtrij. De time-out voor zichtbaarheid geeft aan hoe lang het bericht onzichtbaar moet zijn voor de bewerkingen Dequeue en Peek. De berichtinhoud is maximaal 64 kB groot en moet een indeling hebben die kan worden opgenomen in een XML-aanvraag met UTF-8-codering. Als u markeringen wilt opnemen in het bericht, moet de inhoud van het bericht XML-escaped of Base64-codering zijn.

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

Hiermee stelt u opgeslagen toegangsbeleidsregels in voor de wachtrij die kan worden gebruikt met Shared Access Signatures.

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

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven wachtrij.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van de wachtrij verwijderd.

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

Bijwerken wijzigt de time-out en inhoud van de zichtbaarheid van een bericht. De berichtinhoud is maximaal 64 kB groot en moet een indeling hebben die kan worden opgenomen in een XML-aanvraag met UTF-8-codering. Als u markeringen wilt opnemen in het bericht, moet de inhoud van het bericht XML-escaped of Base64-codering zijn.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

Constructordetails

QueueClient(string, Pipeline)

Hiermee maakt u een exemplaar van QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parameters

url

string

Een URL-tekenreeks die verwijst naar de Azure Storage-wachtrij, zoals 'https://myaccount.queue.core.windows.net/myqueue". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.

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

Hiermee maakt u een exemplaar van QueueClient.

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

Parameters

url

string

Een URL-tekenreeks die verwijst naar de Azure Storage-wachtrij, zoals 'https://myaccount.queue.core.windows.net/myqueue". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.queue.core.windows.net/myqueue?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options
StoragePipelineOptions

Opties voor het configureren van de HTTP-pijplijn.

QueueClient(string, string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van QueueClient.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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

Wachtrijnaam.

options
StoragePipelineOptions

Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

name

De naam van de wachtrij.

string name

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

Overgenomen van StorageClient.accountName

url

Waarde van URL-tekenreeks.

url: string

Waarde van eigenschap

string

Overgenomen van StorageClient.url

Methodedetails

clearMessages(QueueClearMessagesOptions)

Wissen verwijdert alle berichten uit een wachtrij.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages

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

Parameters

options
QueueClearMessagesOptions

Opties voor het wissen van de bewerking van berichten.

Retouren

Promise<MessagesClearResponse>

Antwoordgegevens voor de bewerking Berichten wissen.

create(QueueCreateOptions)

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account.

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

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

Parameters

options
QueueCreateOptions

Opties voor het maken van een wachtrij.

Retouren

Promise<QueueCreateResponse>

Antwoordgegevens voor de bewerking Wachtrij maken.

Gebruiksvoorbeeld:

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

createIfNotExists(QueueCreateOptions)

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account als deze nog niet bestaat. Als de wachtrij al bestaat, wordt deze niet gewijzigd.

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

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

Parameters

options
QueueCreateOptions

Retouren

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Hiermee verwijdert u de opgegeven wachtrij permanent.

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

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

Parameters

options
QueueDeleteOptions

Opties voor het verwijderen van de wachtrij.

Retouren

Promise<QueueDeleteResponse>

Antwoordgegevens voor de bewerking Wachtrij verwijderen.

Gebruiksvoorbeeld:

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

deleteIfExists(QueueDeleteOptions)

Hiermee verwijdert u de opgegeven wachtrij permanent als deze bestaat.

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

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

Parameters

options
QueueDeleteOptions

Retouren

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage verwijdert het opgegeven bericht definitief uit de wachtrij.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2

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

Parameters

messageId

string

Id van het bericht.

popReceipt

string

Een geldige pop-ontvangstbevestiging die is geretourneerd na een eerdere aanroep naar de bewerking berichten ontvangen of bijwerken.

options
QueueDeleteMessageOptions

Opties voor het verwijderen van een berichtbewerking.

Retouren

Promise<MessageIdDeleteResponse>

Antwoordgegevens voor de bewerking bericht verwijderen.

exists(QueueExistsOptions)

Retourneert true als de opgegeven wachtrij bestaat; anders onwaar.

OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaande wachtrij mogelijk wordt verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe wachtrijen worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

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

Parameters

options
QueueExistsOptions

opties voor de bewerking Exists.

Retouren

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

Alleen beschikbaar voor QueueClient die is samengesteld met een gedeelde sleutelreferentie.

Genereert een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parameters

options
QueueGenerateSasUrlOptions

Optionele parameters.

Retouren

string

De SAS-URI die bestaat uit de URI naar de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

getAccessPolicy(QueueGetAccessPolicyOptions)

Hiermee haalt u details op over opgeslagen toegangsbeleidsregels die zijn opgegeven in de wachtrij die kunnen worden gebruikt met Shared Access Signatures.

WAARSCHUWING: JavaScript-datum kan de precisie verloren gaan bij het parseren van de begin- en verloopreeks. Nieuwe Date("2018-12-31T03:44:23.8827891Z"). toISOString() krijgt bijvoorbeeld "2018-12-31T03:44:23.882Z".

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

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

Parameters

options
QueueGetAccessPolicyOptions

Opties voor de bewerking Toegangsbeleid voor wachtrij ophalen.

Retouren

Promise<QueueGetAccessPolicyResponse>

Antwoordgegevens voor de bewerking Toegang tot wachtrij ophalen.

getProperties(QueueGetPropertiesOptions)

Hiermee haalt u alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven wachtrij op. Metagegevens zijn gekoppeld aan de wachtrij als naam-waardenparen.

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

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de listQueues methode van QueueServiceClient met behulp van de optie, die hun includeMetadata oorspronkelijke hoofdletters behouden.

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

Parameters

options
QueueGetPropertiesOptions

Opties voor het ophalen van eigenschappen in wachtrij.

Retouren

Promise<QueueGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen van wachtrij ophalen.

peekMessages(QueuePeekMessagesOptions)

peekMessages haalt een of meer berichten op van de voorkant van de wachtrij, maar wijzigt de zichtbaarheid van het bericht niet.

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

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

Parameters

options
QueuePeekMessagesOptions

Opties voor het weergeven van een berichtbewerking.

Retouren

Promise<QueuePeekMessagesResponse>

Antwoordgegevens voor de bewerking Voor het bekijken van berichten.

Gebruiksvoorbeeld:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages haalt een of meer berichten op van de voorkant van de wachtrij.

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

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

Parameters

options
QueueReceiveMessageOptions

Opties voor het ontvangen van berichtenbewerking.

Retouren

Promise<QueueReceiveMessageResponse>

Antwoordgegevens voor de bewerking berichten ontvangen.

Gebruiksvoorbeeld:

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 voegt een nieuw bericht toe aan de achterkant van een wachtrij. De time-out voor zichtbaarheid geeft aan hoe lang het bericht onzichtbaar moet zijn voor de bewerkingen Dequeue en Peek. De berichtinhoud is maximaal 64 kB groot en moet een indeling hebben die kan worden opgenomen in een XML-aanvraag met UTF-8-codering. Als u markeringen wilt opnemen in het bericht, moet de inhoud van het bericht XML-escaped of Base64-codering zijn.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/put-message

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

Parameters

messageText

string

Tekst van het bericht dat moet worden verzonden

options
QueueSendMessageOptions

Opties voor het verzenden van berichten.

Retouren

Promise<QueueSendMessageResponse>

Antwoordgegevens voor de bewerking voor het verzenden van berichten.

Gebruiksvoorbeeld:

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)

Hiermee stelt u opgeslagen toegangsbeleidsregels in voor de wachtrij die kan worden gebruikt met Shared Access Signatures.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl

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

Parameters

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Opties voor de bewerking Wachtrij instellen van toegangsbeleid.

Retouren

Promise<QueueSetAccessPolicyResponse>

Antwoordgegevens voor de bewerking Voor het toegangsbeleid voor de wachtrijset.

setMetadata(Metadata, QueueSetMetadataOptions)

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven wachtrij.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van de wachtrij verwijderd.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata

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

Parameters

metadata
Metadata

Als er geen metagegevens zijn opgegeven, worden alle bestaande metagegevens verwijderd.

options
QueueSetMetadataOptions

Opties voor de bewerking Voor het instellen van de metagegevens van de wachtrij.

Retouren

Promise<QueueSetMetadataResponse>

Antwoordgegevens voor de bewerking Voor de metagegevens van de wachtrijset.

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

Bijwerken wijzigt de time-out en inhoud van de zichtbaarheid van een bericht. De berichtinhoud is maximaal 64 kB groot en moet een indeling hebben die kan worden opgenomen in een XML-aanvraag met UTF-8-codering. Als u markeringen wilt opnemen in het bericht, moet de inhoud van het bericht XML-escaped of Base64-codering zijn.

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

Parameters

messageId

string

Id van het bericht

popReceipt

string

Een geldige pop-ontvangstbevestiging die is geretourneerd na een eerdere aanroep naar de bewerking berichten ontvangen of bijwerken.

message

string

Bericht dat moet worden bijgewerkt. Als deze parameter niet is gedefinieerd, wordt de inhoud van het bericht niet bijgewerkt.

visibilityTimeout

number

Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van de servertijd. De nieuwe waarde moet groter dan of gelijk zijn aan 0 en mag niet langer zijn dan 7 dagen. De time-out voor zichtbaarheid van een bericht kan niet worden ingesteld op een waarde die later is dan de verlooptijd. Een bericht kan worden bijgewerkt totdat het is verwijderd of is verlopen.

options
QueueUpdateMessageOptions

Opties voor het bijwerken van de berichtbewerking.

Retouren

Promise<MessageIdUpdateResponse>

Antwoordgegevens voor de bewerking van het updatebericht.