Exports - Get

ID でエクスポートを取得します。

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

URI パラメーター

Name In Required Type Description
baseDomain
path True
  • string

すべての Azure IoT Central サービス要求の基本ドメイン。

exportId
path True
  • string

エクスポートの一意の ID。

subdomain
path True
  • string

アプリケーションサブドメイン。

api-version
query True
  • string

呼び出される API のバージョン。

応答

Name Type Description
200 OK

成功

Other Status Codes

IoT Central サービスから受信したエラー応答。

Headers

  • x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

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

定義

DataExportError

データ エクスポート エラーの定義。

DestinationReference

変換先の参照定義。

DestinationSource

エクスポートするデータの種類。

Enrichment

データエクスポートのエンリッチメント定義。

Error

応答エラーの定義。

ErrorDetails

エラーの詳細情報。

Export

データ エクスポート定義。

DataExportError

データ エクスポート エラーの定義。

Name Type Description
code
  • string

発生したエラーのコード。

message
  • string

発生したエラーの説明。

DestinationReference

変換先の参照定義。

Name Type Description
id
  • string

データを送信する宛先の ID。

transform
  • string

メッセージ構造を特定の出力に変換するためのクエリ。

DestinationSource

エクスポートするデータの種類。

Name Type Description
deviceConnectivity
  • string

デバイス接続からの宛先ソース

deviceLifecycle
  • string

デバイスのライフサイクルからの移行先ソース

deviceTemplateLifecycle
  • string

デバイス テンプレートのライフサイクルからの移行先ソース

properties
  • string

デバイスのプロパティからの移行先ソース

telemetry
  • string

デバイス テレメトリからの移行先ソース

Enrichment

データエクスポートのエンリッチメント定義。

Name Type Description
path
  • string

使用するデバイス テンプレートまたはシステム プロパティ内のターゲット機能へのパス。

target
  • string

エンリッチメントのターゲット機能を定義するデバイス テンプレートまたはインターフェイス。

value

エンリッチメントに使用される生の値。

Error

応答エラーの定義。

Name Type Description
error

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージの詳細。

requestId
  • string

現在の要求の関連付け ID。

time
  • string

エラー要求が失敗した時刻。

Export

データ エクスポート定義。

Name Type Description
destinations

エクスポートでデータを送信する宛先の一覧。

displayName
  • string

エクスポートの表示名。

enabled
  • boolean

エクスポートのデータ送信を開始/停止するように切り替えます。

enrichments

送信された各メッセージに含める追加の情報。 データはキーと値のペアのセットとして表されます。ここで、キーは出力メッセージに表示されるエンリッチメントの名前であり、値は送信するデータを識別します。

errors

エクスポートまたはエクスポート先で発生したエラー。

filter
  • string

エクスポートするソースからのイベントを定義するクエリ。

id
  • string

エクスポートの一意の ID。

lastExportTime
  • string

エクスポートまたは宛先に送信された最後のメッセージのタイムスタンプ。

source

エクスポートするデータの種類。

status
  • string

エクスポートまたは宛先の現在の正常性と操作を示します。