Farms - Create Cascade Delete Job
為指定的伺服器陣列建立串聯刪除作業。
PUT {endpoint}/farms/cascade-delete/{jobId}?partyId={partyId}&farmId={farmId}&api-version=2023-11-01-preview
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
命名空間的主機名,例如 admaInstanceName.farmbeats.azure.net |
job
|
path | True |
string |
使用者所提供的作業標識碼。 |
api-version
|
query | True |
string |
要求的 API 版本 |
farm
|
query | True |
string |
要刪除之伺服器陣列的識別碼。 |
party
|
query | True |
string |
相關聯對象的標識碼。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
Authorization | True |
string |
請為授權的 API 呼叫提供有效的持有人令牌。 請注意,如果您之前嘗試了未驗證的呼叫,您可能需要清除瀏覽器快取。 |
回應
名稱 | 類型 | Description |
---|---|---|
202 Accepted |
已接受 |
|
Other Status Codes |
錯誤 標題 x-ms-error-code: string |
安全性
Authorization
請為授權的 API 呼叫提供有效的持有人令牌。 請注意,如果您之前嘗試了未驗證的呼叫,您可能需要清除瀏覽器快取。
類型:
apiKey
位於:
header
範例
Farms_CreateCascadeDeleteJob
範例要求
PUT {endpoint}/farms/cascade-delete/JOB123?partyId=PARTY123&farmId=FARM123&api-version=2023-11-01-preview
範例回覆
{
"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": "FARM123",
"resourceType": "farm"
}
定義
名稱 | Description |
---|---|
Cascade |
串聯刪除作業的架構。 |
Error |
來自 Azure AgPlatform 服務的錯誤。 |
Error |
來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。 |
Inner |
包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。 |
Job |
作業的狀態。 可能的值:『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 |
作業的狀態。 可能的值:『Waiting』、『Running』、『Succeeded』、『Failed』、『Cancelled』。 |
Error
來自 Azure AgPlatform 服務的錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
伺服器定義的錯誤碼集。 |
details |
Error[] |
導致此錯誤之特定錯誤的詳細數據陣列。 |
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 |
來自 Azure AgPlatform 服務的錯誤。 |
|
traceId |
string |
唯一追蹤標識碼。 |
InnerError
包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
名稱 | 類型 | Description |
---|---|---|
code |
string |
包含錯誤所提供的特定錯誤碼。 |
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 |