QueueClient class

Erstellt eine Instanz von QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von QueueClient.

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

Parameter

Erstellt eine Instanz von QueueClient.

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

Parameter

Der Name der Warteschlange.

string name

Eigenschaftswert

accountName: string

Eigenschaftswert

geerbt von StorageClient.accountName

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

geerbt von StorageClient.url

Löscht alle Nachrichten aus einer Warteschlange.

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

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

Parameter

Gibt zurück

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

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

Gibt zurück

Antwortdaten für den Warteschlangenerstellungsvorgang.

Beispielverwendung:

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

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.

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

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

Parameter

Gibt zurück

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

Gibt zurück

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
);

Löscht die angegebene Warteschlange dauerhaft, wenn 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 entfernt die angegebene Nachricht endgültig aus der Warteschlange.

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

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

Parameter

Gibt zurück

Antwortdaten für den Löschnachrichtenvorgang.

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): Promise<boolean>

Parameter

Gibt zurück

Nur für QueueClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert Zeichenfolge zum Signieren für 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.

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

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parameter

Gibt zurück

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

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.

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parameter

Gibt zurück

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

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

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

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

Parameter

Gibt zurück

Antwortdaten für den Warteschlangenzugriffsrichtlinienvorgang erhalten.

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

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

WARNUNG: Das in der Antwort zurückgegebene metadata-Objekt weist die 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 von QueueServiceClient unter Verwendung der Option includeMetadata zurückgegeben werden, wodurch die ursprüngliche Groß-/Kleinschreibung beibehalten wird.

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

Parameter

Gibt zurück

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

peekMessages ruft eine oder mehrere Nachrichten von der Vorderseite 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

Gibt zurück

Antwortdaten für den Vorschaunachrichtenvorgang.

Beispielverwendung:

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

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

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

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

Parameter

Gibt zurück

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

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

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

Parameter

Gibt zurück

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
);

Legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit Freigegebenen Zugriffssignaturen verwendet werden kann.

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

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

Parameter

Gibt zurück

Antwortdaten für den Zugriffsrichtlinienvorgang "Warteschlangensatz".

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.

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

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

Parameter

Gibt zurück

Antwortdaten für den Metadatenvorgang "Warteschlangensatz".

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.

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

Parameter

Gibt zurück

Antwortdaten für den Aktualisierungsnachrichtenvorgang.