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 berichten kunt bewerken.

Uitbreiding

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

URL-tekenreekswaarde.

Methoden

clearMessages(QueueClearMessagesOptions)

Alle berichten uit een wachtrij verwijderen.

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 waar als de opgegeven wachtrij bestaat; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaande wachtrij kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe wachtrijen worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
generateSasStringToSign(QueueGenerateSasUrlOptions)

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

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor 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
generateSasUrl(QueueGenerateSasUrlOptions)

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

Hiermee genereert u 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 worden details opgehaald over opgeslagen toegangsbeleid dat is opgegeven in de wachtrij die kan worden gebruikt met Shared Access Signatures.

WAARSCHUWING: JavaScript-datum kan verloren precisie gaan bij het parseren van de begin- en vervaldatumtekenreeks. Nieuwe datum("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 worden alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven wachtrij opgehaald. Metagegevens worden 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, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de listQueues methode van QueueServiceClient met behulp van de optie includeMetadata, waarmee de oorspronkelijke behuizing wordt behouden.
peekMessages(QueuePeekMessagesOptions)

peekMessages haalt een of meer berichten van de voorzijde van de wachtrij op, 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 voorzijde 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 inhoud van het bericht 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 in het bericht wilt opnemen, 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 toegangsbeleid 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)

De zichtbaarheidstime-out en inhoud van een bericht bijwerken. De inhoud van het bericht 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 in het bericht wilt opnemen, 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 geef een aangepaste pijplijn op.

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 referenties van 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

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - 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

URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen van StorageClient.url

Methodedetails

clearMessages(QueueClearMessagesOptions)

Alle berichten uit een wachtrij verwijderen.

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

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

Parameters

options
QueueClearMessagesOptions

Opties om de berichtenbewerking te wissen.

Retouren

Promise<MessagesClearResponse>

Antwoordgegevens voor de bewerking duidelijke berichten.

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

Retouren

Promise<QueueCreateResponse>

Antwoordgegevens voor de bewerking Wachtrij maken.

Voorbeeldgebruik:

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

Retouren

Promise<QueueDeleteResponse>

Antwoordgegevens voor de verwijderbewerking wachtrij.

Voorbeeldgebruik:

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-ontvangstbevestigingswaarde die is geretourneerd door een eerdere aanroep naar de ontvangst van berichten of het bijwerken van een berichtbewerking.

options
QueueDeleteMessageOptions

Opties voor het verwijderen van een berichtbewerking.

Retouren

Promise<MessageIdDeleteResponse>

Antwoordgegevens voor de verwijderberichtbewerking.

exists(QueueExistsOptions)

Retourneert waar als de opgegeven wachtrij bestaat; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaande wachtrij kan worden 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 bestaat bewerking.

Retouren

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

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

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor 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 generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parameters

options
QueueGenerateSasUrlOptions

Optionele parameters.

Retouren

string

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

generateSasUrl(QueueGenerateSasUrlOptions)

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

Hiermee genereert u 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 voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

getAccessPolicy(QueueGetAccessPolicyOptions)

Hiermee worden details opgehaald over opgeslagen toegangsbeleid dat is opgegeven in de wachtrij die kan worden gebruikt met Shared Access Signatures.

WAARSCHUWING: JavaScript-datum kan verloren precisie gaan bij het parseren van de begin- en vervaldatumtekenreeks. Nieuwe datum("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 queue get access policy operation.

Retouren

Promise<QueueGetAccessPolicyResponse>

Antwoordgegevens voor de wachtrij krijgen toegangsbeleidsbewerking.

getProperties(QueueGetPropertiesOptions)

Hiermee worden alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven wachtrij opgehaald. Metagegevens worden 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, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de listQueues methode van QueueServiceClient met behulp van de optie includeMetadata, waarmee de oorspronkelijke behuizing wordt 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 Wachtrij eigenschappen ophalen.

peekMessages(QueuePeekMessagesOptions)

peekMessages haalt een of meer berichten van de voorzijde van de wachtrij op, 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 bekijken van berichtenbewerkingen.

Retouren

Promise<QueuePeekMessagesResponse>

Antwoordgegevens voor de bewerking Berichten bekijken.

Voorbeeldgebruik:

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

Retouren

Promise<QueueReceiveMessageResponse>

Antwoordgegevens voor de bewerking berichten ontvangen.

Voorbeeldgebruik:

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 inhoud van het bericht 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 in het bericht wilt opnemen, 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 Berichten verzenden.

Voorbeeldgebruik:

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 toegangsbeleid 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 het instellen van toegangsbeleidsbewerking in wachtrij.

Retouren

Promise<QueueSetAccessPolicyResponse>

Antwoordgegevens voor de bewerking Toegangsbeleid in wachtrij instellen.

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 worden opgegeven, worden alle bestaande metagegevens verwijderd.

options
QueueSetMetadataOptions

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

Retouren

Promise<QueueSetMetadataResponse>

Antwoordgegevens voor de bewerking met metagegevens van de wachtrijset.

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

De zichtbaarheidstime-out en inhoud van een bericht bijwerken. De inhoud van het bericht 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 in het bericht wilt opnemen, 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-ontvangstbevestigingswaarde die is geretourneerd door een eerdere aanroep naar de ontvangst van berichten of het bijwerken van een berichtbewerking.

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 servertijd. De nieuwe waarde moet groter zijn dan of gelijk zijn aan 0 en mag niet groter zijn dan 7 dagen. De time-out voor zichtbaarheid van een bericht kan niet worden ingesteld op een waarde later 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 updateberichtbewerking.