QueueClient class

Csomag:: @azure/storage-queue

A QueueClient egy Azure Storage-üzenetsor üzeneteinek URL-címe, amely lehetővé teszi az üzenetek manipulálását.

Kiterjeszti: StorageClient

Konstruktorok

QueueClient(string, Pipeline)	Létrehozza a QueueClient egy példányát.
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Létrehozza a QueueClient egy példányát.
QueueClient(string, string, StoragePipelineOptions)	Létrehozza a QueueClient egy példányát.

Kellékek

name	Az üzenetsor neve.

Örökölt tulajdonságok

accountName
url	URL-sztring értéke.

Módszerek

clearMessages(QueueClearMessagesOptions)	Törli az üzenetsor összes üzenetét. Lásd: https://learn.microsoft.com/rest/api/storageservices/clear-messages
create(QueueCreateOptions)	Új üzenetsort hoz létre a megadott fiók alatt. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-queue4
createIfNotExists(QueueCreateOptions)	Új üzenetsort hoz létre a megadott fiók alatt, ha még nem létezik. Ha az üzenetsor már létezik, az nem módosul. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-queue4
delete(QueueDeleteOptions)	Véglegesen törli a megadott üzenetsort. Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteIfExists(QueueDeleteOptions)	Ha létezik, véglegesen törli a megadott üzenetsort. Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-queue3
deleteMessage(string, string, QueueDeleteMessageOptions)	A deleteMessage véglegesen eltávolítja a megadott üzenetet az üzenetsorból. Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)	Igaz értéket ad vissza, ha a megadott üzenetsor létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő üzenetsort más ügyfelek vagy alkalmazások törölnek. Fordítva, a függvény befejeződése után más ügyfelek vagy alkalmazások új üzenetsorokat adhatnak hozzá.
generateSasStringToSign(QueueGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueClient esetén érhető el. Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(QueueGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueClient esetén érhető el. Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)	Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. A SAS-t a felhasználói delegációs kulcs hitelesítési bemenete írja alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)	Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. A SAS-t a felhasználói delegációs kulcs hitelesítési bemenete írja alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)	A megosztott hozzáférésű jogosultságkódokkal használható üzenetsoron megadott tárolt hozzáférési szabályzatok részletei. FIGYELMEZTETÉS: A JavaScript-dátum a kezdő és a lejárati sztring elemzésekor elveszhet a pontossága. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z". Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)	Lekéri a megadott üzenetsor összes felhasználó által definiált metaadatait és rendszertulajdonságát. A metaadatok név-érték párokként lesznek társítva az üzenetsorhoz. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata FIGYELMEZTETÉS: A válaszban visszaadott `metadata` objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a QueueServiceClient `listQueues` metódusa által visszaadott metaadatkulcsoktól a `includeMetadata` beállítással, amely megőrzi az eredeti burkolatot.
peekMessages(QueuePeekMessagesOptions)	A peekMessages egy vagy több üzenetet kér le az üzenetsor elejéről, de nem módosítja az üzenet láthatóságát. Lásd: https://learn.microsoft.com/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)	A receiveMessages egy vagy több üzenetet kér le az üzenetsor elejéről. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)	A sendMessage új üzenetet ad hozzá az üzenetsor hátuljához. A láthatóság időtúllépése azt határozza meg, hogy az üzenet mennyi ideig legyen láthatatlan a Dequeue és a Betekintő műveletek számára. Az üzenet tartalma legfeljebb 64 KB méretű lehet, és olyan formátumúnak kell lennie, amely UTF-8 kódolású XML-kérelemben is szerepelhet. A korrektúra üzenetbe való belefoglalásához az üzenet tartalmának XML-alapú vagy Base64-kódolásúnak kell lennie. Lásd: https://learn.microsoft.com/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	Beállítja a megosztott hozzáférésű jogosultságkódokkal használható üzenetsor tárolt hozzáférési szabályzatait. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)	Beállít egy vagy több felhasználó által definiált név-érték párot a megadott üzenetsorhoz. Ha nincs megadva lehetőség, vagy nincs megadva metaadat a beállításparaméterben, a rendszer eltávolítja az üzenetsor metaadatait. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	A frissítés megváltoztatja az üzenetek láthatóságának időtúllépését és tartalmát. Az üzenet tartalma legfeljebb 64 KB méretű lehet, és olyan formátumúnak kell lennie, amely UTF-8 kódolású XML-kérelemben is szerepelhet. A korrektúra üzenetbe való belefoglalásához az üzenet tartalmának XML-alapú vagy Base64-kódolásúnak kell lennie. Lásd: https://learn.microsoft.com/rest/api/storageservices/update-message

Építő részletek

QueueClient(string, Pipeline)

Létrehozza a QueueClient egy példányát.

new QueueClient(url: string, pipeline: Pipeline)

Paraméterek

url: string

Az Azure Storage-üzenetsorra mutató URL-sztring, például "https://myaccount.queue.core.windows.net/myqueue". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

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

Létrehozza a QueueClient egy példányát.

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

Paraméterek

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

options: StoragePipelineOptions

A HTTP-folyamat konfigurálására vonatkozó beállítások.

QueueClient(string, string, StoragePipelineOptions)

Létrehozza a QueueClient egy példányát.

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

Paraméterek

connectionString: string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – 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

Üzenetsor neve.

options: StoragePipelineOptions

A HTTP-folyamat konfigurálására vonatkozó beállítások.

Ingatlan részletei

name

Az üzenetsor neve.

string name

Ingatlanérték

string

Örökölt ingatlan részletei

accountName

accountName: string

Ingatlanérték

string

örökölt StorageClient.accountName

url

URL-sztring értéke.

url: string

Ingatlanérték

string

örökölt StorageClient.url-címről

Módszer részletei

clearMessages(QueueClearMessagesOptions)

Törli az üzenetsor összes üzenetét.

Lásd: https://learn.microsoft.com/rest/api/storageservices/clear-messages

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

Paraméterek

options: QueueClearMessagesOptions

Az üzenetek törlésének beállításai.

Visszatér

Promise<MessagesClearResponse>

Válaszadatok a törlési üzenetek műveletéhez.

create(QueueCreateOptions)

Új üzenetsort hoz létre a megadott fiók alatt.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Paraméterek

options: QueueCreateOptions

Az üzenetsor-létrehozási művelet beállításai.

Visszatér

Promise<QueueCreateResponse>

Válaszadatok az üzenetsor-létrehozási művelethez.

Példahasználat:

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}`,
);

createIfNotExists(QueueCreateOptions)

Új üzenetsort hoz létre a megadott fiók alatt, ha még nem létezik. Ha az üzenetsor már létezik, az nem módosul.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Paraméterek

options: QueueCreateOptions

Visszatér

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

Véglegesen törli a megadott üzenetsort.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Paraméterek

options: QueueDeleteOptions

Üzenetsor-törlési művelet beállításai.

Visszatér

Promise<QueueDeleteResponse>

Válaszadatok az Üzenetsor törlése művelethez.

Példahasználat:

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}`,
);

deleteIfExists(QueueDeleteOptions)

Ha létezik, véglegesen törli a megadott üzenetsort.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Paraméterek

options: QueueDeleteOptions

Visszatér

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

A deleteMessage véglegesen eltávolítja a megadott üzenetet az üzenetsorból.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-message2

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

Paraméterek

messageId: string

Az üzenet azonosítója.

popReceipt: string

Érvényes pop-visszaigazolási érték, amely egy korábbi hívásból érkezett a fogadási üzenetekhez vagy az üzenetfrissítési művelethez.

options: QueueDeleteMessageOptions

Az üzenettörlési műveletek beállításai.

Visszatér

Promise<MessageIdDeleteResponse>

Válaszadatok a törlési üzenet műveletéhez.

exists(QueueExistsOptions)

Igaz értéket ad vissza, ha a megadott üzenetsor létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő üzenetsort más ügyfelek vagy alkalmazások törölnek. Fordítva, a függvény befejeződése után más ügyfelek vagy alkalmazások új üzenetsorokat adhatnak hozzá.

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

Paraméterek

options: QueueExistsOptions

beállítási lehetőségeket a Exists művelethez.

Visszatér

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueClient esetén érhető el.

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

Paraméterek

options: QueueGenerateSasUrlOptions

Nem kötelező paraméterek.

Visszatér

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateSasUrl(QueueGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueClient esetén érhető el.

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Paraméterek

options: QueueGenerateSasUrlOptions

Nem kötelező paraméterek.

Visszatér

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. A SAS-t a felhasználói delegációs kulcs hitelesítési bemenete írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: QueueGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Paraméterek

options: QueueGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey: UserDelegationKey

a SAS URI aláírásához használt felhasználói delegációs kulcs

Visszatér

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationStringToSign(options: QueueGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Paraméterek

options: QueueGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey: UserDelegationKey

a SAS URI aláírásához használt felhasználói delegációs kulcs

Visszatér

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

getAccessPolicy(QueueGetAccessPolicyOptions)

A megosztott hozzáférésű jogosultságkódokkal használható üzenetsoron megadott tárolt hozzáférési szabályzatok részletei.

FIGYELMEZTETÉS: A JavaScript-dátum a kezdő és a lejárati sztring elemzésekor elveszhet a pontossága. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-acl

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

Paraméterek

options: QueueGetAccessPolicyOptions

A queue get hozzáférési szabályzat műveletének beállításai.

Visszatér

Promise<QueueGetAccessPolicyResponse>

Az üzenetsor válaszadatai hozzáférési szabályzatot kapnak.

getProperties(QueueGetPropertiesOptions)

Lekéri a megadott üzenetsor összes felhasználó által definiált metaadatait és rendszertulajdonságát. A metaadatok név-érték párokként lesznek társítva az üzenetsorhoz.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a QueueServiceClient listQueues metódusa által visszaadott metaadatkulcsoktól a includeMetadata beállítással, amely megőrzi az eredeti burkolatot.

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

Paraméterek

options: QueueGetPropertiesOptions

A Várólista tulajdonságainak lekérése művelet beállításai.

Visszatér

Promise<QueueGetPropertiesResponse>

Az üzenetsor tulajdonságainak lekérése művelet válaszadatai.

peekMessages(QueuePeekMessagesOptions)

A peekMessages egy vagy több üzenetet kér le az üzenetsor elejéről, de nem módosítja az üzenet láthatóságát.

Lásd: https://learn.microsoft.com/rest/api/storageservices/peek-messages

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

Paraméterek

options: QueuePeekMessagesOptions

Az üzenetek betekintő műveletének beállításai.

Visszatér

Promise<QueuePeekMessagesResponse>

Válaszadatok a betekintő üzenetek műveletéhez.

Példahasználat:

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(QueueReceiveMessageOptions)

A receiveMessages egy vagy több üzenetet kér le az üzenetsor elejéről.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-messages

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

Paraméterek

options: QueueReceiveMessageOptions

Az üzenetek fogadási műveletének beállításai.

Visszatér

Promise<QueueReceiveMessageResponse>

Válaszadatok a fogadási üzenetek műveletéhez.

Példahasználat:

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(string, QueueSendMessageOptions)

A sendMessage új üzenetet ad hozzá az üzenetsor hátuljához. A láthatóság időtúllépése azt határozza meg, hogy az üzenet mennyi ideig legyen láthatatlan a Dequeue és a Betekintő műveletek számára. Az üzenet tartalma legfeljebb 64 KB méretű lehet, és olyan formátumúnak kell lennie, amely UTF-8 kódolású XML-kérelemben is szerepelhet. A korrektúra üzenetbe való belefoglalásához az üzenet tartalmának XML-alapú vagy Base64-kódolásúnak kell lennie.

Lásd: https://learn.microsoft.com/rest/api/storageservices/put-message

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

Paraméterek

messageText: string

A küldendő üzenet szövege

options: QueueSendMessageOptions

Üzenetküldési műveletek beállításai.

Visszatér

Promise<QueueSendMessageResponse>

Válaszadatok az üzenetküldési művelethez.

Példahasználat:

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}`,
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Beállítja a megosztott hozzáférésű jogosultságkódokkal használható üzenetsor tárolt hozzáférési szabályzatait.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-queue-acl

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

Paraméterek

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

Az üzenetsor beállításai a hozzáférési szabályzat műveletének beállításához.

Visszatér

Promise<QueueSetAccessPolicyResponse>

Válaszadatok a Várólistakészlet hozzáférési szabályzat műveletéhez.

setMetadata(Metadata, QueueSetMetadataOptions)

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott üzenetsorhoz.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a beállításparaméterben, a rendszer eltávolítja az üzenetsor metaadatait.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata

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

Paraméterek

metadata: Metadata

Ha nem ad meg metaadatokat, az összes meglévő metaadat el lesz távolítva.

options: QueueSetMetadataOptions

A várólista metaadat-beállítási műveletének beállításai.

Visszatér

Promise<QueueSetMetadataResponse>

Válaszadatok az üzenetsorkészlet metaadat-műveletéhez.

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

A frissítés megváltoztatja az üzenetek láthatóságának időtúllépését és tartalmát. Az üzenet tartalma legfeljebb 64 KB méretű lehet, és olyan formátumúnak kell lennie, amely UTF-8 kódolású XML-kérelemben is szerepelhet. A korrektúra üzenetbe való belefoglalásához az üzenet tartalmának XML-alapú vagy Base64-kódolásúnak kell lennie.

Lásd: https://learn.microsoft.com/rest/api/storageservices/update-message

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

Paraméterek

messageId: string

Az üzenet azonosítója

popReceipt: string

Érvényes pop-visszaigazolási érték, amely egy korábbi hívásból érkezett a fogadási üzenetekhez vagy az üzenetfrissítési művelethez.

message: string

Frissítendő üzenet. Ha ez a paraméter nincs meghatározva, akkor az üzenet tartalma nem frissül.

visibilityTimeout: number

Az új láthatóság időtúllépési értékét adja meg másodpercben a kiszolgálói időhöz viszonyítva. Az új értéknek 0-nál nagyobbnak vagy egyenlőnek kell lennie, és nem lehet nagyobb 7 napnál. Az üzenet láthatósági időtúllépése nem állítható be a lejárati időnél későbbi értékre. Az üzenetek mindaddig frissíthetők, amíg el nem törölték vagy lejárt.

options: QueueUpdateMessageOptions

Az üzenetművelet frissítésének beállításai.

Visszatér

Promise<MessageIdUpdateResponse>

Válaszadatok a frissítési üzenet műveletéhez.

Megosztás:

QueueClient class

Konstruktorok

Kellékek

Örökölt tulajdonságok

Módszerek

Építő részletek

QueueClient(string, Pipeline)

Paraméterek

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

Paraméterek

QueueClient(string, string, StoragePipelineOptions)

Paraméterek

Ingatlan részletei

name

Ingatlanérték

Örökölt ingatlan részletei

accountName

Ingatlanérték

url

Ingatlanérték

Módszer részletei

clearMessages(QueueClearMessagesOptions)

Paraméterek

Visszatér

create(QueueCreateOptions)

Paraméterek

Visszatér

createIfNotExists(QueueCreateOptions)

Paraméterek

Visszatér

delete(QueueDeleteOptions)

Paraméterek

Visszatér

deleteIfExists(QueueDeleteOptions)

Paraméterek

Visszatér

deleteMessage(string, string, QueueDeleteMessageOptions)

Paraméterek

Visszatér

exists(QueueExistsOptions)

Paraméterek

Visszatér

generateSasStringToSign(QueueGenerateSasUrlOptions)

Paraméterek

Visszatér

generateSasUrl(QueueGenerateSasUrlOptions)

Paraméterek

Visszatér

generateUserDelegationSasUrl(QueueGenerateSasUrlOptions, UserDelegationKey)

Paraméterek

Visszatér

generateUserDelegationStringToSign(QueueGenerateSasUrlOptions, UserDelegationKey)

Paraméterek

Visszatér

getAccessPolicy(QueueGetAccessPolicyOptions)

Paraméterek

Visszatér

getProperties(QueueGetPropertiesOptions)

Paraméterek

Visszatér

peekMessages(QueuePeekMessagesOptions)

Paraméterek

Visszatér

receiveMessages(QueueReceiveMessageOptions)

Paraméterek

Visszatér

sendMessage(string, QueueSendMessageOptions)

Paraméterek

Visszatér

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Paraméterek

Visszatér

setMetadata(Metadata, QueueSetMetadataOptions)

Paraméterek

Visszatér

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

Paraméterek

Visszatér