Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

起始作業，此作業會刪除實例上的所有模型、對應項和關聯性。 不會刪除任何其他類型的實體。 狀態碼：

• 202 已建立
• 400 不正確的要求
  • JobLimitReached - 已達到允許的刪除作業數目上限。
  • ValidationFailed - Operation-Id 已經存在。

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

With optional parameters:

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes={timeoutInMinutes}

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要求的 API 版本。
timeoutInMinutes	query		integer int32	刪除作業所需的逾時。 達到指定的逾時後，服務將會停止目前刪除作業所觸發的任何刪除作業正在進行中，並移至失敗狀態。 請注意，這會讓您的實例處於未知狀態，因為沒有任何復原作業。

要求標頭

名稱	必要	類型	Description
operation-id		string	作業狀態監視器的識別碼。 如果標頭不是由用戶端傳遞，就會產生識別碼。
traceparent		string	識別分散式追蹤系統中的要求。
tracestate		string	提供廠商特定的追蹤識別資訊，而且是追蹤親和的隨附專案。

回應

名稱	類型	Description
202 Accepted	DeleteJob	工作已接受 Headers Operation-Location: string
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

範例

Add a job

Sample Request

HTTP

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes=60

Sample Response

Status code:

202

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}

Response Body

{
  "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": "notstarted"
}

定義

名稱	Description
delete-job-status	作業的狀態。
DeleteJob	作業，其中包含要執行、結果和執行中繼資料之作業的參考。
Error	錯誤定義。
ErrorResponse	錯誤回應。
InnerError	比包含的錯誤所提供的更具體錯誤描述。

delete-job-status

作業的狀態。

名稱	類型	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

作業，其中包含要執行、結果和執行中繼資料之作業的參考。

名稱	類型	Description
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	作業的狀態。

Error

錯誤定義。

名稱	類型	Description
code	string	服務特定的錯誤碼，可作為 HTTP 錯誤碼的子狀態。
details	Error[]	內部錯誤詳細資料。
innererror	InnerError	物件，包含比目前物件有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤標記法。

ErrorResponse

錯誤回應。

名稱	類型	Description
error	Error	錯誤詳細資料。

InnerError

比包含的錯誤所提供的更具體錯誤描述。

名稱	類型	Description
code	string	比包含的錯誤所提供的更具體錯誤碼。
innererror	InnerError	物件，包含比目前物件有關錯誤的更特定資訊。