Controlo de versões e suporte

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

Informações de suporte e preterimento

À 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 é suportada as-is. Se você enfrentar um problema com essa versão, solicitamos que você mude para a versão atualmente estável. Quando uma versão é desativada, ela não é suportada 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 ao público (neste exemplo, 2021-10-01) foi imediatamente descontinuada e será desativada 12 meses após o anúncio. Microsoft pode abrir exceções a esta política para problemas de integridade e segurança do serviço.

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

Alterações compatíveis e interruptivas

A Microsoft fornece detalhes das alterações de programação nos planos de lançamento. Se as alterações forem ininterruptas 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 forem interrompidas por natureza, a Microsoft incrementará a versão da API e a versão principal do PowerShell.

Seguem-se alguns exemplos de alterações interruptivas:

  • É alterado o URL ou o pedido/resposta fundamental.
  • Uma propriedade declarada é removida ou é-lhe mudado o nome, ou o respetivo tipo é alterado.
  • A API ou os parâmetros da API são removidos ou os nomes são mudados.
  • É adicionado um parâmetro de pedido obrigatório.

Aqui estão exemplos de alterações ininterruptas:

  • São adicionadas propriedades que são anuláveis ou têm um valor predefinido.
  • É adicionado um membro a uma enumeração.
  • O paging é introduzido nas coleções existentes.
  • Os códigos de erro são alterados.
  • A ordem das propriedades nos pedidos ou nas respostas é alterada.

Available versions

Version Tipo Reference Deprecation date Decommission date
2024-10-01 Stable Reference N/A N/A
2020-10-01 Generally available 2020-10-01 Ref N/A N/A

Note

A versão geralmente disponível de 2020-10-01 da API Power Platform é específica para a gestão do ambiente e também é comumente referida como API da Business Application Platform (BAP). A funcionalidade deste conjunto de endpoints está disponível nas versões mais recentes da Power Platform API.

Next steps

Agora que compreende a estratégia de versões e suporte, vamos aprender a fazer a autenticação com a API do Microsoft Power Platform.