ContainerClient الفصل

‏‏المرجع

عميل للتفاعل مع حاوية معينة، على الرغم من أن هذه الحاوية قد لا تكون موجودة بعد.

بالنسبة للعمليات المتعلقة بكائن ثنائي كبير الحجم محدد داخل هذه الحاوية، يمكن استرداد عميل كائن ثنائي كبير الحجم باستخدام الدالة get_blob_client .

لمزيد من التكوين الاختياري، يرجى النقر هنا.

توريث: azure.storage.blob._shared.base_client.StorageAccountHostsMixin

ContainerClient

azure.storage.blob._encryption.StorageEncryptionMixin

ContainerClient

الدالمنشئ

ContainerClient(account_url: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

المعلمات

account_url: str

مطلوب

عنوان URI لحساب التخزين. لإنشاء عميل نظرا ل URI الكامل للحاوية، استخدم from_container_url classmethod.

container_name: str

مطلوب

اسم الحاوية للكائن الثنائي كبير الحجم.

credential

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

بيانات الاعتماد التي يجب المصادقة بها. هذا اختياري إذا كان عنوان URL للحساب يحتوي بالفعل على رمز SAS مميز. يمكن أن تكون القيمة سلسلة رمز SAS المميز أو مثيل AzureSasCredential أو AzureNamedKeyCredential من azure.core.credentials أو مفتاح وصول مشترك للحساب أو مثيل فئة TokenCredentials من azure.identity. إذا كان عنوان URI للمورد يحتوي بالفعل على رمز SAS المميز، فسيتم تجاهل هذا لصالح بيانات اعتماد صريحة

باستثناء حالة AzureSasCredential، حيث سترفع رموز SAS المميزة المتعارضة ValueError. إذا كنت تستخدم مثيل AzureNamedKeyCredential، يجب أن يكون "الاسم" هو اسم حساب التخزين، ويجب أن يكون "المفتاح" هو مفتاح حساب التخزين.

api_version: str

إصدار Storage API لاستخدامه للطلبات. القيمة الافتراضية هي أحدث إصدار خدمة متوافق مع SDK الحالي. قد يؤدي الإعداد إلى إصدار أقدم إلى تقليل توافق الميزات.

جديد في الإصدار 12.2.0.

secondary_hostname: str

اسم مضيف نقطة النهاية الثانوية.

max_block_size: int

الحد الأقصى لحجم المجموعة لتحميل كائن ثنائي كبير الحجم للكتلة في مجموعات. الإعدادات الافتراضية هي 4*1024*1024 أو 4 ميغابايت.

max_single_put_size: int

إذا كان حجم الكائن الثنائي كبير الحجم أقل من أو يساوي max_single_put_size، فسيتم تحميل الكائن الثنائي كبير الحجم مع طلب http PUT واحد فقط. إذا كان حجم الكائن الثنائي كبير الحجم أكبر من max_single_put_size، فسيتم تحميل الكائن الثنائي كبير الحجم في مجموعات. الإعدادات الافتراضية هي 64*1024*1024 أو 64 ميغابايت.

min_large_block_upload_threshold: int

الحد الأدنى لحجم المجموعة المطلوب لاستخدام خوارزمية الذاكرة الفعالة عند تحميل كائن ثنائي كبير الحجم للكتلة. الإعدادات الافتراضية إلى 4*1024*1024+1.

use_byte_buffer: bool

استخدم مخزنا مؤقتا بايت لتحميلات كائن ثنائي كبير الحجم للكتلة. الإعدادات الافتراضية معينة على False.

max_page_size: int

الحد الأقصى لحجم المجموعة لتحميل كائن ثنائي كبير الحجم للصفحة. الإعدادات الافتراضية هي 4*1024*1024 أو 4 ميغابايت.

max_single_get_size: int

الحد الأقصى لحجم الكائن الثنائي كبير الحجم الذي سيتم تنزيله في مكالمة واحدة، سيتم تنزيل الجزء الذي تم تجاوزه في مجموعات (قد يكون متوازيا). الإعدادات الافتراضية هي 32*1024*1024 أو 32 ميغابايت.

max_chunk_get_size: int

الحد الأقصى لحجم المجموعة المستخدمة لتنزيل كائن ثنائي كبير الحجم. الإعدادات الافتراضية هي 4*1024*1024 أو 4 ميغابايت.

الأساليب

acquire_lease	يطلب عقد إيجار جديد. إذا لم يكن للحاوية عقد إيجار نشط، تقوم خدمة Blob بإنشاء عقد إيجار على الحاوية وإرجاع معرف إيجار جديد.
close	هذا الأسلوب هو إغلاق مآخذ التوصيل التي يفتحها العميل. لا يلزم استخدامه عند استخدام مع مدير سياق.
create_container	إنشاء حاوية جديدة ضمن الحساب المحدد. إذا كانت الحاوية بنفس الاسم موجودة بالفعل، تفشل العملية.
delete_blob	وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف. يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه لحذف كائن ثنائي كبير الحجم، يجب حذف جميع اللقطات الخاصة به. يمكنك حذف كليهما في نفس الوقت مع عملية delete_blob. إذا تم تمكين نهج استبقاء حذف للخدمة، فإن هذه العملية تحذف النقطة أو اللقطة بشكل مبدئي وتحتفظ بالكائنات الثنائية كبيرة الحجم أو اللقطة لعدد محدد من الأيام. بعد عدد محدد من الأيام، تتم إزالة بيانات الكائن الثنائي كبير الحجم من الخدمة أثناء تجميع البيانات المهملة. يمكن الوصول إلى الكائن الثنائي كبير الحجم أو اللقطة المحذوفة مبدئيا من خلال list_blobs تحديد خيار include=["deleted"]. يمكن استعادة الكائن الثنائي كبير الحجم أو اللقطة المحذوفة مبدئيا باستخدام <xref:azure.storage.blob.BlobClient.undelete>
delete_blobs	وضع علامة على الكائنات الثنائية كبيرة الحجم أو اللقطات المحددة للحذف. يتم حذف الكائنات الثنائية كبيرة الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه لحذف الكائنات الثنائية كبيرة الحجم، يجب حذف جميع اللقطات الخاصة بها. يمكنك حذف كليهما في نفس الوقت مع عملية delete_blobs. إذا تم تمكين نهج استبقاء الحذف للخدمة، فإن هذه العملية تحذف الكائنات الثنائية كبيرة الحجم أو اللقطات بشكل مبدئي وتحتفظ بالكائنات الثنائية كبيرة الحجم أو اللقطات لعدد محدد من الأيام. بعد عدد محدد من الأيام، تتم إزالة بيانات الكائنات الثنائية كبيرة الحجم من الخدمة أثناء تجميع البيانات المهملة. يمكن الوصول إلى الكائنات الثنائية كبيرة الحجم أو اللقطات المحذوفة مبدئيا من خلال list_blobs تحديد include=["deleted"] يمكن استعادة الكائنات الثنائية كبيرة الحجم أو اللقطات المحذوفة مبدئيا باستخدام <xref:azure.storage.blob.BlobClient.undelete> الحد الأقصى لعدد الكائنات الثنائية كبيرة الحجم التي يمكن حذفها في طلب واحد هو 256.
delete_container	وضع علامة على الحاوية المحددة للحذف. يتم حذف الحاوية وأي كائنات ثنائية كبيرة الحجم موجودة داخلها لاحقا أثناء تجميع البيانات المهملة.
download_blob	تنزيل كائن ثنائي كبير الحجم إلى StorageStreamDownloader. يجب استخدام أسلوب readall() لقراءة كل المحتوى أو يجب استخدام readinto() لتنزيل الكائن الثنائي كبير الحجم في دفق. يؤدي استخدام الأجزاء () إلى إرجاع مكرر يسمح للمستخدم بالتكرار عبر المحتوى في مجموعات.
exists	إرجاع True إذا كانت الحاوية موجودة وإرجاع False بخلاف ذلك.
find_blobs_by_tags	إرجاع منشئ لسرد الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة التي تتطابق علاماتها مع تعبير البحث المحدد. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة.
from_connection_string	إنشاء ContainerClient من سلسلة اتصال.
from_container_url	إنشاء ContainerClient من عنوان URL للحاوية.
get_account_information	يحصل على معلومات تتعلق بحساب التخزين. يمكن أيضا استرداد المعلومات إذا كان لدى المستخدم SAS إلى حاوية أو كائن ثنائي كبير الحجم. تتضمن المفاتيح الموجودة في القاموس الذي تم إرجاعه "sku_name" و"account_kind".
get_blob_client	احصل على عميل للتفاعل مع الكائن الثنائي كبير الحجم المحدد. الكائن الثنائي كبير الحجم غير موجود بالفعل.
get_container_access_policy	الحصول على أذونات الحاوية المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات الحاوية بشكل عام.
get_container_properties	إرجاع جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام للحاوية المحددة. لا تتضمن البيانات التي تم إرجاعها قائمة الكائنات الثنائية كبيرة الحجم للحاوية.
list_blob_names	إرجاع منشئ لسرد أسماء الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة. لاحظ أنه لن يتم إرجاع أي خصائص أو بيانات تعريف إضافية عند استخدام واجهة برمجة التطبيقات هذه. بالإضافة إلى ذلك، لا تحتوي واجهة برمجة التطبيقات هذه على خيار لتضمين كائنات ثنائية كبيرة الحجم إضافية مثل اللقطات والإصدارات والكائنات الثنائية كبيرة الحجم المحذوفة مبدئيا وما إلى ذلك. للحصول على أي من هذه البيانات، استخدم list_blobs.
list_blobs	إرجاع منشئ لسرد الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة.
set_container_access_policy	تعيين أذونات الحاوية المحددة أو نهج الوصول المخزنة التي يمكن استخدامها مع توقيعات الوصول المشترك. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الكائنات الثنائية كبيرة الحجم في حاوية بشكل عام.
set_container_metadata	تعيين زوج واحد أو أكثر من أزواج الاسم والقيم المعرفة من قبل المستخدم للحاوية المحددة. يحل كل استدعاء لهذه العملية محل جميع بيانات التعريف الموجودة المرفقة بالحاوية. لإزالة جميع بيانات التعريف من الحاوية، قم باستدعاء هذه العملية بدون إملاء بيانات التعريف.
set_premium_page_blob_tier_blobs	تعيين طبقات كائن ثنائي كبير الحجم للصفحة على جميع الكائنات الثنائية كبيرة الحجم. يتم دعم واجهة برمجة التطبيقات هذه فقط لكائنات ثنائية كبيرة الحجم للصفحة على الحسابات المتميزة. الحد الأقصى لعدد الكائنات الثنائية كبيرة الحجم التي يمكن تحديثها في طلب واحد هو 256.
set_standard_blob_tier_blobs	تعين هذه العملية الطبقة على الكائنات الثنائية كبيرة الحجم للكتلة. تحدد طبقة كائن ثنائي كبير الحجم للكتلة نوع التخزين Hot/Cool/Archive. لا تقوم هذه العملية بتحديث ETag للكائن الثنائي كبير الحجم. الحد الأقصى لعدد الكائنات الثنائية كبيرة الحجم التي يمكن تحديثها في طلب واحد هو 256.
upload_blob	إنشاء كائن ثنائي كبير الحجم جديد من مصدر بيانات مع التقسيم التلقائي.
walk_blobs	إرجاع منشئ لسرد الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة. ستسرد هذه العملية الكائنات الثنائية كبيرة الحجم وفقا لتدرج هرمي، كما هو محدد بواسطة حرف المحدد المحدد.

acquire_lease

يطلب عقد إيجار جديد. إذا لم يكن للحاوية عقد إيجار نشط، تقوم خدمة Blob بإنشاء عقد إيجار على الحاوية وإرجاع معرف إيجار جديد.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> BlobLeaseClient

المعلمات

lease_duration: int

مطلوب

يحدد مدة عقد الإيجار، بالثوان، أو القيمة السالبة (-1) لعقد إيجار لا تنتهي صلاحيته أبدا. يمكن أن يتراوح عقد الإيجار غير اللانهائي بين 15 و60 ثانية. لا يمكن تغيير مدة الإيجار باستخدام التجديد أو التغيير. الافتراضي هو -1 (عقد إيجار لا نهائي).

lease_id: str

مطلوب

معرف الإيجار المقترح، بتنسيق سلسلة GUID. تقوم خدمة Blob بإرجاع 400 (طلب غير صالح) إذا لم يكن معرف الإيجار المقترح بالتنسيق الصحيح.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition: MatchConditions

شرط المطابقة لاستخدامه على etag.

timeout: int

المرتجعات

كائن BlobLeaseClient، يمكن تشغيله في مدير سياق.

نوع الإرجاع

BlobLeaseClient

close

هذا الأسلوب هو إغلاق مآخذ التوصيل التي يفتحها العميل. لا يلزم استخدامه عند استخدام مع مدير سياق.

close()

create_container

إنشاء حاوية جديدة ضمن الحساب المحدد. إذا كانت الحاوية بنفس الاسم موجودة بالفعل، تفشل العملية.

create_container(metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

المعلمات

metadata: dict[str, str]

مطلوب

إملاء مع أزواج name_value لإقرانها بالحاوية كبيانات تعريف. مثال:{'Category':'test'}

public_access: PublicAccess

مطلوب

تتضمن القيم المحتملة: "الحاوية" و"الكائن الثنائي كبير الحجم".

container_encryption_scope: dict أو ContainerEncryptionScope

يحدد نطاق التشفير الافتراضي لتعيينه على الحاوية واستخدامه لجميع عمليات الكتابة المستقبلية.

جديد في الإصدار 12.2.0.

timeout: int

المرتجعات

قاموس رؤوس الاستجابة.

نوع الإرجاع

Dict[str, Union[str, datetime]]

delete_blob

وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف.

يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه لحذف كائن ثنائي كبير الحجم، يجب حذف جميع اللقطات الخاصة به. يمكنك حذف كليهما في نفس الوقت مع عملية delete_blob.

إذا تم تمكين نهج استبقاء حذف للخدمة، فإن هذه العملية تحذف النقطة أو اللقطة بشكل مبدئي وتحتفظ بالكائنات الثنائية كبيرة الحجم أو اللقطة لعدد محدد من الأيام. بعد عدد محدد من الأيام، تتم إزالة بيانات الكائن الثنائي كبير الحجم من الخدمة أثناء تجميع البيانات المهملة. يمكن الوصول إلى الكائن الثنائي كبير الحجم أو اللقطة المحذوفة مبدئيا من خلال list_blobs تحديد خيار include=["deleted"]. يمكن استعادة الكائن الثنائي كبير الحجم أو اللقطة المحذوفة مبدئيا باستخدام <xref:azure.storage.blob.BlobClient.undelete>

delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None

المعلمات

blob: str أو BlobProperties

مطلوب

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

delete_snapshots: str

مطلوب

مطلوب إذا كان الكائن الثنائي كبير الحجم يحتوي على لقطات مقترنة. تتضمن القيم ما يلي:

"فقط": يحذف لقطات الكائنات الثنائية كبيرة الحجم فقط.
"include": يحذف الكائن الثنائي كبير الحجم مع جميع اللقطات.

version_id: str

معلمة معرف الإصدار هي قيمة DateTime مبهمة تحدد، عند وجودها، إصدار الكائن الثنائي كبير الحجم المراد حذفه.

جديد في الإصدار 12.4.0.

تم تقديم وسيطة الكلمة الأساسية هذه في إصدار واجهة برمجة التطبيقات '2019-12-12'.

lease: BlobLeaseClient أو str

مطلوب إذا كان الكائن الثنائي كبير الحجم لديه عقد إيجار نشط. يمكن أن تكون القيمة كائن BlobLeaseClient أو معرف الإيجار كسلسلة.

if_modified_since: datetime

if_unmodified_since: datetime

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

etag: str

match_condition: MatchConditions

شرط المطابقة لاستخدامه على etag.

if_tags_match_condition: str

حدد SQL حيث عبارة على علامات الكائن الثنائي كبير الحجم للعمل فقط على كائن ثنائي كبير الحجم بقيمة مطابقة. مثل. "\"tagname\"='my tag'"

جديد في الإصدار 12.4.0.

timeout: int

نوع الإرجاع

None

delete_blobs

وضع علامة على الكائنات الثنائية كبيرة الحجم أو اللقطات المحددة للحذف.

يتم حذف الكائنات الثنائية كبيرة الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه لحذف الكائنات الثنائية كبيرة الحجم، يجب حذف جميع اللقطات الخاصة بها. يمكنك حذف كليهما في نفس الوقت مع عملية delete_blobs.

إذا تم تمكين نهج استبقاء الحذف للخدمة، فإن هذه العملية تحذف الكائنات الثنائية كبيرة الحجم أو اللقطات بشكل مبدئي وتحتفظ بالكائنات الثنائية كبيرة الحجم أو اللقطات لعدد محدد من الأيام. بعد عدد محدد من الأيام، تتم إزالة بيانات الكائنات الثنائية كبيرة الحجم من الخدمة أثناء تجميع البيانات المهملة. يمكن الوصول إلى الكائنات الثنائية كبيرة الحجم أو اللقطات المحذوفة مبدئيا من خلال list_blobs تحديد include=["deleted"] يمكن استعادة الكائنات الثنائية كبيرة الحجم أو اللقطات المحذوفة مبدئيا باستخدام <xref:azure.storage.blob.BlobClient.undelete>

الحد الأقصى لعدد الكائنات الثنائية كبيرة الحجم التي يمكن حذفها في طلب واحد هو 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

المعلمات

blobs: str أو dict(str, Any) أو BlobProperties

مطلوب

الكائنات الثنائية كبيرة الحجم المراد حذفها. يمكن أن يكون هذا كائنا ثنائيا كبير الحجم واحدا، أو يمكن توفير قيم متعددة، حيث تكون كل قيمة إما اسم الكائن الثنائي كبير الحجم (str) أو BlobProperties.

ملاحظة

عندما يكون نوع الكائن الثنائي كبير الحجم إملاء، فإليك قائمة بالمفاتيح وقواعد القيمة.

اسم الكائن الثنائي كبير الحجم:

المفتاح: 'name'، نوع القيمة: str

لقطة تريد حذفها:

المفتاح: "لقطة"، نوع القيمة: str

معرف الإصدار:

المفتاح: "version_id"، نوع القيمة: str

ما إذا كنت تريد حذف اللقطات عند حذف الكائن الثنائي كبير الحجم:

المفتاح: "delete_snapshots"، القيمة: "تضمين" أو "فقط"

إذا تم تعديل الكائن الثنائي كبير الحجم أم لا:

المفتاح: "if_modified_since" و"if_unmodified_since" ونوع القيمة: التاريخ والوقت

Etag:

المفتاح: 'etag'، نوع القيمة: str

مطابقة etag أم لا:

المفتاح: "match_condition"، نوع القيمة: MatchConditions

حالة مطابقة العلامات:

المفتاح: "if_tags_match_condition"، نوع القيمة: str

الايجار:

المفتاح: "lease_id"، نوع القيمة: Union[str، LeaseClient]

مهلة الطلب الفرعي:

المفتاح: "المهلة"، نوع القيمة: int

delete_snapshots: str

مطلوب إذا كان الكائن الثنائي كبير الحجم يحتوي على لقطات مقترنة. تتضمن القيم ما يلي:

"فقط": يحذف لقطات الكائنات الثنائية كبيرة الحجم فقط.
"include": يحذف الكائن الثنائي كبير الحجم مع جميع اللقطات.

if_modified_since: datetime

if_unmodified_since: datetime

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

if_tags_match_condition: str

جديد في الإصدار 12.4.0.

raise_on_any_failure: bool

هذه عبارة عن معلمة منطقية يتم تعيينها افتراضيا إلى True. عند تعيين هذا، يتم رفع استثناء حتى إذا كان هناك فشل عملية واحدة.

timeout: int

المرتجعات

مكرر للاستجابات، واحد لكل كائن ثنائي كبير الحجم بالترتيب

نوع الإرجاع

Iterator[HttpResponse]

delete_container

وضع علامة على الحاوية المحددة للحذف. يتم حذف الحاوية وأي كائنات ثنائية كبيرة الحجم موجودة داخلها لاحقا أثناء تجميع البيانات المهملة.

delete_container(**kwargs: Any) -> None

المعلمات

lease: BlobLeaseClient أو str

إذا تم تحديده، delete_container ينجح فقط إذا كان عقد إيجار الحاوية نشطا ويطابق هذا المعرف. مطلوب إذا كانت الحاوية لديها عقد إيجار نشط.

if_modified_since: datetime

if_unmodified_since: datetime

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

etag: str

match_condition: MatchConditions

شرط المطابقة لاستخدامه على etag.

timeout: int

نوع الإرجاع

None

download_blob

تنزيل كائن ثنائي كبير الحجم إلى StorageStreamDownloader. يجب استخدام أسلوب readall() لقراءة كل المحتوى أو يجب استخدام readinto() لتنزيل الكائن الثنائي كبير الحجم في دفق. يؤدي استخدام الأجزاء () إلى إرجاع مكرر يسمح للمستخدم بالتكرار عبر المحتوى في مجموعات.

download_blob(blob: str | BlobProperties, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

المعلمات

blob: str أو BlobProperties

مطلوب

offset: int

مطلوب

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

length: int

مطلوب

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

version_id: str

معلمة معرف الإصدار هي قيمة DateTime مبهمة تحدد، عند وجودها، إصدار الكائن الثنائي كبير الحجم المراد تنزيله.

جديد في الإصدار 12.4.0.

تم تقديم وسيطة الكلمة الأساسية هذه في إصدار واجهة برمجة التطبيقات '2019-12-12'.

validate_content: bool

إذا كان صحيحا، يحسب تجزئة MD5 لكل جزء من الكائن الثنائي كبير الحجم. تتحقق خدمة التخزين من تجزئة المحتوى الذي وصل مع التجزئة التي تم إرسالها. هذا مهم في المقام الأول للكشف عن bitflips على السلك إذا كان استخدام http بدلا من https، كما https (الافتراضي)، سيتم التحقق من صحته بالفعل. لاحظ أن تجزئة MD5 هذه غير مخزنة مع الكائن الثنائي كبير الحجم. لاحظ أيضا أنه إذا تم تمكينها، فلن يتم استخدام خوارزمية التحميل الفعالة للذاكرة لأن حساب تجزئة MD5 يتطلب تخزين كتل كاملة مؤقتا، وبذلك يهزم الغرض من الخوارزمية الفعالة للذاكرة.

lease: BlobLeaseClient أو str

مطلوب إذا كان الكائن الثنائي كبير الحجم لديه عقد إيجار نشط. إذا تم تحديده، download_blob ينجح فقط إذا كان عقد إيجار الكائن الثنائي كبير الحجم نشطا ويطابق هذا المعرف. يمكن أن تكون القيمة كائن BlobLeaseClient أو معرف الإيجار كسلسلة.

if_modified_since: datetime

if_unmodified_since: datetime

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

etag: str

match_condition: MatchConditions

شرط المطابقة لاستخدامه على etag.

if_tags_match_condition: str

جديد في الإصدار 12.4.0.

cpk: CustomerProvidedEncryptionKey

تشفير البيانات على جانب الخدمة باستخدام المفتاح المحدد. يجب استخدام المفاتيح التي يوفرها العميل عبر HTTPS. نظرا لتوفير مفتاح التشفير نفسه في الطلب، يجب إنشاء اتصال آمن لنقل المفتاح.

max_concurrency: int

عدد الاتصالات المتوازية التي يجب تنزيلها.

encoding: str

الترميز لفك ترميز وحدات البايت التي تم تنزيلها. الافتراضي هو بلا، أي عدم فك التشفير.

progress_hook: Callable[[int, int], None]

رد اتصال لتتبع تقدم التنزيل طويل الأمد. التوقيع هو دالة (الحالية: int، الإجمالي: int) حيث الحالي هو عدد وحدات البايت المنقولة حتى الآن، والإجمالي هو الحجم الإجمالي للتنزيل.

timeout: int

تعيين المهلة من جانب الخادم للعملية بالثوان. لمزيد من التفاصيل، راجع https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. لا يتم تعقب هذه القيمة أو التحقق من صحتها على العميل. لتكوين مهلات الشبكة من جانب العميل، راجع هنا. قد يقوم هذا الأسلوب بإجراء مكالمات متعددة إلى الخدمة وسيتم تطبيق المهلة على كل مكالمة على حدة. سيتم تطبيق مكالمات متعددة إلى خدمة Azure والمهلة على كل مكالمة على حدة.

المرتجعات

كائن دفق (StorageStreamDownloader)

نوع الإرجاع

StorageStreamDownloader

exists

إرجاع True إذا كانت الحاوية موجودة وإرجاع False بخلاف ذلك.

exists(**kwargs: Any) -> bool

المعلمات

timeout: int

المرتجعات

منطقي

نوع الإرجاع

bool

find_blobs_by_tags

إرجاع منشئ لسرد الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة التي تتطابق علاماتها مع تعبير البحث المحدد. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة.

find_blobs_by_tags(filter_expression: str, **kwargs: Any | None) -> ItemPaged[FilteredBlob]

المعلمات

filter_expression: str

مطلوب

التعبير للعثور على الكائنات الثنائية كبيرة الحجم التي تتطابق علاماتها مع الشرط المحدد. مثل. ""yourtagname"="firsttag" و"yourtagname2"="secondtag""

results_per_page: int

الحد الأقصى للنتيجة لكل صفحة عند ترقيم الصفحات.

timeout: int

المرتجعات

استجابة قابلة للتكسير (ترحيل تلقائي) ل FilteredBlob.

نوع الإرجاع

ItemPaged[BlobProperties]

from_connection_string

إنشاء ContainerClient من سلسلة اتصال.

from_connection_string(conn_str: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

المعلمات

conn_str: str

مطلوب

سلسلة اتصال بحساب Azure Storage.

container_name: str

مطلوب

اسم الحاوية للكائن الثنائي كبير الحجم.

credential

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

بيانات الاعتماد التي يجب المصادقة بها. هذا اختياري إذا كان عنوان URL للحساب يحتوي بالفعل على رمز SAS مميز، أو كانت سلسلة الاتصال تحتوي بالفعل على قيم مفتاح الوصول المشترك. يمكن أن تكون القيمة سلسلة رمز SAS المميز أو مثيل AzureSasCredential أو AzureNamedKeyCredential من azure.core.credentials أو مفتاح وصول مشترك للحساب أو مثيل فئة TokenCredentials من azure.identity. ستكون لبيانات الاعتماد المقدمة هنا الأسبقية على تلك الموجودة في سلسلة الاتصال. إذا كنت تستخدم مثيل AzureNamedKeyCredential، يجب أن يكون "الاسم" هو اسم حساب التخزين، ويجب أن يكون "المفتاح" هو مفتاح حساب التخزين.

المرتجعات

عميل حاوية.

نوع الإرجاع

ContainerClient

from_container_url

إنشاء ContainerClient من عنوان URL للحاوية.

from_container_url(container_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

المعلمات

container_url: str

مطلوب

عنوان URL الكامل لنقطة النهاية إلى الحاوية، بما في ذلك رمز SAS المميز إذا تم استخدامه. قد تكون هذه إما نقطة النهاية الأساسية، أو نقطة النهاية الثانوية اعتمادا على location_mode الحالية.

credential

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

بيانات الاعتماد التي يجب المصادقة بها. هذا اختياري إذا كان عنوان URL للحساب يحتوي بالفعل على رمز SAS مميز، أو كانت سلسلة الاتصال تحتوي بالفعل على قيم مفتاح الوصول المشترك. يمكن أن تكون القيمة سلسلة رمز SAS المميز أو مثيل AzureSasCredential أو AzureNamedKeyCredential من azure.core.credentials أو مفتاح وصول مشترك للحساب أو مثيل فئة TokenCredentials من azure.identity. إذا كان عنوان URI للمورد يحتوي بالفعل على رمز SAS المميز، فسيتم تجاهل هذا لصالح بيانات اعتماد صريحة

باستثناء حالة AzureSasCredential، حيث سترفع رموز SAS المميزة المتعارضة ValueError. إذا كنت تستخدم مثيل AzureNamedKeyCredential، يجب أن يكون "الاسم" هو اسم حساب التخزين، ويجب أن يكون "المفتاح" هو مفتاح حساب التخزين.

المرتجعات

عميل حاوية.

نوع الإرجاع

ContainerClient

get_account_information

يحصل على معلومات تتعلق بحساب التخزين.

يمكن أيضا استرداد المعلومات إذا كان لدى المستخدم SAS إلى حاوية أو كائن ثنائي كبير الحجم. تتضمن المفاتيح الموجودة في القاموس الذي تم إرجاعه "sku_name" و"account_kind".

get_account_information(**kwargs: Any) -> Dict[str, str]

المرتجعات

لوحة معلومات الحساب (SKU ونوع الحساب).

نوع الإرجاع

dict(str, str)

get_blob_client

احصل على عميل للتفاعل مع الكائن الثنائي كبير الحجم المحدد.

الكائن الثنائي كبير الحجم غير موجود بالفعل.

get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient

المعلمات

blob: str أو BlobProperties

مطلوب

الكائن الثنائي كبير الحجم الذي يجب التفاعل معه.

snapshot: str

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

لقطة الكائن الثنائي كبير الحجم الاختيارية التي يجب العمل عليها. يمكن أن تكون هذه سلسلة معرف اللقطة أو الاستجابة التي تم إرجاعها من create_snapshot.

version_id: str

معلمة معرف الإصدار هي قيمة DateTime مبهمة تحدد، عند وجودها، إصدار الكائن الثنائي كبير الحجم للعمل عليه.

المرتجعات

A BlobClient.

نوع الإرجاع

BlobClient

get_container_access_policy

الحصول على أذونات الحاوية المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات الحاوية بشكل عام.

get_container_access_policy(**kwargs: Any) -> Dict[str, Any]

المعلمات

lease: BlobLeaseClient أو str

إذا تم تحديده، get_container_access_policy ينجح فقط إذا كان عقد إيجار الحاوية نشطا ويطابق هذا المعرف.

timeout: int

المرتجعات

الوصول إلى معلومات النهج في الإملاء.

نوع الإرجاع

dict[str, Any]

get_container_properties

إرجاع جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام للحاوية المحددة. لا تتضمن البيانات التي تم إرجاعها قائمة الكائنات الثنائية كبيرة الحجم للحاوية.

get_container_properties(**kwargs: Any) -> ContainerProperties

المعلمات

lease: BlobLeaseClient أو str

إذا تم تحديده، get_container_properties ينجح فقط إذا كان عقد إيجار الحاوية نشطا ويطابق هذا المعرف.

timeout: int

المرتجعات

خصائص الحاوية المحددة داخل كائن حاوية.

نوع الإرجاع

ContainerProperties

list_blob_names

إرجاع منشئ لسرد أسماء الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة.

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

list_blob_names(**kwargs: Any) -> ItemPaged[str]

المعلمات

name_starts_with: str

تصفية النتائج لإرجاع الكائنات الثنائية كبيرة الحجم التي تبدأ أسماؤها بالبادئة المحددة فقط.

timeout: int

المرتجعات

استجابة قابلة للتكسير (ترحيل تلقائي) لأسماء الكائنات الثنائية كبيرة الحجم كسلاسل.

نوع الإرجاع

ItemPaged[str]

list_blobs

إرجاع منشئ لسرد الكائنات الثنائية كبيرة الحجم ضمن الحاوية المحددة. سيتبع المولد ببطء الرموز المميزة للاستمرار التي تم إرجاعها بواسطة الخدمة.

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

المعلمات

name_starts_with: str

مطلوب

تصفية النتائج لإرجاع الكائنات الثنائية كبيرة الحجم التي تبدأ أسماؤها بالبادئة المحددة فقط.

include: list[str] أو str

مطلوب

يحدد مجموعة بيانات إضافية واحدة أو أكثر لتضمينها في الاستجابة. تتضمن الخيارات: "اللقطات"، و"بيانات التعريف"، و"uncommittedblobs"، و"copy"، و"deleted"، و"deletedwithversions"، و"tags"، و"versions"، و"immutabilitypolicy"، و"legalhold".

timeout: int

المرتجعات

استجابة قابلة للتكبير (ترحيل تلقائي) ل BlobProperties.

نوع الإرجاع

ItemPaged[BlobProperties]

set_container_access_policy

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

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

المعلمات

signed_identifiers: dict[str, AccessPolicy]

مطلوب

قاموس لنهج الوصول لإقرانه بالحاوية. قد يحتوي القاموس على ما يصل إلى 5 عناصر. سيقوم القاموس الفارغ بمسح نهج الوصول المعينة على الخدمة.

public_access: PublicAccess

مطلوب

تتضمن القيم المحتملة: 'container'، 'blob'.

lease: BlobLeaseClient أو str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

timeout: int

المرتجعات

إملاء الخاصية المحدثة للحاوية (Etag وآخر تعديل).

نوع الإرجاع

dict[str, str,

datetime]

set_container_metadata

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

set_container_metadata(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

المعلمات

metadata: dict[str, str]

مطلوب

إملاء يحتوي على أزواج الاسم والقيمة لإقرانها بالحاوية كبيانات تعريف. مثال: {'category':'test'}

lease: BlobLeaseClient أو str

إذا تم تحديده، set_container_metadata ينجح فقط إذا كان عقد إيجار الحاوية نشطا ويطابق هذا المعرف.

if_modified_since: datetime

if_unmodified_since: datetime

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

etag: str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، والعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

timeout: int

المرتجعات

إملاء الخاصية المحدثة للحاوية (Etag وآخر تعديل).

نوع الإرجاع

dict[str, str,

datetime]

set_premium_page_blob_tier_blobs

تعيين طبقات كائن ثنائي كبير الحجم للصفحة على جميع الكائنات الثنائية كبيرة الحجم. يتم دعم واجهة برمجة التطبيقات هذه فقط لكائنات ثنائية كبيرة الحجم للصفحة على الحسابات المتميزة.

الحد الأقصى لعدد الكائنات الثنائية كبيرة الحجم التي يمكن تحديثها في طلب واحد هو 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

المعلمات

premium_page_blob_tier: PremiumPageBlobTier

مطلوب

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

ملاحظة

إذا كنت تريد تعيين طبقة مختلفة على كائنات ثنائية كبيرة الحجم مختلفة، فيرجى تعيين هذه المعلمة الموضعية إلى بلا.

ثم سيتم أخذ طبقة الكائن الثنائي كبير الحجم على كل BlobProperties.

blobs: str أو dict(str, Any) أو BlobProperties

مطلوب

الكائنات الثنائية كبيرة الحجم التي يجب التفاعل معها. يمكن أن يكون هذا كائن ثنائي كبير الحجم واحد، أو يمكن توفير قيم متعددة، حيث تكون كل قيمة إما اسم الكائن الثنائي كبير الحجم (str) أو BlobProperties.

ملاحظة

عندما يكون نوع الكائن الثنائي كبير الحجم إملاء، إليك قائمة بالمفاتيح وقواعد القيمة.

اسم الكائن الثنائي كبير الحجم:

المفتاح: "name"، نوع القيمة: str

طبقة الكائن الثنائي كبير الحجم المتميزة:

المفتاح: "blob_tier"، نوع القيمة: PremiumPageBlobTier

الايجار:

المفتاح: "lease_id"، نوع القيمة: Union[str، LeaseClient]

مهلة الاستعلام الفرعي:

المفتاح: "المهلة"، نوع القيمة: int

timeout: int

raise_on_any_failure: bool

هذا هو المعلم المنطقي الذي يتم تعيينه افتراضيا إلى True. عند تعيين هذا، يتم رفع استثناء حتى إذا كان هناك فشل عملية واحدة.

المرتجعات

مكرر للاستجابات، واحد لكل كائن ثنائي كبير الحجم بالترتيب

نوع الإرجاع

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

تعين هذه العملية الطبقة على الكائنات الثنائية كبيرة الحجم للكتلة.

تحدد طبقة كائن ثنائي كبير الحجم للكتلة نوع التخزين Hot/Cool/Archive. لا تقوم هذه العملية بتحديث ETag للكائن الثنائي كبير الحجم.

الحد الأقصى لعدد الكائنات الثنائية كبيرة الحجم التي يمكن تحديثها في طلب واحد هو 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

المعلمات

standard_blob_tier: str أو StandardBlobTier

مطلوب

يشير إلى الطبقة التي سيتم تعيينها على جميع الكائنات الثنائية كبيرة الحجم. تتضمن الخيارات "Hot" و"Cool" و"Archive". تم تحسين الطبقة الفعالة لتخزين البيانات التي يتم الوصول إليها بشكل متكرر. تم تحسين طبقة التخزين الباردة لتخزين البيانات التي يتم الوصول إليها وتخزينها بشكل غير متكرر لمدة شهر على الأقل. تم تحسين مستوى الأرشيف لتخزين البيانات التي نادرا ما يتم الوصول إليها وتخزينها لمدة ستة أشهر على الأقل مع متطلبات زمن انتقال مرنة.

ملاحظة

ثم سيتم أخذ طبقة الكائن الثنائي كبير الحجم على كل BlobProperties.

blobs: str أو dict(str, Any) أو BlobProperties

مطلوب

ملاحظة

عندما يكون نوع الكائن الثنائي كبير الحجم إملاء، إليك قائمة بالمفاتيح وقواعد القيمة.

اسم الكائن الثنائي كبير الحجم:

المفتاح: "name"، نوع القيمة: str

مستوى الكائن الثنائي كبير الحجم القياسي:

المفتاح: "blob_tier"، نوع القيمة: StandardBlobTier

إعادة تنشيط الأولوية:

المفتاح: "rehydrate_priority"، نوع القيمة: RehydratePriority

الايجار:

المفتاح: "lease_id"، نوع القيمة: Union[str، LeaseClient]

لقطه:

المفتاح: "snapshot"، نوع القيمة: str

معرف الإصدار:

المفتاح: "version_id"، نوع القيمة: str

شرط مطابقة العلامات:

المفتاح: "if_tags_match_condition"، نوع القيمة: str

مهلة الاستعلام الفرعي:

المفتاح: "المهلة"، نوع القيمة: int

rehydrate_priority: RehydratePriority

يشير إلى الأولوية التي يتم بها إعادة ترطيب كائن ثنائي كبير الحجم مؤرشف

if_tags_match_condition: str

حدد عبارة SQL حيث تعمل على علامات الكائن الثنائي كبير الحجم فقط على كائن ثنائي كبير الحجم بقيمة مطابقة. مثل. "\"tagname\"='my tag'"

جديد في الإصدار 12.4.0.

timeout: int

raise_on_any_failure: bool

المرتجعات

مكرر للاستجابات، واحد لكل كائن ثنائي كبير الحجم بالترتيب

نوع الإرجاع

Iterator[HttpResponse]

upload_blob

إنشاء كائن ثنائي كبير الحجم جديد من مصدر بيانات مع التقسيم التلقائي.

upload_blob(name: str | BlobProperties, data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> BlobClient

المعلمات

name: str أو BlobProperties

مطلوب

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

data

مطلوب

بيانات الكائن الثنائي كبير الحجم لتحميلها.

blob_type: BlobType

مطلوب

نوع الكائن الثنائي كبير الحجم. يمكن أن يكون هذا إما BlockBlob أو PageBlob أو AppendBlob. القيمة الافتراضية هي BlockBlob.

length: int

مطلوب

عدد وحدات البايت المراد قراءتها من الدفق. هذا اختياري، ولكن يجب توفيره للأداء الأمثل.

metadata: dict(str, str)

مطلوب

أزواج الاسم والقيمة المقترنة بالكائنات الثنائية كبيرة الحجم كبيانات تعريف.

overwrite: bool

ما إذا كان يجب أن يقوم الكائن الثنائي كبير الحجم الذي سيتم تحميله بالكتابة فوق البيانات الحالية. إذا كان True، فسيستبدل upload_blob البيانات الموجودة. إذا تم تعيينها إلى False، فستفشل العملية مع ResourceExistsError. الاستثناء لما سبق هو مع أنواع الكائنات الثنائية كبيرة الحجم الملحقة: إذا تم تعيينها إلى False والبيانات موجودة بالفعل، فلن يتم رفع خطأ وسيتم إلحاق البيانات بالكائن الثنائي كبير الحجم الموجود. إذا تم تعيين overwrite=True، فسيتم حذف الكائن الثنائي كبير الحجم الموجود للإلحاق، وإنشاء كائن جديد. الإعدادات الافتراضية معينة على False.

content_settings: ContentSettings

عنصر ContentSettings المستخدم لتعيين خصائص الكائن الثنائي كبير الحجم. يستخدم لتعيين نوع المحتوى والترميز واللغة والتصرف وmd5 والتحكم في ذاكرة التخزين المؤقت.

validate_content: bool

إذا كان صحيحا، تحسب تجزئة MD5 لكل جزء من الكائن الثنائي كبير الحجم. تتحقق خدمة التخزين من تجزئة المحتوى الذي وصل مع التجزئة التي تم إرسالها. هذا مهم في المقام الأول للكشف عن bitflips على السلك إذا كان استخدام http بدلا من https، كما https (الافتراضي)، سيتم التحقق من صحته بالفعل. لاحظ أن تجزئة MD5 هذه غير مخزنة مع الكائن الثنائي كبير الحجم. لاحظ أيضا أنه إذا تم تمكينها، فلن يتم استخدام خوارزمية التحميل الفعالة للذاكرة، لأن حساب تجزئة MD5 يتطلب تخزين كتل كاملة مؤقتا، وبذلك يهزم الغرض من الخوارزمية الفعالة للذاكرة.

lease: BlobLeaseClient أو str

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

if_modified_since: datetime

if_unmodified_since: datetime

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

etag: str

match_condition: MatchConditions

شرط المطابقة لاستخدامه على etag.

if_tags_match_condition: str

جديد في الإصدار 12.4.0.

timeout: int

premium_page_blob_tier: PremiumPageBlobTier

standard_blob_tier: StandardBlobTier

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

maxsize_condition: int

رأس شرطي اختياري. الحد الأقصى للطول بالبايت المسموح به لكائن ثنائي كبير الحجم للإلحاق. إذا كانت عملية Append Block قد تتسبب في تجاوز الكائن الثنائي كبير الحجم لهذا الحد أو إذا كان حجم الكائن الثنائي كبير الحجم أكبر بالفعل من القيمة المحددة في هذا العنوان، فسيفشل الطلب مع خطأ MaxBlobSizeConditionNotMet (رمز حالة HTTP 412 - فشل الشرط المسبق).

max_concurrency: int

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

cpk: CustomerProvidedEncryptionKey

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

encryption_scope: str

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

جديد في الإصدار 12.2.0.

encoding: str

الإعدادات الافتراضية ل UTF-8.

progress_hook: Callable[[int, Optional[int]], None]

رد اتصال لتعقب تقدم التحميل طويل الأمد. التوقيع هو دالة(current: int, total: Optional[int]) حيث الحالي هو عدد وحدات البايت المنقولة حتى الآن، والإجمالي هو حجم الكائن الثنائي كبير الحجم أو بلا إذا كان الحجم غير معروف.

المرتجعات

BlobClient للتفاعل مع الكائن الثنائي كبير الحجم الذي تم تحميله حديثا.

نوع الإرجاع

BlobClient

walk_blobs

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

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any | None) -> ItemPaged[BlobProperties]

المعلمات

name_starts_with: str

مطلوب

تصفية النتائج لإرجاع الكائنات الثنائية كبيرة الحجم التي تبدأ أسماؤها بالبادئة المحددة فقط.

include: list[str] أو str

مطلوب

delimiter: str

مطلوب

عندما يتضمن الطلب هذه المعلمة، ترجع العملية عنصر BlobPrefix في نص الاستجابة الذي يعمل كعنصر نائب لجميع الكائنات الثنائية كبيرة الحجم التي تبدأ أسماؤها بنفس السلسلة الفرعية حتى مظهر حرف المحدد. قد يكون المحدد حرفا واحدا أو سلسلة.

timeout: int

المرتجعات

استجابة قابلة للتكبير (ترحيل تلقائي) ل BlobProperties.

نوع الإرجاع

ItemPaged[BlobProperties]

السمات

api_version

إصدار واجهة برمجة تطبيقات التخزين المستخدمة للطلبات.

location_mode

وضع الموقع الذي يستخدمه العميل حاليا.

بشكل افتراضي، سيكون هذا "أساسي". تتضمن الخيارات "الأساسي" و"الثانوي".

primary_endpoint

عنوان URL الكامل لنقطة النهاية الأساسية.

primary_hostname

اسم مضيف نقطة النهاية الأساسية.

secondary_endpoint

عنوان URL لنقطة النهاية الثانوية الكاملة إذا تم تكوينه.

إذا لم يكن متوفرا، فسيتم رفع ValueError. لتحديد اسم مضيف ثانوي بشكل صريح، استخدم وسيطة الكلمة الأساسية secondary_hostname الاختيارية عند إنشاء مثيل.

استثناءات

ValueError

secondary_hostname

اسم مضيف نقطة النهاية الثانوية.

إذا لم يكن متوفرا، فسيكون هذا بلا. لتحديد اسم مضيف ثانوي بشكل صريح، استخدم وسيطة الكلمة الأساسية secondary_hostname الاختيارية عند إنشاء مثيل.

url

عنوان URL الكامل لنقطة النهاية لهذا الكيان، بما في ذلك رمز SAS المميز إذا تم استخدامه.

قد تكون هذه إما نقطة النهاية الأساسية، أو نقطة النهاية الثانوية اعتمادا على الحالي location_mode. :returns: عنوان URL الكامل لنقطة النهاية لهذا الكيان، بما في ذلك رمز SAS المميز إذا تم استخدامه. :rtype: str

Share via

ContainerClient الفصل

الدالمنشئ

المعلمات

الأساليب

acquire_lease

المعلمات

المرتجعات

نوع الإرجاع

close

create_container

المعلمات

المرتجعات

نوع الإرجاع

delete_blob

المعلمات

نوع الإرجاع

delete_blobs

المعلمات

المرتجعات

نوع الإرجاع

delete_container

المعلمات

نوع الإرجاع

download_blob

المعلمات

المرتجعات

نوع الإرجاع

exists

المعلمات

المرتجعات

نوع الإرجاع

find_blobs_by_tags

المعلمات

المرتجعات

نوع الإرجاع

from_connection_string

المعلمات

المرتجعات

نوع الإرجاع

from_container_url

المعلمات

المرتجعات

نوع الإرجاع

get_account_information

المرتجعات

نوع الإرجاع

get_blob_client

المعلمات

المرتجعات

نوع الإرجاع

get_container_access_policy

المعلمات

المرتجعات

نوع الإرجاع

get_container_properties

المعلمات

المرتجعات

نوع الإرجاع

list_blob_names

المعلمات

المرتجعات

نوع الإرجاع

list_blobs

المعلمات

المرتجعات

نوع الإرجاع

set_container_access_policy

المعلمات

المرتجعات

نوع الإرجاع

set_container_metadata

المعلمات

المرتجعات

نوع الإرجاع

set_premium_page_blob_tier_blobs

المعلمات

المرتجعات

نوع الإرجاع

set_standard_blob_tier_blobs