Jobs - ImportJobs Add

Service:

Azure Digital Twins

API Version:

2023-10-31

Létrehoz egy importálási feladatot. Állapotkódok:

• 201 Létrehozva
• 400 – Hibás kérés
  • JobLimitReached – Elérte az engedélyezett importálási feladatok maximális számát.
  • ValidationFailed – Az importálási feladatkérés érvénytelen.

PUT https://digitaltwins-hostname/jobs/imports/{id}?api-version=2023-10-31

URI-paraméterek

Name	In	Kötelező	Típus	Description
id	path	True	string	Az importálási feladat azonosítója. Az azonosító egyedi a szolgáltatáson belül, és megkülönbözteti a kis- és nagybetűt.
api-version	query	True	string	A kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
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.

Kérelem törzse

Name	Kötelező	Típus	Description
inputBlobUri	True	string	A feladatban végrehajtandó műveleteket leíró fájlokat tartalmazó bemeneti Azure Storage-blob elérési útja.
outputBlobUri	True	string	A kimeneti Azure Storage-blob elérési útja, amely az importálási feladat hibáit és folyamatnaplóit tartalmazza.
error		Error	Az importálási feladat végrehajtása során előforduló hiba(ok) részletei.

Válaszok

Name	Típus	Description
201 Created	ImportJob	Siker
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

HTTP

PUT https://digitaltwins-hostname/jobs/imports/importjob1?api-version=2023-10-31

{
  "inputBlobUri": "path to input blob",
  "outputBlobUri": "path to output blob"
}

Sample Response

Status code:

201

{
  "id": "importjob1",
  "inputBlobUri": "path to input blob",
  "outputBlobUri": "path to output blob",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "notstarted"
}

Definíciók

Name	Description
Error	Hibadefiníció.
ErrorResponse	Hibaválasz.
ImportJob	Egy feladat, amely a végrehajtandó műveletekre, az eredményekre és a végrehajtás metaadataira mutató hivatkozást tartalmaz.
InnerError	Pontosabb hibaleírás, mint amelyet a hiba tartalmazott.
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.

ImportJob

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	Az importálási feladat azonosítója.
inputBlobUri	string	A feladatban végrehajtandó műveleteket leíró fájlokat tartalmazó bemeneti Azure Storage-blob elérési útja.
lastActionDateTime	string	Az utolsó alkalom, amikor a szolgáltatás végrehajtotta a feladat bármely műveletét. Az időbélyeg RFC3339 formátumban van: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	A kimeneti Azure Storage-blob elérési útja, amely az importálási feladat hibáit és folyamatnaplóit tartalmazza.
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	status	A feladat állapota.

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.

status

A feladat állapota.

Name	Típus	Description
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string