@azure/storage-queue package

الفصول

AccountSASPermissions	متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كحقل الأذونات على كائن AccountSASSignatureValues. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة.
AccountSASResourceTypes	متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الموارد التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى نوع المورد هذا. بمجرد تعيين كافة القيم، يجب تسلسل هذا مع toString وتعيينه كحقل الموارد على كائن AccountSASSignatureValues. من الممكن إنشاء سلسلة الموارد دون هذه الفئة، ولكن ترتيب الموارد خاص وتضمن هذه الفئة الصحة.
AccountSASServices	متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الخدمات التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى تلك الخدمة. بمجرد تعيين كافة القيم، يجب تسلسل هذا مع toString وتعيينه كحقل الخدمات على كائن AccountSASSignatureValues. من الممكن إنشاء سلسلة الخدمات دون هذه الفئة، ولكن ترتيب الخدمات خاص وتضمن هذه الفئة الصحة.
AnonymousCredential	يوفر AnonymousCredential عضو credentialPolicyCreator المستخدم لإنشاء كائنات AnonymousCredentialPolicy. يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS).
AnonymousCredentialPolicy	يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS).
BaseRequestPolicy	الفئة الأساسية التي تستمد منها كافة نهج الطلب.
Credential	بيانات الاعتماد هي فئة مجردة لتوقيع طلبات AZURE Storage HTTP. ستستضيف هذه الفئة مصنع credentialPolicyCreator الذي ينشئ CredentialPolicy.
CredentialPolicy	نهج بيانات الاعتماد المستخدم لتوقيع طلبات HTTP(S) قبل الإرسال. هذه فئة مجردة.
Pipeline	فئة البنية الأساسية لبرنامج ربط العمليات التجارية تحتوي على نهج طلب HTTP. يمكنك إنشاء مسار افتراضي عن طريق استدعاء newPipeline. أو يمكنك إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية مع النهج الخاصة بك بواسطة منشئ البنية الأساسية لبرنامج ربط العمليات التجارية. راجع newPipeline والنهج المقدمة قبل تنفيذ البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة.
QueueClient	يمثل QueueClient عنوان URL لرسائل Azure Storage Queue مما يسمح لك بمعالجة رسائلها.
QueueSASPermissions	متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعد لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل ServiceSAS إلى قائمة انتظار. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كخانة أذونات على كائن QueueSASSignatureValues. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة.
QueueServiceClient	يمثل QueueServiceClient عنوان URL لخدمة Azure Storage Queue مما يسمح لك بمعالجة قوائم الانتظار.
SASQueryParameters	يمثل المكونات التي تشكل معلمات استعلام AZURE Storage SAS. لا يتم إنشاء هذا النوع مباشرة من قبل المستخدم؛ يتم إنشاؤه فقط بواسطة أنواع AccountSASSignatureValues QueueSASSignatureValues. بمجرد إنشائه، يمكن ترميزه في toString() وإلحاقه بعنوان URL مباشرة (على الرغم من أنه يجب توخي الحذر هنا في حالة وجود معلمات استعلام، والتي قد تؤثر على الوسائل المناسبة لإلحاق معلمات الاستعلام هذه). ملاحظة: مثيلات هذه الفئة غير قابلة للتغيير.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory هي فئة مصنع تساعد في إنشاء كائنات StorageBrowserPolicy.
StorageRetryPolicy	نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية.
StorageRetryPolicyFactory	StorageRetryPolicyFactory هي فئة مصنع تساعد على إنشاء كائنات StorageRetryPolicy.
StorageSharedKeyCredential	متوفر فقط في وقت تشغيل NODE.JS. StorageSharedKeyCredential لتخويل مفتاح الحساب لخدمة Azure Storage.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy هو نهج يستخدم لتوقيع طلب HTTP باستخدام مفتاح مشترك.

الواجهات

AccessPolicy	نهج الوصول
AccountSASSignatureValues	متوفر فقط في وقت تشغيل NODE.JS. يتم استخدام AccountSASSignatureValues لإنشاء توقيع الوصول المشترك (SAS) لحساب Azure Storage. بمجرد تعيين جميع القيم هنا بشكل مناسب، قم باستدعاء generateSASQueryParameters() للحصول على تمثيل SAS الذي يمكن تطبيقه فعليا على عناوين URL لقائمة الانتظار. ملاحظة: وجود كل من هذه الفئة SASQueryParameters لأن الأول قابل للتغيير وتمثيل منطقي بينما يكون الأخير غير قابل للتغيير ويستخدم لإنشاء طلبات REST الفعلية. راجع https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 لمزيد من المعلومات المفاهيمية حول SAS راجع https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas لأوصاف المعلمات، بما في ذلك المطلوبة
CommonOptions	واجهة للخيارات الشائعة لكل عملية بعيدة.
CorsRule	CORS هي ميزة HTTP تمكن تطبيق ويب يعمل ضمن مجال واحد من الوصول إلى الموارد في مجال آخر. تطبق مستعرضات الويب تقييد أمان يعرف بنهج الأصل نفسه الذي يمنع صفحة ويب من استدعاء واجهات برمجة التطبيقات في مجال مختلف؛ توفر CORS طريقة آمنة للسماح لمجال واحد (مجال الأصل) باستدعاء واجهات برمجة التطبيقات في مجال آخر
DequeuedMessageItem	تم إرجاع الكائن في صفيف QueueMessageList عند استدعاء الحصول على الرسائل في قائمة انتظار.
EnqueuedMessage	الكائن الذي تم إرجاعه في صفيف QueueMessageList عند استدعاء وضع رسالة في قائمة انتظار
GeoReplication	معلومات Geo-Replication لخدمة التخزين الثانوية
HttpHeaders	مجموعة من أزواج مفتاح/قيمة عنوان HTTP.
HttpOperationResponse	استجابة Http المتوافقة مع core-v1(core-http).
HttpResponse	تمثيل لاستجابة HTTP التي تتضمن مرجعا إلى الطلب الذي أنشأه.
ListQueuesSegmentResponse	تم إرجاع الكائن عند استدعاء قوائم انتظار القائمة على خدمة قائمة الانتظار.
Logging	إعدادات تسجيل Azure Analytics.
MessageIdDeleteHeaders	تعريف رؤوس عملية MessageId_delete.
MessageIdUpdateHeaders	تعريف الرؤوس لعملية MessageId_update.
MessagesClearHeaders	تعريف الرؤوس لعملية Messages_clear.
MessagesDequeueHeaders	تعريف الرؤوس لعملية Messages_dequeue.
MessagesDequeueOptionalParams	المعلمات الاختيارية.
MessagesEnqueueHeaders	تعريف الرؤوس لعملية Messages_enqueue.
MessagesEnqueueOptionalParams	المعلمات الاختيارية.
MessagesPeekHeaders	تعريف الرؤوس لعملية Messages_peek.
MessagesPeekOptionalParams	المعلمات الاختيارية.
Metadata	مجموعة من أزواج سلسلة قيمة المفتاح.
Metrics	واجهة تمثل المقاييس.
PeekedMessageItem	الكائن الذي تم إرجاعه في صفيف QueueMessageList عند استدعاء رسائل نظرة خاطفة على قائمة انتظار
PipelineLike	واجهة لفئة Pipeline تحتوي على نهج طلب HTTP. يمكنك إنشاء مسار افتراضي عن طريق استدعاء newPipeline. أو يمكنك إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية مع النهج الخاصة بك بواسطة منشئ البنية الأساسية لبرنامج ربط العمليات التجارية. راجع newPipeline والنهج المقدمة قبل تنفيذ البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة.
PipelineOptions	واجهة الخيار لمنشئ البنية الأساسية لبرنامج ربط العمليات التجارية.
QueueClearMessagesOptions	خيارات لتكوين عملية clearMessages
QueueCreateHeaders	تعريف الرؤوس لعملية Queue_create.
QueueCreateIfNotExistsResponse	يحتوي على بيانات استجابة لعملية createIfNotExists.
QueueCreateOptions	خيارات لتكوين إنشاء عملية
QueueDeleteHeaders	تعريف رؤوس عملية Queue_delete.
QueueDeleteIfExistsResponse	يحتوي على بيانات استجابة لعملية deleteIfExists.
QueueDeleteMessageOptions	خيارات لتكوين عملية deleteMessage
QueueDeleteOptions	خيارات لتكوين عملية حذف
QueueExistsOptions	توجد خيارات لتكوين العملية
QueueGenerateSasUrlOptions	خيارات لتكوين إنشاء عملية SasUrl.
QueueGetAccessPolicyHeaders	تعريف الرؤوس لعملية Queue_getAccessPolicy.
QueueGetAccessPolicyOptions	خيارات لتكوين عملية getAccessPolicy
QueueGetPropertiesHeaders	تعريف الرؤوس لعملية Queue_getProperties.
QueueGetPropertiesOptions	خيارات لتكوين عملية getProperties
QueueItem	قائمة انتظار تخزين Azure.
QueuePeekMessagesOptions	خيارات لتكوين عملية peekMessages
QueueReceiveMessageOptions	خيارات لتكوين عملية receiveMessages
QueueSASSignatureValues	متوفر فقط في وقت تشغيل NODE.JS. يتم استخدام QueueSASSignatureValues للمساعدة في إنشاء رموز SAS المميزة لخدمة قائمة الانتظار لقوائم الانتظار.
QueueSendMessageOptions	خيارات لتكوين عملية sendMessage
QueueServiceProperties	خصائص خدمة التخزين.
QueueServiceStatistics	إحصائيات خدمة التخزين.
QueueSetAccessPolicyHeaders	تعريف الرؤوس لعملية Queue_setAccessPolicy.
QueueSetAccessPolicyOptions	خيارات لتكوين عملية setAccessPolicy
QueueSetMetadataHeaders	تعريف الرؤوس لعملية Queue_setMetadata.
QueueSetMetadataOptions	خيارات لتكوين عملية setMetadata
QueueUpdateMessageOptions	خيارات لتكوين عملية updateMessage
RequestPolicy	واجهة متوافقة لنهج طلب core-http
RequestPolicyFactory	واجهة للتوافق مع RequestPolicyFactory ل core-http
RequestPolicyOptions	واجهة للتوافق مع RequestPolicy
ResponseLike	كائن بخاصية _response بسيطة.
ResponseWithBody	كائن بخاصية _response يحتوي على نص ورؤوس تم تحليلها بالفعل إلى أنواع معروفة.
ResponseWithHeaders	كائن بخاصية _response يحتوي على رؤوس تم تحليلها بالفعل في كائن مكتوب.
RestError	نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.
RetentionPolicy	نهج الاستبقاء
SasIPRange	نطاق IP المسموح به ل SAS.
ServiceClientOptions	مجموعة فرعية من @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	خيارات لتكوين عملية generateAccountSasUrl.
ServiceGetPropertiesHeaders	تعريف الرؤوس لعملية Service_getProperties.
ServiceGetPropertiesOptions	خيارات لتكوين عملية getProperties
ServiceGetStatisticsHeaders	تعريف رؤوس عملية Service_getStatistics.
ServiceGetStatisticsOptions	خيارات لتكوين عملية getStatistics
ServiceListQueuesOptions	خيارات لتكوين listQueues العملية
ServiceListQueuesSegmentHeaders	تعريف الرؤوس لعملية Service_listQueuesSegment.
ServiceSetPropertiesHeaders	تعريف الرؤوس لعملية Service_setProperties.
ServiceSetPropertiesOptions	خيارات لتكوين عملية setProperties
SignedIdentifier	معرف موقع.
SignedIdentifierModel	المعرف الموقع
StoragePipelineOptions	واجهة الخيارات لدالة newPipeline.
StorageRetryOptions	واجهة خيارات إعادة محاولة Storage Blob.
WebResource	وصف لطلب HTTP الذي سيتم إجراؤه إلى خادم بعيد.

النوع أسماء مستعارة

GeoReplicationStatusType	تعريف قيم GeoReplicationStatusType.
HttpRequestBody	أنواع الهيئات المدعومة بناء على الطلب. NodeJS.ReadableStream و () => NodeJS.ReadableStream هي Node only. Blob وReadableStream<Uint8Array> و() => ReadableStream<Uint8Array> هي مستعرض فقط.
ListQueuesIncludeType	تعريف قيم ListQueuesIncludeType. تتضمن القيم المحتملة: "بيانات التعريف"
MessageIdDeleteResponse	يحتوي على بيانات استجابة لعملية الحذف.
MessageIdUpdateResponse	يحتوي على بيانات الاستجابة لعملية التحديث.
MessagesClearResponse	يحتوي على بيانات استجابة لعملية المسح.
QueueClearMessagesResponse	يحتوي على بيانات استجابة لعملية clearMessages.
QueueCreateResponse	يحتوي على بيانات الاستجابة لعملية الإنشاء.
QueueDeleteMessageResponse	يحتوي على بيانات استجابة لعملية deleteMessage.
QueueDeleteResponse	يحتوي على بيانات استجابة لعملية الحذف.
QueueGetAccessPolicyResponse	يحتوي على بيانات استجابة لعملية getAccessPolicy.
QueueGetPropertiesResponse	يحتوي على بيانات الاستجابة لعملية getProperties.
QueuePeekMessagesResponse	يحتوي على بيانات الاستجابة لعملية peekMessages.
QueueReceiveMessageResponse	يحتوي على بيانات الاستجابة لعملية receiveMessages.
QueueSendMessageResponse	يحتوي على بيانات الاستجابة لعملية sendMessage.
QueueSetAccessPolicyResponse	يحتوي على بيانات الاستجابة لعملية setAccessPolicy.
QueueSetMetadataResponse	يحتوي على بيانات استجابة لعملية setMetadata.
QueueUpdateMessageResponse	يحتوي على بيانات استجابة لعملية updateMessage.
ReceivedMessageItem	الكائن الذي تم إرجاعه في الصفيف receivedMessageItems عند استدعاء receiveMessages. راجع: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	يحتوي على بيانات الاستجابة لعملية getProperties.
ServiceGetStatisticsResponse	يحتوي على بيانات الاستجابة لعملية getStatistics.
ServiceListQueuesSegmentResponse	يحتوي على بيانات الاستجابة لعملية listQueuesSegment.
ServiceSetPropertiesResponse	يحتوي على بيانات الاستجابة لعملية setProperties.
WithResponse	نوع يمثل نتيجة عملية بخاصية _response معروفة.

التعدادات

SASProtocol	بروتوكولات SAS التي تم إنشاؤها.
StorageQueueAudience	يحدد جمهور السحابة المعروف ل Storage.
StorageRetryPolicyType	أنواع RetryPolicy.

الوظائف

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	متوفر فقط في وقت تشغيل NODE.JS. إنشاء SASQueryParameters الكائن الذي يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters. يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف. تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه.
getQueueServiceAccountAudience(string)	للحصول على جمهور OAuth لحساب تخزين لخدمة قائمة الانتظار.
isPipelineLike(unknown)	مساعد لتحديد ما إذا كانت وسيطة معينة تفي بعقد البنية الأساسية لبرنامج ربط العمليات التجارية
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	إنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

تفاصيل الوظيفة

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

متوفر فقط في وقت تشغيل NODE.JS.

إنشاء SASQueryParameters الكائن الذي يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

المعلمات

accountSASSignatureValues

AccountSASSignatureValues

قيم توقيع SAS للحساب

sharedKeyCredential

StorageSharedKeyCredential

بيانات اعتماد المفتاح المشترك.

المرتجعات

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

متوفر فقط في وقت تشغيل NODE.JS.

إنشاء مثيل SASQueryParameters.

يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف.

تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

المعلمات

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

المرتجعات

SASQueryParameters

getQueueServiceAccountAudience(string)

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

function getQueueServiceAccountAudience(storageAccountName: string): string

المعلمات

storageAccountName

string

المرتجعات

string

isPipelineLike(unknown)

مساعد لتحديد ما إذا كانت وسيطة معينة تفي بعقد البنية الأساسية لبرنامج ربط العمليات التجارية

function isPipelineLike(pipeline: unknown): pipeline

المعلمات

pipeline

unknown

وسيطة قد تكون مسارا

المرتجعات

pipeline

صواب عندما تفي الوسيطة بعقد البنية الأساسية لبرنامج ربط العمليات التجارية

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

إنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

المعلمات

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions

StoragePipelineOptions

Optional. Options.

المرتجعات

Pipeline

كائن مسار جديد.