Exports - Get

Obtener una exportación por identificador.

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

Parámetros de identificador URI

Name In Required Type Description
baseDomain
path True
  • string

Dominio base para todas las solicitudes de servicio de Azure IoT Central.

exportId
path True
  • string

Identificador único de la exportación.

subdomain
path True
  • string

Subdominio de aplicación.

api-version
query True
  • string

Versión de la API a la que se llama.

Respuestas

Name Type Description
200 OK

Correcto

Other Status Codes

Respuesta de error recibida del servicio IoT Central.

Headers

  • x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Definiciones

DataExportError

Definición de error de exportación de datos.

DestinationReference

Definición de referencia de destino.

DestinationSource

Tipo de datos que se van a exportar.

Enrichment

Definición de enriquecimiento para la exportación de datos.

Error

Definición de error de respuesta.

ErrorDetails

Información detallada del error.

Export

Definición de exportación de datos.

DataExportError

Definición de error de exportación de datos.

Name Type Description
code
  • string

Código del error que se produjo.

message
  • string

Descripción del error que se produjo.

DestinationReference

Definición de referencia de destino.

Name Type Description
id
  • string

Identificador del destino donde se deben enviar los datos.

transform
  • string

Consulta para transformar la estructura de mensajes en una salida determinada.

DestinationSource

Tipo de datos que se van a exportar.

Name Type Description
deviceConnectivity
  • string

Origen de destino de la conectividad del dispositivo

deviceLifecycle
  • string

Origen de destino del ciclo de vida del dispositivo

deviceTemplateLifecycle
  • string

Origen de destino del ciclo de vida de la plantilla de dispositivo

properties
  • string

Origen de destino de las propiedades del dispositivo

telemetry
  • string

Origen de destino de la telemetría del dispositivo

Enrichment

Definición de enriquecimiento para la exportación de datos.

Name Type Description
path
  • string

Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo o la propiedad del sistema que se va a usar.

target
  • string

Plantilla de dispositivo o interfaz que define la funcionalidad de destino para el enriquecimiento.

value

Valor sin procesar usado para el enriquecimiento.

Error

Definición de error de respuesta.

Name Type Description
error

Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Name Type Description
code
  • string

Código de error.

message
  • string

Detalles del mensaje de error.

requestId
  • string

Id. de correlación para la solicitud actual.

time
  • string

Hora en que se produjo un error en la solicitud de error.

Export

Definición de exportación de datos.

Name Type Description
destinations

Lista de destinos a los que la exportación debe enviar datos.

displayName
  • string

Nombre para mostrar de la exportación.

enabled
  • boolean

Alternar para iniciar o detener una exportación desde el envío de datos.

enrichments

Elementos adicionales de información que se van a incluir con cada mensaje enviado. Los datos se representan como un conjunto de pares clave/valor, donde la clave es el nombre del enriquecimiento que aparecerá en el mensaje de salida y el valor identifica los datos que se van a enviar.

errors

Errores detectados por la exportación o el destino.

filter
  • string

Consulta que define qué eventos del origen se deben exportar.

id
  • string

Identificador único de la exportación.

lastExportTime
  • string

Marca de tiempo del último mensaje que se envió al destino o exportación.

source

Tipo de datos que se van a exportar.

status
  • string

Indicación del estado y el funcionamiento actuales de la exportación o el destino.