Zones - Create Cascade Delete Job

サービス:

Azure Data Manager for Agriculture

API バージョン:

2023-11-01-preview

指定したゾーンの連鎖削除ジョブを作成します。

PUT {endpoint}/zones/cascade-delete/{jobId}?partyId={partyId}&zoneId={zoneId}&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 バージョン
partyId	query	True	string	関連付けられているパーティの ID。
zoneId	query	True	string	削除するゾーンの ID。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

応答

名前	型	説明
202 Accepted	CascadeDeleteJob	受け入れられた
Other Status Codes	ErrorResponse	エラー ヘッダー x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

Zones_CreateCascadeDeleteJob

要求のサンプル

HTTP

PUT {endpoint}/zones/cascade-delete/JOB123?partyId=PARTY123&zoneId=ZONE123&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": "ZONE123",
  "resourceType": "zone"
}

定義

名前	説明
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