InvokeRESTAPI@0 - استدعاء مهمة REST API v0

استخدم هذه المهمة لاستدعاء واجهة برمجة تطبيقات REST كجزء من البنية الأساسية لبرنامج ربط العمليات التجارية الخاصة بك.

بناء الجملة

# Invoke REST API v0
# Invoke REST API as a part of your process.
- task: InvokeRESTAPI@0
  inputs:
    serviceConnection: # string. Alias: connectedServiceName. Required. Generic endpoint. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #body: '{"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}' # string. Optional. Use when method != GET && method != HEAD. Body. Default: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.
    #urlSuffix: # string. Url suffix string. 
  # Completion Options
    waitForCompletion: 'false' # 'true' | 'false'. Required. Complete based on. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

الإدخالات

serviceConnection - نقطة نهاية عامة
الاسم المستعار للإدخل: connectedServiceName. string. مطلوب

يحدد اتصال الخدمة العام الذي يوفر baseURL الاستدعاء والتخويل لاستخدامه للمهمة.

method - الاسلوب
string. مطلوب القيم المسموح بها: OPTIONS، GET، HEAD، POST، PUT، DELETE، ، ، TRACE. PATCH القيمة الافتراضية: POST.

يحدد أسلوب HTTP الذي يستدعي واجهة برمجة التطبيقات.

headers - رؤوس
string. القيمة الافتراضية: {\n"Content-Type":"application/json"\n}.

تعريف العنوان بتنسيق JSON. يتم إرفاق العنوان بالطلب المرسل إلى واجهة برمجة التطبيقات.

body - الجسم
string. ‏‏اختياري. استخدم عندما method != GET && method != HEAD. القيمة الافتراضية: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

يحدد نص الطلب لاستدعاء الدالة بتنسيق JSON.

urlSuffix - سلسلة لاحقة Url
string.

يحدد السلسلة المراد إلحاقها ب baseUrl من اتصال الخدمة العام أثناء إجراء استدعاء HTTP.

مثال: إذا كان عنوان URL لاتصال الخدمة ولاحقة https:...TestProj/_apis/Release/releases عنوان URL هي /2/environments/1، يصبح https:.../TestProj/_apis/Release/releases/2/environments/1عنوان URL لاتصال الخدمة . إذا كانت لاحقة عنوان URL هي ?definitionId=1&releaseCount=1، فسيصبح https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1عنوان URL لاتصال الخدمة .

waitForCompletion - مكتمل استنادا إلى
string. مطلوب القيم المسموح بها: true (رد الاتصال)، false (ApiResponse). القيمة الافتراضية: false.

يحدد كيفية إبلاغ المهمة عن الإكمال. القيم المسموح بها هي:

• false - استجابة واجهة برمجة التطبيقات: يبلغ عن الإكمال عندما ترجع الدالة النجاح في غضون 20 ثانية، ويتم تقييم معايير النجاح إلى true.
• true - رد الاتصال: يبلغ عن الإكمال عندما تقوم الخدمة الخارجية بإجراء رد اتصال لتحديث سجل المخطط الزمني.

successCriteria - معايير النجاح
string. ‏‏اختياري. استخدم عندما waitForCompletion = false.

يحدد معايير المهمة للنجاح. لا يؤثر محتوى الاستجابة على النتيجة إذا لم يتم تعريف أي معايير. بشكل افتراضي، تمر المهمة عند إرجاع 200 OKالمكالمة .

مثال: للاستجابة {"status" : "successful"}، يمكن أن يكون eq(root['status'], 'successful')التعبير . تعرف على المزيد حول تحديد الشروط.

خيارات التحكم بالمهمة

تحتوي جميع المهام على خيارات التحكم بالإضافة إلى مدخلات المهام الخاصة بها. لمزيد من المعلومات، راجع خيارات التحكم وخصائص المهمة الشائعة.

متغيرات الإخراج

لا شيء

الملاحظات

ملاحظة

يمكن استخدام هذه المهمة فقط في وظيفة بدون عامل.

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

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

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

ما هي عناوين URL الأساسية المستخدمة عند استدعاء واجهات برمجة تطبيقات Azure Management؟

يتم استدعاء واجهات برمجة تطبيقات إدارة Azure باستخدام ResourceManagerEndpoint للبيئة المحددة. على سبيل المثال https://management.Azure.com ، يستخدم عندما يكون الاشتراك في بيئة AzureCloud .

أين يجب إكمال إشارة المهمة عند اختيار رد الاتصال كحدث إكمال؟

للإشارة إلى الإكمال، يجب أن ترسل الخدمة الخارجية بيانات إكمال POST إلى نقطة نهاية REST للبنية الأساسية لبرنامج ربط العمليات التجارية التالية.

{planUri}/{projectId}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/events?api-version=2.0-preview.1

**Request Body**
 { "name": "TaskCompleted", "taskId": "taskInstanceId", "jobId": "jobId", "result": "succeeded" }

راجع تطبيق cmdline البسيط هذا للحصول على تفاصيل.

بالإضافة إلى ذلك، تتوفر مكتبة مساعد C# لتمكين التسجيل المباشر وإدارة حالة المهمة للمهام بدون عامل. معرفة المزيد

هل يمكنني استخدام نص الاستجابة كمدخل لمهمة أخرى؟

لا، لأن هذه المهمة هي مهمة بدون عامل وتستخدم HttpRequest الداخلي ل TFS، والتي لا ترجع محتوى طلب HTTP.

المتطلبات

المتطلبات	الوصف
أنواع البنية الأساسية لبرنامج ربط العمليات التجارية	YAML، الإصدار الكلاسيكي، الإصدار الكلاسيكي
يعمل على	Server, ServerGate
المطالب	بلا
القدرات	لا تفي هذه المهمة بأي طلبات للمهام اللاحقة في الوظيفة.
قيود الأوامر	أي
متغيرات Settable	أي
إصدار الوكيل	جميع إصدارات العامل المدعومة.
فئة المهمة	نشر