Exports - Get

Exportálás azonosítója alapján.

GET https://{subdomain}.{baseDomain}/api/dataExport/exports/{exportId}?api-version=2022-06-30-preview

URI-paraméterek

Name In Required Type Description
baseDomain
path True
  • string

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

exportId
path True
  • string

Az exportálás egyedi azonosítója.

subdomain
path True
  • string

Az alkalmazás altartománya.

api-version
query True
  • string

A meghívandó API verziója.

Válaszok

Name Type Description
200 OK

Siker

Other Status Codes

Az IoT Central szolgáltatástól kapott hibaválasz.

Headers

  • x-ms-error-code: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

Get data export by ID

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/dataExport/exports/export1?api-version=2022-06-30-preview

Sample Response

{
  "id": "export1",
  "displayName": "Test Export 1",
  "enabled": false,
  "source": "telemetry",
  "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"",
  "enrichments": {
    "abc": {
      "path": "$templateDisplayName"
    }
  },
  "destinations": [
    {
      "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae",
      "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }"
    }
  ],
  "status": "notStarted"
}

Definíciók

DataExportError

Az adatexportálási hiba definíciója.

DestinationReference

A célhivatkozás definíciója.

DestinationSource

Az exportálandó adatok típusa.

Enrichment

Az adatexportálás bővítési definíciója.

Error

A válaszhiba definíciója.

ErrorDetails

A hiba részletes információi.

Export

Az adatexportálási definíció.

DataExportError

Az adatexportálási hiba definíciója.

Name Type Description
code
  • string

A hiba kódja.

message
  • string

A bekövetkezett hiba leírása.

DestinationReference

A célhivatkozás definíciója.

Name Type Description
id
  • string

Annak a célnak az azonosítója, ahová az adatokat el kell küldeni.

transform
  • string

Lekérdezés az üzenetstruktúra adott kimenetre való átalakításához.

DestinationSource

Az exportálandó adatok típusa.

Name Type Description
deviceConnectivity
  • string

Célforrás az eszközkapcsolatból

deviceLifecycle
  • string

Célforrás az eszköz életciklusából

deviceTemplateLifecycle
  • string

Célforrás az eszközsablon életciklusából

properties
  • string

Célforrás az eszköz tulajdonságaiból

telemetry
  • string

Célforrás az eszköztelemetria alapján

Enrichment

Az adatexportálás bővítési definíciója.

Name Type Description
path
  • string

A célképesség elérési útja az eszközsablonon vagy a használni kívánt rendszertulajdonságon belül.

target
  • string

A bővítés célképességét meghatározó eszközsablon vagy felület.

value

A bővítéshez használt nyers érték.

Error

A válaszhiba definíciója.

Name Type Description
error

Az aktuális kérelem hibaadatai.

ErrorDetails

A hiba részletes információi.

Name Type Description
code
  • string

Hibakód.

message
  • string

A hibaüzenet részletei.

requestId
  • string

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

time
  • string

A hibakérés sikertelen volt.

Export

Az adatexportálási definíció.

Name Type Description
destinations

Azon célhelyek listája, amelyekre az exportálásnak adatokat kell küldenie.

displayName
  • string

Az exportálás megjelenítendő neve.

enabled
  • boolean

Az exportálás indításának/leállításának váltása az adatok küldéséről.

enrichments

Az egyes elküldött üzenetekhez mellékelendő további információk. Az adatok kulcs/érték párok halmazaként jelennek meg, ahol a kulcs a kimeneti üzenetben megjelenő bővítés neve, és az érték azonosítja az elküldendő adatokat.

errors

Az exportálás vagy a cél által észlelt hibák.

filter
  • string

A forrásból exportálandó eseményeket meghatározó lekérdezés.

id
  • string

Az exportálás egyedi azonosítója.

lastExportTime
  • string

Az exportálásra vagy a célhelyre küldött utolsó üzenet időbélyege.

source

Az exportálandó adatok típusa.

status
  • string

Az exportálás vagy a cél aktuális állapotának és működésének jelzése.