@azure/storage-queue package
الفصول
| AccountSASPermissions |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه ك حقل الأذونات على كائن <xref:AccountSASSignatureValues>. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة. |
| AccountSASResourceTypes |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الموارد التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى نوع المورد هذا. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه ك حقل الموارد على كائن <xref:AccountSASSignatureValues>. من الممكن إنشاء سلسلة الموارد دون هذه الفئة، ولكن ترتيب الموارد خاص وتضمن هذه الفئة الصحة. |
| AccountSASServices |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الخدمات التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى تلك الخدمة. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه ك حقل الخدمات على كائن <xref:AccountSASSignatureValues>. من الممكن إنشاء سلسلة الخدمات دون هذه الفئة، ولكن ترتيب الخدمات خاص وتضمن هذه الفئة الصحة. |
| AnonymousCredential |
يوفر AnonymousCredential عضوا <xref:CredentialPolicyCreator> يستخدم لإنشاء كائنات <xref:AnonymousCredentialPolicy>. يتم استخدام <xref:AnonymousCredentialPolicy> مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS). |
| AnonymousCredentialPolicy |
يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS). |
| 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 وتعيينه كخانة أذونات على كائن <xref:QueueSASSignatureValues>. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة. |
| QueueServiceClient |
يمثل QueueServiceClient عنوان URL لخدمة Azure Storage Queue مما يسمح لك بمعالجة قوائم الانتظار. |
| SASQueryParameters |
يمثل المكونات التي تشكل معلمات استعلام AZURE Storage SAS. لا يتم إنشاء هذا النوع مباشرة من قبل المستخدم؛ يتم إنشاؤه فقط بواسطة أنواع <xref:AccountSASSignatureValues><xref:QueueSASSignatureValues>. بمجرد إنشائه، يمكن ترميزه في <xref:String> وإلحاقه بعنوان URL مباشرة (على الرغم من أنه يجب توخي الحذر هنا في حالة وجود معلمات استعلام، والتي قد تؤثر على الوسائل المناسبة لإلحاق معلمات الاستعلام هذه). ملاحظة: مثيلات هذه الفئة غير قابلة للتغيير. |
| StorageBrowserPolicy |
سيتعامل StorageBrowserPolicy مع الاختلافات بين Node.js ووقت تشغيل المستعرض، بما في ذلك:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory هي فئة مصنع تساعد على إنشاء كائنات <xref:StorageBrowserPolicy>. |
| StorageClient |
يمثل StorageClient فئة عميل تستند إلى <xref:QueueServiceClient><xref:QueueClient> وما إلى ذلك. |
| StorageClientContext | |
| StorageRetryPolicy |
نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory هي فئة مصنع تساعد على إنشاء كائنات <xref:StorageRetryPolicy>. |
| StorageSharedKeyCredential |
متوفر فقط في وقت تشغيل NODE.JS. StorageSharedKeyCredential لتخويل مفتاح الحساب لخدمة Azure Storage. |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy هو نهج يستخدم لتوقيع طلب HTTP باستخدام مفتاح مشترك. |
الواجهات
| AccessPolicy |
نهج الوصول |
| AccountSASSignatureValues |
متوفر فقط في وقت تشغيل NODE.JS. يتم استخدام AccountSASSignatureValues لإنشاء توقيع الوصول المشترك (SAS) لحساب Azure Storage. بمجرد تعيين جميع القيم هنا بشكل مناسب، قم باستدعاء generateSASQueryParameters() للحصول على تمثيل SAS الذي يمكن تطبيقه فعليا على عناوين URL لقائمة الانتظار. ملاحظة: أن كلا من هذه الفئة <xref:SASQueryParameters> موجودة لأن الأول قابل للتغيير وتمثيل منطقي بينما الأخير غير قابل للتغيير ويستخدم لإنشاء طلبات REST الفعلية. |
| CommonOptions |
واجهة للخيارات الشائعة لكل عملية بعيدة. |
| CorsRule |
CORS هي ميزة HTTP تمكن تطبيق ويب يعمل ضمن مجال واحد من الوصول إلى الموارد في مجال آخر. تطبق مستعرضات الويب تقييد أمان يعرف بنهج الأصل نفسه الذي يمنع صفحة ويب من استدعاء واجهات برمجة التطبيقات في مجال مختلف؛ توفر CORS طريقة آمنة للسماح لمجال واحد (مجال الأصل) باستدعاء واجهات برمجة التطبيقات في مجال آخر |
| DequeuedMessageItem |
تم إرجاع الكائن في صفيف QueueMessageList عند استدعاء الحصول على الرسائل في قائمة انتظار. |
| EnqueuedMessage |
الكائن الذي تم إرجاعه في صفيف QueueMessageList عند استدعاء وضع رسالة في قائمة انتظار |
| GeoReplication |
معلومات Geo-Replication لخدمة التخزين الثانوية |
| 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 عند استدعاء رسائل نظرة خاطفة على قائمة انتظار |
| PipelineOptions |
واجهة الخيار لمنشئ البنية الأساسية لبرنامج ربط العمليات التجارية. |
| QueueClearMessagesOptions |
خيارات لتكوين عملية <xref:QueueClient.clearMessages> |
| QueueCreateHeaders |
تعريف الرؤوس لعملية Queue_create. |
| QueueCreateIfNotExistsResponse |
يحتوي على بيانات استجابة لعملية <xref:QueueClient.createIfNotExists>. |
| QueueCreateOptions |
خيارات لتكوين عملية <xref:QueueClient.create> |
| QueueDeleteHeaders |
تعريف رؤوس عملية Queue_delete. |
| QueueDeleteIfExistsResponse |
يحتوي على بيانات استجابة لعملية <xref:QueueClient.deleteIfExists>. |
| QueueDeleteMessageOptions |
خيارات لتكوين عملية <xref:QueueClient.deleteMessage> |
| QueueDeleteOptions |
خيارات لتكوين عملية <xref:QueueClient.delete> |
| QueueExistsOptions |
خيارات لتكوين عملية <xref:QueueClient.exists> |
| QueueGenerateSasUrlOptions |
خيارات لتكوين عملية <xref:QueueClient.generateSasUrl>. |
| QueueGetAccessPolicyHeaders |
تعريف الرؤوس لعملية Queue_getAccessPolicy. |
| QueueGetAccessPolicyOptions |
خيارات لتكوين عملية <xref:QueueClient.getAccessPolicy> |
| QueueGetPropertiesHeaders |
تعريف الرؤوس لعملية Queue_getProperties. |
| QueueGetPropertiesOptions |
خيارات لتكوين عملية <xref:QueueClient.getProperties> |
| QueueItem |
قائمة انتظار تخزين Azure. |
| QueuePeekMessagesOptions |
خيارات لتكوين عملية <xref:QueueClient.peekMessages> |
| QueueReceiveMessageOptions |
خيارات لتكوين عملية <xref:QueueClient.receiveMessages> |
| QueueSASSignatureValues |
متوفر فقط في وقت تشغيل NODE.JS. يتم استخدام QueueSASSignatureValues للمساعدة في إنشاء رموز SAS المميزة لخدمة قائمة الانتظار لقوائم الانتظار. |
| QueueSendMessageOptions |
خيارات لتكوين عملية <xref:QueueClient.sendMessage> |
| QueueServiceProperties |
خصائص خدمة التخزين. |
| QueueServiceStatistics |
إحصائيات خدمة التخزين. |
| QueueSetAccessPolicyHeaders |
تعريف الرؤوس لعملية Queue_setAccessPolicy. |
| QueueSetAccessPolicyOptions |
خيارات لتكوين عملية <xref:QueueClient.setAccessPolicy> |
| QueueSetMetadataHeaders |
تعريف الرؤوس لعملية Queue_setMetadata. |
| QueueSetMetadataOptions |
خيارات لتكوين عملية <xref:QueueClient.setMetadata> |
| QueueUpdateMessageOptions |
خيارات لتكوين عملية <xref:QueueClient.updateMessage> |
| RetentionPolicy |
نهج الاستبقاء |
| SasIPRange |
نطاق IP المسموح به ل SAS. |
| ServiceGenerateAccountSasUrlOptions |
خيارات لتكوين عملية <xref:QueueServiceClient.generateAccountSasUrl>. |
| ServiceGetPropertiesHeaders |
تعريف الرؤوس لعملية Service_getProperties. |
| ServiceGetPropertiesOptions |
خيارات لتكوين عملية <xref:QueueServiceClient.getProperties> |
| ServiceGetStatisticsHeaders |
تعريف رؤوس عملية Service_getStatistics. |
| ServiceGetStatisticsOptions |
خيارات لتكوين عملية <xref:QueueServiceClient.getStatistics> |
| ServiceListQueuesOptions |
خيارات لتكوين عملية <xref:QueueServiceClient.listQueues> |
| ServiceListQueuesSegmentHeaders |
تعريف الرؤوس لعملية Service_listQueuesSegment. |
| ServiceSetPropertiesHeaders |
تعريف الرؤوس لعملية Service_setProperties. |
| ServiceSetPropertiesOptions |
خيارات لتكوين عملية <xref:QueueServiceClient.setProperties> |
| SignedIdentifier |
المعرف الموقع. |
| SignedIdentifierModel |
المعرف الموقع |
| StorageClientOptionalParams |
المعلمات الاختيارية. |
| StoragePipelineOptions |
واجهة الخيار لأسلوب newPipeline(). |
| StorageRetryOptions |
واجهة خيارات إعادة محاولة قائمة انتظار التخزين. |
النوع أسماء مستعارة
| CredentialPolicyCreator |
دالة مصنع تنشئ نهج بيانات اعتماد جديد يستخدم النهج التالي المتوفر. |
| GeoReplicationStatusType |
تعريف قيم GeoReplicationStatusType. |
| ListQueuesIncludeType |
تعريف قيم ListQueuesIncludeType. تتضمن القيم المحتملة: "بيانات التعريف" |
| MessageIdDeleteResponse |
يحتوي على بيانات استجابة لعملية الحذف. |
| MessageIdUpdateResponse |
يحتوي على بيانات الاستجابة لعملية التحديث. |
| MessagesClearResponse |
يحتوي على بيانات استجابة لعملية المسح. |
| QueueClearMessagesResponse |
يحتوي على بيانات استجابة لعملية <xref:QueueClient.clearMessages>. |
| QueueCreateResponse |
يحتوي على بيانات الاستجابة لعملية الإنشاء. |
| QueueDeleteMessageResponse |
يحتوي على بيانات استجابة لعملية <xref:QueueClient.deleteMessage>. |
| QueueDeleteResponse |
يحتوي على بيانات استجابة لعملية الحذف. |
| QueueGetAccessPolicyResponse |
يحتوي على بيانات استجابة لعملية <xref:QueueClient.getAccessPolicy>. |
| QueueGetPropertiesResponse |
يحتوي على بيانات الاستجابة لعملية getProperties. |
| QueuePeekMessagesResponse |
يحتوي على بيانات الاستجابة لعملية <xref:QueueClient.peekMessages>. |
| QueueReceiveMessageResponse |
يحتوي على بيانات الاستجابة لعملية <xref:QueueClient.receiveMessages>. |
| QueueSendMessageResponse |
يحتوي على بيانات الاستجابة لعملية <xref:QueueClient.sendMessage>. |
| QueueSetAccessPolicyResponse |
يحتوي على بيانات الاستجابة لعملية setAccessPolicy. |
| QueueSetMetadataResponse |
يحتوي على بيانات استجابة لعملية setMetadata. |
| QueueUpdateMessageResponse |
يحتوي على بيانات استجابة لعملية <xref:QueueClient.updateMessage>. |
| ReceivedMessageItem |
تم إرجاع الكائن في الصفيف |
| ServiceGetPropertiesResponse |
يحتوي على بيانات الاستجابة لعملية getProperties. |
| ServiceGetStatisticsResponse |
يحتوي على بيانات الاستجابة لعملية getStatistics. |
| ServiceListQueuesSegmentResponse |
يحتوي على بيانات الاستجابة لعملية listQueuesSegment. |
| ServiceSetPropertiesResponse |
يحتوي على بيانات الاستجابة لعملية setProperties. |
التعدادات
| SASProtocol |
بروتوكولات SAS التي تم إنشاؤها. |
| StorageRetryPolicyType |
أنواع نهج إعادة المحاولة. |
الوظائف
| generate |
متوفر فقط في وقت تشغيل NODE.JS. ينشئ كائن <xref:SASQueryParameters> يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي. |
| generate |
متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters. يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف. تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه. |
| new |
إنشاء كائن مسار جديد مع توفير بيانات الاعتماد. |
تفاصيل الوظيفة
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
متوفر فقط في وقت تشغيل NODE.JS. ينشئ كائن <xref:SASQueryParameters> يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
المعلمات
- accountSASSignatureValues
- AccountSASSignatureValues
قيم توقيع SAS للحساب
- sharedKeyCredential
- StorageSharedKeyCredential
بيانات اعتماد المفتاح المشترك.
المرتجعات
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters.
يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف.
تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه.
function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
المعلمات
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
المرتجعات
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
إنشاء كائن مسار جديد مع توفير بيانات الاعتماد.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
المعلمات
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.
- pipelineOptions
- StoragePipelineOptions
خيارات.
المرتجعات
كائن مسار جديد.