Farms - Create Cascade Delete Job

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-11-01-preview

Erstellen Sie einen Kaskadenlöschauftrag für die angegebene Farm.

PUT {endpoint}/farms/cascade-delete/{jobId}?partyId={partyId}&farmId={farmId}&api-version=2023-11-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
jobId	path	True	string	Auftrags-ID, die vom Endbenutzer angegeben wird.
api-version	query	True	string	Die angeforderte API-Version
farmId	query	True	string	ID der zu löschenden Farm.
partyId	query	True	string	ID der zugeordneten Partei.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
202 Accepted	CascadeDeleteJob	Akzeptiert
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Farms_CreateCascadeDeleteJob

Beispielanforderung

HTTP

PUT {endpoint}/farms/cascade-delete/JOB123?partyId=PARTY123&farmId=FARM123&api-version=2023-11-01-preview

Beispiel für eine Antwort

Statuscode:

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": "FARM123",
  "resourceType": "farm"
}

Definitionen

Name	Beschreibung
CascadeDeleteJob	Schema des kaskadierten Löschauftrags.
Error	Ein Fehler vom Azure AgPlatform-Dienst.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter Referenzdokument zu ErrorResponse.
InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.
JobStatus	Status des Auftrags. Mögliche Werte: "Waiting", "Running", "Succeeded", "Failed", "Cancelled".

CascadeDeleteJob

Schema des kaskadierten Löschauftrags.

Name	Typ	Beschreibung
createdDateTime	string	Auftrag, der bei dateTime erstellt wurde. Beispielformat: yyyy-MM-ttTHH:mm:ssZ.
durationInSeconds	number	Dauer des Auftrags in Sekunden.
endTime	string	Auftragsendzeit, wenn verfügbar. Beispielformat: yyyy-MM-ttTHH:mm:ssZ.
errorCode	string	Fehlercode, wenn der Auftrag fehlgeschlagen ist.
id	string	Eindeutige Auftrags-ID.
lastActionDateTime	string	Der Auftrag wurde zuletzt um dateTime ausgeführt. Beispielformat: yyyy-MM-ttTHH:mm:ssZ.
message	string	Statusmeldung, um weitere Details des Auftrags zu erfassen.
partyId	string	Partei-ID.
resourceId	string	Die ID der Ressource.
resourceType	string	Der Typ der Ressource.
startTime	string	Startzeit des Auftrags, sofern verfügbar. Beispielformat: yyyy-MM-ttTHH:mm:ssZ.
status	JobStatus	Status des Auftrags. Mögliche Werte: "Waiting", "Running", "Succeeded", "Failed", "Cancelled".

Error

Ein Fehler vom Azure AgPlatform-Dienst.

Name	Typ	Beschreibung
code	string	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.
message	string	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter Referenzdokument zu ErrorResponse.

Name	Typ	Beschreibung
error	Error	Ein Fehler vom Azure AgPlatform-Dienst.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.

JobStatus

Status des Auftrags. Mögliche Werte: "Waiting", "Running", "Succeeded", "Failed", "Cancelled".

Name	Typ	Beschreibung
Cancelled	string
Failed	string
Running	string
Succeeded	string
Waiting	string