PoolOperations الفصل
عمليات PoolOperations.
يجب عدم إنشاء مثيل مباشرة لهذه الفئة، ولكن إنشاء مثيل العميل الذي سيقوم بإنشائه لك وإرفاقه كسمة.
- توريث
-
builtins.objectPoolOperations
الدالمنشئ
PoolOperations(client, config, serializer, deserializer)
المعلمات
- client
العميل لطلبات الخدمة.
- config
تكوين عميل الخدمة.
- serializer
مسلسل نموذج كائن.
- deserializer
إلغاء تسلسل نموذج كائن.
المتغيرات
- api_version
إصدار API المراد استخدامه للطلب. القيمة الثابتة: "2023-05-01.17.0".
الأساليب
add |
إضافة تجمع إلى الحساب المحدد. عند تسمية التجمعات، تجنب تضمين معلومات حساسة مثل أسماء المستخدمين أو أسماء المشاريع السرية. قد تظهر هذه المعلومات في سجلات بيانات تتبع الاستخدام التي يمكن لمهندسي دعم Microsoft الوصول إليها. |
delete |
حذف تجمع من الحساب المحدد. عند طلب حذف تجمع، تحدث الإجراءات التالية: يتم تعيين حالة التجمع على الحذف؛ يتم إيقاف أي عملية تغيير حجم مستمرة على التجمع؛ تبدأ خدمة Batch في تغيير حجم التجمع إلى صفر عقد حساب؛ يتم إنهاء أي مهام تعمل على عقد الحوسبة الموجودة وإعادة ترتيبها (كما لو تم طلب عملية تغيير حجم التجمع مع خيار إعادة الانتظار الافتراضي)؛ وأخيرا، تتم إزالة التجمع من النظام. نظرا لإعادة ترتيب المهام قيد التشغيل، يمكن للمستخدم إعادة تشغيل هذه المهام عن طريق تحديث الوظيفة الخاصة به لاستهداف تجمع مختلف. يمكن بعد ذلك تشغيل المهام على التجمع الجديد. إذا كنت تريد تجاوز سلوك إعادة الانتظار، فيجب عليك استدعاء تجمع تغيير الحجم بشكل صريح لتقليص حجم التجمع إلى صفر قبل حذف التجمع. إذا قمت باستدعاء Update أو Patch أو Delete API على تجمع في حالة الحذف، فسيفشل مع رمز حالة HTTP 409 مع رمز الخطأ PoolBeingDeleted. |
disable_auto_scale |
تعطيل التحجيم التلقائي لتجمع. |
enable_auto_scale |
تمكين التحجيم التلقائي لتجمع. لا يمكنك تمكين التحجيم التلقائي على تجمع إذا كانت عملية تغيير الحجم قيد التقدم على التجمع. إذا تم تعطيل التحجيم التلقائي للتجمع حاليا، فيجب تحديد صيغة تحجيم تلقائي صالحة كجزء من الطلب. إذا تم تمكين التحجيم التلقائي للتجمع بالفعل، يمكنك تحديد صيغة تحجيم تلقائي جديدة و/أو فاصل تقييم جديد. لا يمكنك استدعاء واجهة برمجة التطبيقات هذه لنفس التجمع أكثر من مرة كل 30 ثانية. |
evaluate_auto_scale |
يحصل على نتيجة تقييم صيغة تحجيم تلقائي على التجمع. واجهة برمجة التطبيقات هذه مخصصة في المقام الأول للتحقق من صحة صيغة التحجيم التلقائي، لأنها ببساطة ترجع النتيجة دون تطبيق الصيغة على التجمع. يجب تمكين التحجيم التلقائي للتجمع من أجل تقييم صيغة. |
exists |
يحصل على الخصائص الأساسية للتجمع. |
get |
الحصول على معلومات حول التجمع المحدد. |
list |
يسرد كافة التجمعات في الحساب المحدد. |
list_usage_metrics |
يسرد مقاييس الاستخدام، المجمعة حسب التجمع عبر فواصل زمنية فردية، للحساب المحدد. إذا لم تحدد عبارة $filter بما في ذلك poolId، فإن الاستجابة تتضمن جميع التجمعات الموجودة في الحساب في النطاق الزمني للفواصل الزمنية للتجميع التي تم إرجاعها. إذا لم تحدد عبارة $filter بما في ذلك startTime أو endTime، فإن عوامل التصفية هذه افتراضية على أوقات البدء والانتهاء للفاصل الزمني للتجميع الأخير المتاح حاليا؛ أي أنه يتم إرجاع آخر فاصل زمني للتجميع فقط. |
patch |
التحديثات خصائص التجمع المحدد. هذا يحل محل خصائص التجمع المحددة في الطلب فقط. على سبيل المثال، إذا كان التجمع يحتوي على StartTask مقترن به، ولم يحدد الطلب عنصر StartTask، فسيحتفظ التجمع ب StartTask الحالي. |
remove_nodes |
يزيل Compute Nodes من التجمع المحدد. يمكن تشغيل هذه العملية فقط عندما تكون حالة تخصيص التجمع ثابتة. عند تشغيل هذه العملية، تتغير حالة التخصيص من ثابت إلى تغيير الحجم. قد يزيل كل طلب ما يصل إلى 100 عقدة. |
resize |
تغيير عدد عقد الحوسبة التي تم تعيينها إلى تجمع. يمكنك تغيير حجم التجمع فقط عندما تكون حالة التخصيص الخاصة به ثابتة. إذا تم تغيير حجم التجمع بالفعل، يفشل الطلب مع رمز الحالة 409. عند تغيير حجم تجمع، تتغير حالة تخصيص التجمع من ثابت إلى تغيير الحجم. لا يمكنك تغيير حجم التجمعات التي تم تكوينها للتحجيم التلقائي. إذا حاولت القيام بذلك، فإن خدمة Batch ترجع خطأ 409. إذا قمت بتغيير حجم تجمع لأسفل، فإن خدمة Batch تختار عقد الحساب التي تريد إزالتها. لإزالة عقد حساب معينة، استخدم تجمع إزالة واجهة برمجة تطبيقات عقد الحوسبة بدلا من ذلك. |
stop_resize |
إيقاف عملية تغيير الحجم المستمرة على التجمع. لا يؤدي هذا إلى استعادة التجمع إلى حالته السابقة قبل عملية تغيير الحجم: فإنه يوقف فقط أي تغييرات أخرى يتم إجراؤها، ويحافظ التجمع على حالته الحالية. بعد الإيقاف، يستقر التجمع عند عدد عقد الحساب التي كان عليها عند الانتهاء من عملية الإيقاف. أثناء عملية الإيقاف، تتغير حالة تخصيص التجمع أولا إلى إيقاف ثم إلى ثابت. لا يلزم أن تكون عملية تغيير الحجم طلب تجمع تغيير حجم صريح؛ يمكن أيضا استخدام واجهة برمجة التطبيقات هذه لإيقاف التحجيم الأولي للتجمع عند إنشائه. |
update_properties |
التحديثات خصائص التجمع المحدد. هذا يحل محل جميع الخصائص القابلة للتحديث للتجمع بشكل كامل. على سبيل المثال، إذا كان التجمع يحتوي على StartTask مقترن به وإذا لم يتم تحديد StartTask مع هذا الطلب، فستزيل خدمة Batch StartTask الموجودة. |
add
إضافة تجمع إلى الحساب المحدد.
عند تسمية التجمعات، تجنب تضمين معلومات حساسة مثل أسماء المستخدمين أو أسماء المشاريع السرية. قد تظهر هذه المعلومات في سجلات بيانات تتبع الاستخدام التي يمكن لمهندسي دعم Microsoft الوصول إليها.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
delete
حذف تجمع من الحساب المحدد.
عند طلب حذف تجمع، تحدث الإجراءات التالية: يتم تعيين حالة التجمع على الحذف؛ يتم إيقاف أي عملية تغيير حجم مستمرة على التجمع؛ تبدأ خدمة Batch في تغيير حجم التجمع إلى صفر عقد حساب؛ يتم إنهاء أي مهام تعمل على عقد الحوسبة الموجودة وإعادة ترتيبها (كما لو تم طلب عملية تغيير حجم التجمع مع خيار إعادة الانتظار الافتراضي)؛ وأخيرا، تتم إزالة التجمع من النظام. نظرا لإعادة ترتيب المهام قيد التشغيل، يمكن للمستخدم إعادة تشغيل هذه المهام عن طريق تحديث الوظيفة الخاصة به لاستهداف تجمع مختلف. يمكن بعد ذلك تشغيل المهام على التجمع الجديد. إذا كنت تريد تجاوز سلوك إعادة الانتظار، فيجب عليك استدعاء تجمع تغيير الحجم بشكل صريح لتقليص حجم التجمع إلى صفر قبل حذف التجمع. إذا قمت باستدعاء Update أو Patch أو Delete API على تجمع في حالة الحذف، فسيفشل مع رمز حالة HTTP 409 مع رمز الخطأ PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
disable_auto_scale
تعطيل التحجيم التلقائي لتجمع.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
معلمات إضافية للعملية
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
enable_auto_scale
تمكين التحجيم التلقائي لتجمع.
لا يمكنك تمكين التحجيم التلقائي على تجمع إذا كانت عملية تغيير الحجم قيد التقدم على التجمع. إذا تم تعطيل التحجيم التلقائي للتجمع حاليا، فيجب تحديد صيغة تحجيم تلقائي صالحة كجزء من الطلب. إذا تم تمكين التحجيم التلقائي للتجمع بالفعل، يمكنك تحديد صيغة تحجيم تلقائي جديدة و/أو فاصل تقييم جديد. لا يمكنك استدعاء واجهة برمجة التطبيقات هذه لنفس التجمع أكثر من مرة كل 30 ثانية.
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- auto_scale_formula
- str
يتم التحقق من صحة الصيغة قبل تطبيقها على التجمع. إذا كانت الصيغة غير صالحة، ترفض خدمة Batch الطلب بمعلومات مفصلة عن الخطأ. لمزيد من المعلومات حول تحديد هذه الصيغة، راجع توسيع نطاق عقد الحوسبة تلقائيا في تجمع Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
القيمة الافتراضية هي 15 دقيقة. الحد الأدنى والحد الأقصى للقيمة هو 5 دقائق و168 ساعة على التوالي. إذا حددت قيمة أقل من 5 دقائق أو أكثر من 168 ساعة، ترفض خدمة Batch الطلب مع خطأ قيمة خاصية غير صالح؛ إذا كنت تتصل بواجهة برمجة تطبيقات REST مباشرة، فإن رمز حالة HTTP هو 400 (طلب غير صحيح). إذا حددت فاصلا زمنيا جديدا، فسيتم إيقاف جدول تقييم التحجيم التلقائي الحالي وسيتم بدء جدول تقييم مقياس تلقائي جديد، مع وقت البدء الخاص به هو الوقت الذي تم فيه إصدار هذا الطلب.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
معلمات إضافية للعملية
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
evaluate_auto_scale
يحصل على نتيجة تقييم صيغة تحجيم تلقائي على التجمع.
واجهة برمجة التطبيقات هذه مخصصة في المقام الأول للتحقق من صحة صيغة التحجيم التلقائي، لأنها ببساطة ترجع النتيجة دون تطبيق الصيغة على التجمع. يجب تمكين التحجيم التلقائي للتجمع من أجل تقييم صيغة.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- auto_scale_formula
- str
يتم التحقق من صحة الصيغة وحساب نتائجها، ولكن لا يتم تطبيقها على التجمع. لتطبيق الصيغة على التجمع، "تمكين التحجيم التلقائي على تجمع". لمزيد من المعلومات حول تحديد هذه الصيغة، راجع توسيع نطاق عقد الحوسبة تلقائيا في تجمع Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
معلمات إضافية للعملية
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
AutoScaleRun أو ClientRawResponse إذا كان raw=true
نوع الإرجاع
استثناءات
exists
يحصل على الخصائص الأساسية للتجمع.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
bool أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
get
الحصول على معلومات حول التجمع المحدد.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
CloudPool أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
list
يسرد كافة التجمعات في الحساب المحدد.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
مكرر مثل مثيل CloudPool
نوع الإرجاع
استثناءات
list_usage_metrics
يسرد مقاييس الاستخدام، المجمعة حسب التجمع عبر فواصل زمنية فردية، للحساب المحدد.
إذا لم تحدد عبارة $filter بما في ذلك poolId، فإن الاستجابة تتضمن جميع التجمعات الموجودة في الحساب في النطاق الزمني للفواصل الزمنية للتجميع التي تم إرجاعها. إذا لم تحدد عبارة $filter بما في ذلك startTime أو endTime، فإن عوامل التصفية هذه افتراضية على أوقات البدء والانتهاء للفاصل الزمني للتجميع الأخير المتاح حاليا؛ أي أنه يتم إرجاع آخر فاصل زمني للتجميع فقط.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
معلمات إضافية للعملية
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
مكرر مثل مثيل PoolUsageMetrics
نوع الإرجاع
استثناءات
patch
التحديثات خصائص التجمع المحدد.
هذا يحل محل خصائص التجمع المحددة في الطلب فقط. على سبيل المثال، إذا كان التجمع يحتوي على StartTask مقترن به، ولم يحدد الطلب عنصر StartTask، فسيحتفظ التجمع ب StartTask الحالي.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
remove_nodes
يزيل Compute Nodes من التجمع المحدد.
يمكن تشغيل هذه العملية فقط عندما تكون حالة تخصيص التجمع ثابتة. عند تشغيل هذه العملية، تتغير حالة التخصيص من ثابت إلى تغيير الحجم. قد يزيل كل طلب ما يصل إلى 100 عقدة.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
resize
تغيير عدد عقد الحوسبة التي تم تعيينها إلى تجمع.
يمكنك تغيير حجم التجمع فقط عندما تكون حالة التخصيص الخاصة به ثابتة. إذا تم تغيير حجم التجمع بالفعل، يفشل الطلب مع رمز الحالة 409. عند تغيير حجم تجمع، تتغير حالة تخصيص التجمع من ثابت إلى تغيير الحجم. لا يمكنك تغيير حجم التجمعات التي تم تكوينها للتحجيم التلقائي. إذا حاولت القيام بذلك، فإن خدمة Batch ترجع خطأ 409. إذا قمت بتغيير حجم تجمع لأسفل، فإن خدمة Batch تختار عقد الحساب التي تريد إزالتها. لإزالة عقد حساب معينة، استخدم تجمع إزالة واجهة برمجة تطبيقات عقد الحوسبة بدلا من ذلك.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
stop_resize
إيقاف عملية تغيير الحجم المستمرة على التجمع.
لا يؤدي هذا إلى استعادة التجمع إلى حالته السابقة قبل عملية تغيير الحجم: فإنه يوقف فقط أي تغييرات أخرى يتم إجراؤها، ويحافظ التجمع على حالته الحالية. بعد الإيقاف، يستقر التجمع عند عدد عقد الحساب التي كان عليها عند الانتهاء من عملية الإيقاف. أثناء عملية الإيقاف، تتغير حالة تخصيص التجمع أولا إلى إيقاف ثم إلى ثابت. لا يلزم أن تكون عملية تغيير الحجم طلب تجمع تغيير حجم صريح؛ يمكن أيضا استخدام واجهة برمجة التطبيقات هذه لإيقاف التحجيم الأولي للتجمع عند إنشائه.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
update_properties
التحديثات خصائص التجمع المحدد.
هذا يحل محل جميع الخصائص القابلة للتحديث للتجمع بشكل كامل. على سبيل المثال، إذا كان التجمع يحتوي على StartTask مقترن به وإذا لم يتم تحديد StartTask مع هذا الطلب، فستزيل خدمة Batch StartTask الموجودة.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)
المعلمات
- pool_update_properties_options
- PoolUpdatePropertiesOptions
معلمات إضافية للعملية
- raw
- bool
إرجاع الاستجابة المباشرة جنبا إلى جنب مع الاستجابة التي تم إلغاء تسلسلها
- operation_config
تجاوزات تكوين العملية.
المرتجعات
لا شيء أو ClientRawResponse إذا كانت raw=true
نوع الإرجاع
استثناءات
السمات
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python