Jobs - DeleteJobs List

Service:

Azure Digital Twins

API Version:

2023-10-31

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

• 200 موافق

GET https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31

معلمات URI

الاسم	في	مطلوب	النوع	الوصف
api-version	query	True	string	إصدار واجهة برمجة التطبيقات المطلوب.

رأس الطلب

الاسم	مطلوب	النوع	الوصف
max-items-per-page		integer	الحد الأقصى لعدد العناصر المراد استردادها لكل طلب. قد يختار الخادم إرجاع أقل من الرقم المطلوب.
traceparent		string	يحدد الطلب في نظام تتبع موزع.
tracestate		string	يوفر معلومات تعريف التتبع الخاصة بالمورد وهو مصاحب ل traceparent.

الاستجابات

الاسم	النوع	الوصف
200 OK	DeleteJobCollection	نجاح
Other Status Codes	ErrorResponse	الاستجابة الافتراضية. Headers x-ms-error-code: string

الأمان

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

أمثلة

Get all import jobs

Sample Request

HTTP

GET https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "deletejob1",
      "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
      "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
      "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
      "status": "succeeded"
    },
    {
      "id": "deletejob2",
      "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
      "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
      "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
      "status": "succeeded"
    }
  ],
  "nextLink": "url-to-next-page"
}

التعريفات

الاسم	الوصف
delete-job-status	حالة الوظيفة.
DeleteJob	مهمة تحتوي على مرجع إلى العمليات التي يجب تنفيذها والنتائج وبيانات تعريف التنفيذ.
DeleteJobCollection	مجموعة من عناصر مهمة الحذف.
Error	تعريف الخطأ.
ErrorResponse	استجابة الخطأ.
InnerError	وصف خطأ أكثر تحديدا مما تم توفيره بواسطة الخطأ المحتوي.

delete-job-status

حالة الوظيفة.

الاسم	النوع	الوصف
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

مهمة تحتوي على مرجع إلى العمليات التي يجب تنفيذها والنتائج وبيانات تعريف التنفيذ.

الاسم	النوع	الوصف
createdDateTime	string	وقت بدء المهمة. الطابع الزمني بتنسيق RFC3339: yyyy-MM-ddTHH:mm:ssZ.
error	Error	تفاصيل الخطأ (الأخطاء) التي حدثت أثناء تنفيذ مهمة الاستيراد.
finishedDateTime	string	وقت انتهاء المهمة. الطابع الزمني بتنسيق RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	معرف مهمة الحذف.
purgeDateTime	string	الوقت الذي سيتم فيه إزالة الوظيفة من قبل الخدمة من النظام. الطابع الزمني بتنسيق RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	حالة الوظيفة.

DeleteJobCollection

مجموعة من عناصر مهمة الحذف.

الاسم	النوع	الوصف
nextLink	string	URI لاسترداد الصفحة التالية من النتائج.
value	DeleteJob[]	قائمة حذف كائنات المهمة.

Error

تعريف الخطأ.

الاسم	النوع	الوصف
code	string	رمز الخطأ الخاص بالخدمة الذي يعمل بمثابة الإحصائيات الفرعية لرمز خطأ HTTP.
details	Error[]	تفاصيل الخطأ الداخلي.
innererror	InnerError	كائن يحتوي على معلومات أكثر تحديدا من الكائن الحالي حول الخطأ.
message	string	تمثيل يمكن للبشر قراءته للخطأ.

ErrorResponse

استجابة الخطأ.

الاسم	النوع	الوصف
error	Error	تفاصيل الخطأ.

InnerError

وصف خطأ أكثر تحديدا مما تم توفيره بواسطة الخطأ المحتوي.

الاسم	النوع	الوصف
code	string	رمز خطأ أكثر تحديدا مما تم توفيره بواسطة الخطأ المحتوي.
innererror	InnerError	كائن يحتوي على معلومات أكثر تحديدا من الكائن الحالي حول الخطأ.