Megosztás a következőn keresztül:


Jobs - DeleteJobs Add

Elindít egy feladatot, amely törli az összes modellt, ikerpéldányt és kapcsolatot a példányon. Nem töröl más típusú entitásokat. Állapotkódok:

  • 202 Létrehozva
  • 400 – Hibás kérés
    • JobLimitReached – Elérte az engedélyezett törlési feladatok maximális számát.
    • ValidationFailed – Operation-Id már létezik.
POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31
POST https://digitaltwins-hostname/jobs/deletions?api-version=2023-10-31&timeoutInMinutes={timeoutInMinutes}

URI-paraméterek

Name In Kötelező Típus Description
api-version
query True

string

A kért API-verzió.

timeoutInMinutes
query

integer

int32

A törlési feladat kívánt időtúllépése. A megadott időtúllépés elérése után a szolgáltatás leállítja a folyamatban lévő aktuális törlési feladat által aktivált törlési műveleteket, és sikertelen állapotba lép. Vegye figyelembe, hogy ez ismeretlen állapotban hagyja a példányt, mivel nem lesz visszaállítási művelet.

Kérelem fejléce

Name Kötelező Típus Description
operation-id

string

A művelet állapotfigyelőjének azonosítója. Az azonosító akkor jön létre, ha a fejlécet nem adta át az ügyfél.

traceparent

string

Azonosítja a kérést egy elosztott nyomkövetési rendszerben.

tracestate

string

Szállítóspecifikus nyomkövetési azonosítási információkat biztosít, és a nyomkövetési adatok kiegészítője.

Válaszok

Name Típus Description
202 Accepted

DeleteJob

Feladat elfogadva

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Alapértelmezett válasz.

Headers

x-ms-error-code: string

Biztonság

oauth2

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

Példák

Add a job

Sample Request

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

Sample Response

Operation-Location: https://instance-name/jobs/deletions/{id}?api-version=2023-10-31
Operation-Id: {id}
{
  "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"
}

Definíciók

Name Description
delete-job-status

A feladat állapota.

DeleteJob

Egy feladat, amely a végrehajtandó műveletekre, az eredményekre és a végrehajtás metaadataira mutató hivatkozást tartalmaz.

Error

Hibadefiníció.

ErrorResponse

Hibaválasz.

InnerError

Pontosabb hibaleírás, mint amelyet a hiba tartalmazott.

delete-job-status

A feladat állapota.

Name Típus Description
failed

string

notstarted

string

running

string

succeeded

string

DeleteJob

Egy feladat, amely a végrehajtandó műveletekre, az eredményekre és a végrehajtás metaadataira mutató hivatkozást tartalmaz.

Name Típus Description
createdDateTime

string

A feladat kezdési időpontja. Az időbélyeg RFC3339 formátumban van: yyyy-MM-ddTHH:mm:ssZ.

error

Error

Az importálási feladat végrehajtása során előforduló hiba(ok) részletei.

finishedDateTime

string

A feladat befejezési időpontja. Az időbélyeg RFC3339 formátumban van: yyyy-MM-ddTHH:mm:ssZ.

id

string

A törlési feladat azonosítója.

purgeDateTime

string

Az az időpont, amikor a szolgáltatás törli a feladatot a rendszerből. Az időbélyeg RFC3339 formátumban van: yyyy-MM-ddTHH:mm:ssZ.

status

delete-job-status

A feladat állapota.

Error

Hibadefiníció.

Name Típus Description
code

string

Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.

details

Error[]

Belső hiba részletei.

innererror

InnerError

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

message

string

A hiba emberi olvasásra alkalmas ábrázolása.

ErrorResponse

Hibaválasz.

Name Típus Description
error

Error

A hiba részletei.

InnerError

Pontosabb hibaleírás, mint amelyet a hiba tartalmazott.

Name Típus Description
code

string

Pontosabb hibakód, mint amit a tartalmazó hiba adott meg.

innererror

InnerError

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.