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

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

Versões estáveis

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

Versões prévias

Versões prévias são lançadas para testar novas funcionalidades, coletar comentários e descobrir e corrigir problemas. As APIs de visualização estão disponíveis em Termos de Uso Complementares e não são recomendadas para cargas de trabalho de produção.

Notas de versão

2022-10-31-preview

A versão prévia da API do Plano de Dados REST do Azure IoT Central em 31 de outubro de 2022 oferece uma série de melhorias aos pontos de extremidade existentes e adiciona vários novos pontos de extremidade para habilitar os recursos principais a seguir.

• O recurso de consulta de propriedade da API de Consulta atual não tem mais suporte e limitou a taxa a uma solicitação por minuto.

  Observação

  Esse recurso será removido até 30 de junho de 2023.

• Suporte para criar e gerenciar o ciclo de vida para 'Manifestos de Implantação do Microsoft Edge'.

  Observação

  Esses manifestos agora foram separados dos modelos de dispositivo e podem ser gerenciados de forma independente.

• Remoção de 'deploymentManifest' da definição 'DeviceTemplate'. De acordo com a alteração acima, os manifestos de implantação agora são independentes.

  Observação

  Essa atualização é um comportamento de alteração interruptiva da versão anterior de 2022-06-30-preview.

• O suporte para um novo tipo 'iotEdge' foi adicionado à entidade 'Device' como um 'type: string[]'. Esse campo permite que o usuário identifique um dispositivo como um dispositivo IoT Edge habilitado. Esse campo é um tipo opcional e você pode continuar criando e gerenciando instâncias de dispositivo sem ele.

  
  {
  
      "type": ["iotEdge"]
  
  }
  
  

• Suporte para uma nova applyDeploymentManifest rota para Device. Essa operação permite associar um manifesto de implantação IoT Edge a uma instância do dispositivo.

• Suporte para o novo campo readAccess opcional para configuração FileUpload .

• Suporte para idScope dentro da EnrollmentGroup entidade para acesso conveniente.

• Suporte atualizado para paginação com novos parâmetros, incluindo maxpagesize, filter, orderby. E os parâmetros com suporte anterior, incluindo $filter, $top, $orderby foram desativados.

• Suporte para novo deviceManifestMigration tipo de trabalho. Esse novo tipo de trabalho permite que você gerencie sua frota de dispositivos edge e configure um deploymentManifest para eles.

2022-07-31

Nossa última versão ga em 31 de julho de 2022 melhora a versão existente 2022-05-31 anteriormente e é totalmente compatível com versões anteriores. A partir de hoje, a 2022-05-31 versão agora está marcada para deprecation e procuraremos encerrar o suporte até julho de 2025. Aqui estão o conjunto de atualizações capturadas nesta versão:

• Trabalhos com suporte ao status de progresso
• Suporte a trabalhos agendados
• Suporte a Grupos de Registro de Dispositivos
• Suporte a Relações de Dispositivo
• Suporte a dispositivos de lista de grupos de dispositivos

2022-06-30-preview

A versão prévia da API do Plano de Dados REST do Azure IoT Central em 30 de junho de 2022 oferece uma série de melhorias aos pontos de extremidade existentes e adiciona suporte para os seguintes recursos principais:

• Suporte para criação e gerenciamento Enrollment Groups para integração de dispositivos
• Capacidade de criar e configurar Scheduled Jobs
• Suporte para criação Application Dashboard programática por meio da API REST
• Suporte para propriedades e comandos sem modelo para Device
• Capacidade de listar dispositivos em um Device Group
• Resumo do progresso do suporte do trabalho
• Campo de nome removido de Device Relationship

2022-05-31

Nossa última versão ga em 31 de maio de 2022 melhora a versão existente 1.0 anteriormente e é totalmente compatível com versões anteriores. A partir de hoje, a 1.0 versão está marcada para deprecation e procuraremos encerrar o suporte para ela até maio de 2025. Aqui estão o conjunto de atualizações capturadas nesta versão:

• Suporte à configuração de armazenamento de upload de arquivo
• Suporte crud do grupo de dispositivos
• Suporte crud da organização
• Suporte da organização em dispositivos, funções, usuários e tokens de API

1.2-Preview (Deprecated)

A 1.2-preview versão melhora continuamente nossos pontos de extremidade de API de versões prévias anteriores e adiciona suporte para os seguintes recursos:

• Suporte ao CRUD do Grupo de Dispositivos
• Novo tipo de trabalho para dar suporte à migração de modelo de dispositivo

1.0

Primeira versão da API REST ga para o Azure IoT Central que captura o suporte para os seguintes pontos de extremidade: Dispositivos, Lista de Funções, Usuários, Modelos de Dispositivo e Tokens de API. Você pode saber mais sobre cada um dos pontos de extremidade aqui.

• Usuários sem suporte da organização.
• Lista de funções sem suporte da organização.
• Dispositivos CRUD, propriedades, comandos, credenciais, suporte ao atestado.
• Tokens de API sem suporte da organização.
• Modelo de dispositivo sem suporte a PATCH.

1.1-Preview (Deprecated)

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

• DTDLv2 alinhamento, leia mais detalhes.
• Suporte à Relação de Dispositivo.
• Suporte à configuração fileUpload.
• Suporte da organização.
• Suporte à Consulta de Telemetria do Dispositivo.
• Suporte a trabalhos.
• Foi removido o suporte à exportação de dados contínua herdada.
• Adicionar suporte à Exportação de Dados V2 Exportação/Destino.
• Removido api/devices/{deviceId}/cloudProperties, usando api/devices/{deviceId}/properties.
• As propriedades e telemetrias do dispositivo sob a interface herdada não serão tratadas como propriedade raiz e telemetria raiz.
• Suporte à aplicação de patch de modelo de dispositivo.
• Suporte de manifesto de borda 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 de nossos pontos de extremidade da API REST.

Confira também

• Códigos de erro comuns
• Autenticação
• Limitação