queue الحزمة

الحِزم

aio

الفصول

AccessPolicy	فئة نهج الوصول المستخدمة من قبل المجموعة والحصول على أساليب نهج الوصول. يمكن لنهج الوصول المخزن تحديد وقت البدء ووقت انتهاء الصلاحية والأذونات لتوقيعات الوصول المشترك المقترنة به. اعتمادا على الطريقة التي تريد بها التحكم في الوصول إلى المورد الخاص بك، يمكنك تحديد جميع هذه المعلمات ضمن نهج الوصول المخزن، وحذفها من عنوان URL لتوقيع الوصول المشترك. يسمح لك القيام بذلك بتعديل سلوك التوقيع المقترن في أي وقت، بالإضافة إلى إبطاله. أو يمكنك تحديد معلمة واحدة أو أكثر من معلمات نهج الوصول داخل نهج الوصول المخزن، والأخرى على عنوان URL. وأخيرا، يمكنك تحديد جميع المعلمات على عنوان URL. في هذه الحالة، يمكنك استخدام نهج الوصول المخزن لإبطال التوقيع، ولكن ليس لتعديل سلوكه. يجب أن يتضمن كل من توقيع الوصول المشترك ونهج الوصول المخزن جميع الحقول المطلوبة لمصادقة التوقيع. إذا كانت هناك أي حقول مطلوبة مفقودة، فسيفشل الطلب. وبالمثل، إذا تم تحديد حقل في عنوان URL توقيع الوصول المشترك وفي نهج الوصول المخزن، فسيفشل الطلب مع رمز الحالة 400 (طلب غير صحيح).
AccountSasPermissions	ResourceTypes الفئة التي سيتم استخدامها مع دالة generate_account_sas و AccessPolicies المستخدمة مع set_*_acl. هناك نوعان من SAS التي يمكن استخدامها لمنح الوصول إلى الموارد. الأول هو منح حق الوصول إلى مورد معين (خاص بالموارد). آخر هو منح حق الوصول إلى الخدمة بأكملها لحساب معين والسماح بعمليات معينة استنادا إلى perms الموجودة هنا.
BinaryBase64DecodePolicy	نهج فك ترميز الرسائل للرسائل المشفرة الأساسية 64 إلى وحدات البايت. فك ترميز الرسائل المرمزة ب base64 إلى وحدات البايت. إذا لم يكن محتوى الإدخال صالحا للقاعدة 64، فسيتم رفع DecodeError.
BinaryBase64EncodePolicy	نهج ترميز الرسائل الأساسية 64 للرسائل الثنائية. ترميز الرسائل الثنائية إلى القاعدة 64. إذا لم يكن محتوى الإدخال بايت، فسيتم رفع TypeError.
CorsRule	تُعد مشاركة الموارد عبر المنشأ (CORS) إحدى ميزات HTTP التي تمكّن تطبيق ويب يعمل ضمن مجال واحد للوصول إلى الموارد في مجال آخر. تعمل مستعرضات الويب على تطبيق قيود أمان تُعرف باسم نهج المنشأ ذاته الذي يمنع صفحة ويب من استدعاء واجهات برمجة التطبيقات في مجال آخر؛ وتوفر CORS طريقة آمنة للسماح لمجال واحد (مجال المنشأ) باستدعاء واجهات برمجة التطبيقات في مجال آخر. يجب ملء جميع المعلمات المطلوبة لإرسالها إلى Azure.
ExponentialRetry	إعادة المحاولة الأسية. إنشاء كائن إعادة محاولة أسي. يتم استخدام initial_backoff لإعادة المحاولة الأولى. تتم إعادة محاولة عمليات إعادة المحاولة اللاحقة بعد initial_backoff + increment_power^retry_count ثانية.
LinearRetry	إعادة المحاولة الخطية. إنشاء كائن إعادة محاولة خطي.
LocationMode	يحدد الموقع الذي يجب إرسال الطلب إليه. ينطبق هذا الوضع فقط على حسابات RA-GRS التي تسمح بالوصول الثانوي للقراءة. يجب أن تستخدم جميع أنواع الحسابات الأخرى PRIMARY.
Metrics	ملخص إحصائيات الطلب التي تم تجميعها بواسطة واجهة برمجة التطبيقات في تجميعات الساعة أو الدقيقة. يجب ملء جميع المعلمات المطلوبة لإرسالها إلى Azure.
QueueAnalyticsLogging	إعدادات تسجيل Azure Analytics. يجب ملء جميع المعلمات المطلوبة لإرسالها إلى Azure.
QueueClient	عميل للتفاعل مع قائمة انتظار معينة. لمزيد من التكوين الاختياري، يرجى النقر هنا.
QueueMessage	يمثل رسالة قائمة انتظار.
QueueProperties	خصائص قائمة الانتظار.
QueueSasPermissions	فئة QueueSasPermissions لاستخدامها مع الدالة generate_queue_sas و AccessPolicies المستخدمة مع set_queue_access_policy.
QueueServiceClient	عميل للتفاعل مع خدمة قائمة الانتظار على مستوى الحساب. يوفر هذا العميل عمليات لاسترداد وتكوين خصائص الحساب بالإضافة إلى قائمة وإنشاء وحذف قوائم الانتظار داخل الحساب. بالنسبة للعمليات المتعلقة بقائمة انتظار معينة، يمكن استرداد عميل لهذا الكيان باستخدام الدالة get_queue_client . لمزيد من التكوين الاختياري، يرجى النقر هنا.
ResourceTypes	يحدد أنواع الموارد التي يمكن الوصول إليها باستخدام SAS للحساب.
RetentionPolicy	نهج الاستبقاء الذي يحدد المدة التي يجب أن تستمر فيها البيانات المقترنة. يجب ملء جميع المعلمات المطلوبة لإرسالها إلى Azure.
TextBase64DecodePolicy	نهج فك ترميز الرسائل للرسائل المشفرة الأساسية 64 إلى نص. فك ترميز الرسائل المرمزة ب base64 إلى نص (unicode). إذا لم يكن محتوى الإدخال صالحا للقاعدة 64، فسيتم رفع DecodeError. يجب أن تدعم بيانات الرسالة UTF-8.
TextBase64EncodePolicy	نهج ترميز الرسائل الأساسية 64 للرسائل النصية. ترميز رسائل النص (unicode) إلى الأساس 64. إذا لم يكن محتوى الإدخال نصا، فسيتم رفع TypeError. يجب أن يدعم نص الإدخال UTF-8.

التعدادات

StorageErrorCode

الوظائف

generate_account_sas

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

استخدم التوقيع الذي تم إرجاعه مع معلمة بيانات الاعتماد لأي خدمة قائمة انتظار.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str, start: datetime | str | None = None, ip: str | None = None, **kwargs: Any) -> str

المعلمات

account_name

str

مطلوب

اسم حساب التخزين المستخدم لإنشاء توقيع الوصول المشترك.

account_key

str

مطلوب

مفتاح الحساب، الذي يسمى أيضا المفتاح المشترك أو مفتاح الوصول، لإنشاء توقيع الوصول المشترك.

resource_types

ResourceTypes

مطلوب

يحدد أنواع الموارد التي يمكن الوصول إليها باستخدام SAS للحساب.

permission

AccountSasPermissions أو str

مطلوب

الأذونات المقترنة بتوقيع الوصول المشترك. يقتصر المستخدم على العمليات المسموح بها بواسطة الأذونات.

expiry

datetime أو str

مطلوب

الوقت الذي يصبح فيه توقيع الوصول المشترك غير صالح. سيقوم Azure دائما بتحويل القيم إلى UTC. إذا تم تمرير تاريخ بدون معلومات المنطقة الزمنية، فمن المفترض أن يكون UTC.

start

datetime أو str

القيمة الافتراضية: None

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

ip

str

القيمة الافتراضية: None

تحديد عنوان IP أو نطاق من عناوين IP التي يمكن قبول الطلبات منها. إذا كان عنوان IP الذي ينشأ منه الطلب لا يتطابق مع عنوان IP أو نطاق العنوان المحدد على رمز SAS المميز، فلن تتم مصادقة الطلب. على سبيل المثال، يؤدي تحديد sip=168.1.5.65 أو sip=168.1.5.60-168.1.5.70 على SAS إلى تقييد الطلب على عناوين IP هذه.

protocol

str

يحدد البروتوكول المسموح به لطلب تم إجراؤه. القيمة الافتراضية هي https.

المرتجعات

رمز مميز لتوقيع الوصول المشترك (sas).

نوع الإرجاع

str

generate_queue_sas

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

استخدم التوقيع الذي تم إرجاعه مع معلمة بيانات الاعتماد لأي خدمة قائمة انتظار.

generate_queue_sas(account_name: str, queue_name: str, account_key: str, permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> str

المعلمات

account_name

str

مطلوب

اسم حساب التخزين المستخدم لإنشاء توقيع الوصول المشترك.

queue_name

str

مطلوب

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

account_key

str

مطلوب

مفتاح الحساب، الذي يسمى أيضا المفتاح المشترك أو مفتاح الوصول، لإنشاء توقيع الوصول المشترك.

permission

QueueSasPermissions أو str

القيمة الافتراضية: None

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

expiry

datetime أو str

القيمة الافتراضية: None

الوقت الذي يصبح فيه توقيع الوصول المشترك غير صالح. مطلوب ما لم يتم إعطاء policy_id تشير إلى نهج وصول مخزن يحتوي على هذا الحقل. يجب حذف هذا الحقل إذا تم تحديده في نهج وصول مخزن مقترن. سيقوم Azure دائما بتحويل القيم إلى UTC. إذا تم تمرير تاريخ بدون معلومات المنطقة الزمنية، فمن المفترض أن يكون UTC.

start

datetime أو str

القيمة الافتراضية: None

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

policy_id

str

القيمة الافتراضية: None

قيمة فريدة يصل طولها إلى 64 حرفا ترتبط بنهج وصول مخزن. لإنشاء نهج وصول مخزن، استخدم set_queue_access_policy.

ip

str

القيمة الافتراضية: None

تحديد عنوان IP أو نطاق من عناوين IP التي يمكن قبول الطلبات منها. إذا كان عنوان IP الذي ينشأ منه الطلب لا يتطابق مع عنوان IP أو نطاق العنوان المحدد على رمز SAS المميز، فلن تتم مصادقة الطلب. على سبيل المثال، يؤدي تحديد sip='168.1.5.65' أو sip='168.1.5.60-168.1.5.70' على SAS إلى تقييد الطلب على عناوين IP هذه.

protocol

str

يحدد البروتوكول المسموح به لطلب تم إجراؤه. القيمة الافتراضية هي https.

المرتجعات

رمز مميز لتوقيع الوصول المشترك (sas).

نوع الإرجاع

str

أمثلة

إنشاء رمز sas المميز.

   from azure.storage.queue import generate_queue_sas
   sas_token = generate_queue_sas(
       queue.account_name,
       queue.queue_name,
       queue.credential.account_key,
       policy_id='my-access-policy-id'
   )