Versões da API das APIs REST do Plano de Dados do Azure IoT Central

Artigo
05/07/2024

Este artigo lista as versões atuais e anteriores das APIs REST para o Azure IoT Central.

Versões estáveis

Estas versões são as versões estáveis que podem ser utilizadas para desenvolver soluções de produção com o Azure IoT Central.

Versão da API	Especificação	Atualizações da API
`2022-07-31` (Mais recente)	Especificação do Swagger	Nota de versão
`2022-05-31` (Preterido)	Especificação do Swagger	Nota de versão
`1.0` (Preterido)	Especificação do Swagger	Nota de versão

Versões de pré-visualização

As versões de pré-visualização são lançadas para testar novas funcionalidades, recolher feedback e detetar e corrigir problemas. As APIs de pré-visualização estão disponíveis em Termos de Utilização Suplementares e não são recomendadas para cargas de trabalho de produção.

Versão da API	Especificação	Atualizações da API
`2022-10-31-preview` (Mais recente)	Especificação do Swagger	Nota de versão
`2022-06-30-preview` (Preterido)	Especificação do Swagger	Nota de versão
`1.2-Preview` (Preterido)	Especificação do Swagger	Nota de versão
`1.1-Preview` (Preterido)	Especificação do Swagger	Nota de versão

Notas de versão

`2022-10-31-preview`

A versão de pré-visualização da API do Plano de Dados REST do Azure IoT Central a 31 de outubro de 2022 fornece uma série de melhorias aos pontos finais existentes e adiciona vários novos pontos finais para ativar as seguintes capacidades principais.

A funcionalidade de consulta de propriedades da API de Consulta atual já não é suportada e limitou a taxa a um pedido por minuto.

Nota

Esta funcionalidade será removida até 30 de junho de 2023.
Suporte para criar e gerir o ciclo de vida dos "Manifestos de Implementação do Microsoft Edge".

Nota

Estes manifestos foram agora dissociados dos modelos de dispositivo e podem ser geridos de forma independente.
Remoção de "deploymentManifest" da definição "DeviceTemplate". De acordo com a alteração acima, os manifestos de implementação são agora independentes.

Nota

Esta atualização é um comportamento de alteração interruptivo da versão anterior de 2022-06-30-preview.
O suporte para um novo tipo "iotEdge" foi adicionado à entidade "Dispositivo" como um "tipo: cadeia[]". Este campo permite ao utilizador identificar um dispositivo como um dispositivo IoT Edge ativado. Este campo é um tipo opcional e pode continuar a criar e gerir instâncias de dispositivos sem o mesmo.
```
{

    "type": ["iotEdge"]

}
```
Suporte para uma nova applyDeploymentManifest rota para Device. Esta operação permite-lhe associar um Manifesto de Implementação IoT Edge a uma instância de dispositivo.
Suporte para o novo campo readAccess opcional para a FileUpload configuração.
Suporte para idScope dentro da EnrollmentGroup entidade para acesso conveniente.
Suporte atualizado para paginação com novos parâmetros, incluindo maxpagesize, , filterorderby. E os parâmetros anteriormente suportados, incluindo $filter, $top, $orderby foram agora descontinuados.
Suporte para o novo deviceManifestMigration tipo de tarefa. Este novo tipo de tarefa permite-lhe gerir a sua frota de dispositivos Edge e configurar um deploymentManifest para os mesmos.

`2022-07-31`

A nossa versão mais recente da GA a 31 de julho de 2022 melhora a versão anteriormente existente 2022-05-31 e é totalmente compatível com retrocompatibilidade. A partir de hoje, o 2022-05-31 lançamento está marcado para deprecation e vamos procurar terminar o suporte para o mesmo até julho de 2025. Eis um conjunto de atualizações capturadas nesta versão:

Tarefas com suporte de estado de progresso
Suporte para Tarefas Agendadas
Suporte de Grupos de Inscrição de Dispositivos
Suporte para Relações de Dispositivos
Suporte para Dispositivos de Lista de Grupos de Dispositivos

`2022-06-30-preview`

A versão de pré-visualização da API do Plano de Dados REST do Azure IoT Central a 30 de junho de 2022 fornece uma série de melhorias aos pontos finais existentes e adiciona suporte para as seguintes capacidades principais:

Suporte para criar e gerir Enrollment Groups a integração de dispositivos
Capacidade de criar e configurar Scheduled Jobs
Suporte para criação Application Dashboard programática através da API REST
Suporte para propriedades e comandos não modernos para Device
Capacidade de listar dispositivos num Device Group
Resumo do progresso do suporte da tarefa
Campo de nome removido de Device Relationship

`2022-05-31`

A nossa versão mais recente da GA a 31 de maio de 2022 melhora a versão anteriormente existente 1.0 e é totalmente compatível com retrocompatibilidade. A partir de hoje, a 1.0 versão está agora marcada para deprecation e vamos procurar terminar o suporte para o mesmo até maio de 2025. Eis um conjunto de atualizações capturadas nesta versão:

Suporte de Configuração do Armazenamento de Carregamento de Ficheiros
Suporte CRUD do Grupo de Dispositivos
Suporte CRUD da Organização
Suporte da Organização em Dispositivos, Funções, Utilizadores e Tokens de API

`1.2-Preview (Deprecated)`

A 1.2-preview versão melhora continuamente os nossos pontos finais de API a partir de versões de pré-visualização anteriores e adiciona suporte para as seguintes funcionalidades:

Suporte CRUD do Grupo de Dispositivos
Novo tipo de tarefa para suportar a migração de modelos de dispositivos

`1.0`

Primeira versão da API REST ga para o Azure IoT Central que captura suporte para os seguintes pontos finais: Dispositivos, Lista de Funções, Utilizadores, Modelos de Dispositivos e Tokens de API. Pode saber mais sobre cada um dos pontos finais aqui.

Utilizadores sem suporte da organização.
Lista de funções sem suporte da organização.
CRUD de dispositivos, propriedades, comandos, credenciais, suporte de atestado.
Tokens de API sem suporte da organização.
Modelo de Dispositivo sem suporte patch.

`1.1-Preview (Deprecated)`

Esta versão permite o suporte para DTDL v2 na superfície da API REST para o Azure IoT Central. Inclui alterações interruptivas da versão legada preview (agora preterida).

DTDLv2 alinhamento, leia mais detalhes.
Suporte para Relações com Dispositivos.
Suporte de configuração fileUpload.
Suporte da organização.
Suporte de Consulta de Telemetria do Dispositivo.
Suporte de tarefas.
Foi removido o Suporte de Exportação Contínua de Dados Legados.
Adicionar suporte de Exportação de Dados V2 Exportação/Destino.
Api/devices/{deviceId}/cloudProperties removidos com api/devices/{deviceId}/properties.
As propriedades e telemetrias do dispositivo na interface herdada não serão tratadas como propriedade raiz e telemetria raiz.
Suporte para a aplicação de patches do Modelo de Dispositivo.
Suporte de manifesto do Edge a partir do modelo de dispositivo.

`Preview (Deprecated & Removed)`

A primeira versão da API pública do Azure IoT Central, com suporte apenas para DTDL v1 , foi preterida e removida dos nossos pontos finais da API REST.

Partilhar via