Compartilhar via


Controle de versão e suporte

Este artigo fornece uma visão geral das políticas de controle de versão e de alteração interruptiva para as várias ferramentas de programação.

Informações sobre suporte e substituição

À medida que uma nova versão da API REST é lançada, as versões anteriores são desativadas. A Microsoft declara uma versão preterida pelo menos 12 meses antes de desativar um ponto de extremidade de API. Quando uma versão é preterida, ela tem suporte as-is. Se você enfrentar um problema com essa versão, solicitaremos que você mude para a versão atualmente estável. Quando uma versão é desativada, ela não tem suporte e em breve será desligada.

Ao incrementar o número da versão da API (por exemplo, de 2021-10-01 para 2022-04-01), Microsoft anuncia que a versão anterior disponível para o público em geral (neste exemplo, 2021-10-01) será imediatamente descontinuada e será descontinuada 12 meses após o anúncio. O mesmo tratamento é dado às versões preliminares públicas. Microsoft pode abrir exceções a esta política por questões de saúde e segurança do serviço.

As várias ferramentas e SDKs gerados com base na API do Power Platform, como a CLI do Power Platform, o conector do Admin V2 e o PowerShell, são atualizados para versões de API mais recentes por ação e são transparentes para os usuários finais.

Alterações interruptivas e compatíveis

A Microsoft fornece detalhes das alterações de programação nos planos de lançamento. Se as alterações não forem incompletos por natureza, a versão da API permanecerá a mesma e a versão do PowerShell receberá um incremento de versão secundária. Se as alterações estiverem falhando por natureza, a Microsoft incrementará a versão da API e a versão principal do PowerShell.

Aqui estão alguns exemplos de alterações da falha:

  • A URL ou solicitação/resposta fundamental é alterada.
  • Uma propriedade declarada é removida ou renomeada, ou seu tipo é alterado.
  • A API ou os parâmetros da API são removidos ou renomeados.
  • Um parâmetro de solicitação obrigatório é adicionado.

Aqui estão exemplos de alterações sem quebra:

  • As propriedades adicionadas são anuláveis ou têm um valor padrão.
  • Um membro é adicionado a uma enumeração.
  • A paginação é introduzida em coleções existentes.
  • Os códigos de erro são alterados.
  • A ordem das propriedades em solicitações ou respostas é alterada.

Versões disponíveis

Versão Tipo Referência Data de substituição Data de desativação
2024-10-01 Stable Referência N/D N/D
2022-03-01 – versão preliminar Versão preliminar pública 2022-03-01-prévia Ref 2025-03-01 2026-03-01
2020-10-01 Disponível para o público geral 2020-10-01 Referência N/D N/D

Nota

A versão 2020-10-01 disponível para o público geral da API do Power Platform é específica para gerenciamento de ambiente e também é comumente chamada de API da Plataforma de Aplicativos de Negócios (BAP). A funcionalidade desse conjunto de pontos de extremidade é disponibilizada nas versões mais recentes da API do Power Platform, juntamente com muitos recursos adicionais após a versão 2022-03-01-preview.

Próximas etapas

Agora que você entende a estratégia de controle de versão e suporte, vamos ver como se autenticar com a API do Microsoft Power Platform.