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


Jobs - Get

Feladat lekérése azonosító alapján
Egy futó vagy befejezett feladat részleteinek lekérése feladatazonosító alapján.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

URI-paraméterek

Name In Kötelező Típus Description
baseDomain
path True

string

Az összes Azure IoT Central-szolgáltatáskérés alaptartománya.

jobId
path True

string

A feladat egyedi azonosítója.

Reguláris kifejezési minta: ^[a-zA-Z0-9_-]*$

subdomain
path True

string

Az alkalmazás altartománya.

api-version
query True

string

A meghívott API verziója.

Válaszok

Name Típus Description
200 OK

Job

Siker

Other Status Codes

Error

Hibaválasz érkezett az IoT Central szolgáltatástól.

Fejlécek

x-ms-error-code: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

Get a job by ID

Mintakérelem

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Mintaválasz

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definíciók

Name Description
CloudPropertyJobData

A felhőtulajdonságok feladatadatai.

CommandJobData

A parancsfeladat adatdefiníciója.

DeviceTemplateMigrationJobData

Az eszközsablon migrálási feladatának adatdefiníciója.

Error

A válaszhiba definíciója.

ErrorDetails

A hiba részletes információi.

Job

A feladatdefiníció.

JobBatch

A feladat kötegdefiníciója.

JobBatchType

Azt, hogy a kötegelés adott számú eszközön vagy az összes eszköz százalékos arányában történik-e.

JobCancellationThreshold

A feladatlemondási küszöbérték definíciója.

JobCancellationThresholdType

Azt, hogy a lemondási küszöbérték adott számú eszközre vagy az összes eszköz százalékára vonatkozik-e.

JobProgress

egy ütemezett feladat állapotának összegzése.

PropertyJobData

A tulajdonságfeladat adatdefiníciója.

CloudPropertyJobData

A felhőtulajdonságok feladatadatai.

Name Típus Description
path

string

A célképesség elérési útja az eszközsablonon belül.

target

string

A feladat célképességét meghatározó eszközsablon.

type string:

cloudProperty

A feladatadatok típusa.

value

AnyValue

A célképesség frissítéséhez használt érték, ha van ilyen.

CommandJobData

A parancsfeladat adatdefiníciója.

Name Típus Description
path

string

A célképesség elérési útja az eszközsablonon belül.

target

string

A feladat célképességét meghatározó eszközsablon.

type string:

command

A feladatadatok típusa.

value

AnyValue

A célképesség frissítéséhez használt érték, ha van ilyen.

DeviceTemplateMigrationJobData

Az eszközsablon migrálási feladatának adatdefiníciója.

Name Típus Description
template

string

Az a céleszközsablon, amelyre az eszközök migrálva lesznek.

type string:

deviceTemplateMigration

A feladatadatok típusa.

Error

A válaszhiba definíciója.

Name Típus Description
error

ErrorDetails

Az aktuális kérelem hibaadatai.

ErrorDetails

A hiba részletes információi.

Name Típus Description
code

string

Hibakód.

message

string

Hibaüzenet részletei.

requestId

string

Az aktuális kérelem korrelációs azonosítója.

time

string

A hibakérés sikertelen volt.

Job

A feladatdefiníció.

Name Típus Description
batch

JobBatch

A feladat kötegelési konfigurációja.

cancellationThreshold

JobCancellationThreshold

A feladat lemondási küszöbértéke.

data JobData[]:

A feladat által frissítendő képességek és azok az értékek, amelyekkel frissítve vannak.

description

string

A feladat részletes leírása.

displayName

string

A feladat megjelenítendő neve.

end

string

A feladat befejezési időpontja

group

string

Annak az eszközcsoportnak az azonosítója, amelyen végre kívánja hajtani a feladatot.

id

string

A feladat egyedi azonosítója.

organizations

string[]

A feladat szervezeteinek listája, ma csak egy szervezet támogatott, és hamarosan több szervezet is támogatott lesz.

progress

JobProgress

A feladat előrehaladási statisztikája.

scheduledJobId

string

A feladatot létrehozó ütemezett feladatdefiníció azonosítója.

start

string

A feladat kezdési időpontja

status

string

Azt jelzi, hogy a feladat elindul-e, fut-e stb.

JobBatch

A feladat kötegdefiníciója.

Name Típus Description
type

JobBatchType

Azt, hogy a kötegelés adott számú eszközön vagy az összes eszköz százalékos arányában történik-e.

value

number

Azon eszközök száma vagy százalékos aránya, amelyeken a kötegelés történik.

JobBatchType

Azt, hogy a kötegelés adott számú eszközön vagy az összes eszköz százalékos arányában történik-e.

Name Típus Description
number

string

Feladat kötegelése az eszközök száma alapján.

percentage

string

Feladat kötegelése az összes alkalmazott eszköz százalékos aránya alapján.

JobCancellationThreshold

A feladatlemondási küszöbérték definíciója.

Name Típus Description
batch

boolean

Azt, hogy a lemondási küszöbérték kötegenként vagy a teljes feladatra vonatkozik-e.

type

JobCancellationThresholdType

Azt, hogy a lemondási küszöbérték adott számú eszközre vagy az összes eszköz százalékára vonatkozik-e.

value

number

Azon eszközök száma vagy százalékos aránya, amelyeken a lemondási küszöbértéket alkalmazzák.

JobCancellationThresholdType

Azt, hogy a lemondási küszöbérték adott számú eszközre vagy az összes eszköz százalékára vonatkozik-e.

Name Típus Description
number

string

Feladatlemondási küszöbérték meghatározott számú eszköz alapján.

percentage

string

Feladatlemondási küszöbérték az összes eszköz százalékos aránya alapján.

JobProgress

egy ütemezett feladat állapotának összegzése.

Name Típus Description
completed

integer

Azon entitások száma, amelyek esetében a feladat befejeződött.

failed

integer

Azon entitások száma, amelyek esetében a feladat meghiúsult.

pending

integer

Azon entitások száma, amelyek esetében a feladat még nem fut.

total

integer

A feladat által megcélzott entitások teljes száma.

PropertyJobData

A tulajdonságfeladat adatdefiníciója.

Name Típus Description
path

string

A célképesség elérési útja az eszközsablonon belül.

target

string

A feladat célképességét meghatározó eszközsablon.

type string:

property

A feladatadatok típusa.

value

AnyValue

A célképesség frissítéséhez használt érték, ha van ilyen.