مشاركة عبر


BatchClient class

فئة العميل للوصول إلى خدمة Azure Batch المستخدمة.

المنشئون

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

الأساليب

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

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

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

ينشئ جدول مهام للحساب المحدد.

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

يمكنك إضافة حساب مستخدم إلى عقدة الحوسبة فقط عندما تكون في حالة الخمول أو قيد التشغيل. قبل أن تتمكن من تسجيل الدخول عن بعد إلى عقدة الحوسبة، يجب عليك تكوين منافذ الوصول ل SSH وRDP. لمزيد من المعلومات، راجع https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

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

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

أقصى عمر للمهمة من الإضافة إلى الإكمال هو 180 يوما. إذا لم تكتمل المهمة خلال 180 يوما من إضافتها، فسيتم إنهاؤها من قبل خدمة الدفعة وتترك في الحالة التي كانت فيها في ذلك الوقت.

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

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

deallocateNode(string, string, DeallocateNodeOptionalParams)

يمكنك تخصيص عقدة الحوسبة فقط إذا كانت في حالة خمول أو تشغيل.

deleteJob(string, DeleteJobOptionalParams)

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

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

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

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

يحذف الملف المحدد من عقدة الحوسبة.

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

يمكنك حذف حساب المستخدم إلى عقدة حسابية فقط عندما يكون في حالة الخمول أو التشغيل. قبل أن تتمكن من تسجيل الدخول عن بعد إلى عقدة الحوسبة، يجب عليك تكوين منافذ الوصول ل SSH وRDP. لمزيد من المعلومات، راجع https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

deletePool(string, DeletePoolOptionalParams)

عندما تطلب حذف تجمع، تحدث الإجراءات التالية: حالة المجموعة مضبوطة على الحذف؛ يتم إيقاف أي عملية إعادة حجم مستمرة على المسبح؛ تبدأ خدمة الدفعات بتغيير حجم المجموعة إلى عقد حوسبة صفرية؛ أي مهام تعمل على عقد الحوسبة الموجودة تنهي وتعاد تشابئها (كما لو أن عملية إعادة تجمع الأحجام قد طلبت مع خيار إعادة الطابور الافتراضي)؛ وأخيرا، تزال المسبح من النظام. نظرا لأن المهام الجارية تعاد ترتيبها، يمكن للمستخدم إعادة تشغيل هذه المهام عن طريق تحديث وظيفته لاستهداف مجموعة مختلفة. يمكن بعد ذلك تشغيل المهام على المجموعة الجديدة. إذا أردت تجاوز سلوك إعادة الانتظار، فعليك استدعاء resize Pool صراحة لتقليل حجم المجموعة إلى الصفر قبل حذف Pool. إذا استدعيت API تحديث أو تحديث أو حذف على تجمع في حالة الحذف، فسوف يفشل مع رمز حالة HTTP 409 مع رمز خطأ PoolBeingDeleted.

deleteTask(string, string, DeleteTaskOptionalParams)

عند حذف مهمة، يتم حذف جميع الملفات في مجلدها على عقدة الحوسبة التي تم تشغيلها فيها أيضا (بغض النظر عن وقت الاحتفاظ). بالنسبة للمهام متعددة المثلات، تطبق عملية حذف المهمة بشكل متزامن على المهمة الأساسية؛ ثم يتم حذف المهام الفرعية وملفاتها بشكل غير متزامن في الخلفية.

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

يحذف ملف المهمة المحدد من عقدة الحساب حيث كانت المهمة تعمل.

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

تقوم خدمة الدفعة فورا بنقل الوظيفة إلى حالة التعطيل. ثم يستخدم الدفعة معامل disableTasks لتحديد ما يجب فعله بالمهام الجارية حاليا في الوظيفة. تبقى الوظيفة في حالة التعطيل حتى تكتمل عملية التعطيل ويتم التعامل مع جميع المهام وفقا لخيار disableTasks؛ ثم تنتقل الوظيفة إلى حالة الإعاقة. لا تبدأ أي مهام جديدة تحت الوظيفة حتى تعود إلى الحالة النشطة. إذا حاولت تعطيل وظيفة في أي حالة غير نشطة أو معطلة أو معطلة، يفشل الطلب مع رمز الحالة 409.

disableJobSchedule(string, DisableJobScheduleOptionalParams)

لن يتم إنشاء وظائف جديدة حتى يتم تفعيل جدول المهام مرة أخرى.

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

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

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

يعطل التوسع التلقائي للمسبح.

enableJob(string, EnableJobOptionalParams)

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

enableJobSchedule(string, EnableJobScheduleOptionalParams)

يتيح جدول عمل.

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

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

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

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

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

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

getApplication(string, GetApplicationOptionalParams)

تعيد هذه العملية فقط التطبيقات والإصدارات المتاحة للاستخدام على عقد الحوسبة؛ أي أنه يمكن استخدامه في مرجع الحزمة. للحصول على معلومات المسؤول حول التطبيقات والإصدارات التي لم تتوفر بعد لعقد الحوسبة، استخدم بوابة Azure أو واجهة برمجة تطبيقات Azure Resource Manager.

getJob(string, GetJobOptionalParams)

يحصل على معلومات حول الوظيفة المحددة.

getJobSchedule(string, GetJobScheduleOptionalParams)

يحصل على معلومات حول جدول المهام المحدد.

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

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

getNode(string, string, GetNodeOptionalParams)

يحصل على معلومات حول عقدة الحوسبة المحددة.

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

يحصل على معلومات حول امتداد عقدة الحوسبة المحدد.

getNodeFile(string, string, string, GetNodeFileOptionalParams)

يعيد محتوى ملف عقدة الحوسبة المحدد.

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

يحصل على خصائص ملف عقدة الحوسبة المحدد.

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

قبل أن تتمكن من تسجيل الدخول عن بعد إلى عقدة الحوسبة باستخدام إعدادات تسجيل الدخول عن بعد، يجب عليك إنشاء حساب مستخدم على عقدة الحوسبة وتكوين منافذ الوصول ل SSH وRDP. لمزيد من المعلومات، راجع https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

getPool(string, GetPoolOptionalParams)

يحصل على معلومات عن المجموعة المحددة.

getTask(string, string, GetTaskOptionalParams)

بالنسبة للمهام متعددة الحالات، تشير معلومات مثل affinityId و executionInfo و nodeInfo إلى المهمة الأساسية. استخدم واجهة برمجة التطبيقات القائمة للمهام الفرعية لاسترجاع معلومات حول المهام الفرعية.

getTaskFile(string, string, string, GetTaskFileOptionalParams)

يعيد محتوى ملف المهمة المحدد.

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

يحصل على خصائص ملف المهمة المحدد.

jobScheduleExists(string, JobScheduleExistsOptionalParams)

يتحقق من وجود جدول المهام المحدد.

listApplications(ListApplicationsOptionalParams)

تعيد هذه العملية فقط التطبيقات والإصدارات المتاحة للاستخدام على عقد الحوسبة؛ أي أنه يمكن استخدامه في مرجع الحزمة. للحصول على معلومات المسؤول حول التطبيقات والإصدارات التي لم تتوفر بعد لعقد الحوسبة، استخدم بوابة Azure أو واجهة برمجة تطبيقات Azure Resource Manager.

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

تعيد هذه الواجهة حالة مهمة إعداد الوظيفة ومهمة تحرير الوظيفة على جميع عقد الحوسبة التي شغلت مهمة إعداد الوظيفة أو مهمة تحرير الوظيفة. يشمل ذلك عقد الحوسبة التي تمت إزالتها لاحقا من المجموعة. إذا تم استدعاء هذه الواجهة على وظيفة لا تحتوي على مهمة إعداد المهمة أو مهمة تحرير الوظائف، فإن خدمة الدفعة تعيد رمز حالة HTTP 409 (تعارض) مع رمز خطأ يسمى JobPreparationTaskNotSpecified.

listJobs(ListJobsOptionalParams)

يسرد جميع الوظائف في الحساب المحدد.

listJobSchedules(ListJobSchedulesOptionalParams)

يسرد جميع جداول المهام في الحساب المحدد.

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

يسرد الوظائف التي تم إنشاؤها ضمن جدول المهام المحدد.

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

يسرد امتدادات عقد الحوسبة في المجموعة المحددة.

listNodeFiles(string, string, ListNodeFilesOptionalParams)

يسرد جميع الملفات في مجلدات المهام على عقدة الحوسبة المحددة.

listNodes(string, ListNodesOptionalParams)

يسرد عقد الحوسبة في المجموعة المحددة.

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

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

listPools(ListPoolsOptionalParams)

يسرد جميع التجمعات في الحساب المحدد.

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

إذا لم تحدد بند $filter يتضمن معرف poolId، فإن الاستجابة تشمل جميع التجمعات التي كانت موجودة في الحساب ضمن نطاق فترات التجميع المرتجعة. إذا لم تحدد جملة $filter تشمل startTime أو endTime، فإن هذه الفلاتر تفرض بشكل افتراضي توقيت البداية والنهاية لآخر فترة تجميع متاحة حاليا؛ أي أن الفترة الأخيرة للتجميع فقط تعود إليها.

listSubTasks(string, string, ListSubTasksOptionalParams)

إذا لم تكن المهمة مهمة متعددة المثلات، فإن هذا يعيد مجموعة فارغة.

listSupportedImages(ListSupportedImagesOptionalParams)

يسرد جميع صور الآلة الافتراضية المدعومة من خدمة Azure Batch (الدفعة).

listTaskFiles(string, string, ListTaskFilesOptionalParams)

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

listTasks(string, ListTasksOptionalParams)

بالنسبة للمهام متعددة الحالات، تشير معلومات مثل affinityId و executionInfo و nodeInfo إلى المهمة الأساسية. استخدم واجهة برمجة التطبيقات القائمة للمهام الفرعية لاسترجاع معلومات حول المهام الفرعية.

poolExists(string, PoolExistsOptionalParams)

يحصل على الخصائص الأساسية للمجموعة.

reactivateTask(string, string, ReactivateTaskOptionalParams)

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

rebootNode(string, string, RebootNodeOptionalParams)

يمكنك إعادة تشغيل عقدة الحوسبة فقط إذا كانت في حالة خمول أو تشغيل.

reimageNode(string, string, ReimageNodeOptionalParams)

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

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

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

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

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

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

هذا يحل محل جميع الخصائص القابلة للتحديث في جدول المهام. على سبيل المثال، إذا لم يتم تحديد خاصية الجدول مع هذا الطلب، فإن خدمة الدفعة ستزيل الجدول الحالي. تؤثر التغييرات في جدول الوظائف فقط على الوظائف التي تم إنشاؤها بواسطة الجدول بعد إجراء التحديث؛ الوظائف التي تدير حاليا لم تتأثر.

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

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

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

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

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

يقوم بتحديث خصائص المهمة المحددة.

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

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

startNode(string, string, StartNodeOptionalParams)

يمكنك بدء عقدة الحوسبة فقط إذا تم تحديد موقعها.

stopPoolResize(string, StopPoolResizeOptionalParams)

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

terminateJob(string, TerminateJobOptionalParams)

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

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

ينهي جدول عمل.

terminateTask(string, string, TerminateTaskOptionalParams)

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

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

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

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

هذا يستبدل فقط خصائص جدول المهام المحددة في الطلب. على سبيل المثال، إذا لم يتم تحديد خاصية الجدول مع هذا الطلب، فإن خدمة الدفعة ستحتفظ بالجدول الحالي. تؤثر التغييرات في جدول الوظائف فقط على الوظائف التي تم إنشاؤها بواسطة الجدول بعد إجراء التحديث؛ الوظائف التي تدير حاليا لم تتأثر.

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

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

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

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

تفاصيل المنشئ

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

المعلمات

endpointParam

string

تفاصيل الأسلوب

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

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

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

المعلمات

المرتجعات

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

ينشئ جدول مهام للحساب المحدد.

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

المعلمات

المرتجعات

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

يمكنك إضافة حساب مستخدم إلى عقدة الحوسبة فقط عندما تكون في حالة الخمول أو قيد التشغيل. قبل أن تتمكن من تسجيل الدخول عن بعد إلى عقدة الحوسبة، يجب عليك تكوين منافذ الوصول ل SSH وRDP. لمزيد من المعلومات، راجع https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

المعلمات

poolId

string

nodeId

string

المرتجعات

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

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

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

المعلمات

المرتجعات

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

أقصى عمر للمهمة من الإضافة إلى الإكمال هو 180 يوما. إذا لم تكتمل المهمة خلال 180 يوما من إضافتها، فسيتم إنهاؤها من قبل خدمة الدفعة وتترك في الحالة التي كانت فيها في ذلك الوقت.

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

المعلمات

jobId

string

المرتجعات

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

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

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

المعلمات

jobId

string

taskCollection
BatchTaskGroup

المرتجعات

deallocateNode(string, string, DeallocateNodeOptionalParams)

يمكنك تخصيص عقدة الحوسبة فقط إذا كانت في حالة خمول أو تشغيل.

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

nodeId

string

المرتجعات

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

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

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

jobId

string

المرتجعات

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

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

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

jobScheduleId

string

المرتجعات

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

يحذف الملف المحدد من عقدة الحوسبة.

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

المعلمات

poolId

string

nodeId

string

filePath

string

المرتجعات

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

يمكنك حذف حساب المستخدم إلى عقدة حسابية فقط عندما يكون في حالة الخمول أو التشغيل. قبل أن تتمكن من تسجيل الدخول عن بعد إلى عقدة الحوسبة، يجب عليك تكوين منافذ الوصول ل SSH وRDP. لمزيد من المعلومات، راجع https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

المعلمات

poolId

string

nodeId

string

userName

string

المرتجعات

Promise<void>

deletePool(string, DeletePoolOptionalParams)

عندما تطلب حذف تجمع، تحدث الإجراءات التالية: حالة المجموعة مضبوطة على الحذف؛ يتم إيقاف أي عملية إعادة حجم مستمرة على المسبح؛ تبدأ خدمة الدفعات بتغيير حجم المجموعة إلى عقد حوسبة صفرية؛ أي مهام تعمل على عقد الحوسبة الموجودة تنهي وتعاد تشابئها (كما لو أن عملية إعادة تجمع الأحجام قد طلبت مع خيار إعادة الطابور الافتراضي)؛ وأخيرا، تزال المسبح من النظام. نظرا لأن المهام الجارية تعاد ترتيبها، يمكن للمستخدم إعادة تشغيل هذه المهام عن طريق تحديث وظيفته لاستهداف مجموعة مختلفة. يمكن بعد ذلك تشغيل المهام على المجموعة الجديدة. إذا أردت تجاوز سلوك إعادة الانتظار، فعليك استدعاء resize Pool صراحة لتقليل حجم المجموعة إلى الصفر قبل حذف Pool. إذا استدعيت API تحديث أو تحديث أو حذف على تجمع في حالة الحذف، فسوف يفشل مع رمز حالة HTTP 409 مع رمز خطأ PoolBeingDeleted.

function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

المرتجعات

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

عند حذف مهمة، يتم حذف جميع الملفات في مجلدها على عقدة الحوسبة التي تم تشغيلها فيها أيضا (بغض النظر عن وقت الاحتفاظ). بالنسبة للمهام متعددة المثلات، تطبق عملية حذف المهمة بشكل متزامن على المهمة الأساسية؛ ثم يتم حذف المهام الفرعية وملفاتها بشكل غير متزامن في الخلفية.

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

المعلمات

jobId

string

taskId

string

المرتجعات

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

يحذف ملف المهمة المحدد من عقدة الحساب حيث كانت المهمة تعمل.

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

المعلمات

jobId

string

taskId

string

filePath

string

المرتجعات

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

تقوم خدمة الدفعة فورا بنقل الوظيفة إلى حالة التعطيل. ثم يستخدم الدفعة معامل disableTasks لتحديد ما يجب فعله بالمهام الجارية حاليا في الوظيفة. تبقى الوظيفة في حالة التعطيل حتى تكتمل عملية التعطيل ويتم التعامل مع جميع المهام وفقا لخيار disableTasks؛ ثم تنتقل الوظيفة إلى حالة الإعاقة. لا تبدأ أي مهام جديدة تحت الوظيفة حتى تعود إلى الحالة النشطة. إذا حاولت تعطيل وظيفة في أي حالة غير نشطة أو معطلة أو معطلة، يفشل الطلب مع رمز الحالة 409.

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

jobId

string

disableOptions
BatchJobDisableOptions

المرتجعات

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

لن يتم إنشاء وظائف جديدة حتى يتم تفعيل جدول المهام مرة أخرى.

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

المعلمات

jobScheduleId

string

المرتجعات

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

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

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

المعلمات

poolId

string

nodeId

string

المرتجعات

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

يعطل التوسع التلقائي للمسبح.

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

المعلمات

poolId

string

المرتجعات

Promise<void>

enableJob(string, EnableJobOptionalParams)

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

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

jobId

string

المرتجعات

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

يتيح جدول عمل.

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

المعلمات

jobScheduleId

string

المرتجعات

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

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

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

المعلمات

poolId

string

nodeId

string

المرتجعات

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

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

function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

المعلمات

poolId

string

enableAutoScaleOptions
BatchPoolEnableAutoScaleOptions

المرتجعات

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

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

function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

المعلمات

poolId

string

evaluateAutoScaleOptions
BatchPoolEvaluateAutoScaleOptions

المرتجعات

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

تعيد هذه العملية فقط التطبيقات والإصدارات المتاحة للاستخدام على عقد الحوسبة؛ أي أنه يمكن استخدامه في مرجع الحزمة. للحصول على معلومات المسؤول حول التطبيقات والإصدارات التي لم تتوفر بعد لعقد الحوسبة، استخدم بوابة Azure أو واجهة برمجة تطبيقات Azure Resource Manager.

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

المعلمات

applicationId

string

المرتجعات

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

يحصل على معلومات حول الوظيفة المحددة.

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

المعلمات

jobId

string

المرتجعات

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

يحصل على معلومات حول جدول المهام المحدد.

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

المعلمات

jobScheduleId

string

المرتجعات

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

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

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

المعلمات

jobId

string

المرتجعات

getNode(string, string, GetNodeOptionalParams)

يحصل على معلومات حول عقدة الحوسبة المحددة.

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

المعلمات

poolId

string

nodeId

string

المرتجعات

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

يحصل على معلومات حول امتداد عقدة الحوسبة المحدد.

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

المعلمات

poolId

string

nodeId

string

extensionName

string

المرتجعات

getNodeFile(string, string, string, GetNodeFileOptionalParams)

يعيد محتوى ملف عقدة الحوسبة المحدد.

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

المعلمات

poolId

string

nodeId

string

filePath

string

المرتجعات

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

يحصل على خصائص ملف عقدة الحوسبة المحدد.

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

المعلمات

poolId

string

nodeId

string

filePath

string

المرتجعات

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

قبل أن تتمكن من تسجيل الدخول عن بعد إلى عقدة الحوسبة باستخدام إعدادات تسجيل الدخول عن بعد، يجب عليك إنشاء حساب مستخدم على عقدة الحوسبة وتكوين منافذ الوصول ل SSH وRDP. لمزيد من المعلومات، راجع https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

المعلمات

poolId

string

nodeId

string

المرتجعات

getPool(string, GetPoolOptionalParams)

يحصل على معلومات عن المجموعة المحددة.

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

المعلمات

poolId

string

المرتجعات

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

بالنسبة للمهام متعددة الحالات، تشير معلومات مثل affinityId و executionInfo و nodeInfo إلى المهمة الأساسية. استخدم واجهة برمجة التطبيقات القائمة للمهام الفرعية لاسترجاع معلومات حول المهام الفرعية.

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

المعلمات

jobId

string

taskId

string

المرتجعات

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

يعيد محتوى ملف المهمة المحدد.

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

المعلمات

jobId

string

taskId

string

filePath

string

المرتجعات

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

يحصل على خصائص ملف المهمة المحدد.

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

المعلمات

jobId

string

taskId

string

filePath

string

المرتجعات

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

يتحقق من وجود جدول المهام المحدد.

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

المعلمات

jobScheduleId

string

المرتجعات

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

تعيد هذه العملية فقط التطبيقات والإصدارات المتاحة للاستخدام على عقد الحوسبة؛ أي أنه يمكن استخدامه في مرجع الحزمة. للحصول على معلومات المسؤول حول التطبيقات والإصدارات التي لم تتوفر بعد لعقد الحوسبة، استخدم بوابة Azure أو واجهة برمجة تطبيقات Azure Resource Manager.

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

المعلمات

المرتجعات

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

تعيد هذه الواجهة حالة مهمة إعداد الوظيفة ومهمة تحرير الوظيفة على جميع عقد الحوسبة التي شغلت مهمة إعداد الوظيفة أو مهمة تحرير الوظيفة. يشمل ذلك عقد الحوسبة التي تمت إزالتها لاحقا من المجموعة. إذا تم استدعاء هذه الواجهة على وظيفة لا تحتوي على مهمة إعداد المهمة أو مهمة تحرير الوظائف، فإن خدمة الدفعة تعيد رمز حالة HTTP 409 (تعارض) مع رمز خطأ يسمى JobPreparationTaskNotSpecified.

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

المعلمات

jobId

string

المرتجعات

listJobs(ListJobsOptionalParams)

يسرد جميع الوظائف في الحساب المحدد.

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

المعلمات

المرتجعات

listJobSchedules(ListJobSchedulesOptionalParams)

يسرد جميع جداول المهام في الحساب المحدد.

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

المعلمات

المرتجعات

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

يسرد الوظائف التي تم إنشاؤها ضمن جدول المهام المحدد.

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

المعلمات

jobScheduleId

string

المرتجعات

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

يسرد امتدادات عقد الحوسبة في المجموعة المحددة.

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

المعلمات

poolId

string

nodeId

string

المرتجعات

listNodeFiles(string, string, ListNodeFilesOptionalParams)

يسرد جميع الملفات في مجلدات المهام على عقدة الحوسبة المحددة.

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

المعلمات

poolId

string

nodeId

string

المرتجعات

listNodes(string, ListNodesOptionalParams)

يسرد عقد الحوسبة في المجموعة المحددة.

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

المعلمات

poolId

string

المرتجعات

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

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

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

المعلمات

المرتجعات

listPools(ListPoolsOptionalParams)

يسرد جميع التجمعات في الحساب المحدد.

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

المعلمات

المرتجعات

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

إذا لم تحدد بند $filter يتضمن معرف poolId، فإن الاستجابة تشمل جميع التجمعات التي كانت موجودة في الحساب ضمن نطاق فترات التجميع المرتجعة. إذا لم تحدد جملة $filter تشمل startTime أو endTime، فإن هذه الفلاتر تفرض بشكل افتراضي توقيت البداية والنهاية لآخر فترة تجميع متاحة حاليا؛ أي أن الفترة الأخيرة للتجميع فقط تعود إليها.

function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

المعلمات

المرتجعات

listSubTasks(string, string, ListSubTasksOptionalParams)

إذا لم تكن المهمة مهمة متعددة المثلات، فإن هذا يعيد مجموعة فارغة.

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

المعلمات

jobId

string

taskId

string

المرتجعات

listSupportedImages(ListSupportedImagesOptionalParams)

يسرد جميع صور الآلة الافتراضية المدعومة من خدمة Azure Batch (الدفعة).

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

المعلمات

المرتجعات

listTaskFiles(string, string, ListTaskFilesOptionalParams)

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

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

المعلمات

jobId

string

taskId

string

المرتجعات

listTasks(string, ListTasksOptionalParams)

بالنسبة للمهام متعددة الحالات، تشير معلومات مثل affinityId و executionInfo و nodeInfo إلى المهمة الأساسية. استخدم واجهة برمجة التطبيقات القائمة للمهام الفرعية لاسترجاع معلومات حول المهام الفرعية.

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

المعلمات

jobId

string

المرتجعات

poolExists(string, PoolExistsOptionalParams)

يحصل على الخصائص الأساسية للمجموعة.

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

المعلمات

poolId

string

المرتجعات

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

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

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

المعلمات

jobId

string

taskId

string

المرتجعات

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

يمكنك إعادة تشغيل عقدة الحوسبة فقط إذا كانت في حالة خمول أو تشغيل.

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

nodeId

string

المرتجعات

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

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

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

nodeId

string

المرتجعات

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

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

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

removeOptions
BatchNodeRemoveOptions

المرتجعات

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

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

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

المعلمات

jobId

string

job
BatchJob

المرتجعات

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

هذا يحل محل جميع الخصائص القابلة للتحديث في جدول المهام. على سبيل المثال، إذا لم يتم تحديد خاصية الجدول مع هذا الطلب، فإن خدمة الدفعة ستزيل الجدول الحالي. تؤثر التغييرات في جدول الوظائف فقط على الوظائف التي تم إنشاؤها بواسطة الجدول بعد إجراء التحديث؛ الوظائف التي تدير حاليا لم تتأثر.

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

المعلمات

jobScheduleId

string

jobSchedule
BatchJobSchedule

المرتجعات

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

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

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

المعلمات

poolId

string

nodeId

string

userName

string

المرتجعات

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

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

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

المعلمات

poolId

string

المرتجعات

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

يقوم بتحديث خصائص المهمة المحددة.

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

المعلمات

jobId

string

taskId

string

task
BatchTask

المرتجعات

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

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

function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

resizeOptions
BatchPoolResizeOptions

المرتجعات

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

يمكنك بدء عقدة الحوسبة فقط إذا تم تحديد موقعها.

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

nodeId

string

المرتجعات

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

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

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

poolId

string

المرتجعات

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

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

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

jobId

string

المرتجعات

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

ينهي جدول عمل.

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

المعلمات

jobScheduleId

string

المرتجعات

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

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

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

المعلمات

jobId

string

taskId

string

المرتجعات

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

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

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

المعلمات

jobId

string

المرتجعات

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

هذا يستبدل فقط خصائص جدول المهام المحددة في الطلب. على سبيل المثال، إذا لم يتم تحديد خاصية الجدول مع هذا الطلب، فإن خدمة الدفعة ستحتفظ بالجدول الحالي. تؤثر التغييرات في جدول الوظائف فقط على الوظائف التي تم إنشاؤها بواسطة الجدول بعد إجراء التحديث؛ الوظائف التي تدير حاليا لم تتأثر.

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

المعلمات

jobScheduleId

string

المرتجعات

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

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

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

المعلمات

poolId

string

المرتجعات

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

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

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

المعلمات

poolId

string

nodeId

string

المرتجعات