Compartir a través de

Versiones de API de las API de REST del plano de datos de Azure IoT Central

  • Artículo

En este artículo se enumeran las versiones actuales y anteriores de las API REST para Azure IoT Central.

Versiones estables

Estas versiones son las versiones estables que se pueden usar para desarrollar soluciones de producción con Azure IoT Central.

Versión de API Especificación Actualizaciones de la API
2022-07-31 (Más reciente) Especificación de Swagger Nota de la versión
2022-05-31 (en desuso) Especificación de Swagger Nota de la versión
1.0 (en desuso) Especificación de Swagger Nota de la versión

Versiones preliminares

Las versiones preliminares se publican para probar nuevas funcionalidades, recopilar comentarios y detectar y corregir problemas. Las API en versión preliminar están disponibles en Términos de uso complementarios y no se recomiendan para cargas de trabajo de producción.

Versión de API Especificación Actualizaciones de la API
2022-10-31-preview (Más reciente) Especificación de Swagger Nota de la versión
2022-06-30-preview (en desuso) Especificación de Swagger Nota de la versión
1.2-Preview (en desuso) Especificación de Swagger Nota de la versión
1.1-Preview (en desuso) Especificación de Swagger Nota de la versión

Notas de la versión

2022-10-31-preview

La versión preliminar de la API de plano de datos REST de Azure IoT Central el 31 de octubre de 2022 ofrece una serie de mejoras en los puntos de conexión existentes y agrega varios puntos de conexión nuevos para habilitar las siguientes funcionalidades clave.

  • La característica de consulta de propiedades de la API de consulta actual ya no se admite y ha limitado la velocidad a una solicitud por minuto.

    Nota:

    Esta característica se quitará el 30 de junio de 2023.

  • Compatibilidad con la creación y administración del ciclo de vida de "Manifiestos de implementación de Microsoft Edge".

    Nota:

    Estos manifiestos ahora se han desacoplado de las plantillas de dispositivo y se pueden administrar de forma independiente.

  • Eliminación de "deploymentManifest" de la definición "DeviceTemplate". Según el cambio anterior, los manifiestos de implementación ahora son independientes.

    Nota:

    Esta actualización es un comportamiento de cambio importante de la versión anterior de 2022-06-30-preview.

  • Se ha agregado compatibilidad con un nuevo tipo "iotEdge" a la entidad "Device" como "type: string[]". Este campo permite al usuario identificar un dispositivo como un dispositivo habilitado IoT Edge. Este campo es un tipo opcional y puede seguir creando y administrando instancias de dispositivo sin él.

    
{

    "type": ["iotEdge"]

}

  • Compatibilidad con una nueva applyDeploymentManifest ruta a Device. Esta operación permite asociar un manifiesto de implementación de IoT Edge a una instancia de dispositivo.

  • Compatibilidad con el nuevo campo readAccess opcional a FileUpload la configuración.

  • Compatibilidad con idScope dentro de la EnrollmentGroup entidad para un acceso cómodo.

  • Se ha actualizado la compatibilidad con la paginación con nuevos parámetros, como maxpagesize, filter, orderby. Y los parámetros admitidos anteriormente, incluidos $filter, $top$orderby ya se han retirado.

  • Compatibilidad con el nuevo deviceManifestMigration tipo de trabajo. Este nuevo tipo de trabajo le permite administrar la flota de dispositivos Edge y configurar un deploymentManifest para ellos.

2022-07-31

Nuestra versión de disponibilidad general más reciente el 31 de julio de 2022 mejora la versión existente 2022-05-31 anteriormente y es totalmente compatible con versiones anteriores. A partir de hoy, la 2022-05-31 versión ahora está marcada para deprecation y buscaremos finalizar la compatibilidad con ella en julio de 2025. Este es un conjunto de actualizaciones capturadas en esta versión:

  • Trabajos con compatibilidad con el estado de progreso
  • Compatibilidad con trabajos programados
  • Compatibilidad con grupos de inscripción de dispositivos
  • Compatibilidad con relaciones de dispositivo
  • Compatibilidad con dispositivos de lista de grupos de dispositivos

2022-06-30-preview

La versión preliminar de la API de plano de datos REST de Azure IoT Central el 30 de junio de 2022 ofrece una serie de mejoras en los puntos de conexión existentes y agrega compatibilidad con las siguientes funcionalidades clave:

  • Compatibilidad con la creación y administración Enrollment Groups de la incorporación de dispositivos
  • Capacidad de crear y configurar Scheduled Jobs
  • Compatibilidad con la creación Application Dashboard mediante programación a través de la API REST
  • Compatibilidad con propiedades y comandos no modelados para Device
  • Capacidad de enumerar dispositivos dentro de un Device Group
  • Resumen del progreso de soporte técnico del trabajo
  • Se ha quitado el campo de nombre de Device Relationship

2022-05-31

Nuestra versión de disponibilidad general más reciente el 31 de mayo de 2022 mejora la versión existente 1.0 anteriormente y es totalmente compatible con versiones anteriores. A partir de hoy, la 1.0 versión ahora está marcada para deprecation y buscaremos finalizar la compatibilidad con ella en mayo de 2025. Este es un conjunto de actualizaciones capturadas en esta versión:

  • Compatibilidad con la configuración de almacenamiento de carga de archivos
  • Compatibilidad con CRUD del grupo de dispositivos
  • Compatibilidad con CRUD de la organización
  • Compatibilidad con la organización en dispositivos, roles, usuarios y tokens de API

1.2-Preview (Deprecated)

La 1.2-preview versión mejora continuamente los puntos de conexión de API de las versiones preliminares anteriores y agrega compatibilidad con las siguientes características:

  • Compatibilidad con CRUD de grupo de dispositivos
  • Nuevo tipo de trabajo para admitir la migración de plantillas de dispositivo

1.0

Primera versión de la API REST de disponibilidad general para Azure IoT Central que captura la compatibilidad con los siguientes puntos de conexión: Dispositivos, lista de roles, usuarios, plantillas de dispositivo y tokens de API. Puede obtener más información sobre cada uno de los puntos de conexión aquí.

  • Usuarios sin soporte técnico de la organización.
  • Lista de roles sin soporte técnico de la organización.
  • Dispositivos CRUD, propiedades, comandos, credenciales, compatibilidad con atestación.
  • Tokens de API sin soporte técnico de la organización.
  • Plantilla de dispositivo sin compatibilidad con PATCH.

1.1-Preview (Deprecated)

Esta versión habilita la compatibilidad con DTDL v2 dentro de la superficie de la API REST para Azure IoT Central. Incluye cambios importantes de la versión heredada preview (ahora en desuso).

  • DTDLv2 alignment, lea más detalles.
  • Compatibilidad con relación de dispositivo.
  • Compatibilidad con la configuración de FileUpload.
  • Soporte técnico de la organización.
  • Compatibilidad con consultas de telemetría de dispositivos.
  • Compatibilidad con trabajos.
  • Se ha quitado la compatibilidad heredada con la exportación de datos continua.
  • Agregue compatibilidad con exportación de datos V2/Destino.
  • Se ha quitado api/devices/{deviceId}/cloudProperties, mediante api/devices/{deviceId}/properties.
  • Las propiedades del dispositivo y los datos de telemetría en la interfaz heredada no se tratarán como propiedad raíz ni telemetría raíz.
  • Compatibilidad con la aplicación de revisiones de plantillas de dispositivo.
  • Compatibilidad con manifiestos perimetrales desde la plantilla de dispositivo.

Preview (Deprecated & Removed)

La primera versión de la API pública de Azure IoT Central, con compatibilidad DTDL v1 solo, ya ha quedado en desuso y se ha quitado de nuestros puntos de conexión de la API REST.

Consulte también