QueueClient class

Skapar en instans av QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Parametrar

Skapar en instans av QueueClient.

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

Parametrar

Skapar en instans av QueueClient.

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

Parametrar

Namnet på kön.

string name

Egenskapsvärde

accountName: string

Egenskapsvärde

ärvd från StorageClient.accountName

URL-strängvärde.

url: string

Egenskapsvärde

ärvd från StorageClient.url

Rensa tar bort alla meddelanden från en kö.

Se https://free.blessedness.top/rest/api/storageservices/clear-messages

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

Parametrar

Returer

Svarsdata för åtgärden rensa meddelanden.

Skapar en ny kö under det angivna kontot.

Se https://free.blessedness.top/rest/api/storageservices/create-queue4

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

Parametrar

Returer

Svarsdata för åtgärden Skapa kö.

Exempel på användning:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

Skapar en ny kö under det angivna kontot om den inte redan finns. Om kön redan finns ändras den inte.

Se https://free.blessedness.top/rest/api/storageservices/create-queue4

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

Parametrar

Returer

Tar bort den angivna kön permanent.

Se https://free.blessedness.top/rest/api/storageservices/delete-queue3

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

Parametrar

Returer

Svarsdata för borttagningsåtgärden Kö.

Exempel på användning:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const deleteQueueResponse = await queueClient.delete();
console.log(
  `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
);

Tar bort den angivna kön permanent om den finns.

Se https://free.blessedness.top/rest/api/storageservices/delete-queue3

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

Parametrar

Returer

deleteMessage tar bort det angivna meddelandet permanent från kön.

Se https://free.blessedness.top/rest/api/storageservices/delete-message2

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

Parametrar

Returer

Svarsdata för åtgärden ta bort meddelande.

Returnerar sant om den angivna kön finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig kö kan tas bort av andra klienter eller program. Vice versa nya köer kan läggas till av andra klienter eller program när den här funktionen har slutförts.

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

Parametrar

Returer

Endast tillgängligt för QueueClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Parametrar

Returer

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Endast tillgängligt för QueueClient som konstruerats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Parametrar

Returer

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Hämtar information om lagrade åtkomstprinciper som anges i kön som kan användas med signaturer för delad åtkomst.

VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

Se https://free.blessedness.top/rest/api/storageservices/get-queue-acl

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

Parametrar

Returer

Svarsdata för åtgärden Queue get access policy (Hämta åtkomstprincip).

Hämtar alla användardefinierade metadata och systemegenskaper för den angivna kön. Metadata associeras med kön som namn/värden-par.

Se https://free.blessedness.top/rest/api/storageservices/get-queue-metadata

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoden listQueues för QueueServiceClient med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.

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

Parametrar

Returer

Svarsdata för åtgärden Hämta egenskaper i kön.

peekMessages hämtar ett eller flera meddelanden längst fram i kön, men ändrar inte meddelandets synlighet.

Se https://free.blessedness.top/rest/api/storageservices/peek-messages

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

Parametrar

Returer

Svarsdata för åtgärden granska meddelanden.

Exempel på användning:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const peekMessagesResponse = await queueClient.peekMessages();
console.log(`The peeked message is: ${peekMessagesResponse.peekedMessageItems[0].messageText}`);

receiveMessages hämtar ett eller flera meddelanden längst fram i kön.

Se https://free.blessedness.top/rest/api/storageservices/get-messages

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

Parametrar

Returer

Svarsdata för åtgärden ta emot meddelanden.

Exempel på användning:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
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 lägger till ett nytt meddelande på baksidan av en kö. Tidsgränsen för synlighet anger hur länge meddelandet ska vara osynligt för åtgärderna Dequeue och Peek. Meddelandeinnehållet är upp till 64 KB stort och måste vara i ett format som kan ingå i en XML-begäran med UTF-8-kodning. Om du vill inkludera markering i meddelandet måste innehållet i meddelandet antingen vara XML-escape eller Base64-encode.

Se https://free.blessedness.top/rest/api/storageservices/put-message

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

Parametrar

Returer

Svarsdata för åtgärden skicka meddelanden.

Exempel på användning:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
// Send a message into the queue using the sendMessage method.
const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`,
);

Anger lagrade åtkomstprinciper för kön som kan användas med signaturer för delad åtkomst.

Se https://free.blessedness.top/rest/api/storageservices/set-queue-acl

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

Parametrar

Returer

Svarsdata för åtkomstprincipåtgärden Köuppsättning.

Anger ett eller flera användardefinierade namn/värde-par för den angivna kön.

Om inget alternativ har angetts, eller om inga metadata har definierats i alternativparametern, tas kömetadata bort.

Se https://free.blessedness.top/rest/api/storageservices/set-queue-metadata

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

Parametrar

Returer

Svarsdata för metadataåtgärden Köuppsättning.

Uppdatera ändrar ett meddelandes synlighetstimeout och innehåll. Meddelandeinnehållet är upp till 64 KB stort och måste vara i ett format som kan ingå i en XML-begäran med UTF-8-kodning. Om du vill inkludera markering i meddelandet måste innehållet i meddelandet antingen vara XML-escape eller Base64-encode.

Se https://free.blessedness.top/rest/api/storageservices/update-message

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

Parametrar

Returer

Svarsdata för uppdateringsmeddelandeåtgärden.