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 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	命名空间的主机名，例如 admaInstanceName.farmbeats.azure.net
jobId	path	True	string	最终用户提供的作业 ID。
api-version	query	True	string	请求的 API 版本
managementZoneId	query	True	string	要删除的管理区域的 ID。
partyId	query	True	string	关联方的 ID。

请求头

名称	必需	类型	说明
Authorization	True	string	请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试了未经身份验证的调用，可能需要清除浏览器缓存。

响应

名称	类型	说明
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"
}

定义

名称	说明
CascadeDeleteJob	级联删除作业的架构。
Error	Azure AgPlatform 服务中的错误。
ErrorResponse	Azure AgPlatform 服务的错误响应。 请参阅 errorResponse 参考文档 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
InnerError	包含错误列表的内部错误。请参阅 innerError 参考文档 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object。
JobStatus	作业的状态。 可能的值：“Waiting”、“Running”、“Succeeded”、“Failed”、“Cancelled”。

CascadeDeleteJob

Object

级联删除作业的架构。

名称	类型	说明
createdDateTime	string (date-time)	在 dateTime 创建的作业。 示例格式：yyyy-MM-ddTHH：mm：ssZ。
durationInSeconds	number (double)	作业持续时间（以秒为单位）。
endTime	string (date-time)	作业结束时间（可用）。 示例格式：yyyy-MM-ddTHH：mm：ssZ。
errorCode	string	作业失败时的错误代码。
id	string	唯一作业 ID。
lastActionDateTime	string (date-time)	作业在 dateTime 上最后一次执行。 示例格式：yyyy-MM-ddTHH：mm：ssZ。
message	string	用于捕获作业更多详细信息的状态消息。
partyId	string minLength: 1	群 ID。
resourceId	string minLength: 1	资源的 ID。
resourceType	string minLength: 1	资源的类型。
startTime	string (date-time)	作业开始时间（可用）。 示例格式：yyyy-MM-ddTHH：mm：ssZ。
status	JobStatus	作业的状态。 可能的值：“Waiting”、“Running”、“Succeeded”、“Failed”、“Cancelled”。

Error

Object

Azure AgPlatform 服务中的错误。

名称	类型	说明
code	string minLength: 1	服务器定义的错误代码集。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerError	包含错误列表的内部错误。请参阅 innerError 参考文档 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object。
message	string minLength: 1	错误的人工可读表示形式。
target	string	错误的目标。

ErrorResponse

Object

Azure AgPlatform 服务的错误响应。 请参阅 errorResponse 参考文档 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
error	Error	Azure AgPlatform 服务中的错误。
traceId	string	唯一跟踪 ID。

InnerError

Object

包含错误列表的内部错误。请参阅 innerError 参考文档 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object。

名称	类型	说明
code	string	包含的错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。请参阅 innerError 参考文档 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object。

JobStatus

枚举

作业的状态。 可能的值：“Waiting”、“Running”、“Succeeded”、“Failed”、“Cancelled”。

值	说明
Waiting
Running
Succeeded
Failed
Cancelled