QueueClient class

Paket:: @azure/storage-queue

Ein QueueClient stellt eine URL zu den Nachrichten einer Azure Storage-Warteschlange dar, mit denen Sie die zugehörigen Nachrichten bearbeiten können.

Extends: StorageClient

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

accountName
name	Der Name der Warteschlange.
url	URL-Zeichenfolgenwert.

Methoden

clearMessages(QueueClearMessagesOptions)	Löscht alle Nachrichten aus einer Warteschlange.
create(QueueCreateOptions)	Erstellt eine neue Warteschlange unter dem angegebenen Konto.
createIfNotExists(QueueCreateOptions)	Erstellt eine neue Warteschlange unter dem angegebenen Konto, wenn sie noch nicht vorhanden ist. Wenn die Warteschlange bereits vorhanden ist, wird sie nicht geändert.
delete(QueueDeleteOptions)	Löscht die angegebene Warteschlange dauerhaft.
deleteIfExists(QueueDeleteOptions)	Löscht die angegebene Warteschlange dauerhaft, wenn sie vorhanden ist.
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage entfernt die angegebene Nachricht endgültig aus der Warteschlange.
exists(QueueExistsOptions)	Gibt true zurück, wenn die angegebene Warteschlange vorhanden ist; andernfalls "false". HINWEIS: Verwenden Sie diese Funktion mit Bedacht, 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 wurde.
generateSasUrl(QueueGenerateSasUrlOptions)	Nur für QueueClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde. Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.
getAccessPolicy(QueueGetAccessPolicyOptions)	Ruft Details zu allen in der Warteschlange angegebenen gespeicherten Zugriffsrichtlinien ab, die mit Freigegebenen Zugriffssignaturen verwendet werden können. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge eine potenzielle Genauigkeit verlieren. Beispiel: "New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".
getProperties(QueueGetPropertiesOptions)	Ruft alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Werte-Paare zugeordnet.
peekMessages(QueuePeekMessagesOptions)	peekMessages ruft eine oder mehrere Nachrichten von der Vorderseite der Warteschlange ab, ändert jedoch nicht die Sichtbarkeit der Nachricht.
receiveMessages(QueueReceiveMessageOptions)	receiveMessages ruft eine oder mehrere Nachrichten von der Vorderseite der Warteschlange ab.
sendMessage(string, QueueSendMessageOptions)	sendMessage fügt eine neue Nachricht zur Rückseite einer Warteschlange hinzu. Das Timeout für die Sichtbarkeit gibt an, wie lange die Nachricht für Dequeue- und Peek-Vorgänge unsichtbar sein soll. Der Nachrichteninhalt ist bis zu 64 KB groß und muss in einem Format vorliegen, das in einer XML-Anforderung mit UTF-8-Codierung enthalten sein kann. Um Markup in die Nachricht einzuschließen, muss der Inhalt der Nachricht entweder XML-Escapezeichen oder Base64-codiert sein.
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit Freigegebenen Zugriffssignaturen verwendet werden kann.
setMetadata(Metadata, QueueSetMetadataOptions)	Legt ein oder mehrere benutzerdefinierte Namens-Wert-Paare für die angegebene Warteschlange fest. Wenn im Optionsparameter keine Option angegeben oder keine Metadaten definiert sind, werden die Warteschlangenmetadaten entfernt.
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	Aktualisieren sie die Sichtbarkeitszeitüberschreitung und den Inhalt einer Nachricht. Der Nachrichteninhalt ist bis zu 64 KB groß und muss in einem Format vorliegen, das in einer XML-Anforderung mit UTF-8-Codierung enthalten sein kann. Um Markup in die Nachricht einzuschließen, muss der Inhalt der Nachricht entweder XML-Escapezeichen oder Base64-codiert sein.

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 Anonyme Anmeldeinformationen verwendet werden, 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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn 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 : Kontoverbindungszeichenfolge kann nur in NODE.JS Laufzeit verwendet werden. ] Beispiel für kontoverbindungszeichenfolge - beispiel für DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolge - 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

accountName

accountName: string

Eigenschaftswert

string

name

Der Name der Warteschlange.

string name

Eigenschaftswert

string

url

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Details zur Methode

clearMessages(QueueClearMessagesOptions)

Löscht alle Nachrichten aus einer Warteschlange.

function clearMessages(options?: QueueClearMessagesOptions)

Parameter

options: QueueClearMessagesOptions

Optionen zum Löschen des Nachrichtenvorgangs.

Gibt zurück

Promise<QueueClearMessagesResponse>

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

create(QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto.

function create(options?: QueueCreateOptions)

Parameter

options: QueueCreateOptions

Optionen für den Erstellungsvorgang der Warteschlange.

Gibt zurück

Promise<QueueCreateResponse>

Antwortdaten für den Warteschlangenerstellungsvorgang.

Beispielverwendung:

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

createIfNotExists(QueueCreateOptions)

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

function createIfNotExists(options?: QueueCreateOptions)

Parameter

options: QueueCreateOptions

Gibt zurück

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Löscht die angegebene Warteschlange dauerhaft.

function delete(options?: QueueDeleteOptions)

Parameter

options: QueueDeleteOptions

Optionen zum Löschvorgang in der Warteschlange.

Gibt zurück

Promise<QueueDeleteResponse>

Antwortdaten für den Löschvorgang der Warteschlange.

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, wenn sie vorhanden ist.

function deleteIfExists(options?: QueueDeleteOptions)

Parameter

options: QueueDeleteOptions

Gibt zurück

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage entfernt die angegebene Nachricht endgültig aus der Warteschlange.

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

Parameter

messageId: string

ID der Nachricht.

popReceipt: string

Ein gültiger Pop-Belegwert, der von einem früheren Aufruf an den Empfangen von Nachrichten oder einem Aktualisierungsvorgang zurückgegeben wurde.

options: QueueDeleteMessageOptions

Optionen zum Löschen des Nachrichtenvorgangs.

Gibt zurück

Promise<QueueDeleteMessageResponse>

Antwortdaten für den Löschnachrichtenvorgang.

exists(QueueExistsOptions)

Gibt true zurück, wenn die angegebene Warteschlange vorhanden ist; andernfalls "false". HINWEIS: Verwenden Sie diese Funktion mit Bedacht, 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 wurde.

function exists(options?: QueueExistsOptions)

Parameter

options: QueueExistsOptions

Optionen für den Betrieb Exists.

Gibt zurück

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

Nur für QueueClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde. Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

function generateSasUrl(options: QueueGenerateSasUrlOptions)

Parameter

options: QueueGenerateSasUrlOptions

Optionale Parameter.

Gibt zurück

string

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

getAccessPolicy(QueueGetAccessPolicyOptions)

Ruft Details zu allen in der Warteschlange angegebenen gespeicherten Zugriffsrichtlinien ab, die mit Freigegebenen Zugriffssignaturen verwendet werden können. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge eine potenzielle Genauigkeit verlieren. Beispiel: "New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".

function getAccessPolicy(options?: QueueGetAccessPolicyOptions)

Parameter

options: QueueGetAccessPolicyOptions

Optionen zum Abrufen des Zugriffsrichtlinienvorgangs in der Warteschlange.

Gibt zurück

Promise<QueueGetAccessPolicyResponse>

Antwortdaten für den Warteschlangenzugriffsrichtlinienvorgang erhalten.

getProperties(QueueGetPropertiesOptions)

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

function getProperties(options?: QueueGetPropertiesOptions)

Parameter

options: QueueGetPropertiesOptions

Optionen zum Abrufen von Eigenschaften in der Warteschlange.

Gibt zurück

Promise<QueueGetPropertiesResponse>

Antwortdaten für den Vorgang zum Abrufen von Eigenschaften der Warteschlange.

peekMessages(QueuePeekMessagesOptions)

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

function peekMessages(options?: QueuePeekMessagesOptions)

Parameter

options: QueuePeekMessagesOptions

Optionen zum Anzeigen von Nachrichten.

Gibt zurück

Promise<QueuePeekMessagesResponse>

Antwortdaten für den Vorschaunachrichtenvorgang.

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 Vorderseite der Warteschlange ab.

function receiveMessages(options?: QueueReceiveMessageOptions)

Parameter

options: QueueReceiveMessageOptions

Optionen zum Empfangen von Nachrichten.

Gibt zurück

Promise<QueueReceiveMessageResponse>

Antwortdaten für den Empfangsnachrichtenvorgang.

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 zur Rückseite einer Warteschlange hinzu. Das Timeout für die Sichtbarkeit gibt an, wie lange die Nachricht für Dequeue- und Peek-Vorgänge unsichtbar sein soll. Der Nachrichteninhalt ist bis zu 64 KB groß und muss in einem Format vorliegen, das in einer XML-Anforderung mit UTF-8-Codierung enthalten sein kann. Um Markup in die Nachricht einzuschließen, muss der Inhalt der Nachricht entweder XML-Escapezeichen oder Base64-codiert sein.

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

Parameter

messageText: string

Text der zu sendenden Nachricht

options: QueueSendMessageOptions

Optionen zum Senden von Nachrichten.

Gibt zurück

Promise<QueueSendMessageResponse>

Antwortdaten für den Vorgang zum Senden von Nachrichten.

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 Freigegebenen Zugriffssignaturen verwendet werden kann.

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

Parameter

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

Optionen zum Festlegen des Zugriffsrichtlinienvorgangs in der Warteschlange.

Gibt zurück

Promise<QueueSetAccessPolicyResponse>

Antwortdaten für den Zugriffsrichtlinienvorgang "Warteschlangensatz".

setMetadata(Metadata, QueueSetMetadataOptions)

Legt ein oder mehrere benutzerdefinierte Namens-Wert-Paare für die angegebene Warteschlange fest. Wenn im Optionsparameter keine Option angegeben oder keine Metadaten definiert sind, werden die Warteschlangenmetadaten entfernt.

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

Parameter

metadata: Metadata

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

options: QueueSetMetadataOptions

Optionen zum Festlegen des Metadatenvorgangs in der Warteschlange.

Gibt zurück

Promise<QueueSetMetadataResponse>

Antwortdaten für den Metadatenvorgang "Warteschlangensatz".

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

Aktualisieren sie die Sichtbarkeitszeitüberschreitung und den Inhalt einer Nachricht. Der Nachrichteninhalt ist bis zu 64 KB groß und muss in einem Format vorliegen, das in einer XML-Anforderung mit UTF-8-Codierung enthalten sein kann. Um Markup in die Nachricht einzuschließen, muss der Inhalt der Nachricht entweder XML-Escapezeichen oder Base64-codiert sein.

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

Parameter

messageId: string

ID der Nachricht

popReceipt: string

Ein gültiger Pop-Belegwert, der von einem früheren Aufruf an den Empfangen von Nachrichten oder einem Aktualisierungsvorgang zurückgegeben wurde.

message: string

Nachricht, die aktualisiert werden soll. Wenn dieser Parameter nicht definiert ist, wird der Inhalt der Nachricht nicht aktualisiert.

visibilityTimeout: number

Gibt den neuen Timeoutwert für die Sichtbarkeit relativ zur Serverzeit in Sekunden an. Der neue Wert muss größer oder gleich 0 sein und darf nicht größer als 7 Tage sein. Das Timeout für die Sichtbarkeit einer Nachricht kann nicht auf einen Wert festgelegt werden, der später als die Ablaufzeit ist. Eine Nachricht kann aktualisiert werden, bis sie gelöscht oder abgelaufen ist.

options: QueueUpdateMessageOptions

Optionen zum Aktualisieren des Nachrichtenvorgangs.

Gibt zurück

Promise<QueueUpdateMessageResponse>

Antwortdaten für den Aktualisierungsnachrichtenvorgang.

Feedback

War diese Seite hilfreich?

Freigeben über

QueueClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

QueueClient(string, Pipeline)

Parameter

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

Parameter

QueueClient(string, string, StoragePipelineOptions)

Parameter

Details zur Eigenschaft

accountName

Eigenschaftswert

name

Eigenschaftswert

url

Eigenschaftswert

Details zur Methode

clearMessages(QueueClearMessagesOptions)

Parameter

Gibt zurück

create(QueueCreateOptions)

Parameter

Gibt zurück

createIfNotExists(QueueCreateOptions)

Parameter

Gibt zurück

delete(QueueDeleteOptions)

Parameter

Gibt zurück

deleteIfExists(QueueDeleteOptions)

Parameter

Gibt zurück

deleteMessage(string, string, QueueDeleteMessageOptions)

Parameter

Gibt zurück

exists(QueueExistsOptions)

Parameter

Gibt zurück

generateSasUrl(QueueGenerateSasUrlOptions)

Parameter

Gibt zurück

getAccessPolicy(QueueGetAccessPolicyOptions)

Parameter

Gibt zurück

getProperties(QueueGetPropertiesOptions)

Parameter

Gibt zurück

peekMessages(QueuePeekMessagesOptions)

Parameter

Gibt zurück

receiveMessages(QueueReceiveMessageOptions)

Parameter

Gibt zurück

sendMessage(string, QueueSendMessageOptions)

Parameter

Gibt zurück

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Parameter

Gibt zurück

setMetadata(Metadata, QueueSetMetadataOptions)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

Feedback