Exports - Get

Pobieranie eksportu według identyfikatora.

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

Parametry identyfikatora URI

Name In Required Type Description
baseDomain
path True
  • string

Domena podstawowa dla wszystkich żądań obsługi usługi Azure IoT Central.

exportId
path True
  • string

Unikatowy identyfikator eksportu.

subdomain
path True
  • string

Poddomena aplikacji.

api-version
query True
  • string

Wywoływana wersja interfejsu API.

Odpowiedzi

Name Type Description
200 OK

Powodzenie

Other Status Codes

Odebrano odpowiedź o błędzie z usługi IoT Central.

Headers

  • x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

DataExportError

Definicja błędu eksportu danych.

DestinationReference

Definicja odwołania do miejsca docelowego.

DestinationSource

Typ danych do wyeksportowania.

Enrichment

Definicja wzbogacania dla eksportu danych.

Error

Definicja błędu odpowiedzi.

ErrorDetails

Szczegółowe informacje o błędzie.

Export

Definicja eksportu danych.

DataExportError

Definicja błędu eksportu danych.

Name Type Description
code
  • string

Kod błędu, który wystąpił.

message
  • string

Opis błędu, który wystąpił.

DestinationReference

Definicja odwołania do miejsca docelowego.

Name Type Description
id
  • string

Identyfikator miejsca docelowego, w którym powinny być wysyłane dane.

transform
  • string

Zapytanie dotyczące przekształcania struktury komunikatów na określone dane wyjściowe.

DestinationSource

Typ danych do wyeksportowania.

Name Type Description
deviceConnectivity
  • string

Źródło docelowe z łączności urządzenia

deviceLifecycle
  • string

Źródło docelowe z cyklu życia urządzenia

deviceTemplateLifecycle
  • string

Źródło docelowe z cyklu życia szablonu urządzenia

properties
  • string

Źródło docelowe z właściwości urządzenia

telemetry
  • string

Źródło docelowe z telemetrii urządzenia

Enrichment

Definicja wzbogacania dla eksportu danych.

Name Type Description
path
  • string

Ścieżka do możliwości docelowej w szablonie urządzenia lub właściwości systemowej do użycia.

target
  • string

Szablon lub interfejs urządzenia, który definiuje możliwości docelowe dla wzbogacania.

value

Nieprzetworzona wartość używana do wzbogacania.

Error

Definicja błędu odpowiedzi.

Name Type Description
error

Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Szczegółowe informacje o błędzie.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Szczegóły komunikatu o błędzie.

requestId
  • string

Identyfikator korelacji dla bieżącego żądania.

time
  • string

Czas niepowodzenia żądania błędu.

Export

Definicja eksportu danych.

Name Type Description
destinations

Lista miejsc docelowych, do których eksport powinien wysyłać dane.

displayName
  • string

Nazwa wyświetlana eksportu.

enabled
  • boolean

Przełącz się, aby uruchomić/zatrzymać eksportowanie z wysyłania danych.

enrichments

Dodatkowe informacje do uwzględnienia w każdej wysłanej wiadomości. Dane są reprezentowane jako zestaw par klucz/wartość, gdzie klucz jest nazwą wzbogacania, która będzie wyświetlana w komunikacie wyjściowym, a wartość identyfikuje dane do wysłania.

errors

Błędy napotkane przez eksport lub miejsce docelowe.

filter
  • string

Zapytanie definiujące, które zdarzenia ze źródła powinny być eksportowane.

id
  • string

Unikatowy identyfikator eksportu.

lastExportTime
  • string

Sygnatura czasowa ostatniej wiadomości, która została wysłana do eksportu lub miejsca docelowego.

source

Typ danych do wyeksportowania.

status
  • string

Wskazanie bieżącej kondycji i operacji eksportu lub miejsca docelowego.