QueueClient class

الحزمة:: @azure/storage-queue

يمثل QueueClient عنوان URL لرسائل Azure Storage Queue مما يسمح لك بمعالجة رسائلها.

يمتد: StorageClient

المنشئون

QueueClient(string, Pipeline)	إنشاء مثيل QueueClient.
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	إنشاء مثيل QueueClient.
QueueClient(string, string, StoragePipelineOptions)	إنشاء مثيل QueueClient.

الخصائص

accountName
name	اسم قائمة الانتظار.
url	قيمة سلسلة عنوان URL.

الأساليب

clearMessages(QueueClearMessagesOptions)	يؤدي مسح إلى حذف كافة الرسائل من قائمة انتظار.
create(QueueCreateOptions)	إنشاء قائمة انتظار جديدة ضمن الحساب المحدد.
createIfNotExists(QueueCreateOptions)	إنشاء قائمة انتظار جديدة ضمن الحساب المحدد إذا لم تكن موجودة بالفعل. إذا كانت قائمة الانتظار موجودة بالفعل، فلن يتم تغييرها.
delete(QueueDeleteOptions)	حذف قائمة الانتظار المحددة بشكل دائم.
deleteIfExists(QueueDeleteOptions)	حذف قائمة الانتظار المحددة بشكل دائم إذا كانت موجودة.
deleteMessage(string, string, QueueDeleteMessageOptions)	يقوم deleteMessage بإزالة الرسالة المحددة من قائمة الانتظار الخاصة بها بشكل دائم.
exists(QueueExistsOptions)	إرجاع true إذا كانت قائمة الانتظار المحددة موجودة؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف قائمة انتظار موجودة من قبل عملاء أو تطبيقات أخرى. العكس بالعكس قد تتم إضافة قوائم الانتظار الجديدة من قبل عملاء أو تطبيقات أخرى بعد اكتمال هذه الوظيفة.
generateSasUrl(QueueGenerateSasUrlOptions)	متوفر فقط ل QueueClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.
getAccessPolicy(QueueGetAccessPolicyOptions)	الحصول على تفاصيل حول أي نهج وصول مخزنة محددة في قائمة الانتظار التي يمكن استخدامها مع توقيعات الوصول المشترك. تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل سلسلة البدء وانتهاء الصلاحية. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z".
getProperties(QueueGetPropertiesOptions)	يحصل على جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام لقائمة الانتظار المحددة. بيانات التعريف مقترنة بقائمة الانتظار كأزواج قيم الاسم.
peekMessages(QueuePeekMessagesOptions)	يسترد peekMessages رسالة واحدة أو أكثر من مقدمة قائمة الانتظار ولكنه لا يغير رؤية الرسالة.
receiveMessages(QueueReceiveMessageOptions)	يسترد receiveMessages رسالة واحدة أو أكثر من مقدمة قائمة الانتظار.
sendMessage(string, QueueSendMessageOptions)	يضيف sendMessage رسالة جديدة إلى الجزء الخلفي من قائمة الانتظار. تحدد مهلة الرؤية المدة التي يجب أن تكون فيها الرسالة غير مرئية لعمليات Dequeue وPeek. يصل حجم محتوى الرسالة إلى 64 كيلوبايت، ويجب أن يكون بتنسيق يمكن تضمينه في طلب XML مع ترميز UTF-8. لتضمين العلامات في الرسالة، يجب أن تكون محتويات الرسالة إما مهربة من XML أو ترميز Base64.
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	تعيين نهج الوصول المخزنة لقائمة الانتظار التي يمكن استخدامها مع توقيعات الوصول المشترك.
setMetadata(Metadata, QueueSetMetadataOptions)	تعيين زوج واحد أو أكثر من أزواج قيمة الاسم المعرفة من قبل المستخدم لقائمة الانتظار المحددة. إذا لم يتم توفير أي خيار، أو لم يتم تحديد بيانات تعريف في معلمة الخيار، فستتم إزالة بيانات تعريف قائمة الانتظار.
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	يغير التحديث مهلة رؤية الرسالة ومحتوياتها. يصل حجم محتوى الرسالة إلى 64 كيلوبايت، ويجب أن يكون بتنسيق يمكن تضمينه في طلب XML مع ترميز UTF-8. لتضمين العلامات في الرسالة، يجب أن تكون محتويات الرسالة إما مهربة من XML أو ترميز Base64.

تفاصيل المنشئ

QueueClient(string, Pipeline)

إنشاء مثيل QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

المعلمات

url: string

سلسلة URL تشير إلى قائمة انتظار Azure Storage، مثل "https://myaccount.queue.core.windows.net/myqueue". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

استدعاء newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.

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

إنشاء مثيل QueueClient.

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

المعلمات

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.

options: StoragePipelineOptions

خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

QueueClient(string, string, StoragePipelineOptions)

إنشاء مثيل QueueClient.

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

المعلمات

connectionString: string

سلسلة اتصال الحساب أو سلسلة اتصال SAS لحساب تخزين Azure. [ ملاحظة - يمكن استخدام سلسلة اتصال الحساب فقط في وقت تشغيل NODE.JS. ] مثال سلسلة اتصال الحساب - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net مثال سلسلة اتصال SAS - 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

اسم قائمة الانتظار.

options: StoragePipelineOptions

خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

تفاصيل الخاصية

accountName

accountName: string

قيمة الخاصية

string

name

اسم قائمة الانتظار.

string name

قيمة الخاصية

string

url

قيمة سلسلة عنوان URL.

url: string

قيمة الخاصية

string

تفاصيل الأسلوب

clearMessages(QueueClearMessagesOptions)

يؤدي مسح إلى حذف كافة الرسائل من قائمة انتظار.

function clearMessages(options?: QueueClearMessagesOptions)

المعلمات

options: QueueClearMessagesOptions

خيارات لمسح عملية الرسائل.

المرتجعات

Promise<QueueClearMessagesResponse>

بيانات الاستجابة لعملية مسح الرسائل.

create(QueueCreateOptions)

إنشاء قائمة انتظار جديدة ضمن الحساب المحدد.

function create(options?: QueueCreateOptions)

المعلمات

options: QueueCreateOptions

خيارات لعملية إنشاء قائمة الانتظار.

المرتجعات

Promise<QueueCreateResponse>

بيانات الاستجابة لعملية إنشاء قائمة الانتظار.

مثال على الاستخدام:

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

createIfNotExists(QueueCreateOptions)

إنشاء قائمة انتظار جديدة ضمن الحساب المحدد إذا لم تكن موجودة بالفعل. إذا كانت قائمة الانتظار موجودة بالفعل، فلن يتم تغييرها.

function createIfNotExists(options?: QueueCreateOptions)

المعلمات

options: QueueCreateOptions

المرتجعات

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

حذف قائمة الانتظار المحددة بشكل دائم.

function delete(options?: QueueDeleteOptions)

المعلمات

options: QueueDeleteOptions

خيارات لعملية حذف قائمة الانتظار.

المرتجعات

Promise<QueueDeleteResponse>

بيانات الاستجابة لعملية حذف قائمة الانتظار.

مثال على الاستخدام:

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

deleteIfExists(QueueDeleteOptions)

حذف قائمة الانتظار المحددة بشكل دائم إذا كانت موجودة.

function deleteIfExists(options?: QueueDeleteOptions)

المعلمات

options: QueueDeleteOptions

المرتجعات

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

يقوم deleteMessage بإزالة الرسالة المحددة من قائمة الانتظار الخاصة بها بشكل دائم.

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

المعلمات

messageId: string

معرف الرسالة.

popReceipt: string

قيمة إيصال pop صالحة تم إرجاعها من مكالمة سابقة إلى رسائل الاستلام أو عملية تحديث الرسالة.

options: QueueDeleteMessageOptions

خيارات لحذف عملية الرسالة.

المرتجعات

Promise<QueueDeleteMessageResponse>

بيانات الاستجابة لعملية حذف الرسالة.

exists(QueueExistsOptions)

إرجاع true إذا كانت قائمة الانتظار المحددة موجودة؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف قائمة انتظار موجودة من قبل عملاء أو تطبيقات أخرى. العكس بالعكس قد تتم إضافة قوائم الانتظار الجديدة من قبل عملاء أو تطبيقات أخرى بعد اكتمال هذه الوظيفة.

function exists(options?: QueueExistsOptions)

المعلمات

options: QueueExistsOptions

خيارات لعملية Exists.

المرتجعات

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

متوفر فقط ل QueueClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

function generateSasUrl(options: QueueGenerateSasUrlOptions)

المعلمات

options: QueueGenerateSasUrlOptions

المعلمات الاختيارية.

المرتجعات

string

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

getAccessPolicy(QueueGetAccessPolicyOptions)

الحصول على تفاصيل حول أي نهج وصول مخزنة محددة في قائمة الانتظار التي يمكن استخدامها مع توقيعات الوصول المشترك. تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل سلسلة البدء وانتهاء الصلاحية. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z".

function getAccessPolicy(options?: QueueGetAccessPolicyOptions)

المعلمات

options: QueueGetAccessPolicyOptions

خيارات قائمة الانتظار الحصول على عملية نهج الوصول.

المرتجعات

Promise<QueueGetAccessPolicyResponse>

بيانات الاستجابة لعملية نهج الوصول إلى قائمة الانتظار.

getProperties(QueueGetPropertiesOptions)

يحصل على جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام لقائمة الانتظار المحددة. بيانات التعريف مقترنة بقائمة الانتظار كأزواج قيم الاسم.

function getProperties(options?: QueueGetPropertiesOptions)

المعلمات

options: QueueGetPropertiesOptions

خيارات قائمة الانتظار الحصول على عملية الخصائص.

المرتجعات

Promise<QueueGetPropertiesResponse>

بيانات الاستجابة لعملية الحصول على خصائص قائمة الانتظار.

peekMessages(QueuePeekMessagesOptions)

يسترد peekMessages رسالة واحدة أو أكثر من مقدمة قائمة الانتظار ولكنه لا يغير رؤية الرسالة.

function peekMessages(options?: QueuePeekMessagesOptions)

المعلمات

options: QueuePeekMessagesOptions

خيارات لعملية الرسائل خاطفة.

المرتجعات

Promise<QueuePeekMessagesResponse>

بيانات الاستجابة لعملية رسائل النظرة الخاطفة.

مثال على الاستخدام:

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

receiveMessages(QueueReceiveMessageOptions)

يسترد receiveMessages رسالة واحدة أو أكثر من مقدمة قائمة الانتظار.

function receiveMessages(options?: QueueReceiveMessageOptions)

المعلمات

options: QueueReceiveMessageOptions

خيارات لتلقي عملية الرسائل.

المرتجعات

Promise<QueueReceiveMessageResponse>

بيانات الاستجابة لعملية تلقي الرسائل.

مثال على الاستخدام:

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 رسالة جديدة إلى الجزء الخلفي من قائمة الانتظار. تحدد مهلة الرؤية المدة التي يجب أن تكون فيها الرسالة غير مرئية لعمليات Dequeue وPeek. يصل حجم محتوى الرسالة إلى 64 كيلوبايت، ويجب أن يكون بتنسيق يمكن تضمينه في طلب XML مع ترميز UTF-8. لتضمين العلامات في الرسالة، يجب أن تكون محتويات الرسالة إما مهربة من XML أو ترميز Base64.

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

المعلمات

messageText: string

نص الرسالة المراد إرسالها

options: QueueSendMessageOptions

خيارات لإرسال عملية الرسائل.

المرتجعات

Promise<QueueSendMessageResponse>

بيانات الاستجابة لعملية إرسال الرسائل.

مثال على الاستخدام:

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)

تعيين نهج الوصول المخزنة لقائمة الانتظار التي يمكن استخدامها مع توقيعات الوصول المشترك.

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

المعلمات

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

خيارات قائمة الانتظار تعيين عملية نهج الوصول.

المرتجعات

Promise<QueueSetAccessPolicyResponse>

بيانات الاستجابة لعملية نهج الوصول لمجموعة الانتظار.

setMetadata(Metadata, QueueSetMetadataOptions)

تعيين زوج واحد أو أكثر من أزواج قيمة الاسم المعرفة من قبل المستخدم لقائمة الانتظار المحددة. إذا لم يتم توفير أي خيار، أو لم يتم تحديد بيانات تعريف في معلمة الخيار، فستتم إزالة بيانات تعريف قائمة الانتظار.

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

المعلمات

metadata: Metadata

إذا لم يتم توفير بيانات تعريف، فستتم إزالة جميع بيانات التعريف الموجودة.

options: QueueSetMetadataOptions

خيارات لقائمة الانتظار تعيين عملية بيانات التعريف.

المرتجعات

Promise<QueueSetMetadataResponse>

بيانات الاستجابة لعملية بيانات تعريف مجموعة قائمة الانتظار.

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

يغير التحديث مهلة رؤية الرسالة ومحتوياتها. يصل حجم محتوى الرسالة إلى 64 كيلوبايت، ويجب أن يكون بتنسيق يمكن تضمينه في طلب XML مع ترميز UTF-8. لتضمين العلامات في الرسالة، يجب أن تكون محتويات الرسالة إما مهربة من XML أو ترميز Base64.

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

المعلمات

messageId: string

معرف الرسالة

popReceipt: string

قيمة إيصال pop صالحة تم إرجاعها من مكالمة سابقة إلى رسائل الاستلام أو عملية تحديث الرسالة.

message: string

رسالة للتحديث. إذا كانت هذه المعلمة غير معرفة، فلن يتم تحديث محتوى الرسالة.

visibilityTimeout: number

تحديد قيمة مهلة الرؤية الجديدة، بالثوان، بالنسبة إلى وقت الخادم. يجب أن تكون القيمة الجديدة أكبر من أو تساوي 0، ولا يمكن أن تكون أكبر من 7 أيام. لا يمكن تعيين مهلة رؤية الرسالة إلى قيمة بعد وقت انتهاء الصلاحية. يمكن تحديث رسالة حتى يتم حذفها أو انتهاء صلاحيتها.

options: QueueUpdateMessageOptions

خيارات لتحديث عملية الرسالة.

المرتجعات

Promise<QueueUpdateMessageResponse>

بيانات الاستجابة لعملية رسالة التحديث.

الملاحظات

هل كانت هذه الصفحة مفيدة؟