Condividi tramite

Versioni API delle API delle API REST del piano dati di Azure IoT Central

  • Articolo

Questo articolo elenca le versioni correnti e precedenti delle API REST per Azure IoT Central.

Versioni stabili

Queste versioni sono le versioni stabili che possono essere usate per sviluppare soluzioni di produzione con Azure IoT Central.

Versione dell'API Specifiche Aggiornamenti delle API
2022-07-31 (Più recente) Specifica Swagger Note sulla versione
2022-05-31 (Deprecato) Specifica Swagger Note sulla versione
1.0 (Deprecato) Specifica Swagger Note sulla versione

Versioni di anteprima

Le versioni di anteprima vengono rilasciate per testare nuove funzionalità, raccogliere commenti e suggerimenti e individuare e risolvere i problemi. Le API di anteprima sono disponibili in Condizioni aggiuntive per l'uso e non sono consigliate per i carichi di lavoro di produzione.

Versione dell'API Specifiche Aggiornamenti delle API
2022-10-31-preview (Più recente) Specifica Swagger Note sulla versione
2022-06-30-preview (Deprecato) Specifica Swagger Note sulla versione
1.2-Preview (Deprecato) Specifica Swagger Note sulla versione
1.1-Preview (Deprecato) Specifica Swagger Note sulla versione

Note sulla versione

2022-10-31-preview

La versione di anteprima dell'API del piano dati REST di Azure IoT Central il 31 ottobre 2022 offre una serie di miglioramenti agli endpoint esistenti e aggiunge diversi nuovi endpoint per abilitare le funzionalità chiave seguenti.

  • La funzionalità di query delle proprietà dell'API query corrente non è più supportata e ha limitato la frequenza a una richiesta al minuto.

    Nota

    Questa funzionalità verrà rimossa dal 30 giugno 2023.

  • Supporto per la creazione e la gestione del ciclo di vita per i manifesti di distribuzione di Microsoft Edge.

    Nota

    Questi manifesti sono stati ora separati dai modelli di dispositivo e possono essere gestiti in modo indipendente.

  • Rimozione di "deploymentManifest" dalla definizione "DeviceTemplate". Per la modifica precedente, i manifesti di distribuzione sono ora indipendenti.

    Nota

    Questo aggiornamento è un comportamento di modifica di rilievo rispetto alla versione precedente 2022-06-30-preview.

  • Il supporto per un nuovo tipo 'iotEdge' è stato aggiunto all'entità 'Device' come 'type: string[]'. Questo campo consente all'utente di identificare un dispositivo come dispositivo abilitato IoT Edge. Questo campo è un tipo facoltativo e puoi continuare a creare e gestire le istanze del dispositivo senza di esso.

    
{

    "type": ["iotEdge"]

}

  • Supporto per una nuova applyDeploymentManifest route a Device. Questa operazione consente di associare un manifesto di distribuzione IoT Edge a un'istanza del dispositivo.

  • Supporto per la configurazione di un nuovo campo readAccessFileUpload facoltativo.

  • Supporto per idScope l'interno dell'entità per l'accesso EnrollmentGroup pratico.

  • Supporto aggiornato per il paging con nuovi parametri, tra cui maxpagesize, filterorderby. E i parametri supportati in precedenza, inclusi $filter, $top$orderby sono stati ritirati.

  • Supporto per il nuovo deviceManifestMigration tipo di processo. Questo nuovo tipo di processo consente di gestire la flotta di dispositivi Edge e di configurare un oggetto deploymentManifest per essi.

2022-07-31

La versione generale più recente del 31 luglio 2022 migliora la versione precedentemente esistente 2022-05-31 ed è completamente compatibile con le versioni precedenti. A partire da oggi, la 2022-05-31 versione è ora contrassegnata per deprecation e si cercherà di terminare il supporto per questo entro luglio 2025. Ecco un set di aggiornamenti acquisiti in questa versione:

  • Processi con supporto dello stato di avanzamento
  • Supporto dei processi pianificati
  • Supporto dei gruppi di registrazione dei dispositivi
  • Supporto delle relazioni dei dispositivi
  • Supporto dei dispositivi Elenco gruppi di dispositivi

2022-06-30-preview

La versione di anteprima dell'API del piano dati REST di Azure IoT Central il 30 giugno 2022 offre una serie di miglioramenti agli endpoint esistenti e aggiunge il supporto per le funzionalità chiave seguenti:

  • Supporto per la creazione e la gestione Enrollment Groups per l'onboarding dei dispositivi
  • Possibilità di creare e configurare Scheduled Jobs
  • Supporto per la creazione a livello di Application Dashboard codice tramite API REST
  • Supporto per le proprietà e i comandi non modellati per Device
  • Possibilità di elencare i dispositivi all'interno di un Device Group
  • Riepilogo dello stato di avanzamento del supporto dal processo
  • Campo nome rimosso da Device Relationship

2022-05-31

La versione ga più recente del 31 maggio 2022 migliora la versione esistente in 1.0 precedenza ed è completamente compatibile con le versioni precedenti. A partire da oggi, la 1.0 versione è ora contrassegnata per deprecation e si cercherà di terminare il supporto per questo entro maggio 2025. Ecco un set di aggiornamenti acquisiti in questa versione:

  • Supporto per la configurazione dell'archiviazione caricamento file
  • Supporto CRUD del gruppo di dispositivi
  • Supporto CRUD dell'organizzazione
  • Supporto dell'organizzazione su dispositivi, ruoli, utenti e token API

1.2-Preview (Deprecated)

La 1.2-preview versione migliora continuamente gli endpoint DELL'API dalle versioni di anteprima precedenti e aggiunge il supporto per le funzionalità seguenti:

  • Supporto crud del gruppo di dispositivi
  • Nuovo tipo di processo per supportare la migrazione del modello di dispositivo

1.0

Prima versione dell'API REST ga per Azure IoT Central che acquisisce il supporto per gli endpoint seguenti: dispositivi, elenco ruoli, utenti, modelli di dispositivo e token API. Per altre informazioni su ognuno degli endpoint, vedere qui.

  • Gli utenti senza supporto dell'organizzazione.
  • Elenco di ruoli senza supporto dell'organizzazione.
  • Dispositivi CRUD, proprietà, comandi, credenziali, supporto attestazione.
  • Token API senza supporto dell'organizzazione.
  • Modello di dispositivo senza supporto PATCH.

1.1-Preview (Deprecated)

Questa versione abilita il supporto per DTDL v2 all'interno dell'area API REST per Azure IoT Central. Include modifiche di rilievo dalla versione legacy preview (ora deprecata).

  • DTDLv2 allineamento, leggere altri dettagli.
  • Supporto della relazione del dispositivo.
  • Supporto della configurazione fileUpload.
  • Supporto dell'organizzazione.
  • Supporto di Query di telemetria del dispositivo.
  • Supporto dei processi.
  • Rimozione del supporto per l'esportazione continua dei dati legacy.
  • Aggiungere il supporto di Esportazione dati V2 Export/Destination.
  • Rimosso api/devices/{deviceId}/cloudProperties, usando api/devices/{deviceId}/properties.
  • Le proprietà e i telemetri del dispositivo nell'interfaccia ereditata non verranno considerati come proprietà radice e dati di telemetria radice.
  • Supporto dell'applicazione di patch ai modelli di dispositivo.
  • Supporto del manifesto edge dal modello di dispositivo.

Preview (Deprecated & Removed)

La prima versione dell'API pubblica di Azure IoT Central, con il supporto DTDL v1 solo, è stata deprecata e rimossa dagli endpoint dell'API REST.

Vedi anche