Management Zones - Create Cascade Delete Job

服務:

Azure Data Manager for Agriculture

API 版本:

2023-11-01-preview

為指定的管理區域建立串聯刪除作業。

PUT {endpoint}/management-zones/cascade-delete/{jobId}?partyId={partyId}&managementZoneId={managementZoneId}&api-version=2023-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
jobId	path	True	string	使用者所提供的作業標識碼。
api-version	query	True	string	要求的 API 版本
managementZoneId	query	True	string	要刪除的管理區域識別碼。
partyId	query	True	string	關聯物件的標識碼。

要求標頭

名稱	必要	類型	Description
Authorization	True	string	請為授權的 API 呼叫提供有效的持有人令牌。 請注意，如果您之前嘗試了未驗證的呼叫，您可能需要清除瀏覽器快取。

回應

名稱	類型	Description
202 Accepted	CascadeDeleteJob	已接受
Other Status Codes	ErrorResponse	錯誤 標題 x-ms-error-code: string

安全性

Authorization

請為授權的 API 呼叫提供有效的持有人令牌。 請注意，如果您之前嘗試了未驗證的呼叫，您可能需要清除瀏覽器快取。

類型: apiKey
位於: header

範例

ManagementZones_CreateCascadeDeleteJob

範例要求

HTTP

PUT {endpoint}/management-zones/cascade-delete/JOB123?partyId=PARTY123&managementZoneId=MANAGEMENTZONE123&api-version=2023-11-01-preview

範例回覆

狀態碼:

202

{
  "id": "JOB123",
  "status": "Succeeded",
  "message": "Job completed successfully.",
  "durationInSeconds": 14.7977857,
  "createdDateTime": "2021-04-19T11:31:20Z",
  "lastActionDateTime": "2021-04-19T11:31:34Z",
  "startTime": "2021-04-19T11:31:19Z",
  "endTime": "2021-04-19T11:31:34Z",
  "partyId": "PARTY123",
  "resourceId": "MANAGEMENTZONE123",
  "resourceType": "managementzone"
}

定義

名稱	Description
CascadeDeleteJob	串聯刪除作業的架構。
Error	來自 Azure AgPlatform 服務的錯誤。
ErrorResponse	來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。
InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
JobStatus	作業的狀態。 可能的值：『Waiting』、『Running』、『Succeeded』、『Failed』、『Cancelled』。

CascadeDeleteJob

串聯刪除作業的架構。

名稱	類型	Description
createdDateTime	string	在 dateTime 建立的作業。 範例格式：yyyy-MM-ddTHH：mm：ssZ。
durationInSeconds	number	作業的持續時間，以秒為單位。
endTime	string	可用時的工作結束時間。 範例格式：yyyy-MM-ddTHH：mm：ssZ。
errorCode	string	作業失敗時的錯誤碼。
id	string	唯一的工作標識碼。
lastActionDateTime	string	作業上次在 dateTime 採取動作。 範例格式：yyyy-MM-ddTHH：mm：ssZ。
message	string	擷取更多作業詳細資料的狀態訊息。
partyId	string	合作對象識別碼。
resourceId	string	資源的標識碼。
resourceType	string	資源類型。
startTime	string	可用時的工作開始時間。 範例格式：yyyy-MM-ddTHH：mm：ssZ。
status	JobStatus	作業的狀態。 可能的值：『Waiting』、『Running』、『Succeeded』、『Failed』、『Cancelled』。

Error

來自 Azure AgPlatform 服務的錯誤。

名稱	類型	Description
code	string	伺服器定義的錯誤碼集。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
message	string	人類可閱讀的錯誤表示法。
target	string	錯誤的目標。

ErrorResponse

來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。

名稱	類型	Description
error	Error	來自 Azure AgPlatform 服務的錯誤。
traceId	string	唯一追蹤標識碼。

InnerError

包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

名稱	類型	Description
code	string	包含的錯誤所提供的特定錯誤碼。
innererror	InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

JobStatus

作業的狀態。 可能的值：『Waiting』、『Running』、『Succeeded』、『Failed』、『Cancelled』。

名稱	類型	Description
Cancelled	string
Failed	string
Running	string
Succeeded	string
Waiting	string