Exports - Get

Rufen Sie einen Export nach ID ab.

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

URI-Parameter

Name In Required Type Description
baseDomain
path True
  • string

Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.

exportId
path True
  • string

Eindeutige ID für den Export.

subdomain
path True
  • string

Die Anwendungsdomäne.

api-version
query True
  • string

Die Aufgerufene Version der API.

Antworten

Name Type Description
200 OK

Erfolg

Other Status Codes

Eine Fehlerantwort, die vom IoT Central Service empfangen wurde.

Headers

  • x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
}

Definitionen

DataExportError

Die Fehlerdefinition für den Datenexport.

DestinationReference

Die Zielreferenzdefinition.

DestinationSource

Der Typ der zu exportierenden Daten.

Enrichment

Die Anreicherungsdefinition für den Datenexport.

Error

Die Antwortfehlerdefinition.

ErrorDetails

Die Detailinformationen des Fehlers.

Export

Die Datenexportdefinition.

DataExportError

Die Fehlerdefinition für den Datenexport.

Name Type Description
code
  • string

Der Code für den fehler, der aufgetreten ist.

message
  • string

Die Beschreibung des fehlers, der aufgetreten ist.

DestinationReference

Die Zielreferenzdefinition.

Name Type Description
id
  • string

Die ID des Ziels, an das Daten gesendet werden sollen.

transform
  • string

Abfragen zum Transformieren der Nachrichtenstruktur in eine bestimmte Ausgabe.

DestinationSource

Der Typ der zu exportierenden Daten.

Name Type Description
deviceConnectivity
  • string

Zielquelle aus der Gerätekonnektivität

deviceLifecycle
  • string

Zielquelle aus dem Gerätelebenszyklus

deviceTemplateLifecycle
  • string

Zielquelle aus dem Gerätevorlagenlebenszyklus

properties
  • string

Zielquelle aus Geräteeigenschaften

telemetry
  • string

Zielquelle aus Geräte telemetrie

Enrichment

Die Anreicherungsdefinition für den Datenexport.

Name Type Description
path
  • string

Der Pfad zur Zielfunktion innerhalb der Gerätevorlage oder der zu verwendenden Systemeigenschaft.

target
  • string

Die Gerätevorlage oder Schnittstelle, die die Zielfunktion für die Anreicherung definiert.

value

Der rohe Wert, der für die Anreicherung verwendet wird.

Error

Die Antwortfehlerdefinition.

Name Type Description
error

Fehlerdetails für aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name Type Description
code
  • string

Fehlercode

message
  • string

Fehlermeldungsdetails.

requestId
  • string

Korrelations-ID für aktuelle Anforderung.

time
  • string

Der Zeitpunkt, an dem die Fehleranforderung fehlgeschlagen ist.

Export

Die Datenexportdefinition.

Name Type Description
destinations

Die Liste der Ziele, an die der Export Daten senden soll.

displayName
  • string

Anzeigename des Exportes.

enabled
  • boolean

Wechseln Sie zum Starten/Beenden eines Exportes, um Daten zu senden.

enrichments

Zusätzliche Informationen, die bei jeder gesendeten Nachricht enthalten sind. Daten werden als Schlüssel-Wert-Paare dargestellt, wobei der Schlüssel der Name der Erweiterung ist, die in der Ausgabenachricht angezeigt wird, und der Wert die zu sendenden Daten identifiziert.

errors

Fehler, die vom Export oder Ziel aufgetreten sind.

filter
  • string

Abfrage, die definiert, welche Ereignisse aus der Quelle exportiert werden sollen.

id
  • string

Eindeutige ID des Exports.

lastExportTime
  • string

Der Zeitstempel der letzten Nachricht, die an den Export oder Ziel gesendet wurde.

source

Der Typ der zu exportierenden Daten.

status
  • string

Hinweis auf die aktuelle Integrität und den Betrieb des Exports oder Ziels.