Jobs - DeleteJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Initiiert einen Auftrag, der alle Modelle, Zwillinge und Beziehungen auf der instance löscht. Löscht keine anderen Entitätstypen. Statuscodes:

• 202 Erstellt
• 400 – Ungültige Anforderung
  • JobLimitReached: Die maximale Anzahl der zulässigen Löschaufträge wurde erreicht.
  • ValidationFailed: Operation-Id bereits vorhanden.

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31

With optional parameters:

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes={timeoutInMinutes}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Die angeforderte API-Version.
timeoutInMinutes	query		integer int32	Gewünschtes Timeout für den Löschauftrag. Sobald das angegebene Timeout erreicht ist, beendet der Dienst alle Löschvorgänge, die durch den aktuellen Löschauftrag ausgelöst werden, die gerade ausgeführt werden, und wechselt in den Status "Fehler". Beachten Sie, dass Ihr instance dadurch in einem unbekannten Zustand bleibt, da es keinen Rollbackvorgang gibt.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
operation-id		string	ID für den status-Monitor des Vorgangs. Die ID wird generiert, wenn der Header nicht vom Client übergeben wurde.
traceparent		string	Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem.
tracestate		string	Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für die Ablaufverfolgung.

Antworten

Name	Typ	Beschreibung
202 Accepted	DeleteJob	Angenommener Auftrag Headers Operation-Location: string
Other Status Codes	ErrorResponse	Standardantwort. Headers x-ms-error-code: string

Sicherheit

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Beispiele

Add a job

Sample Request

HTTP

POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes=60

Sample Response

Status code:

202

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}

Response Body

{
  "id": "deletejob1",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "notstarted"
}

Definitionen

Name	Beschreibung
delete-job-status	Status des Auftrags.
DeleteJob	Ein Auftrag, der einen Verweis auf auszuführende Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.
Error	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
InnerError	Eine spezifischere Fehlerbeschreibung, als vom enthaltenden Fehler bereitgestellt wurde.

delete-job-status

Status des Auftrags.

Name	Typ	Beschreibung
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Ein Auftrag, der einen Verweis auf auszuführende Vorgänge, Ergebnisse und Ausführungsmetadaten enthält.

Name	Typ	Beschreibung
createdDateTime	string	Startzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Details zu den Fehlern, die beim Ausführen des Importauftrags aufgetreten sind.
finishedDateTime	string	Endzeit des Auftrags. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
id	string	Der Bezeichner des Löschauftrags.
purgeDateTime	string	Zeitpunkt, zu dem der Auftrag vom Dienst aus dem System gelöscht wird. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	Status des Auftrags.

Error

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	Error[]	Interne Fehlerdetails.
innererror	InnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

Eine spezifischere Fehlerbeschreibung, als vom enthaltenden Fehler bereitgestellt wurde.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode, als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.