Exports - Get

Ottenere un'esportazione in base all'ID.

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

Parametri dell'URI

Name In Required Type Description
baseDomain
path True
  • string

Dominio di base per tutte le richieste di servizio di Azure IoT Central.

exportId
path True
  • string

ID univoco per l'esportazione.

subdomain
path True
  • string

Sottodominio dell'applicazione.

api-version
query True
  • string

Versione dell'API chiamata.

Risposte

Name Type Description
200 OK

Operazione riuscita

Other Status Codes

Risposta di errore ricevuta dal servizio IoT Central.

Headers

  • x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

DataExportError

Definizione dell'errore di esportazione dei dati.

DestinationReference

Definizione di riferimento di destinazione.

DestinationSource

Tipo di dati da esportare.

Enrichment

Definizione di arricchimento per l'esportazione dei dati.

Error

Definizione dell'errore di risposta.

ErrorDetails

Informazioni dettagliate sull'errore.

Export

Definizione di esportazione dei dati.

DataExportError

Definizione dell'errore di esportazione dei dati.

Name Type Description
code
  • string

Codice per l'errore che si è verificato.

message
  • string

Descrizione dell'errore che si è verificato.

DestinationReference

Definizione di riferimento di destinazione.

Name Type Description
id
  • string

ID della destinazione in cui devono essere inviati i dati.

transform
  • string

Eseguire una query per trasformare la struttura dei messaggi in un output specifico.

DestinationSource

Tipo di dati da esportare.

Name Type Description
deviceConnectivity
  • string

Origine di destinazione dalla connettività del dispositivo

deviceLifecycle
  • string

Origine di destinazione dal ciclo di vita del dispositivo

deviceTemplateLifecycle
  • string

Origine di destinazione dal ciclo di vita del modello di dispositivo

properties
  • string

Origine di destinazione dalle proprietà del dispositivo

telemetry
  • string

Origine di destinazione dai dati di telemetria del dispositivo

Enrichment

Definizione di arricchimento per l'esportazione dei dati.

Name Type Description
path
  • string

Percorso della funzionalità di destinazione all'interno del modello di dispositivo o della proprietà di sistema da usare.

target
  • string

Modello di dispositivo o interfaccia che definisce la funzionalità di destinazione per l'arricchimento.

value

Valore non elaborato utilizzato per l'arricchimento.

Error

Definizione dell'errore di risposta.

Name Type Description
error

Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Informazioni dettagliate sull'errore.

Name Type Description
code
  • string

Codice di errore.

message
  • string

Dettagli del messaggio di errore.

requestId
  • string

ID correlazione per la richiesta corrente.

time
  • string

Ora in cui la richiesta di errore non è riuscita.

Export

Definizione di esportazione dei dati.

Name Type Description
destinations

Elenco di destinazioni in cui l'esportazione deve inviare dati.

displayName
  • string

Nome visualizzato dell'esportazione.

enabled
  • boolean

Attivare/arrestare l'avvio/arresto di un'esportazione dall'invio di dati.

enrichments

Informazioni aggiuntive da includere con ogni messaggio inviato. I dati vengono rappresentati come un set di coppie chiave/valore, in cui la chiave è il nome dell'arricchimento che verrà visualizzato nel messaggio di output e il valore identifica i dati da inviare.

errors

Errori rilevati dall'esportazione o dalla destinazione.

filter
  • string

Query che definisce gli eventi dell'origine da esportare.

id
  • string

ID univoco dell'esportazione.

lastExportTime
  • string

Timestamp dell'ultimo messaggio inviato all'esportazione o alla destinazione.

source

Tipo di dati da esportare.

status
  • string

Indicazione dell'integrità e del funzionamento correnti dell'esportazione o della destinazione.