Freigeben über


QueueClient class

Ein QueueClient stellt eine URL zu den Nachrichten einer Azure Storage-Warteschlange dar, mit der Sie deren Nachrichten bearbeiten können.

Extends

Konstruktoren

QueueClient(string, Pipeline)

Erstellt eine Instanz von QueueClient.

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

Erstellt eine Instanz von QueueClient.

QueueClient(string, string, StoragePipelineOptions)

Erstellt eine Instanz von QueueClient.

Eigenschaften

name

Der Name der Warteschlange.

Geerbte Eigenschaften

accountName
url

URL-Zeichenfolgenwert.

Methoden

clearMessages(QueueClearMessagesOptions)

Löschen löscht alle Nachrichten aus einer Warteschlange.

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

create(QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto.

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

createIfNotExists(QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto, sofern sie noch nicht vorhanden ist. Wenn die Warteschlange bereits vorhanden ist, wird sie nicht geändert.

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

delete(QueueDeleteOptions)

Löscht die angegebene Warteschlange dauerhaft.

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

deleteIfExists(QueueDeleteOptions)

Löscht die angegebene Warteschlange dauerhaft, sofern sie vorhanden ist.

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

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage entfernt die angegebene Nachricht dauerhaft aus der Warteschlange.

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

exists(QueueExistsOptions)

Gibt true zurück, wenn die angegebene Warteschlange vorhanden ist. false andernfalls. HINWEIS: Verwenden Sie diese Funktion sorgfältig, da eine vorhandene Warteschlange möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Warteschlangen von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

generateSasUrl(QueueGenerateSasUrlOptions)

Nur verfügbar für QueueClient, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde. Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

getAccessPolicy(QueueGetAccessPolicyOptions)

Ruft Details zu allen gespeicherten Zugriffsrichtlinien ab, die in der Warteschlange angegeben sind, die möglicherweise mit Shared Access Signatures verwendet werden. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge an Genauigkeit verlieren. New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".

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

getProperties(QueueGetPropertiesOptions)

Ruft alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Wert-Paare zugeordnet.

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

WARNUNG: Das metadata in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von der listQueues Methode der Verwendung der QueueServiceClientincludeMetadata Option zurückgegeben werden, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.

peekMessages(QueuePeekMessagesOptions)

peekMessages ruft eine oder mehrere Nachrichten von der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht.

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages ruft eine oder mehrere Nachrichten von der Front der Warteschlange ab.

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

sendMessage(string, QueueSendMessageOptions)

sendMessage fügt eine neue Nachricht an der Rückseite einer Warteschlange hinzu. Das Sichtbarkeitstimeout gibt an, wie lange die Nachricht für Dequeue- und Peek-Vorgänge unsichtbar sein soll. Der Nachrichteninhalt hat eine Größe von bis zu 64 KB und muss in einem Format vorliegen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Zum Einbeziehen des Markups in der Nachricht müssen Inhalte der Nachricht entweder XML-escaped oder Base64-codiert sein.

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

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit SAS (Shared Access Signature) verwendet werden können.

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

setMetadata(Metadata, QueueSetMetadataOptions)

Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für die angegebene Warteschlange fest. Wenn keine Option oder keine im Optionsparameter definierten Metadaten angegeben sind, werden die Warteschlangenmetadaten entfernt.

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

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

Aktualisieren sie das Sichtbarkeitstimeout und den Inhalt einer Nachricht. Der Nachrichteninhalt hat eine Größe von bis zu 64 KB und muss in einem Format vorliegen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Zum Einbeziehen des Markups in der Nachricht müssen Inhalte der Nachricht entweder XML-escaped oder Base64-codiert sein.

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

Details zum Konstruktor

QueueClient(string, Pipeline)

Erstellt eine Instanz von QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parameter

url

string

Eine URL-Zeichenfolge, die auf die Azure Storage-Warteschlange verweist, z. B. "https://myaccount.queue.core.windows.net/myqueue"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.queue.core.windows.net/myqueue?sasString"".

pipeline
Pipeline

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

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

Erstellt eine Instanz von QueueClient.

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

Parameter

url

string

Eine URL-Zeichenfolge, die auf die Azure Storage-Warteschlange verweist, z. B. "https://myaccount.queue.core.windows.net/myqueue"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.queue.core.windows.net/myqueue?sasString"".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

z. B. AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Falls nicht angegeben, wird AnonymousCredential verwendet.

options
StoragePipelineOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

QueueClient(string, string, StoragePipelineOptions)

Erstellt eine Instanz von QueueClient.

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

Parameter

connectionString

string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für die Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolgenbeispiel: 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

Warteschlangenname.

options
StoragePipelineOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Eigenschaft

name

Der Name der Warteschlange.

string name

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName

accountName: string

Eigenschaftswert

string

Geerbt vonStorageClient.accountName

url

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt vonStorageClient.url

Details zur Methode

clearMessages(QueueClearMessagesOptions)

Löschen löscht alle Nachrichten aus einer Warteschlange.

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

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

Parameter

options
QueueClearMessagesOptions

Optionen zum Löschen von Nachrichtenvorgängen.

Gibt zurück

Antwortdaten für den Vorgang "Klare Nachrichten".

create(QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto.

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

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

Parameter

options
QueueCreateOptions

Optionen zum Warteschlangenerstellungsvorgang.

Gibt zurück

Antwortdaten für den Vorgang "Warteschlangenerstellung".

Beispielverwendung:

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

createIfNotExists(QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto, sofern sie noch nicht vorhanden ist. Wenn die Warteschlange bereits vorhanden ist, wird sie nicht geändert.

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

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

Parameter

Gibt zurück

delete(QueueDeleteOptions)

Löscht die angegebene Warteschlange dauerhaft.

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

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

Parameter

options
QueueDeleteOptions

Optionen zum Warteschlangenlöschvorgang.

Gibt zurück

Antwortdaten für den Warteschlangenlöschvorgang.

Beispielverwendung:

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

deleteIfExists(QueueDeleteOptions)

Löscht die angegebene Warteschlange dauerhaft, sofern sie vorhanden ist.

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

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

Parameter

Gibt zurück

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage entfernt die angegebene Nachricht dauerhaft aus der Warteschlange.

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

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

Parameter

messageId

string

ID der Nachricht.

popReceipt

string

Ein gültiger Popquittungswert, der von einem früheren Aufruf des Empfangs- oder Aktualisierungsvorgangs zurückgegeben wurde.

options
QueueDeleteMessageOptions

Optionen zum Löschen des Nachrichtenvorgangs.

Gibt zurück

Antwortdaten für den Vorgang zum Löschen von Nachrichten.

exists(QueueExistsOptions)

Gibt true zurück, wenn die angegebene Warteschlange vorhanden ist. false andernfalls. HINWEIS: Verwenden Sie diese Funktion sorgfältig, da eine vorhandene Warteschlange möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Warteschlangen von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

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

Parameter

options
QueueExistsOptions

Options to Exists-Vorgang.

Gibt zurück

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

Nur verfügbar für QueueClient, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde. Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parameter

options
QueueGenerateSasUrlOptions

Optionale Parameter.

Gibt zurück

string

Der SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.

getAccessPolicy(QueueGetAccessPolicyOptions)

Ruft Details zu allen gespeicherten Zugriffsrichtlinien ab, die in der Warteschlange angegeben sind, die möglicherweise mit Shared Access Signatures verwendet werden. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge an Genauigkeit verlieren. New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".

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

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

Parameter

options
QueueGetAccessPolicyOptions

Optionen zum Warteschlangenzugriffsrichtlinienvorgang.

Gibt zurück

Antwortdaten für den Warteschlangenzugriffsrichtlinienvorgang.

getProperties(QueueGetPropertiesOptions)

Ruft alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Wert-Paare zugeordnet.

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

WARNUNG: Das metadata in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von der listQueues Methode der Verwendung der QueueServiceClientincludeMetadata Option zurückgegeben werden, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.

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

Parameter

options
QueueGetPropertiesOptions

Optionen für den Vorgang "Warteschlangen abrufen von Eigenschaften".

Gibt zurück

Antwortdaten für den Vorgang Warteschlangen abrufen eigenschaften.

peekMessages(QueuePeekMessagesOptions)

peekMessages ruft eine oder mehrere Nachrichten von der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht.

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

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

Parameter

options
QueuePeekMessagesOptions

Optionen zum Anzeigen von Nachrichtenvorgängen.

Gibt zurück

Antwortdaten für den Vorgang "Vorschaunachrichten".

Beispielverwendung:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages ruft eine oder mehrere Nachrichten von der Front der Warteschlange ab.

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

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

Parameter

options
QueueReceiveMessageOptions

Optionen zum Empfangen von Nachrichten.

Gibt zurück

Antwortdaten für den Vorgang "Empfangen von Nachrichten".

Beispielverwendung:

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 fügt eine neue Nachricht an der Rückseite einer Warteschlange hinzu. Das Sichtbarkeitstimeout gibt an, wie lange die Nachricht für Dequeue- und Peek-Vorgänge unsichtbar sein soll. Der Nachrichteninhalt hat eine Größe von bis zu 64 KB und muss in einem Format vorliegen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Zum Einbeziehen des Markups in der Nachricht müssen Inhalte der Nachricht entweder XML-escaped oder Base64-codiert sein.

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

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

Parameter

messageText

string

Text der zu sendenden Nachricht

options
QueueSendMessageOptions

Optionen zum Senden von Nachrichten.

Gibt zurück

Antwortdaten für den Vorgang "Nachrichten senden".

Beispielverwendung:

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)

Legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit SAS (Shared Access Signature) verwendet werden können.

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

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

Parameter

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Optionen zum Warteschlangensatz-Zugriffsrichtlinienvorgang.

Gibt zurück

Antwortdaten für den Warteschlangensatzzugriffsrichtlinienvorgang.

setMetadata(Metadata, QueueSetMetadataOptions)

Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für die angegebene Warteschlange fest. Wenn keine Option oder keine im Optionsparameter definierten Metadaten angegeben sind, werden die Warteschlangenmetadaten entfernt.

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

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

Parameter

metadata
Metadata

Wenn keine Metadaten bereitgestellt werden, werden alle vorhandenen Metadaten entfernt.

options
QueueSetMetadataOptions

Optionen zum Warteschlangensatzmetadatenvorgang.

Gibt zurück

Antwortdaten für den Metadatenvorgang "Warteschlangensatz".

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

Aktualisieren sie das Sichtbarkeitstimeout und den Inhalt einer Nachricht. Der Nachrichteninhalt hat eine Größe von bis zu 64 KB und muss in einem Format vorliegen, das in eine XML-Anforderung mit UTF-8-Codierung eingeschlossen werden kann. Zum Einbeziehen des Markups in der Nachricht müssen Inhalte der Nachricht entweder XML-escaped oder Base64-codiert sein.

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

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

Parameter

messageId

string

ID der Nachricht

popReceipt

string

Ein gültiger Popquittungswert, der von einem früheren Aufruf des Empfangs- oder Aktualisierungsvorgangs zurückgegeben wurde.

message

string

Nachricht zu aktualisieren. Wenn dieser Parameter nicht definiert ist, wird der Inhalt der Nachricht nicht aktualisiert.

visibilityTimeout

number

Gibt den neuen Sichtbarkeitstimeoutwert in Sekunden relativ zur Serverzeit an. Der neue Wert muss größer oder gleich 0 sein und darf nicht größer als 7 Tage sein. Das Sichtbarkeitstimeout einer Nachricht darf nicht auf einen Wert festgelegt werden, der nach der Ablaufzeit liegt. Eine Nachricht kann aktualisiert werden, bis sie gelöscht wurde oder abgelaufen ist.

options
QueueUpdateMessageOptions

Optionen zum Aktualisieren des Nachrichtenvorgangs.

Gibt zurück

Antwortdaten für den Vorgang der Aktualisierungsnachricht.